Get Attribute

Customer attributes are custom attributes that you can apply to customer accounts to add further definition for special uses, such as marketing campaigns, or discounts.

GET /commerce/customer/attributedefinition/attributes/{attributeFQN}

Error

A valid request URL is required to generate request examples

200

{
  "attributeCode": "<string>",
  "displayGroup": "<string>",
  "valueType": "<string>",
  "adminName": "<string>",
  "attributeFQN": "<string>",
  "attributeMetadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "availableForDiscounts": true,
  "availableForOrderRouting": true,
  "content": {
    "localeCode": "<string>",
    "value": "<string>"
  },
  "dataType": "<string>",
  "id": 123,
  "inputType": "<string>",
  "isActive": true,
  "isMultiValued": true,
  "isReadOnly": true,
  "isRequired": true,
  "isVisible": true,
  "namespace": "<string>",
  "order": 123,
  "validation": {
    "maxDateTime": "2023-11-07T05:31:56Z",
    "maxNumericValue": 123,
    "maxStringLength": 123,
    "minDateTime": "2023-11-07T05:31:56Z",
    "minNumericValue": 123,
    "minStringLength": 123,
    "regularExpression": "<string>"
  },
  "vocabularyValues": [
    {
      "value": "<string>",
      "content": {
        "localeCode": "<string>",
        "value": "<string>"
      },
      "isHidden": true,
      "sequence": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

attributeFQN · string · required

Query Parameters

responseGroups · string

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

attributeCode · string · required

Required string length: 1 - 50

displayGroup · string · required

Minimum string length: 1

valueType · string · required

Minimum string length: 1

adminName · string | null

Maximum string length: 50

attributeFQN · string | null

attributeMetadata · object[] | null

Show child attributes

auditInfo · object

Show child attributes

availableForDiscounts · boolean

availableForOrderRouting · boolean

content · object

Show child attributes

dataType · string | null

id · integer<int32> | null

inputType · string | null

isActive · boolean | null

isMultiValued · boolean | null

isReadOnly · boolean

isRequired · boolean | null

isVisible · boolean | null

namespace · string | null

Maximum string length: 200

order · integer<int32> | null

validation · object

Show child attributes

vocabularyValues · object[] | null

Show child attributes