Search

Provides access to intelligent search and filtering across your catalog

Endpoint Details

POST /catalog/search

Headers

Header
Value

Content-Type

application/json

Authorization

Bearer <YOUR_ACCESS_TOKEN>

Body

Parameter
Type
Description
Required

search

string

Text to search for in the catalog. Can include product names, brands, or other attributes

pageToken

string

Token for pagination, used to retrieve the next or previous page of results

entity

string

Entity identifier for personalized results

page

integer

Page number for pagination (starts at 0)

perPage

integer

Number of results to return per page

visitorId

string

Unique identifier for the visitor/user to enable personalized results

retailers

array<string>

Array of retailer identifiers

orderBy

string

Field to sort results by. Possible values: "price", "name", "brand", "price")

orderDirection

string

Sort direction. Possible values: "asc", "desc"

filters

Array of filter objects to refine search results

loc

Location object for determining real-time availability

isLegacy

boolean

Whether to return legacy identifiers

isLean

boolean

Whether to return a minimal response format

refresh

boolean

When set to true, a new access token will be generated and returned

Response Details

Field
Type
Description

statusCode

number

HTTP status code of the response

message

string

A brief message describing the result of the API call

metadata

Contains metadata about the API call

auth

Authentication object, only when refresh in true

navigation

Navigation schema

products

Array of matched products

retailers

Array of available retailers

Metadata Object

Field
Type
Description

languages

Array<string>

List of supported languages for the response, e.g. ["en"]

timestamp

string

Unix timestamp (in milliseconds) when the response was generated

timezone

string

Timezone used for the response, always "UTC"

requestId

string

Unique identifier for the API request. Used for debugging and support

path

string

API path

version

string

API version used for the request

Sample Request and Response

Last updated