Skip to main content
GET
List Orders

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:100

How many results to return at a time. Defaults to 100.

offset
integer
default:0

How many results to skip. Used for pagination. Defaults to 0.

order_by
enum<string>
default:created_on

Column to sort orders by. Defaults to created_on.

Available options:
created_on,
ordered_on,
total,
merchant_legal_dba
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
payment_status
enum<string>[]

Filter by payment status.

Available options:
paid,
unpaid
fulfillment_status
enum<string>[]

Filter by fulfillment status.

Available options:
partial,
fulfilled,
unfulfilled
order_type
enum<string>[]

Filter by order type.

Available options:
invoice,
memo
has_unfulfilled_line_item
boolean

Filter to orders that have at least one unfulfilled line item.

debug
boolean[]

Filter by debug mode flag on orders.

Response

200 - application/json

OK

orders
object[]
total
integer
offset
integer
limit
integer