Skip to main content
POST
/
commerce
/
catalog
/
storefront
/
productsearch
/
preview
Error
A valid request URL is required to generate request examples
{
  "facets": [
    {
      "label": "<string>",
      "facetType": "<string>",
      "field": "<string>",
      "values": [
        {
          "label": "<string>",
          "isApplied": true,
          "count": 123,
          "value": "<string>",
          "filterValue": "<string>",
          "rangeQueryValueStart": "<string>",
          "rangeQueryValueEnd": "<string>",
          "parentFacetValue": "<string>",
          "isDisplayed": true,
          "childrenFacetValues": [
            {}
          ]
        }
      ]
    }
  ],
  "solrDebugInfo": {
    "searchTuningRuleCode": "<string>",
    "boostedProductCodes": [
      "<string>"
    ],
    "blockedProductCodes": [
      "<string>"
    ],
    "boostQueries": [
      "<string>"
    ],
    "boostFunctions": [
      "<string>"
    ],
    "solrUrl": "<string>"
  },
  "searchRedirect": "<string>",
  "searchEngine": "<string>",
  "nextCursorMark": "<string>",
  "spellcheck": {
    "candidateCorrections": [
      {
        "query": "<string>"
      }
    ],
    "autoCorrected": true,
    "originalQuery": "<string>",
    "correctedQuery": "<string>"
  },
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "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.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json

This should follow the immutable DTO pattern

mid
string | null
query
string | null
pageSize
integer<int32> | null
startIndex
integer<int32> | null
searchType
string | null
fieldList
string[] | null
searchSettings
string | null
campaignSettings
object

Response

Success

Products and search information returned for search preview query.

facets
object[] | null
solrDebugInfo
object
searchRedirect
string | null
searchEngine
string | null
nextCursorMark
string | null
spellcheck
object

Spellcheck related results

startIndex
integer<int32>
pageSize
integer<int32>
pageCount
integer<int32>
totalCount
integer<int32>
items
object[] | null