Get Product Type
Get product type by Id.
GET
/
commerce
/
catalog
/
admin
/
attributedefinition
/
producttypes
/
{productTypeId}
Error
A valid request URL is required to generate request examples{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"extras": [
{
"attributeDetail": {
"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,
"availableInRules": 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": "<string>",
"valueSequence": 123
}
]
},
"attributeFQN": "<string>",
"displayInfo": {
"displayIntention": "<string>"
},
"isAdminOnlyProperty": true,
"isHiddenProperty": true,
"isInheritedFromBaseType": true,
"isMultiValueProperty": true,
"isProductDetailsOnlyProperty": true,
"isRequiredByAdmin": true,
"order": 123,
"vocabularyValues": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"order": 123,
"value": "<unknown>",
"vocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<string>",
"valueSequence": 123
}
}
]
}
],
"goodsType": "<string>",
"id": 123,
"isBaseProductType": true,
"masterCatalogId": 123,
"name": "<string>",
"options": [
{
"attributeDetail": {
"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,
"availableInRules": 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": "<string>",
"valueSequence": 123
}
]
},
"attributeFQN": "<string>",
"displayInfo": {
"displayIntention": "<string>"
},
"isAdminOnlyProperty": true,
"isHiddenProperty": true,
"isInheritedFromBaseType": true,
"isMultiValueProperty": true,
"isProductDetailsOnlyProperty": true,
"isRequiredByAdmin": true,
"order": 123,
"vocabularyValues": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"order": 123,
"value": "<unknown>",
"vocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<string>",
"valueSequence": 123
}
}
]
}
],
"productCount": 123,
"productUsages": [
"<string>"
],
"properties": [
{
"attributeDetail": {
"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,
"availableInRules": 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": "<string>",
"valueSequence": 123
}
]
},
"attributeFQN": "<string>",
"displayInfo": {
"displayIntention": "<string>"
},
"isAdminOnlyProperty": true,
"isHiddenProperty": true,
"isInheritedFromBaseType": true,
"isMultiValueProperty": true,
"isProductDetailsOnlyProperty": true,
"isRequiredByAdmin": true,
"order": 123,
"vocabularyValues": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"order": 123,
"value": "<unknown>",
"vocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<string>",
"valueSequence": 123
}
}
]
}
],
"variantProperties": [
{
"attributeDetail": {
"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,
"availableInRules": 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": "<string>",
"valueSequence": 123
}
]
},
"attributeFQN": "<string>",
"displayInfo": {
"displayIntention": "<string>"
},
"isAdminOnlyProperty": true,
"isHiddenProperty": true,
"isInheritedFromBaseType": true,
"isMultiValueProperty": true,
"isProductDetailsOnlyProperty": true,
"isRequiredByAdmin": true,
"order": 123,
"vocabularyValues": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"order": 123,
"value": "<unknown>",
"vocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<string>",
"valueSequence": 123
}
}
]
}
]
}Response
OK
⌘I
Error
A valid request URL is required to generate request examples{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"extras": [
{
"attributeDetail": {
"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,
"availableInRules": 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": "<string>",
"valueSequence": 123
}
]
},
"attributeFQN": "<string>",
"displayInfo": {
"displayIntention": "<string>"
},
"isAdminOnlyProperty": true,
"isHiddenProperty": true,
"isInheritedFromBaseType": true,
"isMultiValueProperty": true,
"isProductDetailsOnlyProperty": true,
"isRequiredByAdmin": true,
"order": 123,
"vocabularyValues": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"order": 123,
"value": "<unknown>",
"vocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<string>",
"valueSequence": 123
}
}
]
}
],
"goodsType": "<string>",
"id": 123,
"isBaseProductType": true,
"masterCatalogId": 123,
"name": "<string>",
"options": [
{
"attributeDetail": {
"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,
"availableInRules": 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": "<string>",
"valueSequence": 123
}
]
},
"attributeFQN": "<string>",
"displayInfo": {
"displayIntention": "<string>"
},
"isAdminOnlyProperty": true,
"isHiddenProperty": true,
"isInheritedFromBaseType": true,
"isMultiValueProperty": true,
"isProductDetailsOnlyProperty": true,
"isRequiredByAdmin": true,
"order": 123,
"vocabularyValues": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"order": 123,
"value": "<unknown>",
"vocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<string>",
"valueSequence": 123
}
}
]
}
],
"productCount": 123,
"productUsages": [
"<string>"
],
"properties": [
{
"attributeDetail": {
"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,
"availableInRules": 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": "<string>",
"valueSequence": 123
}
]
},
"attributeFQN": "<string>",
"displayInfo": {
"displayIntention": "<string>"
},
"isAdminOnlyProperty": true,
"isHiddenProperty": true,
"isInheritedFromBaseType": true,
"isMultiValueProperty": true,
"isProductDetailsOnlyProperty": true,
"isRequiredByAdmin": true,
"order": 123,
"vocabularyValues": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"order": 123,
"value": "<unknown>",
"vocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<string>",
"valueSequence": 123
}
}
]
}
],
"variantProperties": [
{
"attributeDetail": {
"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,
"availableInRules": 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": "<string>",
"valueSequence": 123
}
]
},
"attributeFQN": "<string>",
"displayInfo": {
"displayIntention": "<string>"
},
"isAdminOnlyProperty": true,
"isHiddenProperty": true,
"isInheritedFromBaseType": true,
"isMultiValueProperty": true,
"isProductDetailsOnlyProperty": true,
"isRequiredByAdmin": true,
"order": 123,
"vocabularyValues": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"order": 123,
"value": "<unknown>",
"vocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<string>",
"valueSequence": 123
}
}
]
}
]
}
