Skip to main content
POST
/
commerce
/
catalog
/
storefront
/
products
/
{productCode}
/
configure
Error
A valid request URL is required to generate request examples
{
  "productCode": "<string>",
  "purchaseLocation": "<string>",
  "fulfillmentTypesSupported": [
    "<string>"
  ],
  "variationProductCode": "<string>",
  "upc": "<string>",
  "mfgPartNumber": "<string>",
  "purchasableState": {
    "isPurchasable": true,
    "messages": [
      {
        "severity": "<string>",
        "source": "<string>",
        "message": "<string>",
        "validationType": "<string>",
        "sourceId": "<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>"
    }
  },
  "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>"
  },
  "availableShippingDiscounts": [
    {
      "discountId": 123,
      "expirationDate": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "friendlyDescription": "<string>",
      "impact": 123
    }
  ],
  "measurements": {
    "packageHeight": {
      "unit": "<string>",
      "value": 123
    },
    "packageWidth": {
      "unit": "<string>",
      "value": 123
    },
    "packageLength": {
      "unit": "<string>",
      "value": 123
    },
    "packageWeight": {
      "unit": "<string>",
      "value": 123
    }
  },
  "inventoryInfo": {
    "manageStock": true,
    "outOfStockBehavior": "<string>",
    "onlineStockAvailable": 123,
    "onlineSoftStockAvailable": 123,
    "onlineLocationCode": "<string>",
    "availableDate": "2023-11-07T05:31:56Z",
    "isSubstitutable": true
  },
  "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
    }
  ],
  "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>"
    }
  ],
  "priceListEntryTypeProperty": {
    "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>"
  },
  "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

Merchant-created code for the product being configured, for example, a SKU. Max length: 30.

Query Parameters

​
includeOptionDetails
boolean

If true, the response returns product details such as. If false, returns a product summary such as the product name, price, and sale price.

​
skipInventoryCheck
boolean
default:false

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

​
quantity
integer<int32>

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

​
purchaseLocation
string
​
variationProductCodeFilter
string
​
useSubscriptionPricing
boolean
default:false
​
subscriptionFrequency
string
​
customerSegments
string
​
responseFields
string

limits which fields are returned in the response body

Body

application/json

Shopper-selected options.

If the product has configurable options, the current state of the shopper's selections.

​
variationProductCode
string | null

For a product with options, the code of the product variation that represents the current selection of product options.

​
options
object[] | null

List of the product options that the shopper has currently selected.

Response

Success

Product as it is currently configured on the storefront. The configuration changes each time the shopper changes the product order.

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

​
fulfillmentTypesSupported
string[] | null

Indicates the fulfillment types the product supports.

​
variationProductCode
string | null

For a product with options, the code of the product variation that represents the current selection of product options. Question: is this right?

​
upc
string | null

UPC code of the product.

​
mfgPartNumber
string | null

Manufacturer part number.

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

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

​
price
object

Price of the product with any sale and discounts applied.

​
availableShippingDiscounts
object[] | null

List of potential shipping discounts available for this product.

​
measurements
object

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

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

​
options
object[] | null

Remaining options and option values that can be selected given the shopper's current selection of options.

​
properties
object[] | null

Remaining options and option values that can be selected given the shopper's current selection of options.

​
priceListEntryTypeProperty
object

An attribute used as a property of a product

​
productImages
object[] | null

Images associated with the product.