Skip to main content
GET
List orders with selected fields

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.

fields
enum<string>[]

Fields to include in each order. Unknown values are ignored; omit to receive all allowed fields.

Available options:
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,
estimated_time_arrival,
delivered_at,
updated_at,
is_click_and_collect,
click_and_collect_metadata,
channel_shipping_line_code,
warehouse_timezone,
shipping_method,
is_multi_package,
delivery_tracking,
is_first_time_buyer,
is_subscription_renewal
status
enum<string>[]

Only return orders in these statuses. Values outside the enum return 422.

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. Values outside the enum return 422.

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
shipping_email
string

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

normalized_shipping_phone_suffix
string

Match orders whose buyer phone ends with these digits. Non-digits are stripped; at least 3 digits must remain.

Minimum string length: 3
sort_by
enum<string>

Field to sort by.

Available options:
id,
order_date,
channel_created_at,
shipping_date,
updated_at
sort
enum<string>

Sort direction. Defaults to descending when sort_by is given.

Available options:
asc,
desc
page
integer
default:1

Page number, starting at 1.

Required range: x >= 1
per_page
integer
default:10

Orders per page.

Required range: 1 <= x <= 100

Response

Orders with only the requested fields, plus pagination metadata.

orders
object[]
required

Orders on this page, each limited to the requested fields.

meta
object
required

Paging information returned next to list results.