Search result regrouping product, variant, attributes and offers

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
string

Navigation categories external ids

string

Menu navigation category externalId

skus
array of strings
skus
brand
array of strings
brand
string

Search is based on the following fields : brand, product id, product sku, product external id, product name, product description, variant name, variant sku, variant description, variant ean, variant mpn, variant external id, attribute values, custom field values

productTags
array of strings
productTags
string
required
string
enum
Allowed:
string
string
string

Suppliers external ids

string
string

Indicates whether query search facets should be included in the response. Default to true.

string
string
string

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Format: property:direction (recommended) or property,direction (kept for backward compatibility).

number
number
integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 20

The size of the page to be returned

Headers
string
enum
required

Specifies the client type making the request.

  • OPERATOR: Platform operator user.

  • ACCOUNT: Customer account user.

  • SUPPLIER: Supplier managing orders.

Allowed:
string
required

API key required for authentication. Must be valid and linked to the requesting user.

string

(Optional) Store ID in multi-store environments.

string

(Optional) Store view ID in multi-store environments.

string

(Optional) Customer account ID in multi-account customer user.

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json