Sign in

v2

latestOpenAPI 3.1.02026-08-05245967.6 KB
Product Listing
V2

Product Listing Endpoint V2

post/v2/product-listing

Request body

cursorstring nullable

Used for cursor-based pagination. Set it to the cursor from the last response. If not set, will return the first results.

limitinteger nullable

Used for cursor-based pagination. Maximum number of results per response.

pageinteger nullable

Page-based pagination. We recommend using cursor-based pagination instead.

hits_per_pageinteger nullable

Page-based pagination. We recommend using cursor-based pagination instead.

marketstring required
session_idstring nullable

Session identifier

metadataobject nullable

Metadata that can be used to modify the behaviour of the search.

tenantstring required
localestring nullable

The locale to use for the search. If not set, the default locale will be used.

user_idstring nullable

User identifier

dsidstring nullable

Populated for integrations performed by Depict.ai only. Depict.ai Session Id

query_idstring required

ID of the page to get products for. This is typically the slug, for example hoodies-and-sweaters.

show_hidden_productsboolean

Disables rules to hide products.

return_grouping_idsboolean

Whether to return grouping IDs or not.

type'category' | 'collection' | 'scollection'

Response

Successful Response

displaysobject[] required

The products to be shown on the product listing page.

n_hitsinteger required

Total number of results for this query. Not necessarily exact.

product_listing_request_idstring required
cursorstring nullable

Cursor that can be used in the next request to get subsequent results when using cursor based pagination. If this is not set, there are no more results.

pageinteger nullable

Deprecated, do not use.

grouping_idsobject nullable

Maps product ID to grouping ID. Only returned if return_grouping_ids is True.