Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

Token returned by POST /auth/token, sent as Authorization: Bearer <token>.

Query Parameters

store_id
integer
required

ID of the store whose orders you want to list.

status
enum<string>[]

Only return orders in these statuses. processing implicitly includes picking and packing.

Fulfillment status of an order. processing, picking and packing all mean the order is being prepared in the warehouse. holded means the order is on hold. packed is unused.

Available options:
initial,
unpaid,
empty,
pending,
error,
cancelation_window,
entirely_dropshipping,
backorder,
processing,
picking,
packing,
packed,
shipped,
canceled,
holded,
interrupted,
returned,
return_arrived,
returning,
reentered,
awaiting_fulfillment_request,
awaiting_dropoff,
arrived_at_warehouse
order_type
enum<string>[]

Only return orders of these types.

Kind of order. SALE is a regular sale; DONATION ships goods without a sale; REMOVE_STOCK, REMOVE_DAMAGED_STOCK, REMOVE_EXPIRED_STOCK and REMOVE_LOST_STOCK withdraw stock from the warehouse; STOCK_TRANSFER_OUT moves stock to another store; C2C is a consumer-to-consumer shipment created by Cubbo and cannot be created through the API.

Available options:
SALE,
DONATION,
REMOVE_STOCK,
REMOVE_DAMAGED_STOCK,
REMOVE_EXPIRED_STOCK,
REMOVE_LOST_STOCK,
STOCK_TRANSFER_OUT,
C2C
order_number

Exact order number, or an array of order numbers. Enables unit_code exposure on stock units.

shipping_email
string

Case-insensitive partial match on the buyer's shipping email.

shipping_date[from]
string<date-time>

Lower bound of the shipping date range. Required when shipping_date[to] is sent.

shipping_date[to]
string<date-time>

Upper bound of the shipping date range. Required when shipping_date[from] is sent.

channel_created_at[from]
string<date-time>

Lower bound of the range on the date the order was created in the sales channel. Required when channel_created_at[to] is sent.

channel_created_at[to]
string<date-time>

Upper bound of the range on the date the order was created in the sales channel. Required when channel_created_at[from] is sent.

sort_by
string

Field to sort by. Any order field, or shipping_methods.<field> / stores.<field>. Unknown fields return 422.

sort
enum<string>
default:desc

Sort direction. Any value other than asc sorts descending.

Available options:
asc,
desc
page
integer
default:1

Page number, starting at 1.

per_page
integer
default:10

Orders per page. Values above 100 are capped at 100.

Required range: x <= 100
include_event_history
boolean
default:false

When true, each order includes order_histories with its status and tracking events.

Response

Orders matching the filters, with pagination metadata.

orders
object[]
required

Orders on this page. Each item is an Order limited to: id, store_id, order_number, status, channel_created_at, order_date, shipping_date, pending_at, shipping_email, shipping_status, is_paid, channel_order_id, channel_name, is_cod, cod_amount, has_carrier_insurance, requires_document_return, requires_pickup_on_delivery, currency, total_price, shipping, billing, delivery_tracking, return_shipping_labels, estimated_time_arrival, delivered_at, updated_at, is_click_and_collect, click_and_collect_metadata, latest_estimated_time_arrival_range, channel_shipping_line_code, warehouse_timezone, is_first_time_buyer, is_subscription_renewal, is_multi_package, is_b2b (mixed B2B/D2C stores only), plus the associations shipping_method (id, carrier_name, shipping_name, is_cod), order_lines (id, name, sku, quantity, generated, price_per_item, product, stock_units), invoices, store (id, name), channel_integration (id, channel_type_name), return, created_by_return and, when include_event_history=true, order_histories (new_status, incident_description, timestamp, origin).

meta
object
required

Paging information returned next to list results.