Orders
List Orders
Orders
List Orders
List Orders.
Returns
An object with a metadata field containing pagination information, and an orders field containing a list of order objects.
GET
/
api
/
v2
/
orders
/
list
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
limit
integer
default: 50How many results to return at a time in the "orders" field of the response object. Defaults to 50.
offset
integer
default: 0How many results to skip. Used for pagination. Defaults to 0.
payment_status
enum<string>[]
Payment status filter.
Available options:
paid, unpaid fulfillment_status
enum<string>[]
Available options:
partial, fulfilled, unfulfilled order_type
enum<string>[]
Available options:
invoice, memo sort_col
enum<string>
default: ordered_onSelects a column to sort the orders. Defaults to sorting by the created_on date.
Available options:
ordered_on, total, merchant_legal_dba sort_order
enum<string>
default: ascOrder to sort the column.
Available options:
asc, desc Response
200 - application/json
metadata
object
orders
object[]