Skip to main content
GET
/
commerce
/
catalog
/
admin
/
attributedefinition
/
attributes
Error
A valid request URL is required to generate request examples
{
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "adminName": "<string>",
      "namespace": "<string>",
      "attributeCode": "<string>",
      "attributeFQN": "<string>",
      "isValueMappingAttribute": true,
      "valueMappingAttributeFQN": "<string>",
      "attributeSequence": 123,
      "attributeDataTypeSequence": 123,
      "masterCatalogId": 123,
      "inputType": "<string>",
      "valueType": "<string>",
      "dataType": "<string>",
      "isOption": true,
      "isExtra": true,
      "isProperty": true,
      "availableForOrderRouting": true,
      "attributeMetadata": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "content": {
        "localeCode": "<string>",
        "name": "<string>",
        "description": "<string>"
      },
      "localizedContent": [
        {
          "localeCode": "<string>",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "validation": {
        "regularExpression": "<string>",
        "minStringLength": 123,
        "maxStringLength": 123,
        "minNumericValue": 123,
        "maxNumericValue": 123,
        "minDateValue": "2023-11-07T05:31:56Z",
        "maxDateValue": "2023-11-07T05:31:56Z"
      },
      "vocabularyValues": [
        {
          "valueSequence": 123,
          "value": "<unknown>",
          "mappedGenericValues": [
            "<unknown>"
          ],
          "productName": "<string>",
          "content": {
            "localeCode": "<string>",
            "stringValue": "<string>"
          },
          "localizedContent": [
            {
              "localeCode": "<string>",
              "stringValue": "<string>"
            }
          ],
          "displayOrder": 123
        }
      ],
      "searchSettings": {
        "searchableInStorefront": true,
        "searchableInAdmin": true,
        "searchDisplayValue": true,
        "allowFilteringAndSortingInStorefront": true,
        "indexValueWithCase": true,
        "customWeightInStorefrontSearch": true
      },
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      }
    }
  ]
}

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

Success

Collection of attributes.

startIndex
integer<int32>
pageSize
integer<int32>
pageCount
integer<int32>
totalCount
integer<int32>
items
object[] | null