Skip to main content
POST
/
commerce
/
catalog
/
admin
/
attributedefinition
/
producttypes
Error
A valid request URL is required to generate request examples
{
  "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

​
responseFields
string

limits which fields are returned in the response body

Body

application/json
​
id
integer<int32> | null

Unique identifier of the ProductType. System-supplied and read-only.

​
name
string | null

Name of the productType

​
masterCatalogId
integer<int32> | null

Indentifier of the Master Catalog that this ProductType is a member of. System-supplied and read-only.

​
isBaseProductType
boolean

System supplied and read only. There is only one BaseProductType per MasterCatalog.

​
productCount
integer<int32> | null

Indicates the number of products currently using this Product Type. System-supplied and read-only.

​
productUsages
string[] | null

List of ProductUsages supported by the ProductType.

​
goodsType
string | null

The TYpe of Goods of this product

​
options
object[] | null

Collection of the Attributes that are Options in this productType

​
extras
object[] | null

Collection of the Attributes that are Extras in this productType

​
properties
object[] | null

Collection of the Attributes that are Properties in this productType

​
variantProperties
object[] | null

Collection of the Attributes that are VariantProperties in this productType

​
auditInfo
object

Response

Success

​
id
integer<int32> | null

Unique identifier of the ProductType. System-supplied and read-only.

​
name
string | null

Name of the productType

​
masterCatalogId
integer<int32> | null

Indentifier of the Master Catalog that this ProductType is a member of. System-supplied and read-only.

​
isBaseProductType
boolean

System supplied and read only. There is only one BaseProductType per MasterCatalog.

​
productCount
integer<int32> | null

Indicates the number of products currently using this Product Type. System-supplied and read-only.

​
productUsages
string[] | null

List of ProductUsages supported by the ProductType.

​
goodsType
string | null

The TYpe of Goods of this product

​
options
object[] | null

Collection of the Attributes that are Options in this productType

​
extras
object[] | null

Collection of the Attributes that are Extras in this productType

​
properties
object[] | null

Collection of the Attributes that are Properties in this productType

​
variantProperties
object[] | null

Collection of the Attributes that are VariantProperties in this productType

​
auditInfo
object