Get Attributes

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

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "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
        }
      ]
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

startIndex · integer<int32> · default: 0

pageSize · integer<int32> · default: 0

sortBy · string

responseGroups · string

filter · string

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>