Skip to main content
GET
/
commerce
/
catalog
/
storefront
/
products
/
{productCode}
Error
A valid request URL is required to generate request examples
{
  "productCode": "<string>",
  "purchaseLocation": "<string>",
  "productSequence": 123,
  "productUsage": "<string>",
  "fulfillmentTypesSupported": [
    "<string>"
  ],
  "goodsType": "<string>",
  "bundledProducts": [
    {
      "productCode": "<string>",
      "goodsType": "<string>",
      "quantity": 123,
      "measurements": {
        "packageHeight": {
          "unit": "<string>",
          "value": 123
        },
        "packageWidth": {
          "unit": "<string>",
          "value": 123
        },
        "packageLength": {
          "unit": "<string>",
          "value": 123
        },
        "packageWeight": {
          "unit": "<string>",
          "value": 123
        }
      },
      "isPackagedStandAlone": true,
      "inventoryInfo": {
        "manageStock": true,
        "outOfStockBehavior": "<string>",
        "onlineStockAvailable": 123,
        "onlineSoftStockAvailable": 123,
        "onlineLocationCode": "<string>",
        "availableDate": "2023-11-07T05:31:56Z",
        "isSubstitutable": true
      },
      "optionAttributeFQN": "<string>",
      "optionValue": "<unknown>",
      "creditValue": 123,
      "productType": "<string>",
      "content": {
        "productName": "<string>",
        "productFullDescription": "<string>",
        "productShortDescription": "<string>",
        "metaTagTitle": "<string>",
        "metaTagDescription": "<string>",
        "metaTagKeywords": "<string>",
        "seoFriendlyUrl": "<string>",
        "productImages": [
          {
            "imageLabel": "<string>",
            "altText": "<string>",
            "imageUrl": "<string>",
            "cmsId": "<string>",
            "videoUrl": "<string>",
            "mediaType": "<string>",
            "sequence": 123,
            "productImageGroupId": "<string>"
          }
        ]
      }
    }
  ],
  "content": {
    "productName": "<string>",
    "productFullDescription": "<string>",
    "productShortDescription": "<string>",
    "metaTagTitle": "<string>",
    "metaTagDescription": "<string>",
    "metaTagKeywords": "<string>",
    "seoFriendlyUrl": "<string>",
    "productImages": [
      {
        "imageLabel": "<string>",
        "altText": "<string>",
        "imageUrl": "<string>",
        "cmsId": "<string>",
        "videoUrl": "<string>",
        "mediaType": "<string>",
        "sequence": 123,
        "productImageGroupId": "<string>"
      }
    ]
  },
  "purchasableState": {
    "isPurchasable": true,
    "messages": [
      {
        "severity": "<string>",
        "source": "<string>",
        "message": "<string>",
        "validationType": "<string>",
        "sourceId": "<string>"
      }
    ]
  },
  "isActive": true,
  "publishState": "<string>",
  "price": {
    "msrp": 123,
    "price": 123,
    "priceType": "<string>",
    "salePrice": 123,
    "salePriceType": "<string>",
    "catalogSalePrice": 123,
    "catalogListPrice": 123,
    "priceListEntryEndDate": "2023-11-07T05:31:56Z",
    "discount": {
      "couponCode": "<string>",
      "discount": {
        "discountId": 123,
        "expirationDate": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "friendlyDescription": "<string>",
        "impact": 123
      },
      "discounts": [
        {
          "discountId": 123,
          "expirationDate": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "friendlyDescription": "<string>",
          "impact": 123
        }
      ],
      "impact": 123
    },
    "creditValue": 123,
    "effectivePricelistCode": "<string>",
    "priceListEntryCode": "<string>",
    "priceListEntryMode": "<string>"
  },
  "priceRange": {
    "lower": {
      "msrp": 123,
      "price": 123,
      "priceType": "<string>",
      "salePrice": 123,
      "salePriceType": "<string>",
      "catalogSalePrice": 123,
      "catalogListPrice": 123,
      "priceListEntryEndDate": "2023-11-07T05:31:56Z",
      "discount": {
        "couponCode": "<string>",
        "discount": {
          "discountId": 123,
          "expirationDate": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "friendlyDescription": "<string>",
          "impact": 123
        },
        "discounts": [
          {
            "discountId": 123,
            "expirationDate": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "friendlyDescription": "<string>",
            "impact": 123
          }
        ],
        "impact": 123
      },
      "creditValue": 123,
      "effectivePricelistCode": "<string>",
      "priceListEntryCode": "<string>",
      "priceListEntryMode": "<string>"
    },
    "upper": {
      "msrp": 123,
      "price": 123,
      "priceType": "<string>",
      "salePrice": 123,
      "salePriceType": "<string>",
      "catalogSalePrice": 123,
      "catalogListPrice": 123,
      "priceListEntryEndDate": "2023-11-07T05:31:56Z",
      "discount": {
        "couponCode": "<string>",
        "discount": {
          "discountId": 123,
          "expirationDate": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "friendlyDescription": "<string>",
          "impact": 123
        },
        "discounts": [
          {
            "discountId": 123,
            "expirationDate": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "friendlyDescription": "<string>",
            "impact": 123
          }
        ],
        "impact": 123
      },
      "creditValue": 123,
      "effectivePricelistCode": "<string>",
      "priceListEntryCode": "<string>",
      "priceListEntryMode": "<string>"
    }
  },
  "volumePriceBands": [
    {
      "isCurrent": true,
      "minQty": 123,
      "maxQty": 123,
      "priceRange": {
        "lower": {
          "msrp": 123,
          "price": 123,
          "priceType": "<string>",
          "salePrice": 123,
          "salePriceType": "<string>",
          "catalogSalePrice": 123,
          "catalogListPrice": 123,
          "priceListEntryEndDate": "2023-11-07T05:31:56Z",
          "discount": {
            "couponCode": "<string>",
            "discount": {
              "discountId": 123,
              "expirationDate": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "friendlyDescription": "<string>",
              "impact": 123
            },
            "discounts": [
              {
                "discountId": 123,
                "expirationDate": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "friendlyDescription": "<string>",
                "impact": 123
              }
            ],
            "impact": 123
          },
          "creditValue": 123,
          "effectivePricelistCode": "<string>",
          "priceListEntryCode": "<string>",
          "priceListEntryMode": "<string>"
        },
        "upper": {
          "msrp": 123,
          "price": 123,
          "priceType": "<string>",
          "salePrice": 123,
          "salePriceType": "<string>",
          "catalogSalePrice": 123,
          "catalogListPrice": 123,
          "priceListEntryEndDate": "2023-11-07T05:31:56Z",
          "discount": {
            "couponCode": "<string>",
            "discount": {
              "discountId": 123,
              "expirationDate": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "friendlyDescription": "<string>",
              "impact": 123
            },
            "discounts": [
              {
                "discountId": 123,
                "expirationDate": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "friendlyDescription": "<string>",
                "impact": 123
              }
            ],
            "impact": 123
          },
          "creditValue": 123,
          "effectivePricelistCode": "<string>",
          "priceListEntryCode": "<string>",
          "priceListEntryMode": "<string>"
        }
      },
      "price": {
        "msrp": 123,
        "price": 123,
        "priceType": "<string>",
        "salePrice": 123,
        "salePriceType": "<string>",
        "catalogSalePrice": 123,
        "catalogListPrice": 123,
        "priceListEntryEndDate": "2023-11-07T05:31:56Z",
        "discount": {
          "couponCode": "<string>",
          "discount": {
            "discountId": 123,
            "expirationDate": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "friendlyDescription": "<string>",
            "impact": 123
          },
          "discounts": [
            {
              "discountId": 123,
              "expirationDate": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "friendlyDescription": "<string>",
              "impact": 123
            }
          ],
          "impact": 123
        },
        "creditValue": 123,
        "effectivePricelistCode": "<string>",
        "priceListEntryCode": "<string>",
        "priceListEntryMode": "<string>"
      }
    }
  ],
  "volumePriceRange": {
    "lower": {
      "msrp": 123,
      "price": 123,
      "priceType": "<string>",
      "salePrice": 123,
      "salePriceType": "<string>",
      "catalogSalePrice": 123,
      "catalogListPrice": 123,
      "priceListEntryEndDate": "2023-11-07T05:31:56Z",
      "discount": {
        "couponCode": "<string>",
        "discount": {
          "discountId": 123,
          "expirationDate": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "friendlyDescription": "<string>",
          "impact": 123
        },
        "discounts": [
          {
            "discountId": 123,
            "expirationDate": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "friendlyDescription": "<string>",
            "impact": 123
          }
        ],
        "impact": 123
      },
      "creditValue": 123,
      "effectivePricelistCode": "<string>",
      "priceListEntryCode": "<string>",
      "priceListEntryMode": "<string>"
    },
    "upper": {
      "msrp": 123,
      "price": 123,
      "priceType": "<string>",
      "salePrice": 123,
      "salePriceType": "<string>",
      "catalogSalePrice": 123,
      "catalogListPrice": 123,
      "priceListEntryEndDate": "2023-11-07T05:31:56Z",
      "discount": {
        "couponCode": "<string>",
        "discount": {
          "discountId": 123,
          "expirationDate": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "friendlyDescription": "<string>",
          "impact": 123
        },
        "discounts": [
          {
            "discountId": 123,
            "expirationDate": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "friendlyDescription": "<string>",
            "impact": 123
          }
        ],
        "impact": 123
      },
      "creditValue": 123,
      "effectivePricelistCode": "<string>",
      "priceListEntryCode": "<string>",
      "priceListEntryMode": "<string>"
    }
  },
  "availableShippingDiscounts": [
    {
      "discountId": 123,
      "expirationDate": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "friendlyDescription": "<string>",
      "impact": 123
    }
  ],
  "productType": "<string>",
  "productTypeId": 123,
  "isTaxable": true,
  "isRecurring": true,
  "pricingBehavior": {
    "discountsRestricted": true,
    "discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
    "discountsRestrictedEndDate": "2023-11-07T05:31:56Z"
  },
  "inventoryInfo": {
    "manageStock": true,
    "outOfStockBehavior": "<string>",
    "onlineStockAvailable": 123,
    "onlineSoftStockAvailable": 123,
    "onlineLocationCode": "<string>",
    "availableDate": "2023-11-07T05:31:56Z",
    "isSubstitutable": true
  },
  "createDate": "2023-11-07T05:31:56Z",
  "updateDate": "2023-11-07T05:31:56Z",
  "dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
  "catalogStartDate": "2023-11-07T05:31:56Z",
  "catalogEndDate": "2023-11-07T05:31:56Z",
  "daysAvailableInCatalog": 123,
  "upc": "<string>",
  "upCs": [
    "<string>"
  ],
  "mfgPartNumber": "<string>",
  "mfgPartNumbers": [
    "<string>"
  ],
  "variationProductCode": "<string>",
  "categories": [
    {
      "categoryId": 123,
      "parentCategory": {},
      "content": {
        "categoryImages": [
          {
            "imageLabel": "<string>",
            "altText": "<string>",
            "imageUrl": "<string>",
            "cmsId": "<string>",
            "videoUrl": "<string>",
            "mediaType": "<string>",
            "sequence": 123
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "pageTitle": "<string>",
        "metaTagTitle": "<string>",
        "metaTagDescription": "<string>",
        "metaTagKeywords": "<string>",
        "slug": "<string>"
      },
      "childrenCategories": [
        {}
      ],
      "sequence": 123,
      "isDisplayed": true,
      "categoryCode": "<string>",
      "count": 123,
      "updateDate": "2023-11-07T05:31:56Z",
      "shouldSlice": true,
      "attributes": [
        {
          "fullyQualifiedName": "<string>",
          "dataType": 123,
          "values": [
            "<unknown>"
          ]
        }
      ]
    }
  ],
  "productRules": [
    "<string>"
  ],
  "measurements": {
    "packageHeight": {
      "unit": "<string>",
      "value": 123
    },
    "packageWidth": {
      "unit": "<string>",
      "value": 123
    },
    "packageLength": {
      "unit": "<string>",
      "value": 123
    },
    "packageWeight": {
      "unit": "<string>",
      "value": 123
    }
  },
  "isPackagedStandAlone": true,
  "properties": [
    {
      "attributeFQN": "<string>",
      "isHidden": true,
      "isMultiValue": true,
      "attributeDetail": {
        "valueType": "<string>",
        "inputType": "<string>",
        "dataType": "<string>",
        "usageType": "<string>",
        "dataTypeSequence": 123,
        "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"
        },
        "searchableInStorefront": true,
        "searchDisplayValue": true,
        "allowFilteringAndSortingInStorefront": true,
        "indexValueWithCase": true,
        "customWeightInStorefrontSearch": true,
        "displayIntention": "<string>",
        "availableForOrderRouting": true
      },
      "values": [
        {
          "value": "<unknown>",
          "stringValue": "<string>",
          "displayInfo": {
            "cmsId": "<string>",
            "imageUrl": "<string>",
            "colorValue": "<string>"
          }
        }
      ],
      "propertyType": "<string>"
    }
  ],
  "options": [
    {
      "attributeFQN": "<string>",
      "isRequired": true,
      "isMultiValue": true,
      "values": [
        {
          "value": "<unknown>",
          "attributeValueId": 123,
          "stringValue": "<string>",
          "isEnabled": true,
          "isSelected": true,
          "isDefault": true,
          "deltaWeight": 123,
          "deltaPrice": 123,
          "shopperEnteredValue": "<unknown>",
          "bundledProduct": {
            "productCode": "<string>",
            "goodsType": "<string>",
            "quantity": 123,
            "measurements": {
              "packageHeight": {
                "unit": "<string>",
                "value": 123
              },
              "packageWidth": {
                "unit": "<string>",
                "value": 123
              },
              "packageLength": {
                "unit": "<string>",
                "value": 123
              },
              "packageWeight": {
                "unit": "<string>",
                "value": 123
              }
            },
            "isPackagedStandAlone": true,
            "inventoryInfo": {
              "manageStock": true,
              "outOfStockBehavior": "<string>",
              "onlineStockAvailable": 123,
              "onlineSoftStockAvailable": 123,
              "onlineLocationCode": "<string>",
              "availableDate": "2023-11-07T05:31:56Z",
              "isSubstitutable": true
            },
            "optionAttributeFQN": "<string>",
            "optionValue": "<unknown>",
            "creditValue": 123,
            "productType": "<string>",
            "content": {
              "productName": "<string>",
              "productFullDescription": "<string>",
              "productShortDescription": "<string>",
              "metaTagTitle": "<string>",
              "metaTagDescription": "<string>",
              "metaTagKeywords": "<string>",
              "seoFriendlyUrl": "<string>",
              "productImages": [
                {
                  "imageLabel": "<string>",
                  "altText": "<string>",
                  "imageUrl": "<string>",
                  "cmsId": "<string>",
                  "videoUrl": "<string>",
                  "mediaType": "<string>",
                  "sequence": 123,
                  "productImageGroupId": "<string>"
                }
              ]
            }
          },
          "displayInfo": {
            "cmsId": "<string>",
            "imageUrl": "<string>",
            "colorValue": "<string>"
          }
        }
      ],
      "attributeDetail": {
        "valueType": "<string>",
        "inputType": "<string>",
        "dataType": "<string>",
        "usageType": "<string>",
        "dataTypeSequence": 123,
        "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"
        },
        "searchableInStorefront": true,
        "searchDisplayValue": true,
        "allowFilteringAndSortingInStorefront": true,
        "indexValueWithCase": true,
        "customWeightInStorefrontSearch": true,
        "displayIntention": "<string>",
        "availableForOrderRouting": true
      },
      "isProductImageGroupSelector": true
    }
  ],
  "variations": [
    {
      "productCode": "<string>",
      "upc": "<string>",
      "options": [
        {
          "valueSequence": 123,
          "attributeFQN": "<string>",
          "value": "<unknown>"
        }
      ],
      "inventoryInfo": {
        "manageStock": true,
        "outOfStockBehavior": "<string>",
        "onlineStockAvailable": 123,
        "onlineSoftStockAvailable": 123,
        "onlineLocationCode": "<string>",
        "availableDate": "2023-11-07T05:31:56Z",
        "isSubstitutable": true
      }
    }
  ],
  "validPriceLists": [
    "<string>"
  ],
  "locationsInStock": [
    "<string>"
  ],
  "slicingAttributeFQN": "<string>",
  "productImageGroups": [
    {
      "productImageGroupId": "<string>",
      "productImageGroupTags": [
        {
          "attributeFqn": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "sliceValue": "<string>",
  "productCollections": [
    {
      "productCode": "<string>",
      "isPrimary": true
    }
  ],
  "productCollectionMembers": [
    {
      "memberKey": {
        "value": "<string>"
      }
    }
  ],
  "collectionMembersProductContent": [
    {
      "productName": "<string>",
      "productFullDescription": "<string>",
      "productShortDescription": "<string>",
      "metaTagTitle": "<string>",
      "metaTagDescription": "<string>",
      "metaTagKeywords": "<string>",
      "seoFriendlyUrl": "<string>",
      "productImages": [
        {
          "imageLabel": "<string>",
          "altText": "<string>",
          "imageUrl": "<string>",
          "cmsId": "<string>",
          "videoUrl": "<string>",
          "mediaType": "<string>",
          "sequence": 123,
          "productImageGroupId": "<string>"
        }
      ]
    }
  ],
  "score": 123,
  "personalizationScore": 123,
  "costPriceMargin": 123
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

productCode
string
required

Required. Merchant-created code associated with the product, for example, a SKU. Max length: 30.

Query Parameters

variationProductCode
string

Optional. Merchant-created code associated with a specific product variation. Max length: #.

responseGroups
string

Optional. Response groups to be determined.

allowInactive
boolean

Optional. If true, return a product if it is located but inactive.

skipInventoryCheck
boolean
default:false

Determines whether or not to check inventory on an item when validating

supressOutOfStock404
boolean
default:false

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.

quantity
integer<int32>

Optional. If specified, will be used for returning pricing based on volume if applicable. Defaults to 1 if not specified.

acceptVariantProductCode
boolean
default:false
purchaseLocation
string
variationProductCodeFilter
string
sliceValue
string
includeAllImages
boolean
default:false
useSubscriptionPricing
boolean
default:false
customerSegments
string
responseFields
string

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.

productCode
string | null

Merchant-created code associated with the product, for example, a SKU.

purchaseLocation
string | null

The location where the product is being purchased.. default is null. Products can have different prices by purchaseLocation via custom priceListResolution....

productSequence
integer<int32> | null

System generated monotonically increasing sequence

productUsage
string | null

The UsageType of this product (Standard, Configurable, Bundle, Component, Collection)

fulfillmentTypesSupported
string[] | null

Indicates the fulfillment types the product supports.

goodsType
string | null

The GoodsType of the product (Physical, Digital, DigitalCredit....)

bundledProducts
object[] | null

The list of Bundled products included in this product. This is only populated when ProductUsage=Bundle

content
object

Name of the product and, if supplied, description, metatags, friendly URL, and associated images.

purchasableState
object

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.

isActive
boolean | null

If true, the product exists. If not, the product should not appear in search results.

publishState
string | null

Represents the published state of the product returned. Valid values for ValueType are defined in PublishStateConst.

price
object

Price of the product with any sale and discounts applied.

priceRange
object

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.

volumePriceBands
object[] | null

For products with bulk pricing... this will be populated with pricebands, depending on what options have been selected...

volumePriceRange
object

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.

availableShippingDiscounts
object[] | null

List of potential shipping discounts available for this product.

productType
string | null
productTypeId
integer<int32> | null
isTaxable
boolean

If true, the product is subject to tax.

isRecurring
boolean

If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.

pricingBehavior
object
inventoryInfo
object

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.

createDate
string<date-time>

When the product was created with the product admin resource.

updateDate
string<date-time>

When the product was last modified with the product admin resource.

dateFirstAvailableInCatalog
string<date-time> | null
catalogStartDate
string<date-time> | null
catalogEndDate
string<date-time> | null
daysAvailableInCatalog
integer<int32> | null
upc
string | null

UPC code of the product.

upCs
string[] | null

UPC code of the products (populated for configurable products).

mfgPartNumber
string | null

Manufacturer part number.

mfgPartNumbers
string[] | null

Manufacturer part numbers (populated for configurable products).

variationProductCode
string | null

When a configurable product has IsPurchasable=true on a GetProduct, this property will be populated for submission to cart.

categories
object[] | null

List of categories to which this product belongs.

productRules
string[] | null
measurements
object

Physical dimensions of the package required to ship the product and its weight.

isPackagedStandAlone
boolean | null

Is this product shipped in its own package

properties
object[] | null

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.

options
object[] | null

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).

variations
object[] | null
validPriceLists
string[] | null

List of valid pricelists for the product

locationsInStock
string[] | null

Any location code (eq) or array of location codes which are in stock.

slicingAttributeFQN
string | null
productImageGroups
object[] | null

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.

sliceValue
string | null

Readonly value of the selected value of the option corresponding to the Mozu.ProductRuntime.Contracts.Product.SlicingAttributeFQN

productCollections
object[] | null

List of product codes of product collections that this product is a member of.

productCollectionMembers
object[] | null

list of member products that are part of the collection This requires that the ProductUsage be set to Collection

collectionMembersProductContent
object[] | null

Only used for indexing

score
number<double>

The item's search engine relevancy score.

personalizationScore
number<double>
costPriceMargin
number<double> | null