v3

latestOpenAPI 3.1.02026-08-0619186200.1 KB

Products

Retrieve List of Products

Results are not guaranteed to be consistent across paginated calls. As inventory is updated during fulfillment, products shift position in the sort order and may reappear on later pages. For consistent pagination, use the Products for Inventory Sync endpoint instead.

get/v1/products

Query parameters

searchstring nullable

Free-text filter matched against product SKU, name, or barcode.

pageinteger

1-based page number to return. Defaults to 1.

pageSizeinteger

Number of products returned per page (default and maximum values are documented at the endpoint level).

sortBystring nullable

Field to sort the results by; one of 'id', 'created_at', or 'updated_at'.

sortOrder'DESC' | 'ASC'

Sort direction for the results: ASC (ascending) or DESC (descending). Defaults to DESC.

status'blacklisted' | 'active' | 'disabled'

Return only products in this status (e.g., active, blacklisted, disabled). See the enum schema for the full list of allowed values.

dateUpdatedStartstring date-time

Return only products updated at or after this ISO 8601 timestamp.

dateUpdatedEndstring date-time

Return only products updated at or before this ISO 8601 timestamp.

dateCreatedStartstring date-time

Return only products created at or after this ISO 8601 timestamp.

dateCreatedEndstring date-time

Return only products created at or before this ISO 8601 timestamp.

Response

Success

totalinteger required

pagesinteger required

pageinteger required