Orders

Get orders

GET /v2/orders?limit=10&offset=0 Bearer token

Lists orders on your account, most recently placed first. Standard pagination applies: limit, offset, order_by and order. The response carries a count of the full result set.

A channel key only sees the orders on its own channel, except when it fetches one order by id: that only checks the order is on your account.

Parameters

Name Type Notes
id integer Fetch one order.
channel_order_number string Filter on your own order number.
limit integer Page size. Defaults to 100, capped at 100.
offset integer Rows to skip. Use with limit to page.
start_date timestamp Filters on the date the order was placed.
end_date timestamp Filters on the date the order was placed.
order string asc or desc. Ignored unless you also send order_by.
order_by string Field to sort on. Leave it out for the default, date_placed_on_channel descending. Sent without order, it sorts ascending.
payment_status array of string unpaid, pending, authorized, partially-paid, paid, partially-refunded, refunded, voided.
status array of string new, processing, completed, cancelled. A new order's status comes back empty, and new matches it.
fulfillment_status array of string fulfilled, unfulfilled, partially-fulfilled.
tracking_reference string The tracking reference of a shipment fulfilling the order.
has_delivery_address boolean true returns only orders with a delivery address, false only orders without one.
delivery_address_zone array of string Filter on the province code of the delivery address, e.g. ["GP","WC"]. A province name such as Gauteng matches nothing. See addresses.
archived boolean true returns only archived orders, false only orders that are not archived. Leave it out to get both.
include_items boolean The order's line items, in order_items. Defaults to true.
include_relations boolean The delivery address, channel, tags and the users who created or archived the order. Defaults to true.
include_fulfillments boolean The fulfilments, with their tracking references. Defaults to false.

Array filters are sent as a JSON array in the query string, with no spaces, e.g. ?fulfillment_status=["unfulfilled","partially-fulfilled"]. With a space after the comma the filter matches nothing.

Response

One order, trimmed to the fields most integrations read:

See the example response.

Items and relations are on unless you turn them off, so on a large page ask only for what you use.

View as Markdown