Get Products
Query Parameters
Body
Used for cursor-based pagination. Set it to the cursor from the last response. If not set, will return the first results.
Used for cursor-based pagination. Maximum number of results per response.
List of filters to apply to the results.
Specifies the sorting method. By default, the results are ordered by relevance. To find the possible values for this field, query the endpoint and look at the sorts field.
Session identifier
Metadata that can be used to modify the behaviour of the search.
The locale to use for the search. If not set, the default locale will be used.
User identifier
Populated for integrations performed by Depict.ai only. Depict.ai Session Id
ID of the page to get products for. This is typically the slug, for example hoodies-and-sweaters.
The type of query. If not set the endpoint will look up query id in the following type order: collections, categories.
category, collection, scollection Response
The products to be shown on the product listing page.
Total number of results for this query. Not necessarily exact.
Available methods for sorting the response. Any element from this list can be sent as sort in subsequent requests.
Available filters that can be used for filtering in the subsequent request.
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.
Breadcrumb for the current page. Ordered from less to more specific, where the last element is the current page.
List of pages that can be used as quick links. Will return child pages if they exist, otherwise sibling pages.
Metadata about the PLP requested, for example Collection/Category title, description, etc.
Was this page helpful?