Skip to content

Search Page

https://{cluster-id}.api.esales.apptus.cloud/api/v2/queries/search-page

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.

Request

Header parameters

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

Query parameters

Name Description Example
customerKey
Required
A key that uniquely identifies the current visitor.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
market
Required
The visitor market identifier. Must match the corresponding market identifier in the data feed. UK
q
Required
The search query used for the current result. May be corrected in the response. green
sessionKey
Required
A unique key, identifying the session.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
touchpoint
Required
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|STORE
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. 10
notify A boolean that can be used to disable notifications and behavioural registration for the query. false
origin The search origin of the search phrase. Defaults to ORGANIC. This is recommended to include. Supported values: ORGANIC, DID_YOU_MEAN, UNDO_AUTO_CORRECT, PHRASE_SUGGEST, RELATED_SEARCHES, RECENT_SEARCH. PHRASE_SUGGEST
presentCustom A pipe-separated list of custom product attributes to include in all listings. season|manufacturer
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. Must match supplied custom price identifiers in the data feed. 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. 0
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, PRICE_ASCENDING, PRICE_DESCENDING, DISCOUNT, RATING. 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
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
curl -i \
-X GET \
-H 'Accept-Encoding: gzip' \
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/queries/search-page?customerKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&market=UK&q=green&sessionKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&touchpoint=DESKTOP&channels=ONLINE|STORE&f.[id]=Bosch|Dewalt or true/false&f.[id].max=1000&f.[id].min=0&limit=10&notify=false&origin=PHRASE_SUGGEST&presentCustom=season|manufacturer&presentPrices=VIP|member&priceId=VIP&selectedCategory=/women/dresses&skip=0&sort=RELEVANCE&stores=240|100&viewAllSecondary=true&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.

Response headers

Name Type Description Example
X-Response-Time integer Response time in milliseconds (ms) 65

Response body

Example
application/json;charset=utf-8
{
  "autoCorrect" : {
    "originalTotalHits" : 5,
    "q" : "Jeans"
  },
  "contentLists" : [ {
    "id" : "content-hits",
    "items" : [ {
      "custom" : { },
      "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://examplecdn.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"
  } ],
  "navigation" : {
    "breadcrumbs" : [ {
      "label" : "Women's shoes",
      "path" : "womens/shoes/"
    } ],
    "tree" : {
      "children" : { },
      "count" : 5,
      "expandable" : true,
      "label" : "All products",
      "link" : "/springselections",
      "path" : "/",
      "selected" : false,
      "type" : "PAGE_LINK"
    }
  },
  "primaryList" : {
    "facets" : [ {
      "id" : "size",
      "label" : "size",
      "type" : "RANGE"
    } ],
    "productGroups" : [ {
      "key" : "PRODGROUP060194",
      "products" : [ {
        "badges" : {
          "primary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : "NEW"
          } ],
          "secondary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : "NEW"
          } ]
        },
        "brand" : "Versace",
        "custom" : { },
        "description" : "Super elastic fit.",
        "imageInfo" : {
          "effect" : "NONE",
          "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://examplecdn.com/img/j12_prod.jpg",
              "height" : 820,
              "width" : 420
            } ]
          } ],
          "thumbnail" : "https://examplecdn.com/thumbs/j12_prod.jpg"
        },
        "inStock" : true,
        "key" : "p1000-101",
        "link" : "men/jeans/country-fit-cowboy-jeans",
        "listPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "rating" : 4.5,
        "sellingPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "swatch" : {
          "colors" : [ "#FF0000" ],
          "type" : "COLORS"
        },
        "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
        "title" : "Country Fit Cowboy Jeans",
        "variants" : [ {
          "availability" : [ {
            "channel" : "STORE",
            "key" : "boardwalk",
            "stockNumber" : 5
          } ],
          "inStock" : true,
          "key" : "1000-101_RED",
          "link" : "women/pants/khaki/101-v3-red",
          "listPrice" : 15.0,
          "prices" : [ {
            "id" : "VIP_EUR",
            "listPrice" : 12.99,
            "sellingPrice" : 9.99
          } ],
          "sellingPrice" : 24.0,
          "size" : "XL",
          "stockNumber" : 5,
          "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7"
        } ]
      } ]
    } ],
    "sort" : {
      "options" : [ {
        "id" : "RELEVANCE",
        "label" : "Relevance"
      } ],
      "selected" : "RELEVANCE"
    },
    "totalHits" : 0
  },
  "q" : "Jean",
  "relatedSearches" : [ {
    "q" : "shoes"
  } ],
  "secondaryList" : {
    "productGroups" : [ {
      "key" : "PRODGROUP060194",
      "products" : [ {
        "badges" : {
          "primary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : "NEW"
          } ],
          "secondary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : "NEW"
          } ]
        },
        "brand" : "Versace",
        "custom" : { },
        "description" : "Super elastic fit.",
        "imageInfo" : {
          "effect" : "NONE",
          "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://examplecdn.com/img/j12_prod.jpg",
              "height" : 820,
              "width" : 420
            } ]
          } ],
          "thumbnail" : "https://examplecdn.com/thumbs/j12_prod.jpg"
        },
        "inStock" : true,
        "key" : "p1000-101",
        "link" : "men/jeans/country-fit-cowboy-jeans",
        "listPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "rating" : 4.5,
        "sellingPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "swatch" : {
          "colors" : [ "#FF0000" ],
          "type" : "COLORS"
        },
        "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
        "title" : "Country Fit Cowboy Jeans",
        "variants" : [ {
          "availability" : [ {
            "channel" : "STORE",
            "key" : "boardwalk",
            "stockNumber" : 5
          } ],
          "inStock" : true,
          "key" : "1000-101_RED",
          "link" : "women/pants/khaki/101-v3-red",
          "listPrice" : 15.0,
          "prices" : [ {
            "id" : "VIP_EUR",
            "listPrice" : 12.99,
            "sellingPrice" : 9.99
          } ],
          "sellingPrice" : 24.0,
          "size" : "XL",
          "stockNumber" : 5,
          "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7"
        } ]
      } ]
    } ],
    "totalHits" : 10
  }
}
Schema

SearchPageResult

The object representation of the search page result.

Name Type Description Example
autoCorrect AutoCorrect
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.
navigation NavigationResult
primaryList PrimaryList
q string The search query used for the current result. May be corrected in the response. Jean
relatedSearches RelatedSearch[] A list of phrases related to the search phrase.
secondaryList SecondaryList

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.

Request

Header parameters

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

Query parameters

Name Description Example
customerKey
Required
A key that uniquely identifies the current visitor.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
market
Required
The visitor market identifier. Must match the corresponding market identifier in the data feed. UK
q
Required
The search query used for the current result. May be corrected in the response. green
sessionKey
Required
A unique key, identifying the session.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
touchpoint
Required
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|STORE
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. 10
notify A boolean that can be used to disable notifications and behavioural registration for the query. false
origin The search origin of the search phrase. Defaults to ORGANIC. This is recommended to include. Supported values: ORGANIC, DID_YOU_MEAN, UNDO_AUTO_CORRECT, PHRASE_SUGGEST, RELATED_SEARCHES, RECENT_SEARCH. PHRASE_SUGGEST
presentCustom A pipe-separated list of custom product attributes to include in all listings. season|manufacturer
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. Must match supplied custom price identifiers in the data feed. 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. 0
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, PRICE_ASCENDING, PRICE_DESCENDING, DISCOUNT, RATING. 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
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

Supported Content-Type

  • application/json;charset=utf-8
  • text/plain;charset=utf-8

Request body

Example
application/json;charset=utf-8
{
  "contentLists" : [ {
    "contentFilter" : {
      "content_key" : "string",
      "type" : "string"
    },
    "id" : "CDP-2",
    "limit" : 8
  } ],
  "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\" } "
  }
}
Schema

SearchPageRequestSettings

A configuration object for the search page request.

Name Type Description Example
contentLists ContentListSettingsSearch[]
navigation NavigationSettings
primaryList PrimaryListSettings
curl -i \
-X POST \
-H 'Accept-Encoding: gzip' \
-H 'Content-Type: application/json;charset=utf-8' \
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/queries/search-page?customerKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&market=UK&q=green&sessionKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&touchpoint=DESKTOP&channels=ONLINE|STORE&f.[id]=Bosch|Dewalt or true/false&f.[id].max=1000&f.[id].min=0&limit=10&notify=false&origin=PHRASE_SUGGEST&presentCustom=season|manufacturer&presentPrices=VIP|member&priceId=VIP&selectedCategory=/women/dresses&skip=0&sort=RELEVANCE&stores=240|100&viewAllSecondary=true&viewId=production" \
-T request-body.file

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.

Response headers

Name Type Description Example
X-Response-Time integer Response time in milliseconds (ms) 65

Response body

Example
application/json;charset=utf-8
{
  "autoCorrect" : {
    "originalTotalHits" : 5,
    "q" : "Jeans"
  },
  "contentLists" : [ {
    "id" : "content-hits",
    "items" : [ {
      "custom" : { },
      "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://examplecdn.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"
  } ],
  "navigation" : {
    "breadcrumbs" : [ {
      "label" : "Women's shoes",
      "path" : "womens/shoes/"
    } ],
    "tree" : {
      "children" : { },
      "count" : 5,
      "expandable" : true,
      "label" : "All products",
      "link" : "/springselections",
      "path" : "/",
      "selected" : false,
      "type" : "PAGE_LINK"
    }
  },
  "primaryList" : {
    "facets" : [ {
      "id" : "size",
      "label" : "size",
      "type" : "RANGE"
    } ],
    "productGroups" : [ {
      "key" : "PRODGROUP060194",
      "products" : [ {
        "badges" : {
          "primary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : "NEW"
          } ],
          "secondary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : "NEW"
          } ]
        },
        "brand" : "Versace",
        "custom" : { },
        "description" : "Super elastic fit.",
        "imageInfo" : {
          "effect" : "NONE",
          "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://examplecdn.com/img/j12_prod.jpg",
              "height" : 820,
              "width" : 420
            } ]
          } ],
          "thumbnail" : "https://examplecdn.com/thumbs/j12_prod.jpg"
        },
        "inStock" : true,
        "key" : "p1000-101",
        "link" : "men/jeans/country-fit-cowboy-jeans",
        "listPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "rating" : 4.5,
        "sellingPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "swatch" : {
          "colors" : [ "#FF0000" ],
          "type" : "COLORS"
        },
        "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
        "title" : "Country Fit Cowboy Jeans",
        "variants" : [ {
          "availability" : [ {
            "channel" : "STORE",
            "key" : "boardwalk",
            "stockNumber" : 5
          } ],
          "inStock" : true,
          "key" : "1000-101_RED",
          "link" : "women/pants/khaki/101-v3-red",
          "listPrice" : 15.0,
          "prices" : [ {
            "id" : "VIP_EUR",
            "listPrice" : 12.99,
            "sellingPrice" : 9.99
          } ],
          "sellingPrice" : 24.0,
          "size" : "XL",
          "stockNumber" : 5,
          "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7"
        } ]
      } ]
    } ],
    "sort" : {
      "options" : [ {
        "id" : "RELEVANCE",
        "label" : "Relevance"
      } ],
      "selected" : "RELEVANCE"
    },
    "totalHits" : 0
  },
  "q" : "Jean",
  "relatedSearches" : [ {
    "q" : "shoes"
  } ],
  "secondaryList" : {
    "productGroups" : [ {
      "key" : "PRODGROUP060194",
      "products" : [ {
        "badges" : {
          "primary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : "NEW"
          } ],
          "secondary" : [ {
            "attribute" : "is_new",
            "label" : "Latest!",
            "theme" : "NEW"
          } ]
        },
        "brand" : "Versace",
        "custom" : { },
        "description" : "Super elastic fit.",
        "imageInfo" : {
          "effect" : "NONE",
          "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://examplecdn.com/img/j12_prod.jpg",
              "height" : 820,
              "width" : 420
            } ]
          } ],
          "thumbnail" : "https://examplecdn.com/thumbs/j12_prod.jpg"
        },
        "inStock" : true,
        "key" : "p1000-101",
        "link" : "men/jeans/country-fit-cowboy-jeans",
        "listPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "rating" : 4.5,
        "sellingPrice" : {
          "max" : 4500.0,
          "min" : 190.5
        },
        "swatch" : {
          "colors" : [ "#FF0000" ],
          "type" : "COLORS"
        },
        "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
        "title" : "Country Fit Cowboy Jeans",
        "variants" : [ {
          "availability" : [ {
            "channel" : "STORE",
            "key" : "boardwalk",
            "stockNumber" : 5
          } ],
          "inStock" : true,
          "key" : "1000-101_RED",
          "link" : "women/pants/khaki/101-v3-red",
          "listPrice" : 15.0,
          "prices" : [ {
            "id" : "VIP_EUR",
            "listPrice" : 12.99,
            "sellingPrice" : 9.99
          } ],
          "sellingPrice" : 24.0,
          "size" : "XL",
          "stockNumber" : 5,
          "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7"
        } ]
      } ]
    } ],
    "totalHits" : 10
  }
}
Schema

SearchPageResult

The object representation of the search page result.

Name Type Description Example
autoCorrect AutoCorrect
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.
navigation NavigationResult
primaryList PrimaryList
q string The search query used for the current result. May be corrected in the response. Jean
relatedSearches RelatedSearch[] A list of phrases related to the search phrase.
secondaryList SecondaryList

Schemas

Inner schemas

AutoCorrect

Information about applied auto corrections to the search phrase. Omitted if no correction was made.

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

Badges

Product badges, split per area.

Name Type Description Example
primary ProductBadge[]
secondary ProductBadge[]

The breadcrumb navigation object.

Name Type Description Example
label string Breadcrumb label Women's shoes
path string Breadcrumb path womens/shoes/

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.

Name Type Description Example
content_key string The key of the content item as provided in the data feed.
type string The type value of the content item as provided in the data feed.

ContentItem

Object representation of the content item.

Name Type Description Example
custom object Custom attributes of the content item.
description string Description of the content item. Undefined if omitted during import. To wash or not to wash? And how?! Those are questions jeans shoppers are asking.
image Image
key string Content identifier wash_care
link string Link to the page representing this content item. /wash-guide
releaseDate string Release date of the content item. Undefined if omitted during import. 2021-10-01T00:00:00Z
ticket string Used in notification calls to register visitor interaction. Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7
title string Title of the content item. How to wash jeans
type string Type of the content item. 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 Example
id string List identifier. content-hits
items ContentItem[] The content items.
totalHits integer The total number of content that matches the filter and query if applicable. 10

ContentListSettingsSearch

The content list request configuration.

Name Type Description Example
contentFilter ContentFilter
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. CDP-2
limit integer The number of content items to list. Default is page-type specific, 5 for search page and 3 for autocomplete. 8

DidYouMean

A list of did-you-mean suggestions.

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

FacetResult

A collection of facets.

Name Type Description Example
id string The identifier for the facet. Should be used when creating a facet query-parameter in combination with a facet value. size
label string The presentation text for the facet. size
type string The type of facet. The facet has additional properties based on its type. Supported values: SIZE, RANGE, TEXT, COLOR, EMPTY, CHECKBOX. RANGE

Image

The object representation of an image.

Name Type Description Example
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. 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). The model is 176 cm tall and is wearing size S
custom object Custom attributes of the image.
sources Source[]

ImageInfo

The object representation of image information.

Name Type Description Example
effect string The interaction effects of the product images. Merchandiser option. Supported values: NONE, SWAP, GALLERY. NONE
images Image[] The product images to display.
thumbnail string The url of the thumbnail for the product. Undefined if images is empty. https://examplecdn.com/thumbs/j12_prod.jpg

The object representation of a navigation result.

Name Type Description Example
breadcrumbs Breadcrumb[] List of breadcrumbs
tree NavigationTreeNode

The object representation of the navigation configuration.

Name Type Description Example
include boolean Defaults to include: false. Set to include: true to return the navigation object (including breadcrumbs), i.e. when navigation is handled through eSales. true

The object representation of the navigation node.

Name Type Description Example
children object A list of NavigationNode children of the current node.
count integer The number of product groups in the node. 5
expandable boolean Indicates that this node can be expanded, e.g. a request with this node as selected will return children under this node. true
label string The presentation text for the node. All products
link string Link to page, will only by populated if type is PAGE_LINK /springselections
path string The path to the node. /
selected boolean Identifies the node as selected in the tree. false
type string The type of node, used for separating visuals of different node types. Supported values: PRODUCT, LABEL, PAGE_LINK, SPACER. PAGE_LINK

Price

Min and max price

Name Type Description Example
max number 4500.0
min number 190.5

PriceResult

Additional prices for presentation. Only available on the product-page productGroup and when using the query parameter 'presentPrices'.

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

PrimaryList

The object representation of the primary list

Name Type Description Example
facets FacetResult[] Collection of facets.
productGroups ProductGroupResult[] Collection of product groups.
sort SortOrderResult
totalHits integer The total number of product group hits.

PrimaryListSettings

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

Name Type Description Example
include boolean Specifies if the primary list should be included or not in the response. Always included in search page requests. true
productFilter
Deprecated
ProductFilter
productRules string A logical expression used by Apptus eSales 4 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 20 attribute values can be supplied for each attribute. 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 Example
attribute string The attribute in the data feed that the badge is based on. is_new
label string The presentation text of the badge. Latest!
theme string The type of badge style used. Supported values: NONE, SALE, DISCOUNT, NEW, THEME_1, THEME_2, THEME_3. NEW

ProductFilter

Deprecated

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 20 attribute values can be supplied per attribute and at most 100 product keys can be picked at once.

Name Type Description Example
price
Deprecated
RangeAttribute

ProductGroupResult

The object representation of the product group result.

Name Type Description Example
key string Product group identifier. PRODGROUP060194
products ProductResult[] Products in the Product group.

ProductResult

The object representation of a product.

Name Type Description Example
badges Badges
brand string Brand of the product. Versace
custom object Custom attributes of the product. Only available on the product-page productGroup and when using the query parameter 'presentCustom'.
description string Description of the product. Undefined if omitted during import. Super elastic fit.
imageInfo ImageInfo
inStock boolean True if any variant is in stock. true
key string Product identifier. p1000-101
link string Link to the product page. men/jeans/country-fit-cowboy-jeans
listPrice Price
rating number Current rating value. Undefined when ratings are disabled. 4.5
sellingPrice Price
swatch Swatch
ticket string The ticket is a unique string for an object generated by eSales. Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7
title string Title of the product. Country Fit Cowboy Jeans
variants VariantResult[] List of variants. Empty if all variants are out of stock and the setting Display out of stock sizes in product card is disabled.

RangeAttribute

Deprecated

This feature will most likely be removed in new versions.

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

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

RelatedSearch

A list of phrases related to the search phrase.

Name Type Description Example
q string A suggested query related to the original query shoes

SecondaryList

The object representation of a Secondary list.

Name Type Description Example
productGroups ProductGroupResult[] Collection of product groups.
totalHits integer The total number of product group hits. 10

SortOption

Which sort types to choose from.

Name Type Description Example
id string Identifier for the SortOption. Supported values: RELEVANCE, NEWEST_FIRST, PRICE_ASCENDING, PRICE_DESCENDING, DISCOUNT, RATING. RELEVANCE
label string The presentation text for the SortOption. Relevance

SortOrderResult

The object representation of the sort order result.

Name Type Description Example
options SortOption[] Which sort types to choose from. RELEVANCE
selected string Which sort type is currently selected. Supported values: RELEVANCE, NEWEST_FIRST, PRICE_ASCENDING, PRICE_DESCENDING, DISCOUNT, RATING. RELEVANCE

Source

Name Type Description Example
url
Required
string The URL of the image source. https://examplecdn.com/img/j12_prod.jpg
height integer The height of the image. Undefined if height was not specified. 820
width integer The width of the image. Undefined if width was not specified and hasn't yet been assessed by the image service. 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, or MULTI are other possible return types. These are to be used to generate swatches matching these specific properties.

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

VariantAvailabilityInfo

Represents availability in one store or online.

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

VariantResult

The object representation of a variant.

Name Type Description Example
availability VariantAvailabilityInfo[] List of availability information. Contains an entry for the online channel and one for each relevant store.
inStock boolean True if the variant is in stock. true
key string Variant identifier. 1000-101_RED
link string Link to product page with variant selected. women/pants/khaki/101-v3-red
listPrice number List price of the variant. 15.0
prices PriceResult[] 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. 24.0
size string The size of the variant. Undefined if not specified in the import. XL
stockNumber integer The amount of this variant that is in stock. 5
ticket string Unique ticket for the eSales object. Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7
×
Copyright

This online publication is intellectual property of Voyado Lund AB. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Voyado Lund AB nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Voyado Lund AB essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE