Get Product Substitutions

Returns a list of up to 10 products that can be substituted for the provided product code.

GET /commerce/catalog/storefront/products/{productCode}/substitutions

Error

A valid request URL is required to generate request examples

200

{
  "allowAutoSubstitutions": true,
  "items": [
    {
      "baseProductCode": "<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>"
          }
        }
      ],
      "mfgPartNumber": "<string>",
      "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>"
      },
      "productCode": "<string>",
      "productImages": [
        {
          "altText": "<string>",
          "cmsId": "<string>",
          "imageLabel": "<string>",
          "imageUrl": "<string>",
          "mediaType": "<string>",
          "productImageGroupId": "<string>",
          "sequence": 123,
          "videoUrl": "<string>"
        }
      ],
      "productName": "<string>",
      "productUsage": "<string>",
      "upc": "<string>"
    }
  ],
  "totalCount": 123
}

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

200

application/json

Success

Collection used for product substitutions

allowAutoSubstitutions · boolean

Indicates if a product allows automatic substitutions

items · object[] | null

Show child attributes

totalCount · integer<int32>