Skip to main content
POST
/
commerce
/
catalog
/
storefront
/
products
/
{productCode}
/
validate
Error
A valid request URL is required to generate request examples
{
  "productCode": "<string>",
  "purchaseLocation": "<string>",
  "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>",
      "productShortDescription": "<string>",
      "productName": "<string>"
    }
  ],
  "upc": "<string>",
  "mfgPartNumber": "<string>",
  "variationProductCode": "<string>",
  "purchasableState": {
    "isPurchasable": true,
    "messages": [
      {
        "severity": "<string>",
        "source": "<string>",
        "message": "<string>",
        "validationType": "<string>",
        "sourceId": "<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>"
  },
  "measurements": {
    "packageHeight": {
      "unit": "<string>",
      "value": 123
    },
    "packageWidth": {
      "unit": "<string>",
      "value": 123
    },
    "packageLength": {
      "unit": "<string>",
      "value": 123
    },
    "packageWeight": {
      "unit": "<string>",
      "value": 123
    }
  },
  "isPackagedStandAlone": true,
  "image": {
    "imageLabel": "<string>",
    "altText": "<string>",
    "imageUrl": "<string>",
    "cmsId": "<string>",
    "videoUrl": "<string>",
    "mediaType": "<string>",
    "sequence": 123,
    "productImageGroupId": "<string>"
  },
  "productShortDescription": "<string>",
  "productName": "<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>"
          ]
        }
      ]
    }
  ],
  "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>"
    }
  ],
  "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
  },
  "isTaxable": true,
  "productType": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
productCode
string
required

Merchant-created code of product being validated.

Query Parameters

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

​
skipDefaults
boolean
default:false

Determines whether or not to add configured default-extras on an item when validating

​
purchaseLocation
string
​
useSubscriptionPricing
boolean
default:false
​
recalculateDynamicCategories
boolean
default:false
​
acceptVariantProductCode
boolean
default:false
​
responseFields
string

limits which fields are returned in the response body

Body

application/json

Final state of 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

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

​
productUsage
string | null

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

​
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

​
upc
string | null

UPC code of the product.

​
mfgPartNumber
string | null

Manufacturer part number.

​
variationProductCode
string | null

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

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

​
price
object

Price of the product with any sale and discounts applied.

​
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

​
image
object

Image or video associated with a product.

​
productShortDescription
string | null

Brief description of the product typically used when the product is displayed in a list or search results.

​
productName
string | null

Name of the product.

​
categories
object[] | null

Categories to which the product belongs.

​
properties
object[] | null

List of product Properties.

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

​
isTaxable
boolean

If true, the product listed on the live order is subject to tax.

​
productType
string | null