API reference
Error
A valid request URL is required to generate request examples{
"availableShippingDiscounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"bundledProducts": [
{
"creditValue": 123,
"goodsType": "<string>",
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"isPackagedStandAlone": true,
"measurements": {
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
}
},
"optionAttributeFQN": "<string>",
"optionValue": "<unknown>",
"productCode": "<string>",
"productType": "<string>",
"quantity": 123,
"content": {
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>",
"seoFriendlyUrl": "<string>"
}
}
],
"catalogEndDate": "2023-11-07T05:31:56Z",
"catalogStartDate": "2023-11-07T05:31:56Z",
"categories": [
{
"attributes": [
{
"dataType": 123,
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"categoryCode": "<string>",
"categoryId": 123,
"childrenCategories": [
{}
],
"content": {
"categoryImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"description": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"name": "<string>",
"pageTitle": "<string>",
"slug": "<string>"
},
"count": 123,
"isDisplayed": true,
"parentCategory": {},
"sequence": 123,
"shouldSlice": true,
"updateDate": "2023-11-07T05:31:56Z"
}
],
"collectionMembersProductContent": [
{
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>",
"seoFriendlyUrl": "<string>"
}
],
"content": {
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>",
"seoFriendlyUrl": "<string>"
},
"costPriceMargin": 123,
"createDate": "2023-11-07T05:31:56Z",
"dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
"daysAvailableInCatalog": 123,
"fulfillmentTypesSupported": [
"<string>"
],
"goodsType": "<string>",
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"isActive": true,
"isPackagedStandAlone": true,
"isRecurring": true,
"isTaxable": true,
"locationsInStock": [
"<string>"
],
"measurements": {
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
}
},
"mfgPartNumber": "<string>",
"mfgPartNumbers": [
"<string>"
],
"options": [
{
"attributeDetail": {
"allowFilteringAndSortingInStorefront": true,
"availableForOrderRouting": true,
"customWeightInStorefrontSearch": true,
"dataType": "<string>",
"dataTypeSequence": 123,
"description": "<string>",
"displayIntention": "<string>",
"indexValueWithCase": true,
"inputType": "<string>",
"name": "<string>",
"searchDisplayValue": true,
"searchableInStorefront": true,
"usageType": "<string>",
"validation": {
"maxDateValue": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateValue": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"valueType": "<string>"
},
"attributeFQN": "<string>",
"isMultiValue": true,
"isProductImageGroupSelector": true,
"isRequired": true,
"values": [
{
"attributeValueId": 123,
"bundledProduct": {
"creditValue": 123,
"goodsType": "<string>",
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"isPackagedStandAlone": true,
"measurements": {
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
}
},
"optionAttributeFQN": "<string>",
"optionValue": "<unknown>",
"productCode": "<string>",
"productType": "<string>",
"quantity": 123,
"content": {
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>",
"seoFriendlyUrl": "<string>"
}
},
"deltaPrice": 123,
"deltaWeight": 123,
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"isDefault": true,
"isEnabled": true,
"isSelected": true,
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": null
}
]
}
],
"personalizationScore": 123,
"price": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
},
"priceRange": {
"lower": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
},
"upper": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
}
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z"
},
"productCode": "<string>",
"productCollectionMembers": [
{
"memberKey": {
"value": "<string>"
}
}
],
"productCollections": [
{
"isPrimary": true,
"productCode": "<string>"
}
],
"productImageGroups": [
{
"productImageGroupId": "<string>",
"productImageGroupTags": [
{
"attributeFqn": "<string>",
"value": "<string>"
}
]
}
],
"productRules": [
"<string>"
],
"productSequence": 123,
"productType": "<string>",
"productTypeId": 123,
"productUsage": "<string>",
"properties": [
{
"attributeDetail": {
"allowFilteringAndSortingInStorefront": true,
"availableForOrderRouting": true,
"customWeightInStorefrontSearch": true,
"dataType": "<string>",
"dataTypeSequence": 123,
"description": "<string>",
"displayIntention": "<string>",
"indexValueWithCase": true,
"inputType": "<string>",
"name": "<string>",
"searchDisplayValue": true,
"searchableInStorefront": true,
"usageType": "<string>",
"validation": {
"maxDateValue": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateValue": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"valueType": "<string>"
},
"attributeFQN": "<string>",
"isHidden": true,
"isMultiValue": true,
"propertyType": "<string>",
"values": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"stringValue": "<string>",
"value": null
}
]
}
],
"publishState": "<string>",
"purchasableState": {
"isPurchasable": true,
"messages": [
{
"message": "<string>",
"severity": "<string>",
"source": "<string>",
"sourceId": "<string>",
"validationType": "<string>"
}
]
},
"purchaseLocation": "<string>",
"score": 123,
"sliceValue": "<string>",
"slicingAttributeFQN": "<string>",
"upCs": [
"<string>"
],
"upc": "<string>",
"updateDate": "2023-11-07T05:31:56Z",
"validPriceLists": [
"<string>"
],
"variationProductCode": "<string>",
"variations": [
{
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"options": [
{
"attributeFQN": "<string>",
"value": null,
"valueSequence": 123
}
],
"productCode": "<string>",
"upc": "<string>"
}
],
"volumePriceBands": [
{
"isCurrent": true,
"maxQty": 123,
"minQty": 123,
"price": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
},
"priceRange": {
"lower": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
},
"upper": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
}
}
}
],
"volumePriceRange": {
"lower": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
},
"upper": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
}
}
}Retrieves information about a single product given its product code.
GET
/
commerce
/
catalog
/
storefront
/
products
/
{productCode}
Error
A valid request URL is required to generate request examples{
"availableShippingDiscounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"bundledProducts": [
{
"creditValue": 123,
"goodsType": "<string>",
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"isPackagedStandAlone": true,
"measurements": {
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
}
},
"optionAttributeFQN": "<string>",
"optionValue": "<unknown>",
"productCode": "<string>",
"productType": "<string>",
"quantity": 123,
"content": {
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>",
"seoFriendlyUrl": "<string>"
}
}
],
"catalogEndDate": "2023-11-07T05:31:56Z",
"catalogStartDate": "2023-11-07T05:31:56Z",
"categories": [
{
"attributes": [
{
"dataType": 123,
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"categoryCode": "<string>",
"categoryId": 123,
"childrenCategories": [
{}
],
"content": {
"categoryImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"description": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"name": "<string>",
"pageTitle": "<string>",
"slug": "<string>"
},
"count": 123,
"isDisplayed": true,
"parentCategory": {},
"sequence": 123,
"shouldSlice": true,
"updateDate": "2023-11-07T05:31:56Z"
}
],
"collectionMembersProductContent": [
{
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>",
"seoFriendlyUrl": "<string>"
}
],
"content": {
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>",
"seoFriendlyUrl": "<string>"
},
"costPriceMargin": 123,
"createDate": "2023-11-07T05:31:56Z",
"dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
"daysAvailableInCatalog": 123,
"fulfillmentTypesSupported": [
"<string>"
],
"goodsType": "<string>",
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"isActive": true,
"isPackagedStandAlone": true,
"isRecurring": true,
"isTaxable": true,
"locationsInStock": [
"<string>"
],
"measurements": {
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
}
},
"mfgPartNumber": "<string>",
"mfgPartNumbers": [
"<string>"
],
"options": [
{
"attributeDetail": {
"allowFilteringAndSortingInStorefront": true,
"availableForOrderRouting": true,
"customWeightInStorefrontSearch": true,
"dataType": "<string>",
"dataTypeSequence": 123,
"description": "<string>",
"displayIntention": "<string>",
"indexValueWithCase": true,
"inputType": "<string>",
"name": "<string>",
"searchDisplayValue": true,
"searchableInStorefront": true,
"usageType": "<string>",
"validation": {
"maxDateValue": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateValue": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"valueType": "<string>"
},
"attributeFQN": "<string>",
"isMultiValue": true,
"isProductImageGroupSelector": true,
"isRequired": true,
"values": [
{
"attributeValueId": 123,
"bundledProduct": {
"creditValue": 123,
"goodsType": "<string>",
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"isPackagedStandAlone": true,
"measurements": {
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
}
},
"optionAttributeFQN": "<string>",
"optionValue": "<unknown>",
"productCode": "<string>",
"productType": "<string>",
"quantity": 123,
"content": {
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>",
"seoFriendlyUrl": "<string>"
}
},
"deltaPrice": 123,
"deltaWeight": 123,
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"isDefault": true,
"isEnabled": true,
"isSelected": true,
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": null
}
]
}
],
"personalizationScore": 123,
"price": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
},
"priceRange": {
"lower": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
},
"upper": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
}
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z"
},
"productCode": "<string>",
"productCollectionMembers": [
{
"memberKey": {
"value": "<string>"
}
}
],
"productCollections": [
{
"isPrimary": true,
"productCode": "<string>"
}
],
"productImageGroups": [
{
"productImageGroupId": "<string>",
"productImageGroupTags": [
{
"attributeFqn": "<string>",
"value": "<string>"
}
]
}
],
"productRules": [
"<string>"
],
"productSequence": 123,
"productType": "<string>",
"productTypeId": 123,
"productUsage": "<string>",
"properties": [
{
"attributeDetail": {
"allowFilteringAndSortingInStorefront": true,
"availableForOrderRouting": true,
"customWeightInStorefrontSearch": true,
"dataType": "<string>",
"dataTypeSequence": 123,
"description": "<string>",
"displayIntention": "<string>",
"indexValueWithCase": true,
"inputType": "<string>",
"name": "<string>",
"searchDisplayValue": true,
"searchableInStorefront": true,
"usageType": "<string>",
"validation": {
"maxDateValue": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateValue": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"valueType": "<string>"
},
"attributeFQN": "<string>",
"isHidden": true,
"isMultiValue": true,
"propertyType": "<string>",
"values": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"stringValue": "<string>",
"value": null
}
]
}
],
"publishState": "<string>",
"purchasableState": {
"isPurchasable": true,
"messages": [
{
"message": "<string>",
"severity": "<string>",
"source": "<string>",
"sourceId": "<string>",
"validationType": "<string>"
}
]
},
"purchaseLocation": "<string>",
"score": 123,
"sliceValue": "<string>",
"slicingAttributeFQN": "<string>",
"upCs": [
"<string>"
],
"upc": "<string>",
"updateDate": "2023-11-07T05:31:56Z",
"validPriceLists": [
"<string>"
],
"variationProductCode": "<string>",
"variations": [
{
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"options": [
{
"attributeFQN": "<string>",
"value": null,
"valueSequence": 123
}
],
"productCode": "<string>",
"upc": "<string>"
}
],
"volumePriceBands": [
{
"isCurrent": true,
"maxQty": 123,
"minQty": 123,
"price": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
},
"priceRange": {
"lower": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
},
"upper": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
}
}
}
],
"volumePriceRange": {
"lower": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
},
"upper": {
"catalogListPrice": 123,
"catalogSalePrice": 123,
"creditValue": 123,
"discount": {
"couponCode": "<string>",
"discount": {
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
},
"discounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"impact": 123
},
"effectivePricelistCode": "<string>",
"msrp": 123,
"price": 123,
"priceListEntryCode": "<string>",
"priceListEntryEndDate": "2023-11-07T05:31:56Z",
"priceListEntryMode": "<string>",
"priceType": "<string>",
"salePrice": 123,
"salePriceType": "<string>"
}
}
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Required. Merchant-created code associated with the product, for example, a SKU. Max length: 30.
Query Parameters
Optional. Merchant-created code associated with a specific product variation. Max length: #.
Optional. Response groups to be determined.
Optional. If true, return a product if it is located but inactive.
Determines whether or not to check inventory on an item when validating
Optional. If true, will still return the product, even if product is out of stock and the out of stock behavior is set to “Hide Product in Store”. If false or omitted, the same product will return a 404 not found. Suppressing the 404 not found is useful for site SEO.
Optional. If specified, will be used for returning pricing based on volume if applicable. Defaults to 1 if not specified.
limits which fields are returned in the response body
Response
Success
Details of a product, including its product code, name, description, options (if any), and current state--whether the product can be purchased given the options selected currently.
List of potential shipping discounts available for this product.
Show child attributes
Show child attributes
The list of Bundled products included in this product. This is only populated when ProductUsage=Bundle
Show child attributes
Show child attributes
List of categories to which this product belongs.
Show child attributes
Show child attributes
Only used for indexing
Show child attributes
Show child attributes
Name of the product and, if supplied, description, metatags, friendly URL, and associated images.
Show child attributes
Show child attributes
When the product was created with the product admin resource.
Indicates the fulfillment types the product supports.
The GoodsType of the product (Physical, Digital, DigitalCredit....)
Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.
Show child attributes
Show child attributes
If true, the product exists. If not, the product should not appear in search results.
Is this product shipped in its own package
If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.
If true, the product is subject to tax.
Any location code (eq) or array of location codes which are in stock.
Physical dimensions of the package required to ship the product and its weight.
Show child attributes
Show child attributes
Manufacturer part number.
Manufacturer part numbers (populated for configurable products).
List of the product's configurable options and extras. Includes whether an option is configurable (for example, a T-shirt) or an Extra (for example, monogram or gift-wrapping).
Show child attributes
Show child attributes
Price of the product with any sale and discounts applied.
Show child attributes
Show child attributes
For products with options that vary the cost of the product, the range between lowest and highest possible price of the product based on the current selection of options.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Merchant-created code associated with the product, for example, a SKU.
list of member products that are part of the collection This requires that the ProductUsage be set to Collection
Show child attributes
Show child attributes
List of product codes of product collections that this product is a member of.
Show child attributes
Show child attributes
List of the image groups this product uses. Image groups are used to map different images to different product options. If the product doesn't have options then all images will be in the default image group.
Show child attributes
Show child attributes
System generated monotonically increasing sequence
The UsageType of this product (Standard, Configurable, Bundle, Component, Collection)
List of product properties. These are attributes that might apply to multiple products, for example, price, size, manufacturer. These attributes cannot be configured by the shopper.
Show child attributes
Show child attributes
Represents the published state of the product returned. Valid values for ValueType are defined in PublishStateConst.
Current state of the product purchase, that is, whether it is ready to be purchased. For products with configurable options, /// the product is purchaseable if the shopper has selected all required options. If not, a message lists which required options are missing.
Show child attributes
Show child attributes
The location where the product is being purchased.. default is null. Products can have different prices by purchaseLocation via custom priceListResolution....
The item's search engine relevancy score.
Readonly value of the selected value of the option corresponding to the Mozu.ProductRuntime.Contracts.Product.SlicingAttributeFQN
UPC code of the products (populated for configurable products).
UPC code of the product.
When the product was last modified with the product admin resource.
List of valid pricelists for the product
When a configurable product has IsPurchasable=true on a GetProduct, this property will be populated for submission to cart.
Show child attributes
Show child attributes
For products with bulk pricing... this will be populated with pricebands, depending on what options have been selected...
Show child attributes
Show child attributes
For products with options that vary the cost of the product, the range between lowest and highest possible price of the product based on the current selection of options.
Show child attributes
Show child attributes
⌘I