Error
A valid request URL is required to generate request examples{
"facets": [
{
"facetType": "<string>",
"field": "<string>",
"label": "<string>",
"values": [
{
"childrenFacetValues": [
{}
],
"count": 123,
"filterValue": "<string>",
"isApplied": true,
"isDisplayed": true,
"label": "<string>",
"parentFacetValue": "<string>",
"rangeQueryValueEnd": "<string>",
"rangeQueryValueStart": "<string>",
"value": "<string>"
}
]
}
],
"items": [
{
"availableShippingDiscounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"bundledProducts": [
{
"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>"
},
"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
}
],
"catalogEndDate": "2023-11-07T05:31:56Z",
"catalogStartDate": "2023-11-07T05:31:56Z",
"categories": [
{
"attributes": [
{
"dataType": 123,
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"categoryCode": "<string>",
"categoryId": 123,
"childrenCategories": [
{}
],
"content": {
"categoryImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"description": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"name": "<string>",
"pageTitle": "<string>",
"slug": "<string>"
},
"count": 123,
"isDisplayed": true,
"parentCategory": {},
"sequence": 123,
"shouldSlice": true,
"updateDate": "2023-11-07T05:31:56Z"
}
],
"collectionMembersProductContent": [
{
"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>"
}
],
"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>"
},
"costPriceMargin": 123,
"createDate": "2023-11-07T05:31:56Z",
"dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
"daysAvailableInCatalog": 123,
"fulfillmentTypesSupported": [
"<string>"
],
"goodsType": "<string>",
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"isActive": true,
"isPackagedStandAlone": true,
"isRecurring": true,
"isTaxable": true,
"locationsInStock": [
"<string>"
],
"measurements": {
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
}
},
"mfgPartNumber": "<string>",
"mfgPartNumbers": [
"<string>"
],
"options": [
{
"attributeDetail": {
"allowFilteringAndSortingInStorefront": true,
"availableForOrderRouting": true,
"customWeightInStorefrontSearch": true,
"dataType": "<string>",
"dataTypeSequence": 123,
"description": "<string>",
"displayIntention": "<string>",
"indexValueWithCase": true,
"inputType": "<string>",
"name": "<string>",
"searchDisplayValue": true,
"searchableInStorefront": true,
"usageType": "<string>",
"validation": {
"maxDateValue": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateValue": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"valueType": "<string>"
},
"attributeFQN": "<string>",
"isMultiValue": true,
"isProductImageGroupSelector": true,
"isRequired": true,
"values": [
{
"attributeValueId": 123,
"bundledProduct": {
"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>"
},
"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
},
"deltaPrice": 123,
"deltaWeight": 123,
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"isDefault": true,
"isEnabled": true,
"isSelected": true,
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": null
}
]
}
],
"personalizationScore": 123,
"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>"
},
"priceRange": {
"lower": {
"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>"
},
"upper": {
"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>"
}
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z"
},
"productCode": "<string>",
"productCollectionMembers": [
{
"memberKey": {
"value": "<string>"
}
}
],
"productCollections": [
{
"isPrimary": true,
"productCode": "<string>"
}
],
"productImageGroups": [
{
"productImageGroupId": "<string>",
"productImageGroupTags": [
{
"attributeFqn": "<string>",
"value": "<string>"
}
]
}
],
"productRules": [
"<string>"
],
"productSequence": 123,
"productType": "<string>",
"productTypeId": 123,
"productUsage": "<string>",
"properties": [
{
"attributeDetail": {
"allowFilteringAndSortingInStorefront": true,
"availableForOrderRouting": true,
"customWeightInStorefrontSearch": true,
"dataType": "<string>",
"dataTypeSequence": 123,
"description": "<string>",
"displayIntention": "<string>",
"indexValueWithCase": true,
"inputType": "<string>",
"name": "<string>",
"searchDisplayValue": true,
"searchableInStorefront": true,
"usageType": "<string>",
"validation": {
"maxDateValue": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateValue": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"valueType": "<string>"
},
"attributeFQN": "<string>",
"isHidden": true,
"isMultiValue": true,
"propertyType": "<string>",
"values": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"stringValue": "<string>",
"value": null
}
]
}
],
"publishState": "<string>",
"purchasableState": {
"isPurchasable": true,
"messages": [
{
"message": "<string>",
"severity": "<string>",
"source": "<string>",
"sourceId": "<string>",
"validationType": "<string>"
}
]
},
"purchaseLocation": "<string>",
"score": 123,
"sliceValue": "<string>",
"slicingAttributeFQN": "<string>",
"upCs": [
"<string>"
],
"upc": "<string>",
"updateDate": "2023-11-07T05:31:56Z",
"validPriceLists": [
"<string>"
],
"variationProductCode": "<string>",
"variations": [
{
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"options": [
{
"attributeFQN": "<string>",
"value": null,
"valueSequence": 123
}
],
"productCode": "<string>",
"upc": "<string>"
}
],
"volumePriceBands": [
{
"isCurrent": true,
"maxQty": 123,
"minQty": 123,
"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>"
},
"priceRange": {
"lower": {
"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>"
},
"upper": {
"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>"
}
}
}
],
"volumePriceRange": {
"lower": {
"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>"
},
"upper": {
"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>"
}
}
}
],
"nextCursorMark": "<string>",
"pageCount": 123,
"pageSize": 123,
"searchEngine": "<string>",
"searchRedirect": "<string>",
"solrDebugInfo": {
"blockedProductCodes": [
"<string>"
],
"boostFunctions": [
"<string>"
],
"boostQueries": [
"<string>"
],
"boostedProductCodes": [
"<string>"
],
"searchTuningRuleCode": "<string>",
"solrUrl": "<string>"
},
"spellcheck": {
"autoCorrected": true,
"candidateCorrections": [
{
"query": "<string>"
}
],
"correctedQuery": "<string>",
"originalQuery": "<string>"
},
"startIndex": 123,
"totalCount": 123
}Search Products
Searches the categories displayed on the storefront for products or product options that the shopper types in a search query.
GET
/
commerce
/
catalog
/
storefront
/
productsearch
/
search
Error
A valid request URL is required to generate request examples{
"facets": [
{
"facetType": "<string>",
"field": "<string>",
"label": "<string>",
"values": [
{
"childrenFacetValues": [
{}
],
"count": 123,
"filterValue": "<string>",
"isApplied": true,
"isDisplayed": true,
"label": "<string>",
"parentFacetValue": "<string>",
"rangeQueryValueEnd": "<string>",
"rangeQueryValueStart": "<string>",
"value": "<string>"
}
]
}
],
"items": [
{
"availableShippingDiscounts": [
{
"discountId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"friendlyDescription": "<string>",
"impact": 123,
"name": "<string>"
}
],
"bundledProducts": [
{
"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>"
},
"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
}
],
"catalogEndDate": "2023-11-07T05:31:56Z",
"catalogStartDate": "2023-11-07T05:31:56Z",
"categories": [
{
"attributes": [
{
"dataType": 123,
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"categoryCode": "<string>",
"categoryId": 123,
"childrenCategories": [
{}
],
"content": {
"categoryImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"description": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"name": "<string>",
"pageTitle": "<string>",
"slug": "<string>"
},
"count": 123,
"isDisplayed": true,
"parentCategory": {},
"sequence": 123,
"shouldSlice": true,
"updateDate": "2023-11-07T05:31:56Z"
}
],
"collectionMembersProductContent": [
{
"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>"
}
],
"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>"
},
"costPriceMargin": 123,
"createDate": "2023-11-07T05:31:56Z",
"dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
"daysAvailableInCatalog": 123,
"fulfillmentTypesSupported": [
"<string>"
],
"goodsType": "<string>",
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"isActive": true,
"isPackagedStandAlone": true,
"isRecurring": true,
"isTaxable": true,
"locationsInStock": [
"<string>"
],
"measurements": {
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
}
},
"mfgPartNumber": "<string>",
"mfgPartNumbers": [
"<string>"
],
"options": [
{
"attributeDetail": {
"allowFilteringAndSortingInStorefront": true,
"availableForOrderRouting": true,
"customWeightInStorefrontSearch": true,
"dataType": "<string>",
"dataTypeSequence": 123,
"description": "<string>",
"displayIntention": "<string>",
"indexValueWithCase": true,
"inputType": "<string>",
"name": "<string>",
"searchDisplayValue": true,
"searchableInStorefront": true,
"usageType": "<string>",
"validation": {
"maxDateValue": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateValue": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"valueType": "<string>"
},
"attributeFQN": "<string>",
"isMultiValue": true,
"isProductImageGroupSelector": true,
"isRequired": true,
"values": [
{
"attributeValueId": 123,
"bundledProduct": {
"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>"
},
"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
},
"deltaPrice": 123,
"deltaWeight": 123,
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"isDefault": true,
"isEnabled": true,
"isSelected": true,
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": null
}
]
}
],
"personalizationScore": 123,
"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>"
},
"priceRange": {
"lower": {
"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>"
},
"upper": {
"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>"
}
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z"
},
"productCode": "<string>",
"productCollectionMembers": [
{
"memberKey": {
"value": "<string>"
}
}
],
"productCollections": [
{
"isPrimary": true,
"productCode": "<string>"
}
],
"productImageGroups": [
{
"productImageGroupId": "<string>",
"productImageGroupTags": [
{
"attributeFqn": "<string>",
"value": "<string>"
}
]
}
],
"productRules": [
"<string>"
],
"productSequence": 123,
"productType": "<string>",
"productTypeId": 123,
"productUsage": "<string>",
"properties": [
{
"attributeDetail": {
"allowFilteringAndSortingInStorefront": true,
"availableForOrderRouting": true,
"customWeightInStorefrontSearch": true,
"dataType": "<string>",
"dataTypeSequence": 123,
"description": "<string>",
"displayIntention": "<string>",
"indexValueWithCase": true,
"inputType": "<string>",
"name": "<string>",
"searchDisplayValue": true,
"searchableInStorefront": true,
"usageType": "<string>",
"validation": {
"maxDateValue": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateValue": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"valueType": "<string>"
},
"attributeFQN": "<string>",
"isHidden": true,
"isMultiValue": true,
"propertyType": "<string>",
"values": [
{
"displayInfo": {
"cmsId": "<string>",
"colorValue": "<string>",
"imageUrl": "<string>"
},
"stringValue": "<string>",
"value": null
}
]
}
],
"publishState": "<string>",
"purchasableState": {
"isPurchasable": true,
"messages": [
{
"message": "<string>",
"severity": "<string>",
"source": "<string>",
"sourceId": "<string>",
"validationType": "<string>"
}
]
},
"purchaseLocation": "<string>",
"score": 123,
"sliceValue": "<string>",
"slicingAttributeFQN": "<string>",
"upCs": [
"<string>"
],
"upc": "<string>",
"updateDate": "2023-11-07T05:31:56Z",
"validPriceLists": [
"<string>"
],
"variationProductCode": "<string>",
"variations": [
{
"inventoryInfo": {
"availableDate": "2023-11-07T05:31:56Z",
"isSubstitutable": true,
"manageStock": true,
"onlineLocationCode": "<string>",
"onlineSoftStockAvailable": 123,
"onlineStockAvailable": 123,
"outOfStockBehavior": "<string>"
},
"options": [
{
"attributeFQN": "<string>",
"value": null,
"valueSequence": 123
}
],
"productCode": "<string>",
"upc": "<string>"
}
],
"volumePriceBands": [
{
"isCurrent": true,
"maxQty": 123,
"minQty": 123,
"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>"
},
"priceRange": {
"lower": {
"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>"
},
"upper": {
"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>"
}
}
}
],
"volumePriceRange": {
"lower": {
"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>"
},
"upper": {
"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>"
}
}
}
],
"nextCursorMark": "<string>",
"pageCount": 123,
"pageSize": 123,
"searchEngine": "<string>",
"searchRedirect": "<string>",
"solrDebugInfo": {
"blockedProductCodes": [
"<string>"
],
"boostFunctions": [
"<string>"
],
"boostQueries": [
"<string>"
],
"boostedProductCodes": [
"<string>"
],
"searchTuningRuleCode": "<string>",
"solrUrl": "<string>"
},
"spellcheck": {
"autoCorrected": true,
"candidateCorrections": [
{
"query": "<string>"
}
],
"correctedQuery": "<string>",
"originalQuery": "<string>"
},
"startIndex": 123,
"totalCount": 123
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
The terms to search on.
A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.
The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.
Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 12 and the maximum value is 200. Optional.
Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. The default value is 0. Optional.
Pass in * to begin a deep page operation. The response will include a nextCursorMark value. Pass this into the next call. Continue with this pattern until nextCursorMark is null.
Optional. If true return all images instead of default images.
Optional. Use a specific search-merchandizing-rule code if provided.
limits which fields are returned in the response body
Response
OK
Products and facets returned from search criteria supplied in a ProductSearch query.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Spellcheck related results
Show child attributes
Show child attributes
⌘I