v1

latestOpenAPI 3.1.02026-07-14110151.9 KB

/orders

Search and filter orders account-wide

get/api/orders

Query parameters

pageinteger

The page to return in the paginated result set

per_pageinteger

The number of result to include per pagein the paginated result set. The maximum number of results returned per page is 200.

last_updated_atstring date

Filters the results by the orders' last updated at timestamp and only returns results with a timestamp newer than or equal to the specified value. The maximum time this value can be set to is 3 months ago. Note that "1 week ago" is the default, but cannot be used literally - you must specify a timestamp, for example: last_updated_at=2017-05-24T19:38:25.000-00:00

statusstring[]

Filters the results by the orders' ShippingEasy order status. Possible values are "shipped", "cleared", "pending_shipment", and "ready_for_shipment". It is possible to pass an array of statuses, e.g. ["shipped", "ready_for_shipment"]

includesstring

Adds information to the response. Specifying includes=products will deliver additional information (if available) about each product in the order.

order_numberstring

The external_order_identifier to search for

tagsstring[]

Filters the results by tags that have been applied to the order. Specifying one or more tags limits the results to only orders that have at least one of the specified tags.

Response

200