Skip to main content
GET
List the company's orders

Authorizations

Authorization
string
header
required

Bearer token authentication. Accepts company tokens, partner tokens, public tokens, droplet installation tokens, and user_company tokens. The authenticated credential determines editor_type and editor_id on the resulting order-edit audit records — the payload never carries either field.

Query Parameters

Free-text search. Matches substrings, so a partial value finds the row — pasting 4821 finds order number F148217.

Searches, in one pass:

  • the order's order_number, email, first_name, last_name, phone and external_id
  • the buyer's full name and the owning member's full name and email
  • the order's numeric id, its number sequence, and the customer's legacy id

Every term must match, and all of them must match within a single one of those fields. Full names are indexed joined for exactly this reason, so jane smith finds an order whose first and last name columns hold one word each.

A cart token instead finds the orders placed from that cart, an exact match. A token that matches no order of the company is searched as free text.

sort
enum<string>

Sort key. A leading - reverses the direction. Defaults to -sale_date (newest first by effective sale date, which is the order's sale_date falling back to created_at).

Available options:
sale_date,
-sale_date,
created_at,
-created_at,
id,
-id,
order_status,
-order_status,
status,
-status,
customer_name,
-customer_name,
customer,
-customer,
amount,
-amount
page[cursor]
string

Opaque cursor from a previous response's meta.pagination.next_cursor or prev_cursor. Omit for the first page. A malformed cursor returns 422. Start again from the first page whenever search or sort changes; a cursor from the other source, or a database cursor sent with a different sort, returns 422.

page[limit]
integer

Page size. Defaults to 25, capped at 100.

Required range: 1 <= x <= 100
filter[status]
enum<string>

Restrict to one order status. The sentinel all imposes no constraint and is equivalent to omitting the filter.

Available options:
all,
draft,
pending,
pending_review,
processing,
completed,
cancelled,
archived
filter[type]
enum<string>

Restrict to one order class.

Available options:
sample_order,
customer_order,
member_order,
enrollment_order,
autoship_order
filter[order_number]
string

Exact match on the human-facing order number.

filter[cart_source]
string

Restrict to orders whose originating cart carried this source value.

filter[cart_token]
string

Restrict to orders placed from the cart with this exact token. A token that matches no cart of the company returns no orders.

filter[customer_id]
integer

Restrict to one customer's orders, matched on either the owning member or a legacy customer id carried on order metadata.

filter[user_company_id]
integer

Restrict to orders a given rep holds volume credit on, addressed by legacy UserCompany id.

filter[subscription_id]
integer

Restrict to orders belonging to one subscription.

filter[country_isos]
string

Comma-separated ISO-2 country codes; matches the order's own country, not the shipping address.

filter[start_date]
string<date>

Inclusive lower bound on the effective sale date, as a calendar date resolved through filter[timezone].

filter[end_date]
string<date>

Inclusive upper bound on the effective sale date, as a calendar date resolved through filter[timezone].

filter[timezone]
string

IANA timezone used to resolve filter[start_date] and filter[end_date] to day boundaries, so a day means the caller's day. Defaults to UTC; Etc/Unknown is treated as absent. An unrecognised zone returns 422.

Response

A page of orders, newest first unless sort says otherwise.

A page of orders. meta carries pagination only — this surface publishes no stats block; see GET /api/v202506/orders/stats.

orders
object[]
required

The orders on this page, in the requested sort order.

status
integer
required

HTTP status code, repeated in the body (200 on success).

meta
object
required

Response metadata — request correlation fields plus cursor pagination.