Skip to main content
GET
/
commerce
/
catalog
/
storefront
/
products
/
{productCode}
/
substitutions
Error
A valid request URL is required to generate request examples
{
  "allowAutoSubstitutions": true,
  "totalCount": 123,
  "items": [
    {
      "productCode": "<string>",
      "baseProductCode": "<string>",
      "productName": "<string>",
      "productUsage": "<string>",
      "upc": "<string>",
      "mfgPartNumber": "<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>"
              }
            ]
          }
        }
      ],
      "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>"
      },
      "productImages": [
        {
          "imageLabel": "<string>",
          "altText": "<string>",
          "imageUrl": "<string>",
          "cmsId": "<string>",
          "videoUrl": "<string>",
          "mediaType": "<string>",
          "sequence": 123,
          "productImageGroupId": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

productCode
string
required

Query Parameters

preferredProductCode
string
responseFields
string

limits which fields are returned in the response body

Response

Success

Collection used for product substitutions

allowAutoSubstitutions
boolean

Indicates if a product allows automatic substitutions

totalCount
integer<int32>
items
object[] | null