Skip to main content
GET
/
commerce
/
catalog
/
admin
/
attributedefinition
/
producttypes
Error
A valid request URL is required to generate request examples
{
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "masterCatalogId": 123,
      "isBaseProductType": true,
      "productCount": 123,
      "productUsages": [
        "<string>"
      ],
      "goodsType": "<string>",
      "options": [
        {
          "attributeFQN": "<string>",
          "isInheritedFromBaseType": true,
          "order": 123,
          "isRequiredByAdmin": true,
          "isHiddenProperty": true,
          "isAdminOnlyProperty": true,
          "isProductDetailsOnlyProperty": true,
          "isMultiValueProperty": true,
          "displayInfo": {
            "displayIntention": "<string>"
          },
          "vocabularyValues": [
            {
              "value": "<unknown>",
              "order": 123,
              "displayInfo": {
                "cmsId": "<string>",
                "imageUrl": "<string>",
                "colorValue": "<string>"
              },
              "vocabularyValueDetail": {
                "valueSequence": 123,
                "value": "<unknown>",
                "mappedGenericValues": [
                  "<unknown>"
                ],
                "productName": "<string>",
                "content": {
                  "localeCode": "<string>",
                  "stringValue": "<string>"
                },
                "localizedContent": [
                  {
                    "localeCode": "<string>",
                    "stringValue": "<string>"
                  }
                ],
                "displayOrder": 123
              }
            }
          ],
          "attributeDetail": {
            "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>"
            }
          }
        }
      ],
      "extras": [
        {
          "attributeFQN": "<string>",
          "isInheritedFromBaseType": true,
          "order": 123,
          "isRequiredByAdmin": true,
          "isHiddenProperty": true,
          "isAdminOnlyProperty": true,
          "isProductDetailsOnlyProperty": true,
          "isMultiValueProperty": true,
          "displayInfo": {
            "displayIntention": "<string>"
          },
          "vocabularyValues": [
            {
              "value": "<unknown>",
              "order": 123,
              "displayInfo": {
                "cmsId": "<string>",
                "imageUrl": "<string>",
                "colorValue": "<string>"
              },
              "vocabularyValueDetail": {
                "valueSequence": 123,
                "value": "<unknown>",
                "mappedGenericValues": [
                  "<unknown>"
                ],
                "productName": "<string>",
                "content": {
                  "localeCode": "<string>",
                  "stringValue": "<string>"
                },
                "localizedContent": [
                  {
                    "localeCode": "<string>",
                    "stringValue": "<string>"
                  }
                ],
                "displayOrder": 123
              }
            }
          ],
          "attributeDetail": {
            "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>"
            }
          }
        }
      ],
      "properties": [
        {
          "attributeFQN": "<string>",
          "isInheritedFromBaseType": true,
          "order": 123,
          "isRequiredByAdmin": true,
          "isHiddenProperty": true,
          "isAdminOnlyProperty": true,
          "isProductDetailsOnlyProperty": true,
          "isMultiValueProperty": true,
          "displayInfo": {
            "displayIntention": "<string>"
          },
          "vocabularyValues": [
            {
              "value": "<unknown>",
              "order": 123,
              "displayInfo": {
                "cmsId": "<string>",
                "imageUrl": "<string>",
                "colorValue": "<string>"
              },
              "vocabularyValueDetail": {
                "valueSequence": 123,
                "value": "<unknown>",
                "mappedGenericValues": [
                  "<unknown>"
                ],
                "productName": "<string>",
                "content": {
                  "localeCode": "<string>",
                  "stringValue": "<string>"
                },
                "localizedContent": [
                  {
                    "localeCode": "<string>",
                    "stringValue": "<string>"
                  }
                ],
                "displayOrder": 123
              }
            }
          ],
          "attributeDetail": {
            "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>"
            }
          }
        }
      ],
      "variantProperties": [
        {
          "attributeFQN": "<string>",
          "isInheritedFromBaseType": true,
          "order": 123,
          "isRequiredByAdmin": true,
          "isHiddenProperty": true,
          "isAdminOnlyProperty": true,
          "isProductDetailsOnlyProperty": true,
          "isMultiValueProperty": true,
          "displayInfo": {
            "displayIntention": "<string>"
          },
          "vocabularyValues": [
            {
              "value": "<unknown>",
              "order": 123,
              "displayInfo": {
                "cmsId": "<string>",
                "imageUrl": "<string>",
                "colorValue": "<string>"
              },
              "vocabularyValueDetail": {
                "valueSequence": 123,
                "value": "<unknown>",
                "mappedGenericValues": [
                  "<unknown>"
                ],
                "productName": "<string>",
                "content": {
                  "localeCode": "<string>",
                  "stringValue": "<string>"
                },
                "localizedContent": [
                  {
                    "localeCode": "<string>",
                    "stringValue": "<string>"
                  }
                ],
                "displayOrder": 123
              }
            }
          ],
          "attributeDetail": {
            "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>"
            }
          }
        }
      ],
      "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

Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0.

​
pageSize
integer<int32>
default:0

Used to page results from a query. Indicates the maximum number of entities to return from a single query. The default value is 20 and the maximum value is 200.

​
sortBy
string

The element to sort the results by and the order in which the results appear. Either ascending or descending order. For example, to sort the results by “ID” ascending then by “CreateDate” descending, use: id asc,createdate desc.

​
filter
string

A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

​
responseGroups
string

Used to get more specific information from the request. For example to get discounts applied to a product use the AppliedProducts response group. Available response groups: ApplicableDiscounts, VariationOptions, and BaseProductCode.

​
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