Sign in

v3

latestOpenAPI 3.1.02026-08-0619186200.1 KB
Orders

Retrieve List of Orders

When no filters are specified, the endpoint will return up to the first 1,000,000 orders, based on selected ordering. If filters are used, this endpoint will return a maximum of 10,000 orders.

get/v1/integrations/orders-list

Query parameters

pageinteger

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

pageSizeinteger

Number of results per page. Defaults to a server-configured value; check the response metadata for the effective size.

sortOrder'DESC' | 'ASC'

Sort direction by internal order id: DESC (newest first) or ASC (oldest first).

orderKeysstring[] nullable

Filter to orders whose order_key matches any value in this list.

orderNumbersstring[] nullable

Filter to orders whose order_number matches any value in this list.

orderStatus'unfulfilled' | 'fulfilled' | 'onHold' | 'cancelled'

Filter by current order status (see PublicApiOrderStatus enum); omit to return all statuses.

orderType'direct_to_consumer' | 'retail' | 'amazon' | 'transfer' | 'internal_warehouse_transfer' | 'removal_liquidation' | 'disposal' | 'bonded_inventory_clearance' | 'work_order'

Filter by order type (see OrderType enum); omit to return all types.

updatedAtStartstring date-time

Lower bound (inclusive) on updated_at as an ISO 8601 timestamp; returns orders updated at or after this time.

updatedAtEndstring date-time

Upper bound (inclusive) on updated_at as an ISO 8601 timestamp; returns orders updated at or before this time.

shippedAtStartstring date-time

Lower bound (inclusive) on shipped_at as an ISO 8601 timestamp; returns orders shipped at or after this time.

shippedAtEndstring date-time

Upper bound (inclusive) on shipped_at as an ISO 8601 timestamp; returns orders shipped at or before this time.

Response

Success

statusinteger required