List products

Get products page. Default page response size is 50, max requested page size is 200.

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

The site's unique name (its ID), returned when the site is created.

Query Params
integer
≥ 0
Defaults to 0

Zero-based offset for elements (0..N)

integer
1 to 200
Defaults to 50

The size of the page to be returned

string
string
enum
Defaults to asc

Order direction for property specified in sort

Allowed:

Match products whose name contains the given string, ignore-case, or whose own or variation sku equals it

category_id
array of strings

Return products assigned to any of the given category ids. Given exactly one category and no explicit sort, products keep their order within that category - unless option_id or several customization_id values are also given

category_id
status
array of objects

Return products in any of the given statuses

status
Allowed:
type
array of objects

Return products of any of the given types

type
Allowed:
id
array of strings

Return the products with any of the given ids

id
option_id
array of strings

Return products whose variations use any of the given option ids

option_id
customization_id
array of strings

Return products assigned any of the given customization ids

customization_id
string
length ≥ 1

Return the product whose seo.product_url equals the given slug

string
length ≥ 1

Return the whole product that has a variation with the given external id - note this is the variation's external_id, not the product's own

date-time

Return products whose created_at is at or after the given ISO-8601 timestamp. The offset is required - 2026-01-31T10:15:30Z or 2026-01-31T12:15:30+02:00

date-time

Return products whose created_at is at or before the given ISO-8601 timestamp, offset required

date-time

Return products whose updated_at is at or after the given ISO-8601 timestamp, offset required. The entry point for incremental sync - unlike created_at it also catches edits of products fetched earlier

date-time

Return products whose updated_at is at or before the given ISO-8601 timestamp, offset required

boolean

Return products whose compare_at_price is set (true) or unset (false). Variations carry a price difference rather than their own compare_at_price, so this always refers to the product-level price

boolean

Return products that have (true) or do not have (false) variations

Responses

401

Unauthorized request - missing or invalid credentials

429

Rate limit exceeded - please refer to api documentation for limits

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