A valid request URL is required to generate request examples{
"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>"
}
}
}Add a property to a product type.
A valid request URL is required to generate request examples{
"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>"
}
}
}JWT Authorization header using the Bearer scheme.
limits which fields are returned in the response body
Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed
If True, the attribute is part of the base product type and can only have order modified.
Used to order the display of the attributes within a section
If True, the admin must include this attribute in products of this productType
If True, the property is hidden in the storefront. This field only applies to properties.
If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API.
If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)
If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.
Show child attributes
The collection of vocabulary values included in this product type.
Show child attributes
Attribute
Show child attributes
Success
Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed
If True, the attribute is part of the base product type and can only have order modified.
Used to order the display of the attributes within a section
If True, the admin must include this attribute in products of this productType
If True, the property is hidden in the storefront. This field only applies to properties.
If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API.
If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)
If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.
Show child attributes
The collection of vocabulary values included in this product type.
Show child attributes
Attribute
Show child attributes