Content Search Page

GET

The content search page query is intended to be used on a separate part of a site, such as an FAQ or a customer service section. A content search page query will return a search result content listing with applicable sort orders and total hits.

GET https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/content-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 executed search query.	`shipping`
`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`
`limit`	The number of content items to list. 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`	To correctly track and analyse search behaviour, searches that originate from autocomplete suggestions, triggered through did-you-mean, or are actual organic searches are differentiated. Supported values: `ORGANIC`, `DID_YOU_MEAN`, `UNDO_AUTO_CORRECT`, `PHRASE_SUGGEST`, `RELATED_SEARCHES`, `RECENT_SEARCH`, `DISCOVERY_AGENT`.	`ORGANIC`
`skip`	The number of content items to skip. Used for pagination, defaults to 0 if omitted in the query.	`10`
`sort`	The applied Sort order in the search result. Strongly recommended to omit for initial searches. Only recommended for explicit visitor interaction after initial searches. Supported values: `RELEVANCE`, `NEWEST_FIRST`.	`NEWEST_FIRST`
`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`
`viewId`	A parameter that is used to show the page in either production or preview mode. 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: gzip' \
"https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/content-search-page?customerKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&locale=en-GB&market=UK&q=shipping&sessionKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&touchpoint=DESKTOP&limit=10&notify=false&origin=ORGANIC&skip=10&sort=NEWEST_FIRST&userContext=PERSONALIZED&viewId=PRODUCTION"

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"
  },
  "didYouMean" : [ {
    "q" : "shoes"
  } ],
  "primaryList" : {
    "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"
    } ],
    "sort" : {
      "options" : [ {
        "id" : null,
        "label" : "Relevance"
      } ],
      "selected" : "RELEVANCE"
    },
    "totalHits" : 0
  },
  "q" : "Jean"
}

Response body schema

ContentSearchPageResult

The object representation of the content search page result.

Name	Type	Description
autoCorrect	AutoCorrect	Information about applied auto corrections to the search phrase. Omitted if no correction was made.
didYouMean	DidYouMean[]	A list of did-you-mean suggestions
primaryList	PrimaryContentList	A content list with the search result.
q	string	The search query used for the current result. May be corrected and differ from the requested query. Examples: `"Jean"`

POST

POST https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/content-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 executed search query.	`shipping`
`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`
`limit`	The number of content items to list. 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`	To correctly track and analyse search behaviour, searches that originate from autocomplete suggestions, triggered through did-you-mean, or are actual organic searches are differentiated. Supported values: `ORGANIC`, `DID_YOU_MEAN`, `UNDO_AUTO_CORRECT`, `PHRASE_SUGGEST`, `RELATED_SEARCHES`, `RECENT_SEARCH`, `DISCOVERY_AGENT`.	`ORGANIC`
`skip`	The number of content items to skip. Used for pagination, defaults to 0 if omitted in the query.	`10`
`sort`	The applied Sort order in the search result. Strongly recommended to omit for initial searches. Only recommended for explicit visitor interaction after initial searches. Supported values: `RELEVANCE`, `NEWEST_FIRST`.	`NEWEST_FIRST`
`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`
`viewId`	A parameter that is used to show the page in either production or preview mode. 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

{
  "primaryList" : {
    "contentFilter" : {
      "content_key" : [ "a1", "d2" ],
      "type" : [ "article", "designer" ]
    }
  }
}

Request body schema

ContentSearchPageRequestSettings

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

Name	Type	Description
primaryList	PrimaryContentListSettings	A configuration object allowing filter restrictions of the primary listing, i.e. the search results.

Example request

bash

curl -i \
-X POST \
-H 'Accept-Encoding: gzip' \
-H 'Content-Type: application/json;charset=utf-8' \
"https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/content-search-page?customerKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&locale=en-GB&market=UK&q=shipping&sessionKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&touchpoint=DESKTOP&limit=10&notify=false&origin=ORGANIC&skip=10&sort=NEWEST_FIRST&userContext=PERSONALIZED&viewId=PRODUCTION" \
-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"
  },
  "didYouMean" : [ {
    "q" : "shoes"
  } ],
  "primaryList" : {
    "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"
    } ],
    "sort" : {
      "options" : [ {
        "id" : null,
        "label" : "Relevance"
      } ],
      "selected" : "RELEVANCE"
    },
    "totalHits" : 0
  },
  "q" : "Jean"
}

Response body schema

ContentSearchPageResult

The object representation of the content search page result.

Name	Type	Description
autoCorrect	AutoCorrect	Information about applied auto corrections to the search phrase. Omitted if no correction was made.
didYouMean	DidYouMean[]	A list of did-you-mean suggestions
primaryList	PrimaryContentList	A content list with the search result.
q	string	The search query used for the current result. May be corrected and differ from the requested query. Examples: `"Jean"`

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"`

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"`

ContentSortOrder

Name	Type	Description
options	SortOption[]	The available sort order options
selected	string	The chosen sort order Supported values: `RELEVANCE`, `NEWEST_FIRST`. Examples: `"RELEVANCE"`

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"`

DidYouMean

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

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.

PrimaryContentList

The object representation of the primary content list.

Name	Type	Description
items	ContentItem[]	A list of the result of the search.
sort	ContentSortOrder	How the content is sorted and the available sort options.
totalHits	integer	The total number of content item hits.

PrimaryContentListSettings

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

Name	Type	Description
contentFilter	ContentFilter	Examples: `{"custom.designer":"Langdon","type":"article","custom.season":["Winter","Spring"]}`

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"`

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`

Overview

Admin

Storefront

GET

Request

Response

ContentSearchPageResult

POST

Request

ContentSearchPageRequestSettings

Response

ContentSearchPageResult

Schemas

AutoCorrect

ContentFilter

ContentItem

ContentSortOrder

CustomAttribute

DidYouMean

Image

PrimaryContentList

PrimaryContentListSettings

SortOption

SortOrderV2 (enum)

Source

​GET

​Request

​Response

​ContentSearchPageResult

​POST

​Request

​ContentSearchPageRequestSettings

​Response

​ContentSearchPageResult

​Schemas

​AutoCorrect

​ContentFilter

​ContentItem

​ContentSortOrder

​CustomAttribute

​DidYouMean

​Image

​PrimaryContentList

​PrimaryContentListSettings

​SortOption

​SortOrderV2 (enum)

​Source

GET

Request

Response

ContentSearchPageResult

POST

Request

ContentSearchPageRequestSettings

Response

ContentSearchPageResult

Schemas

AutoCorrect

ContentFilter

ContentItem

ContentSortOrder

CustomAttribute

DidYouMean

Image

PrimaryContentList

PrimaryContentListSettings

SortOption

SortOrderV2 (enum)

Source