Search Page - Voyado Elevate Docs

GET

The search page query is intended to be used on the search page. A search page query will return a search result product listing with associated facets, navigation, applicable sort orders, and a result count. The contentList is empty unless specified in the request body. The request body is specified in a POST request. Note that the contents of the response object depends on which template is used, if any.

GET https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/search-page

Request

Request header parameters

Name	Description	Example
`Accept-Encoding`	Allows responses to be compressed using Gzip.	`gzip`

Request query parameters

Name	Description	Example
`customerKey`*	A key that uniquely identifies the current visitor. Using UUIDs as keys are recommended. This field is required unless `userContext` is set to `ANONYMOUS` or `UNPERSONALIZED` in which case it is not allowed. If `userContext` is set to `SYNTHETIC` this is optional.	`0b05119e-eeb8-418a-bbfb-defa0dde417e`
`locale`*	The visitor locale. Must match an available locale identifier on the current market in the data feed.	`en-GB`
`market`*	The visitor market identifier. Must match the corresponding market identifier in the data feed.	`UK`
`q`*	The search query used for the current result. May be corrected in the response.	`green`
`sessionKey`*	A unique key, identifying the session. Using UUIDs as keys are recommended. This field is required unless `userContext` is set to `ANONYMOUS` in which case it is not allowed. If `userContext` is set to `SYNTHETIC` this is optional.	`0b05119e-eeb8-418a-bbfb-defa0dde417e`
`touchpoint`*	The visitor’s touchpoint. Supported values: `DESKTOP`, `MOBILE`.	`DESKTOP`
`channels`	Which channels to use. Valid values are `ONLINE` and `STORE`. Multiple values are provided with a pipe, `\|`, as a separator. channels will default to `ONLINE\|STORE` if nothing is provided. If `STORE` is explicitly provided then stores cannot be empty. Supported values: `ONLINE`, `STORE`.	`ONLINE`
`f.[id]`	An example parameter of a value or checkbox attribute. Value attributes can be a `\|` pipe-separated list of strings, while a checkbox attributes only can be true or false. Detailed information is available at Facet selections.	`Bosch\|Dewalt or true/false`
`f.[id].max`	An example parameter of a range attribute.	`1000`
`f.[id].min`	The applied Facet selection in the search result/primary product listing. Each facet attribute is prefixed with f.	`0`
`limit`	The number of product hits to list. For each product hit in the list, its product group is returned in full to facilitate rendering of colour swatches and more. Defaults to `60` if omitted in the query, the min value is `1` and the max value is `600`.	`10`
`notify`	A boolean that can be used to disable notifications and behavioural registration for the query. May not be combined with any userContext. You are recommended to set an appropriate userContext instead.	`false`
`origin`	The search origin of the search phrase. Defaults to ORGANIC. This is strongly recommended to include. Supported values: `ORGANIC`, `DID_YOU_MEAN`, `UNDO_AUTO_CORRECT`, `PHRASE_SUGGEST`, `RELATED_SEARCHES`, `RECENT_SEARCH`, `DISCOVERY_AGENT`.	`PHRASE_SUGGEST`
`presentCustom`	A pipe-separated list of custom attributes or custom typed attributes to include in all listings. Prefix with `variant.` to request custom variant attributes. Prefix with `number.`, `length.` or `json.` to request custom typed attributes	`season\|variant.number.item_count\|variant.weight`
`presentPrices`	A pipe-separated list of custom price ids to include in all listings. Each id must match a supplied custom price id in the data feed.	`VIP\|member`
`priceId`	A custom price identifier that determines which price is used throughout the response. Must match a supplied custom price identifier in the data feed. When set, all product prices (selling price, list price etc.), price filtering, and price-based sorting will use this price instead of the standard prices.	`VIP`
`selectedCategory`	The selected category in the navigation. Use the path from selected node in the navigation tree.	`/women/dresses`
`skip`	The number of product groups to skip. Used for pagination, defaults to `0` if omitted in the query. The min value is `0` and the max value is `10000`.	`0`
`sort`	The applied sort order in the search result. Only include this after explicit visitor interaction. Defaults to ‘RELEVANCE’ or overridden default value set in Apps. Supported values: `RELEVANCE`, `NEWEST_FIRST`, `PRICE_ASCENDING`, `PRICE_DESCENDING`, `DISCOUNT`, `RATING`, `NAME`, `LENGTH_INCREASING`, `LENGTH_DECREASING`, `WIDTH_INCREASING`, `WIDTH_DECREASING`, `HEIGHT_INCREASING`, `HEIGHT_DECREASING`, `DEPTH_INCREASING`, `DEPTH_DECREASING`, `VOLUME_INCREASING`, `VOLUME_DECREASING`, `WEIGHT_INCREASING`, `WEIGHT_DECREASING`, `TITLE`.	`RELEVANCE`
`stores`	Which stores to use. Will impact which stock is displayed and which stock is used for filtering/ranking together with channel. Multiple values are provided with a pipe, `\|`, as a separator. Each store must match a supplied store key in the data feed.	`240\|100`
`templateId`	The id of a response template to apply to all product lists returned. Templates can be imported via the template API.	`template1`
`userContext`	Specifies the level of consent for data tracking. Can also be used to flag requests as synthetic to not contribute to statistics. If omitted, the request will be treated as if PERSONALIZED is used. See user context for more details. Supported values: `PERSONALIZED`, `UNPERSONALIZED`, `ANONYMOUS`, `SYNTHETIC`.	`PERSONALIZED`
`viewAllSecondary`	Show an expanded view of secondary list instead of primary list	`true`
`viewId`	A parameter that is used to show the page in either production or preview mode. Can be `production` or `preview`. Defaults to `production` if omitted in the query. For more information, see App Integration. Supported values: `PRODUCTION`, `PREVIEW`.	`PRODUCTION`

Example request

bash

curl -i \
-X GET \
-H 'Accept-Encoding: null' \
"https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/search-page?customerKey=customerKey&locale=locale&market=market&q=q&sessionKey=sessionKey&touchpoint=touchpoint&channels=channels&f.%5Bid%5D=f.%5Bid%5D&f.%5Bid%5D.max=f.%5Bid%5D.max&f.%5Bid%5D.min=f.%5Bid%5D.min&limit=limit&notify=notify&origin=origin&presentCustom=presentCustom&presentPrices=presentPrices&priceId=priceId&selectedCategory=selectedCategory&skip=skip&sort=sort&stores=stores&templateId=templateId&userContext=userContext&viewAllSecondary=viewAllSecondary&viewId=viewId"

Response

Response codes

Status	Description
`200`	Query accepted, content flattened and serialised to JSON.
`400`	Invalid or missing required arguments.
`404`	Endpoint is not valid.
`503`	Service unavailable, no products found in the cluster.
`500`	Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Example response

{
  "autoCorrect" : {
    "originalTotalHits" : 5,
    "q" : "Jeans"
  },
  "contentLists" : [ {
    "id" : "content-hits",
    "items" : [ {
      "custom" : {
        "tags" : [ {
          "id" : "78",
          "label" : "Guide"
        }, {
          "id" : "223",
          "label" : "Jeans"
        } ]
      },
      "description" : "To wash or not to wash? And how?! Those are questions jeans shoppers are asking.",
      "image" : {
        "alt" : "A woman wearing a white t-shirt",
        "caption" : "The model is 176 cm tall and is wearing size S",
        "custom" : { },
        "sources" : [ {
          "url" : "https://cdn.example.com/img/j12_prod.jpg",
          "height" : 820,
          "width" : 420
        } ]
      },
      "key" : "wash_care",
      "link" : "/wash-guide",
      "releaseDate" : "2021-10-01T00:00:00Z",
      "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
      "title" : "How to wash jeans",
      "type" : "article"
    } ],
    "totalHits" : 10
  } ],
  "didYouMean" : [ {
    "q" : "shoes"
  } ],
  "listToken" : "eyJrZXkiOiJTX3RzaGlydCIsImNsaWNrZWRQcm9kdWN0S2V5cyI6WyI3MzY5NzE1X0Y4MDIiXX0K",
  "navigation" : {
    "breadcrumbs" : [ {
      "label" : "Women's shoes",
      "path" : "womens/shoes/"
    } ],
    "tree" : {
      "children" : [ null ],
      "count" : 5,
      "customData" : {
        "highlight" : "true",
        "viewableFrom" : "2010-10-20 00:00:00"
      },
      "expandable" : true,
      "iconPath" : "/resources/images/navigation/spring_node.jpg",
      "label" : "All products",
      "link" : "/springselections",
      "path" : "/",
      "selected" : false,
      "type" : "PRODUCT"
    }
  },
  "primaryList" : {
    "facets" : [ {
      "id" : "size",
      "label" : "size",
      "type" : null
    } ],
    "productGroups" : [ {
      "key" : "PRODGROUP060194",
      "products" : [ {
        "badges" : {
          "primary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : null
          } ],
          "secondary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : null
          } ]
        },
        "brand" : "Versace",
        "custom" : { },
        "depth" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "description" : "null",
        "height" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "imageInfo" : {
          "effect" : null,
          "images" : [ {
            "alt" : "A woman wearing a white t-shirt",
            "caption" : "The model is 176 cm tall and is wearing size S",
            "custom" : { },
            "sources" : [ {
              "url" : "https://cdn.example.com/img/j12_prod.jpg",
              "height" : 820,
              "width" : 420
            } ]
          } ],
          "thumbnail" : "https://cdn.example.com/thumbs/j12_prod.jpg"
        },
        "inStock" : true,
        "key" : "p1000-101",
        "length" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "link" : "men/jeans/country-fit-cowboy-jeans",
        "listPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "name" : "Romeo",
        "rating" : 4.5,
        "remainingVariants" : 0,
        "sellingPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "series" : "Billy",
        "sponsored" : true,
        "swatch" : {
          "colors" : [ "#FF0000" ],
          "type" : null
        },
        "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
        "title" : "Country Fit Cowboy Jeans",
        "typedCustom" : {
          "json" : { },
          "lengths" : { },
          "numbers" : { }
        },
        "variants" : [ {
          "availability" : [ {
            "channel" : "STORE",
            "key" : "boardwalk",
            "stockNumber" : 5
          } ],
          "custom" : { },
          "depth" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "height" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "inStock" : true,
          "key" : "1000-101_RED",
          "label" : "XL",
          "length" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "link" : "women/pants/khaki/101-v3-red",
          "listPrice" : 15.0,
          "prices" : [ {
            "id" : "VIP_EUR",
            "listPrice" : 12.99,
            "sellingPrice" : 9.99
          } ],
          "sellingPrice" : 24.0,
          "stockNumber" : 5,
          "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
          "typedCustom" : {
            "json" : { },
            "lengths" : { },
            "numbers" : { }
          },
          "volume" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "weight" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "width" : {
            "amount" : 25.0,
            "unit" : "cm"
          }
        } ],
        "volume" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "weight" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "width" : {
          "amount" : 25.0,
          "unit" : "cm"
        }
      } ],
      "remaining" : 2
    } ],
    "sliceRanges" : [ {
      "from" : 0,
      "id" : null,
      "to" : 1
    } ],
    "sort" : {
      "options" : [ {
        "id" : null,
        "label" : "Relevance"
      } ],
      "selected" : null
    },
    "totalHits" : 0
  },
  "q" : "Jean",
  "relatedSearches" : [ {
    "q" : "shoes"
  } ],
  "secondaryList" : {
    "productGroups" : [ {
      "key" : "PRODGROUP060194",
      "products" : [ {
        "badges" : {
          "primary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : null
          } ],
          "secondary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : null
          } ]
        },
        "brand" : "Versace",
        "custom" : { },
        "depth" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "description" : "null",
        "height" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "imageInfo" : {
          "effect" : null,
          "images" : [ {
            "alt" : "A woman wearing a white t-shirt",
            "caption" : "The model is 176 cm tall and is wearing size S",
            "custom" : { },
            "sources" : [ {
              "url" : "https://cdn.example.com/img/j12_prod.jpg",
              "height" : 820,
              "width" : 420
            } ]
          } ],
          "thumbnail" : "https://cdn.example.com/thumbs/j12_prod.jpg"
        },
        "inStock" : true,
        "key" : "p1000-101",
        "length" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "link" : "men/jeans/country-fit-cowboy-jeans",
        "listPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "name" : "Romeo",
        "rating" : 4.5,
        "remainingVariants" : 0,
        "sellingPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "series" : "Billy",
        "sponsored" : true,
        "swatch" : {
          "colors" : [ "#FF0000" ],
          "type" : null
        },
        "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
        "title" : "Country Fit Cowboy Jeans",
        "typedCustom" : {
          "json" : { },
          "lengths" : { },
          "numbers" : { }
        },
        "variants" : [ {
          "availability" : [ {
            "channel" : "STORE",
            "key" : "boardwalk",
            "stockNumber" : 5
          } ],
          "custom" : { },
          "depth" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "height" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "inStock" : true,
          "key" : "1000-101_RED",
          "label" : "XL",
          "length" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "link" : "women/pants/khaki/101-v3-red",
          "listPrice" : 15.0,
          "prices" : [ {
            "id" : "VIP_EUR",
            "listPrice" : 12.99,
            "sellingPrice" : 9.99
          } ],
          "sellingPrice" : 24.0,
          "stockNumber" : 5,
          "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
          "typedCustom" : {
            "json" : { },
            "lengths" : { },
            "numbers" : { }
          },
          "volume" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "weight" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "width" : {
            "amount" : 25.0,
            "unit" : "cm"
          }
        } ],
        "volume" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "weight" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "width" : {
          "amount" : 25.0,
          "unit" : "cm"
        }
      } ],
      "remaining" : 2
    } ],
    "totalHits" : 10
  }
}

Response body schema

SearchPageResult

The object representation of the search page result.

Name	Type	Description
autoCorrect	AutoCorrect	Information about applied auto corrections to the search phrase. Omitted if no correction was made.
contentLists	ContentList[]	A list of lists of requested content, as specified in request body. Empty unless specified in the request body.
didYouMean	DidYouMean[]	A list of did-you-mean suggestions.
listToken	string	An opaque token to keep primaryList stable across requests by freezing the personalization context. Pass the listToken in the next request to fetch the next page of results. Examples: `"eyJrZXkiOiJTX3RzaGlydCIsImNsaWNrZWRQcm9kdWN0S2V5cyI6WyI3MzY5NzE1X0Y4MDIiXX0K"`
navigation	Navigation	The root node of the navigation structure. Omitted unless specified in the request body.
primaryList	PrimaryList	A faceted product list with the search result.
q	string	The search query used for the current result. May be corrected in the response. Examples: `"Jean"`
relatedSearches	RelatedSearch[]	A list of phrases related to the search phrase.
secondaryList	SecondaryList	A product list with products related to the query.

POST

The search page query is intended to be used on the search page. A search page query will return a search result product listing with associated facets, navigation, applicable sort orders, and a result count. Note that the contents of the response object depends on which template is used, if any.

POST https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/search-page

Request

Request header parameters

Name	Description	Example
`Accept-Encoding`	Allows responses to be compressed using Gzip.	`gzip`

Request query parameters

Name	Description	Example
`customerKey`*	A key that uniquely identifies the current visitor. Using UUIDs as keys are recommended. This field is required unless `userContext` is set to `ANONYMOUS` or `UNPERSONALIZED` in which case it is not allowed. If `userContext` is set to `SYNTHETIC` this is optional.	`0b05119e-eeb8-418a-bbfb-defa0dde417e`
`locale`*	The visitor locale. Must match an available locale identifier on the current market in the data feed.	`en-GB`
`market`*	The visitor market identifier. Must match the corresponding market identifier in the data feed.	`UK`
`q`*	The search query used for the current result. May be corrected in the response.	`green`
`sessionKey`*	A unique key, identifying the session. Using UUIDs as keys are recommended. This field is required unless `userContext` is set to `ANONYMOUS` in which case it is not allowed. If `userContext` is set to `SYNTHETIC` this is optional.	`0b05119e-eeb8-418a-bbfb-defa0dde417e`
`touchpoint`*	The visitor’s touchpoint. Supported values: `DESKTOP`, `MOBILE`.	`DESKTOP`
`channels`	Which channels to use. Valid values are `ONLINE` and `STORE`. Multiple values are provided with a pipe, `\|`, as a separator. channels will default to `ONLINE\|STORE` if nothing is provided. If `STORE` is explicitly provided then stores cannot be empty. Supported values: `ONLINE`, `STORE`.	`ONLINE`
`f.[id]`	An example parameter of a value or checkbox attribute. Value attributes can be a `\|` pipe-separated list of strings, while a checkbox attributes only can be true or false. Detailed information is available at Facet selections.	`Bosch\|Dewalt or true/false`
`f.[id].max`	An example parameter of a range attribute.	`1000`
`f.[id].min`	The applied Facet selection in the search result/primary product listing. Each facet attribute is prefixed with f.	`0`
`limit`	The number of product hits to list. For each product hit in the list, its product group is returned in full to facilitate rendering of colour swatches and more. Defaults to `60` if omitted in the query, the min value is `1` and the max value is `600`.	`10`
`notify`	A boolean that can be used to disable notifications and behavioural registration for the query. May not be combined with any userContext. You are recommended to set an appropriate userContext instead.	`false`
`origin`	The search origin of the search phrase. Defaults to ORGANIC. This is strongly recommended to include. Supported values: `ORGANIC`, `DID_YOU_MEAN`, `UNDO_AUTO_CORRECT`, `PHRASE_SUGGEST`, `RELATED_SEARCHES`, `RECENT_SEARCH`, `DISCOVERY_AGENT`.	`PHRASE_SUGGEST`
`presentCustom`	A pipe-separated list of custom attributes or custom typed attributes to include in all listings. Prefix with `variant.` to request custom variant attributes. Prefix with `number.`, `length.` or `json.` to request custom typed attributes	`season\|variant.number.item_count\|variant.weight`
`presentPrices`	A pipe-separated list of custom price ids to include in all listings. Each id must match a supplied custom price id in the data feed.	`VIP\|member`
`priceId`	A custom price identifier that determines which price is used throughout the response. Must match a supplied custom price identifier in the data feed. When set, all product prices (selling price, list price etc.), price filtering, and price-based sorting will use this price instead of the standard prices.	`VIP`
`selectedCategory`	The selected category in the navigation. Use the path from selected node in the navigation tree.	`/women/dresses`
`skip`	The number of product groups to skip. Used for pagination, defaults to `0` if omitted in the query. The min value is `0` and the max value is `10000`.	`0`
`sort`	The applied sort order in the search result. Only include this after explicit visitor interaction. Defaults to ‘RELEVANCE’ or overridden default value set in Apps. Supported values: `RELEVANCE`, `NEWEST_FIRST`, `PRICE_ASCENDING`, `PRICE_DESCENDING`, `DISCOUNT`, `RATING`, `NAME`, `LENGTH_INCREASING`, `LENGTH_DECREASING`, `WIDTH_INCREASING`, `WIDTH_DECREASING`, `HEIGHT_INCREASING`, `HEIGHT_DECREASING`, `DEPTH_INCREASING`, `DEPTH_DECREASING`, `VOLUME_INCREASING`, `VOLUME_DECREASING`, `WEIGHT_INCREASING`, `WEIGHT_DECREASING`, `TITLE`.	`RELEVANCE`
`stores`	Which stores to use. Will impact which stock is displayed and which stock is used for filtering/ranking together with channel. Multiple values are provided with a pipe, `\|`, as a separator. Each store must match a supplied store key in the data feed.	`240\|100`
`templateId`	The id of a response template to apply to all product lists returned. Templates can be imported via the template API.	`template1`
`userContext`	Specifies the level of consent for data tracking. Can also be used to flag requests as synthetic to not contribute to statistics. If omitted, the request will be treated as if PERSONALIZED is used. See user context for more details. Supported values: `PERSONALIZED`, `UNPERSONALIZED`, `ANONYMOUS`, `SYNTHETIC`.	`PERSONALIZED`
`viewAllSecondary`	Show an expanded view of secondary list instead of primary list	`true`
`viewId`	A parameter that is used to show the page in either production or preview mode. Can be `production` or `preview`. Defaults to `production` if omitted in the query. For more information, see App Integration. Supported values: `PRODUCTION`, `PREVIEW`.	`PRODUCTION`

Request body example

application/json;charset=utf-8

{
  "catalogEntitlement" : "rule incl product_key { \"ABC123\" \"DEF456\" \"GHJ789\" } rule incl custom.material { \"leather\" } excl price [ -infinity, 100 ] rule incl newness 10d rule incl brand { \"Birkenstock\" } excl custom.isActive { \"false\" }",
  "contentLists" : [ {
    "contentFilter" : {
      "content_key" : [ "a1", "d2" ],
      "type" : [ "article", "designer" ]
    },
    "id" : "CDP-2",
    "limit" : 8
  } ],
  "listToken" : "eyJrZXkiOiJTX3RzaGlydCIsImNsaWNrZWRQcm9kdWN0S2V5cyI6WyI3MzY5NzE1X0Y4MDIiXX0K",
  "navigation" : {
    "include" : true
  },
  "primaryList" : {
    "include" : true,
    "productRules" : "rule incl product_key { \"ABC123\" \"DEF456\" \"GHJ789\" } rule incl custom.material { \"leather\" } excl price [ -infinity, 100 ] rule incl newness 10d rule incl brand { \"Birkenstock\" } excl custom.isActive { \"false\" }"
  }
}

Request body schema

SearchPageRequestSettings

A configuration object for the search page request.

Name	Type	Description
catalogEntitlement	string	An optional product rule that may be supplied to further limit which products are returned. Products not matching this filter will be purged from all lists and will be excluded from all returned product groups. Use this with extreme care in the rare case where you wish to hide part of your catalog from specific visitors. Examples: `"rule incl product_key { \"ABC123\" \"DEF456\" \"GHJ789\" } rule incl custom.material { \"leather\" } excl price [ -infinity, 100 ] rule incl newness 10d rule incl brand { \"Birkenstock\" } excl custom.isActive { \"false\" }"`
contentLists	ContentListSettingsSearch[]	Content to search in. Min items: `0`. Max items: `10`.
listToken	string	An opaque token to keep primaryList stable across requests by freezing the personalization context. Pass the listToken returned in the previous response when requesting the next page. Examples: `"eyJrZXkiOiJTX3RzaGlydCIsImNsaWNrZWRQcm9kdWN0S2V5cyI6WyI3MzY5NzE1X0Y4MDIiXX0K"`
navigation	NavigationSettings
primaryList	PrimaryListSettings

Example request

bash

curl -i \
-X POST \
-H 'Accept-Encoding: null' \
-H 'Content-Type: application/json;charset=utf-8' \
"https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/search-page?customerKey=customerKey&locale=locale&market=market&q=q&sessionKey=sessionKey&touchpoint=touchpoint&channels=channels&f.%5Bid%5D=f.%5Bid%5D&f.%5Bid%5D.max=f.%5Bid%5D.max&f.%5Bid%5D.min=f.%5Bid%5D.min&limit=limit&notify=notify&origin=origin&presentCustom=presentCustom&presentPrices=presentPrices&priceId=priceId&selectedCategory=selectedCategory&skip=skip&sort=sort&stores=stores&templateId=templateId&userContext=userContext&viewAllSecondary=viewAllSecondary&viewId=viewId" \
-T request-body.file

Response

Response codes

Status	Description
`415`	Incorrect headers or the body encoding could not be parsed. The request body is expected to be plain text.
`200`	Query accepted, content flattened and serialised to JSON.
`400`	Invalid or missing required arguments.
`404`	Endpoint is not valid.
`503`	Service unavailable, no products found in the cluster.
`500`	Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Example response

{
  "autoCorrect" : {
    "originalTotalHits" : 5,
    "q" : "Jeans"
  },
  "contentLists" : [ {
    "id" : "content-hits",
    "items" : [ {
      "custom" : {
        "tags" : [ {
          "id" : "78",
          "label" : "Guide"
        }, {
          "id" : "223",
          "label" : "Jeans"
        } ]
      },
      "description" : "To wash or not to wash? And how?! Those are questions jeans shoppers are asking.",
      "image" : {
        "alt" : "A woman wearing a white t-shirt",
        "caption" : "The model is 176 cm tall and is wearing size S",
        "custom" : { },
        "sources" : [ {
          "url" : "https://cdn.example.com/img/j12_prod.jpg",
          "height" : 820,
          "width" : 420
        } ]
      },
      "key" : "wash_care",
      "link" : "/wash-guide",
      "releaseDate" : "2021-10-01T00:00:00Z",
      "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
      "title" : "How to wash jeans",
      "type" : "article"
    } ],
    "totalHits" : 10
  } ],
  "didYouMean" : [ {
    "q" : "shoes"
  } ],
  "listToken" : "eyJrZXkiOiJTX3RzaGlydCIsImNsaWNrZWRQcm9kdWN0S2V5cyI6WyI3MzY5NzE1X0Y4MDIiXX0K",
  "navigation" : {
    "breadcrumbs" : [ {
      "label" : "Women's shoes",
      "path" : "womens/shoes/"
    } ],
    "tree" : {
      "children" : [ null ],
      "count" : 5,
      "customData" : {
        "highlight" : "true",
        "viewableFrom" : "2010-10-20 00:00:00"
      },
      "expandable" : true,
      "iconPath" : "/resources/images/navigation/spring_node.jpg",
      "label" : "All products",
      "link" : "/springselections",
      "path" : "/",
      "selected" : false,
      "type" : "PRODUCT"
    }
  },
  "primaryList" : {
    "facets" : [ {
      "id" : "size",
      "label" : "size",
      "type" : null
    } ],
    "productGroups" : [ {
      "key" : "PRODGROUP060194",
      "products" : [ {
        "badges" : {
          "primary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : null
          } ],
          "secondary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : null
          } ]
        },
        "brand" : "Versace",
        "custom" : { },
        "depth" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "description" : "null",
        "height" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "imageInfo" : {
          "effect" : null,
          "images" : [ {
            "alt" : "A woman wearing a white t-shirt",
            "caption" : "The model is 176 cm tall and is wearing size S",
            "custom" : { },
            "sources" : [ {
              "url" : "https://cdn.example.com/img/j12_prod.jpg",
              "height" : 820,
              "width" : 420
            } ]
          } ],
          "thumbnail" : "https://cdn.example.com/thumbs/j12_prod.jpg"
        },
        "inStock" : true,
        "key" : "p1000-101",
        "length" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "link" : "men/jeans/country-fit-cowboy-jeans",
        "listPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "name" : "Romeo",
        "rating" : 4.5,
        "remainingVariants" : 0,
        "sellingPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "series" : "Billy",
        "sponsored" : true,
        "swatch" : {
          "colors" : [ "#FF0000" ],
          "type" : null
        },
        "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
        "title" : "Country Fit Cowboy Jeans",
        "typedCustom" : {
          "json" : { },
          "lengths" : { },
          "numbers" : { }
        },
        "variants" : [ {
          "availability" : [ {
            "channel" : "STORE",
            "key" : "boardwalk",
            "stockNumber" : 5
          } ],
          "custom" : { },
          "depth" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "height" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "inStock" : true,
          "key" : "1000-101_RED",
          "label" : "XL",
          "length" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "link" : "women/pants/khaki/101-v3-red",
          "listPrice" : 15.0,
          "prices" : [ {
            "id" : "VIP_EUR",
            "listPrice" : 12.99,
            "sellingPrice" : 9.99
          } ],
          "sellingPrice" : 24.0,
          "stockNumber" : 5,
          "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
          "typedCustom" : {
            "json" : { },
            "lengths" : { },
            "numbers" : { }
          },
          "volume" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "weight" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "width" : {
            "amount" : 25.0,
            "unit" : "cm"
          }
        } ],
        "volume" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "weight" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "width" : {
          "amount" : 25.0,
          "unit" : "cm"
        }
      } ],
      "remaining" : 2
    } ],
    "sliceRanges" : [ {
      "from" : 0,
      "id" : null,
      "to" : 1
    } ],
    "sort" : {
      "options" : [ {
        "id" : null,
        "label" : "Relevance"
      } ],
      "selected" : null
    },
    "totalHits" : 0
  },
  "q" : "Jean",
  "relatedSearches" : [ {
    "q" : "shoes"
  } ],
  "secondaryList" : {
    "productGroups" : [ {
      "key" : "PRODGROUP060194",
      "products" : [ {
        "badges" : {
          "primary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : null
          } ],
          "secondary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : null
          } ]
        },
        "brand" : "Versace",
        "custom" : { },
        "depth" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "description" : "null",
        "height" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "imageInfo" : {
          "effect" : null,
          "images" : [ {
            "alt" : "A woman wearing a white t-shirt",
            "caption" : "The model is 176 cm tall and is wearing size S",
            "custom" : { },
            "sources" : [ {
              "url" : "https://cdn.example.com/img/j12_prod.jpg",
              "height" : 820,
              "width" : 420
            } ]
          } ],
          "thumbnail" : "https://cdn.example.com/thumbs/j12_prod.jpg"
        },
        "inStock" : true,
        "key" : "p1000-101",
        "length" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "link" : "men/jeans/country-fit-cowboy-jeans",
        "listPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "name" : "Romeo",
        "rating" : 4.5,
        "remainingVariants" : 0,
        "sellingPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "series" : "Billy",
        "sponsored" : true,
        "swatch" : {
          "colors" : [ "#FF0000" ],
          "type" : null
        },
        "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
        "title" : "Country Fit Cowboy Jeans",
        "typedCustom" : {
          "json" : { },
          "lengths" : { },
          "numbers" : { }
        },
        "variants" : [ {
          "availability" : [ {
            "channel" : "STORE",
            "key" : "boardwalk",
            "stockNumber" : 5
          } ],
          "custom" : { },
          "depth" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "height" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "inStock" : true,
          "key" : "1000-101_RED",
          "label" : "XL",
          "length" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "link" : "women/pants/khaki/101-v3-red",
          "listPrice" : 15.0,
          "prices" : [ {
            "id" : "VIP_EUR",
            "listPrice" : 12.99,
            "sellingPrice" : 9.99
          } ],
          "sellingPrice" : 24.0,
          "stockNumber" : 5,
          "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
          "typedCustom" : {
            "json" : { },
            "lengths" : { },
            "numbers" : { }
          },
          "volume" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "weight" : {
            "amount" : 25.0,
            "unit" : "cm"
          },
          "width" : {
            "amount" : 25.0,
            "unit" : "cm"
          }
        } ],
        "volume" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "weight" : {
          "amount" : 25.0,
          "unit" : "cm"
        },
        "width" : {
          "amount" : 25.0,
          "unit" : "cm"
        }
      } ],
      "remaining" : 2
    } ],
    "totalHits" : 10
  }
}

Response body schema

SearchPageResult

The object representation of the search page result.

Name	Type	Description
autoCorrect	AutoCorrect	Information about applied auto corrections to the search phrase. Omitted if no correction was made.
contentLists	ContentList[]	A list of lists of requested content, as specified in request body. Empty unless specified in the request body.
didYouMean	DidYouMean[]	A list of did-you-mean suggestions.
listToken	string	An opaque token to keep primaryList stable across requests by freezing the personalization context. Pass the listToken in the next request to fetch the next page of results. Examples: `"eyJrZXkiOiJTX3RzaGlydCIsImNsaWNrZWRQcm9kdWN0S2V5cyI6WyI3MzY5NzE1X0Y4MDIiXX0K"`
navigation	Navigation	The root node of the navigation structure. Omitted unless specified in the request body.
primaryList	PrimaryList	A faceted product list with the search result.
q	string	The search query used for the current result. May be corrected in the response. Examples: `"Jean"`
relatedSearches	RelatedSearch[]	A list of phrases related to the search phrase.
secondaryList	SecondaryList	A product list with products related to the query.

Inner Schemas

AutoCorrect

Name	Type	Description
originalTotalHits	integer	The number of hits for the original search phrase. Examples: `5`
q	string	The autocorrected suggestion. Examples: `"Jeans"`

Badges

Name	Type	Description
primary	ProductBadge[]	Badges in the primary area
secondary	ProductBadge[]	Badges in the secondary area

BadgeTheme (enum)

Name	Description
NONE	No badge used.
SALE	Used when the product is on sale.
DISCOUNT	Used when the product has a discounted price.
NEW	Used if the product is determined as new by Elevate.
THEME_1	Custom badge 1.
THEME_2	Custom badge 2.
THEME_3	Custom badge 3.

The breadcrumb navigation object.

Name	Type	Description
label	string	Breadcrumb label Examples: `"Women's shoes"`
path	string	Breadcrumb path Examples: `"womens/shoes/"`

CheckboxFacet

A facet designed to be rendered as a checkbox.

Name	Type	Description
count	integer	For checkbox facets: the number of products that match the criteria. Only available when selected is true Examples: `10`
id	string	The identifier for the facet. Should be used when creating a facet query-parameter in combination with a facet value. Examples: `"size"`
label	string	The presentation text for the facet. Examples: `"size"`
selected	boolean	For checkbox facets: identifies the checkbox as selected. Examples: `"true"`
type	FacetType	The type of facet. Supported values: `SIZE`, `RANGE`, `TEXT`, `COLOR`, `CHECKBOX`. Examples: `"RANGE"`

ColorFacet

A facet containing color values.

Name	Type	Description
id	string	The identifier for the facet. Should be used when creating a facet query-parameter in combination with a facet value. Examples: `"size"`
label	string	The presentation text for the facet. Examples: `"size"`
selectedCount	integer	The number of selected facet values.
type	FacetType	The type of facet. Supported values: `SIZE`, `RANGE`, `TEXT`, `COLOR`, `CHECKBOX`. Examples: `"RANGE"`
values	Color[]	The values of the facet.

Color

Name	Type	Description
color	string	A CSS-color code for this color facet.
count	integer	The number of values that matches the criteria.
id	string	The identifier for the facet value, used by Elevate to determine which facet value has been selected. Should only be used when creating facet query-parameters.
label	string	The presentation text for the facet value.
selected	boolean	Identifies the value as selected.

ContentFilter

Content filters can be applied to most content listings and are included in the request body for the target listing. Applying a filter will restrict the set of returned content and can only be string value filters e.g. not numeric. Listing multiple attributes to filter on will restrict the content to all conditions (logical AND). When listing values within one attribute, content with any of the listed properties apply (logical OR). In addition, any custom attribute can be used as a value filter, through prefixing the attribute to be filtered with custom., for example custom.season. The following example filters on content having both a specific designer and one or both seasons listed: {"custom.designer": "Langdon","type": "article", "custom.season": ["Winter", "Spring"]}

Name	Type	Description
content_key	string[]	The key(s) of the content items you wish to filter. Examples: `["a1","d2"]`
type	string[]	The type(s) of the content items you wish to filter. Examples: `["article","designer"]`

ContentItem

Object representation of the content item.

Name	Type	Description
custom	<string, CustomAttribute[]>	Custom attributes of the content item, represented as key-value pairs. Examples: `{"tags":[{"id":"78","label":"Guide"},{"id":"223","label":"Jeans"}]}`
description	string	Description of the content item. Undefined if omitted during import. Examples: `"To wash or not to wash? And how?! Those are questions jeans shoppers are asking."`
image	Image	Image information. Undefined if omitted during import.
key	string	Content identifier Examples: `"wash_care"`
link	string	Link to the page representing this content item. Examples: `"/wash-guide"`
releaseDate	string	Release date of the content item. Undefined if omitted during import. Examples: `"2021-10-01T00:00:00Z"`
ticket	string	Used in notification calls to register visitor interaction. Examples: `"Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7"`
title	string	Title of the content item. Examples: `"How to wash jeans"`
type	string	Type of the content item. Examples: `"article"`

ContentList

The object representation of the content list. Content lists are supported by the Search-page, autocomplete and landing-page. To include content lists in a page response, the request body must include a content list configuration.

Name	Type	Description
id	string	List identifier. Examples: `"content-hits"`
items	ContentItem[]	The content items.
totalHits	integer	The total number of content that matches the filter and query if applicable. Examples: `10`

ContentListSettingsSearch

The content list request configuration.

Name	Type	Description
contentFilter	ContentFilter	Examples: `{"custom.designer":"Langdon","type":"article","custom.season":["Winter","Spring"]}`
id	string	An identifier for the content listing area. Multiple pages using the same template can share identifiers, but one identifier may not appear twice within a page. Required Type restrictions: Maximum length is 20 characters. Allowed characters are letters, numbers, dashes, and underscores. Min length: `1`. Max length: `20`. Pattern: `^[A-Za-z0-9_-]*$`. Examples: `"CDP-2"`
limit	integer	The number of content items to list. Default is page-type specific, 5 for search page and 3 for autocomplete. Min: `1`. Max: `200`. Examples: `8`

CustomAttribute

Name	Type	Description
id	string	Id of the attribute (the actual value). Examples: `"summer"`
label	string	The label of the attribute (the name attribute in the feed - currently not available for content items). Examples: `"Summer"`

CustomPrice

Name	Type	Description
id	string	The id identifying the custom price. Examples: `"VIP_EUR"`
listPrice	number	The price displayed in the shop as the standard price. Examples: `12.99`
sellingPrice	number	The price that the customer pays. Examples: `9.99`

DidYouMean

Name	Type	Description
q	string	A suggested correction of the original query. Never returned simultaneously as an applied autocorrection. Examples: `"shoes"`

A collection of facets. Depending on the type they may have additional fields. Implemented by: CheckboxFacet or ColorFacet or RangeFacet or SizeFacet or TextFacet

Name	Type	Description
id*	string	The identifier for the facet. Should be used when creating a facet query-parameter in combination with a facet value. Examples: `"size"`
label*	string	The presentation text for the facet. Examples: `"size"`
type*	FacetType	The type of facet. Supported values: `SIZE`, `RANGE`, `TEXT`, `COLOR`, `CHECKBOX`. Examples: `"RANGE"`

FacetType (enum)

Name	Description
SIZE	The facet contains size values.
RANGE	The facet contains range values.
TEXT	The facet contains text values.
COLOR	The facet contains color values.
CHECKBOX	The facet should be rendered as a checkbox.

Format

Name	Type	Description
format	string	The format, e.g. SML or custom.EU. Empty if size cleaning is enabled in the experience app.
values	Size[]	The size values for the format.

Image

The object representation of an image.

Name	Type	Description
alt	string	Element of image specifying the alt text of an image. The alt text should describe the image. Always returned along with the image. Examples: `"A woman wearing a white t-shirt"`
caption	string	Element of image specifying the caption for the image, only returned on the product page (or content information for content). Examples: `"The model is 176 cm tall and is wearing size S"`
custom	<string, string>	Custom attributes of the image.
sources	Source[]	All valid image URLs and dimensions. If no images are valid, one arbitrary URL will be selected.

ImageEffect (enum)

Name	Description
NONE	No image effect should be applied. The images array will contain as most one element.
SWAP	The images array will always contain two elements. The images should swap on hover.
GALLERY	The images array will always contain more than one element. The images can be used to, for example, present an image gallery where the visitor can alternate between images.

ImageInfo

The object representation of image information.

Name	Type	Description
effect	ImageEffect	The interaction effects of the product images. Merchandiser option. Defaults to `NONE` if there are fewer than two valid images for that product. Supported values: `NONE`, `SWAP`, `GALLERY`.
images	Image[]	The product images to display.
thumbnail	string	The url of the thumbnail for the product. Undefined if images is empty. Examples: `"https://cdn.example.com/thumbs/j12_prod.jpg"`

Measurement

Name	Type	Description
amount	number	The amount of the measurement as provided in the import. Examples: `25`
unit	string	The unit of the measurement as provided in the import. Examples: `"cm"`

The object representation of a navigation result.

Name	Type	Description
breadcrumbs	Breadcrumb[]	List of breadcrumbs
tree	NavigationTreeNode	Tree of navigation nodes

NavigationSettings

The object representation of the navigation configuration.

Name	Type	Description
include	boolean	Set to true to return the navigation object (including breadcrumbs), i.e. when navigation is handled through Elevate. Default: `false`. Examples: `true`

NavigationTreeNode

The object representation of the navigation node.

Name	Type	Description
children	NavigationTreeNode[]	A list of NavigationNode children of the current node.
count	integer	The number of product groups in the node. Examples: `5`
customData	<string, string>	A key-value mapping of custom data associated with this page as defined in the navigation import. Examples: `{"highlight":"true","viewableFrom":"2010-10-20 00:00:00"}`
expandable	boolean	Indicates that this node can be expanded, e.g. a request with this node as selected will return children under this node. Examples: `true`
iconPath	string	The path to the image used as this node’s icon, if any. Examples: `"/resources/images/navigation/spring_node.jpg"`
label	string	The presentation text for the node. Examples: `"All products"`
link	string	Link to page, will only by populated if type is PAGE_LINK Examples: `"/springselections"`
path	string	The path to the node. Examples: `"/"`
selected	boolean	Identifies the node as selected in the tree. Examples: `false`
type	NavigationTreeNodeType	The type of node, used for separating visuals of different node types. Supported values: `PRODUCT`, `LABEL`, `PAGE_LINK`, `SPACER`. Examples: `"PAGE_LINK"`

NavigationTreeNodeType (enum)

Name	Description
PRODUCT	A node containing products, typically modifies a product listing on click.
LABEL	A node used for visually separating other navigation nodes.
PAGE_LINK	A node intended to takes the user to another page, does not have to contain products.
SPACER	A node used for adding spaces between other navigation nodes.

Price

Name	Type	Description
max	number	Examples: `4500.0`
min	number	Examples: `190.5`

PrimaryList

The object representation of the primary list

Name	Type	Description
facets	Facet[]	Collection of facets.
productGroups	ProductGroup[]	A list of products, represented as groups containing a main product and its sibling products within its product group. Each element in this list should correspond to its own product card.
sliceRanges	SliceRange[]	A list of ranges for slices, which describe when a slice starts and when it ends.
sort	SortOrder	How the product groups are sorted.
totalHits	integer	The total number of product hits.

PrimaryListSettings

A configuration object allowing filter restrictions of the primary listing, i.e. the search results.

Name	Type	Description
include	boolean	Specifies if the primary list should be included or not in the response. Always included in search page requests. Default: `true`. Examples: `true`
productFilter Deprecated	ProductFilter
productRules	string	A logical expression used by Elevate to restrict the data set to a Product Selection. The rules can go from easy, such as to only include a product by its key or items that are in stock, to more complex expressions with multiple attributes for products at the same time. If no rules are provided, the entire data set will be used. Please note that when used in Landing Pages, the “Handpicked” rule must be the first rule, and must contain a set of product keys as its only condition. At most 100 product keys can be handpicked in a single request, and at most 200 attribute values can be supplied for each attribute. Examples: `"rule incl product_key { \"ABC123\" \"DEF456\" \"GHJ789\" } rule incl custom.material { \"leather\" } excl price [ -infinity, 100 ] rule incl newness 10d rule incl brand { \"Birkenstock\" } excl custom.isActive { \"false\" }"`

ProductBadge

Name	Type	Description
attribute	string	The attribute in the data feed that the badge is based on. Examples: `"is_new"`
label	string	The presentation text of the badge. Examples: `"Latest!"`
theme	BadgeTheme	The type of badge style used. Supported values: `NONE`, `SALE`, `DISCOUNT`, `NEW`, `THEME_1`, `THEME_2`, `THEME_3`. Examples: `"NEW"`

This feature will most likely be removed in new versions.

A product filter restricting which products that the listing may contain. Supports single values, lists, and (for numerical attributes) ranges. Listing multiple attributes to filter on will restrict the products to all conditions (logical AND). When listing values within one attribute, products with any of the listed properties apply (logical OR). In addition to built-in attributes, it is also possible to filter on custom facets, through prefixing the attribute to be filtered with custom., for example “custom.season”: [“Winter”, “Spring”]. At most 200 attribute values can be supplied per attribute and at most 100 product keys can be picked at once.

Name	Type	Description
price Deprecated	RangeAttribute	An example parameter of a range attribute.

ProductGroup

The object representation of the product group result.

Name	Type	Description
key	string	Product group identifier. Examples: `"PRODGROUP060194"`
products	Product[]	Products in the Product group. The first element corresponds to the main product. The remaining elements are the other products in the group, to be shown as thumbnails or color swatches, etc.
remaining	integer	The number of products within this group not included in the response. E.g. if Elevate has been set to include the first five products in the response and this group has seven, there will be two remaining. Examples: `2`

Product

The object representation of a product.

Name	Type	Description
badges	Badges	Product badges, split per area.
brand	string	Brand of the product. Examples: `"Versace"`
custom	<string, CustomAttribute[]>	Custom attributes of the product. Only available on the product-page productGroup and when using the query parameter ‘presentCustom’.
depth	Measurement	Depth of the product. Undefined if omitted during import.
description	string	Description of the product. Only available on the product-page productGroup, unless specified in a template. Undefined if omitted during import. Examples: `"null"`
height	Measurement	Height of the product. Undefined if omitted during import.
imageInfo	ImageInfo	Product image information.
inStock	boolean	True if any variant is in stock. Examples: `true`
key	string	Product identifier. Examples: `"p1000-101"`
length	Measurement	Length of the product. Undefined if omitted during import.
link	string	Link to the product page. Will point to a variant if the visitor has filtered on a specific size. Examples: `"men/jeans/country-fit-cowboy-jeans"`
listPrice	Price	Min and max price
name	string	Name of the product. Examples: `"Romeo"`
notifyImpression Deprecated	boolean	True, if the rendering of the product card should trigger an impression notification. For retail media only. Examples: `true`
rating	number	Current rating value. Undefined when ratings are disabled. Examples: `4.5`
remainingVariants	integer	The number of variants not included in the response. Only included if the number of variants have been limited through a template. Does not include variants hidden for being out of stock.
sellingPrice	Price	Min and max price
series	string	Series that this product belongs to. Examples: `"Billy"`
sponsored	boolean	True if the product is sponsored. For retail media only. Examples: `true`
swatch	Swatch	Swatch information.
ticket	string	The ticket is a unique string for an object generated by Elevate. Examples: `"Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7"`
title	string	Title of the product. Examples: `"Country Fit Cowboy Jeans"`
typedCustom	TypedCustomAttributes	Typed custom attributes of the product. Only available on the product-page productGroup and when using the query parameter ‘presentCustom’.
variants	Variant[]	List of variants. Empty if all variants are out of stock and the setting Display out of stock sizes in product card is disabled.
volume	Measurement	Volume of the product. Undefined if omitted during import.
weight	Measurement	Weight of the product. Undefined if omitted during import.
width	Measurement	Width of the product. Undefined if omitted during import.

RangeAttribute

This feature will most likely be removed in new versions.

A min and max range value object for a specific attribute.

Name	Type	Description
max	integer	Defaults to the maximum eligible value if omitted. Examples: `1000`
min	integer	Defaults to 0 if omitted. Examples: `0`

RangeFacet

A facet containing range values.

Name	Type	Description
id	string	The identifier for the facet. Should be used when creating a facet query-parameter in combination with a facet value. Examples: `"size"`
label	string	The presentation text for the facet. Examples: `"size"`
max	number	The maximum inclusive value of the range. Undefined if no products in selection.
maxSelected	number	The selected maximum value. Undefined if not selected.
min	number	The minimum inclusive value of the range. Undefined if no products in selection.
minSelected	number	The selected minimum value. Undefined if not selected.
type	FacetType	The type of facet. Supported values: `SIZE`, `RANGE`, `TEXT`, `COLOR`, `CHECKBOX`. Examples: `"RANGE"`
unit	string	The unit of the value. Only applicable for measurements Examples: `"cm"`

RelatedSearch

Name	Type	Description
q	string	A suggested query related to the original query Examples: `"shoes"`

SecondaryList

The object representation of a Secondary list. Uses product rules of the primary list. Contains max 12 productGroups. Intended as a preview of the entire secondary list.

Name	Type	Description
productGroups	ProductGroup[]	A list of products. Each group contains a main product and its sibling products within its product group. Each group should correspond to one product card.
totalHits	integer	The total number of product hits. Examples: `10`

SizeFacet

A facet containing size values.

Name	Type	Description
id	string	The identifier for the facet. Should be used when creating a facet query-parameter in combination with a facet value. Examples: `"size"`
label	string	The presentation text for the facet. Examples: `"size"`
selectedCount	integer	The number of selected facet values.
sizeTypes	SizeType[]	The defined SizeTypes.
type	FacetType	The type of facet. Supported values: `SIZE`, `RANGE`, `TEXT`, `COLOR`, `CHECKBOX`. Examples: `"RANGE"`

Size

Name	Type	Description
count	integer	The number of values that matches the criteria.
id	string	The identifier for the facet value, used by Elevate to determine which facet value has been selected. Should only be used when creating facet query-parameters.
label	string	The presentation text for the facet value.
selected	boolean	Identifies the value as selected.

SizeType

Name	Type	Description
formats	Format[]	The size formats for the size type.
label	string	The size type, e.g. shoe or clothes sizes. Empty if size type is disabled in the experience app.

SliceRange

Object representing the range of a slice.

Name	Type	Description
from	integer	Start index in the PrimaryList for this slice, inclusive. Examples: `0`
id	string	Id of the slice
to	integer	End index in the PrimaryList for this slice, exclusive. Examples: `1`

Sort (enum)

Name	Description
RELEVANCE	Ordered by the relevance of the facet values given the current context, from the most relevant to the least relevant.
ALPHABETICAL	Ordered in alphabetical order from A to Z, numbers are sorted as text values.
NATURAL	Ordered in alphabetical order from A to Z, numbers are sorted as numbers.

SortOption

Name	Type	Description
id	SortOrderV2	Identifier for the SortOption. Supported values: `RELEVANCE`, `NEWEST_FIRST`, `PRICE_ASCENDING`, `PRICE_DESCENDING`, `DISCOUNT`, `RATING`, `NAME`, `LENGTH_INCREASING`, `LENGTH_DECREASING`, `WIDTH_INCREASING`, `WIDTH_DECREASING`, `HEIGHT_INCREASING`, `HEIGHT_DECREASING`, `DEPTH_INCREASING`, `DEPTH_DECREASING`, `VOLUME_INCREASING`, `VOLUME_DECREASING`, `WEIGHT_INCREASING`, `WEIGHT_DECREASING`, `TITLE`. Examples: `"RELEVANCE"`
label	string	The presentation text for the SortOption. Examples: `"Relevance"`

SortOrder

The object representation of the sort order result.

Name	Type	Description
options	SortOption[]	Which sort types to choose from.
selected	SortOrderV2	Which sort type is currently selected. Supported values: `RELEVANCE`, `NEWEST_FIRST`, `PRICE_ASCENDING`, `PRICE_DESCENDING`, `DISCOUNT`, `RATING`, `NAME`, `LENGTH_INCREASING`, `LENGTH_DECREASING`, `WIDTH_INCREASING`, `WIDTH_DECREASING`, `HEIGHT_INCREASING`, `HEIGHT_DECREASING`, `DEPTH_INCREASING`, `DEPTH_DECREASING`, `VOLUME_INCREASING`, `VOLUME_DECREASING`, `WEIGHT_INCREASING`, `WEIGHT_DECREASING`, `TITLE`. Examples: `"RELEVANCE"`

SortOrderV2 (enum)

Name	Description
RELEVANCE	Sort for the most relevant product in the current context, based on set business goals. Default for all primary listings.
NEWEST_FIRST	The newest product first, determined by release date provided in the product feed. The first import date will be used for a product if no release date is provided in the product feed.
PRICE_ASCENDING	Ordered by the selling price of the least expensive variant of a product, low to high.
PRICE_DESCENDING	Ordered by the selling price of the most expensive variant of a product, high to low.
DISCOUNT	Ordered by the discount percentage of the most discounted variant of a product, high to low.
RATING	Ordered by the rating of a product, high to low. Only applicable if `rating` is supplied in the product feed.
NAME	Ordered by the name of the products. Only applicable if `name` is supplied in the product feed.
LENGTH_INCREASING	Sort by smallest length.
LENGTH_DECREASING	Sort by largest length.
WIDTH_INCREASING	Sort by smallest width.
WIDTH_DECREASING	Sort by largest width.
HEIGHT_INCREASING	Sort by smallest height.
HEIGHT_DECREASING	Sort by largest height.
DEPTH_INCREASING	Sort by smallest depth.
DEPTH_DECREASING	Sort by largest depth.
VOLUME_INCREASING	Sort by smallest volume.
VOLUME_DECREASING	Sort by largest volume.
WEIGHT_INCREASING	Sort by smallest weight.
WEIGHT_DECREASING	Sort by largest weight.
TITLE	Ordered by the title of the products. Only applicable if `title` is supplied in the product feed.

Source

Name	Type	Description
url*	string	The URL of the image source. Examples: `"https://cdn.example.com/img/j12_prod.jpg"`
height	integer	The height of the image. Undefined if height was not specified. Examples: `820`
width	integer	The width of the image. Undefined if width was not specified and hasn’t yet been assessed by the image service. Examples: `420`

Swatch

Swatch information is used to generate swatches for different products. The type COLORS is the most common returned type and is accompanied by the actual colours as CSS colour codes. Special colour properties, supported in the data feed such as GOLD, SILVER, MULTI or TRANSPARENT are other possible return types. These are to be used to generate swatches matching these specific properties.

Name	Type	Description
colors	string[]	An array with 1 - 3 CSS colour codes for SwatchType COLORS. Empty for other types. Examples: `"#FF0000"`
type	SwatchType	Type of colour swatch for the product. Supported values: `MISSING_COLORS`, `COLORS`, `SILVER`, `GOLD`, `MULTI`, `TRANSPARENT`. Examples: `"COLORS"`

SwatchType (enum)

Name	Description
MISSING_COLORS	Used if there is no available color.
COLORS	Used if colors have been analysed or provided in the data feed.
SILVER	Used if silver properties are found in analysis or SILVER is provided as color in the data feed.
GOLD	Used if gold properties are found in analysis or GOLD is provided as color in the data feed.
MULTI	Used if MULTI was provided as color in the data feed.
TRANSPARENT	Used if TRANSPARENT was provided as color in the data feed.

TextFacet

A facet containing text values.

Name	Type	Description
id	string	The identifier for the facet. Should be used when creating a facet query-parameter in combination with a facet value. Examples: `"size"`
label	string	The presentation text for the facet. Examples: `"size"`
selectedCount	integer	The number of selected facet values.
sort	Sort	How the facet values are sorted. Supported values: `RELEVANCE`, `ALPHABETICAL`, `NATURAL`.
type	FacetType	The type of facet. Supported values: `SIZE`, `RANGE`, `TEXT`, `COLOR`, `CHECKBOX`. Examples: `"RANGE"`
values	TextValue[]	The values of the facet.

TextValue

Name	Type	Description
count	integer	The number of values that matches the criteria.
id	string	The identifier for the facet value, used by Elevate to determine which facet value has been selected. Should only be used when creating facet query-parameters.
label	string	The presentation text for the facet value.
selected	boolean	Identifies the value as selected.

TypedCustomAttributes

Name	Type	Description
json	<string, object>	Custom json data of the product matching json attributes requested by the query parameter ‘presentCustom’.
lengths	<string, Measurement>	Custom lengths of the product matching length attributes requested by the query parameter ‘presentCustom’.
numbers	<string, number>	Custom numbers of the product matching numbers attributes requested by the query parameter ‘presentCustom’.

VariantAvailabilityInfo

Represents availability in one store or online.

Name	Type	Description
channel	string	The channel either STORE or ONLINE. Examples: `"STORE"`
key	string	The key identifying the store. Null if channel = ONLINE. Examples: `"boardwalk"`
stockNumber	integer	The number of items of this variant in stock in this channel/key. Examples: `5`

Variant

The object representation of a variant.

Name	Type	Description
availability	VariantAvailabilityInfo[]	List of availability information. Contains an entry for the online channel and one for each relevant store.
custom	<string, CustomAttribute[]>	Custom attributes of the variant. Available when specified in the applied template or the query parameter `presentCustom` (always available in product-page productGroup).
depth	Measurement	Depth of the variant. Undefined if omitted during import.
height	Measurement	Height of the variant. Undefined if omitted during import.
inStock	boolean	True if the variant is in stock. Examples: `true`
key	string	Variant identifier. Examples: `"1000-101_RED"`
label	string	The label of the variant. Defaults to size if undefined. Undefined if neither label or size is specified in the import. Examples: `"XL"`
length	Measurement	Length of the variant. Undefined if omitted during import.
link	string	Link to product page with variant selected. Examples: `"women/pants/khaki/101-v3-red"`
listPrice	number	List price of the variant. Examples: `15.0`
prices	CustomPrice[]	Additional prices for presentation. Only available on the product-page productGroup and when using the query parameter ‘presentPrices’.
sellingPrice	number	Selling price of the variant. Examples: `24.0`
size Deprecated	string	A representative size of the variant. Overridden by label if provided. Deprecated, use label instead, Examples: `"XL"`
stockNumber	integer	The amount of this variant that is in stock. Examples: `5`
ticket	string	Unique ticket for the eSales object. Examples: `"Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7"`
typedCustom	TypedCustomAttributes	Typed custom attributes of the variant. Available when specified in the applied template or the query parameter `presentCustom` (always available in product-page productGroup).
volume	Measurement	Volume of the variant. Undefined if omitted during import.
weight	Measurement	Weight of the variant. Undefined if omitted during import.
width	Measurement	Width of the variant. Undefined if omitted during import.

​GET

​Request

​Response

​SearchPageResult

​POST

​Request

​SearchPageRequestSettings

​Response

​SearchPageResult

​Inner Schemas

​AutoCorrect

​Badges

​BadgeTheme (enum)

​Breadcrumb

​CheckboxFacet

​ColorFacet

​Color

​ContentFilter

​ContentItem

​ContentList

​ContentListSettingsSearch

​CustomAttribute

​CustomPrice

​DidYouMean

​Facet

​FacetType (enum)

​Format

​Image

​ImageEffect (enum)

​ImageInfo

​Measurement

​Navigation

​NavigationSettings

​NavigationTreeNode

​NavigationTreeNodeType (enum)

​Price

​PrimaryList

​PrimaryListSettings

​ProductBadge

​ProductFilter

​ProductGroup

​Product

​RangeAttribute

​RangeFacet

​RelatedSearch

​SecondaryList

​SizeFacet

​Size

​SizeType

​SliceRange

​Sort (enum)

​SortOption

​SortOrder

​SortOrderV2 (enum)

​Source

​Swatch

​SwatchType (enum)

​TextFacet

​TextValue

​TypedCustomAttributes

​VariantAvailabilityInfo

​Variant

GET

Request

Response

SearchPageResult

POST

Request

SearchPageRequestSettings

Response

SearchPageResult

Inner Schemas

AutoCorrect

Badges

BadgeTheme (enum)

Breadcrumb

CheckboxFacet

ColorFacet

Color

ContentFilter

ContentItem

ContentList

ContentListSettingsSearch

CustomAttribute

CustomPrice

DidYouMean

Facet

FacetType (enum)

Format

Image

ImageEffect (enum)

ImageInfo

Measurement

Navigation

NavigationSettings

NavigationTreeNode

NavigationTreeNodeType (enum)

Price

PrimaryList

PrimaryListSettings

ProductBadge

ProductFilter

ProductGroup

Product

RangeAttribute

RangeFacet

RelatedSearch

SecondaryList

SizeFacet

Size

SizeType

SliceRange

Sort (enum)

SortOption

SortOrder

SortOrderV2 (enum)

Source

Swatch

SwatchType (enum)

TextFacet

TextValue

TypedCustomAttributes

VariantAvailabilityInfo

Variant