Get Product Attributes.

Get product attributes. This current version of the Attributes API includes localizedContent to support multi-locale catalogs, which was not present in the previous API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access attribute data that has not yet been rewritten to the new model by providing an x-api-version header set to “1”.

GET /commerce/catalog/admin/attributedefinition/attributes

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "adminName": "<string>",
      "attributeCode": "<string>",
      "attributeDataTypeSequence": 123,
      "attributeFQN": "<string>",
      "attributeMetadata": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "attributeSequence": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "availableForOrderRouting": true,
      "content": {
        "description": "<string>",
        "localeCode": "<string>",
        "name": "<string>"
      },
      "dataType": "<string>",
      "inputType": "<string>",
      "isExtra": true,
      "isOption": true,
      "isProperty": true,
      "isValueMappingAttribute": true,
      "localizedContent": [
        {
          "description": "<string>",
          "localeCode": "<string>",
          "name": "<string>"
        }
      ],
      "masterCatalogId": 123,
      "namespace": "<string>",
      "searchSettings": {
        "allowFilteringAndSortingInStorefront": true,
        "customWeightInStorefrontSearch": true,
        "indexValueWithCase": true,
        "searchDisplayValue": true,
        "searchableInAdmin": true,
        "searchableInStorefront": true
      },
      "validation": {
        "maxDateValue": "2023-11-07T05:31:56Z",
        "maxNumericValue": 123,
        "maxStringLength": 123,
        "minDateValue": "2023-11-07T05:31:56Z",
        "minNumericValue": 123,
        "minStringLength": 123,
        "regularExpression": "<string>"
      },
      "valueMappingAttributeFQN": "<string>",
      "valueType": "<string>",
      "vocabularyValues": [
        {
          "content": {
            "localeCode": "<string>",
            "stringValue": "<string>"
          },
          "displayOrder": 123,
          "localizedContent": [
            {
              "localeCode": "<string>",
              "stringValue": "<string>"
            }
          ],
          "mappedGenericValues": [
            "<unknown>"
          ],
          "productName": "<string>",
          "value": "<unknown>",
          "valueSequence": 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

filter · string

responseGroups · string

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

Collection of attributes.

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>