Skip to main content
GET
List Order Analytics

Authorizations

Authorization
string
header
required

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

Query Parameters

start_date__gte
string<date> | null

Start date (YYYY-MM-DD). Defaults to 4 weeks ago

end_date__lte
string<date> | null

End date (YYYY-MM-DD). Defaults to today

last_modified__gte
string<date> | null

Orders modified on or after a date (YYYY-MM-DD). Modifications include order status updates and refunds

sort_by
enum<string> | null

Parameter to sort results by

Available options:
ORDER_PLACED_TIME_ASC,
ORDER_PLACED_TIME_DESC,
ORDER_PLACED_TIME_ASC_V2,
ORDER_PLACED_TIME_DESC_V2,
MODIFIED_ASC,
MODIFIED_DESC
order_statuses
enum<string>[] | null

List of Order Status values to filter by

Available options:
APPROVAL_NEEDED,
APPROVED,
CANCELED,
PAYMENT_FAILED,
SENT_TO_VENDOR,
SHIPPED,
COMPLETED,
TRIAGED
order_item_statuses
enum<string>[] | null

List of Order Item Status values to filter by

Available options:
APPROVAL_NEEDED,
APPROVED,
CLINIC_CANCELED,
CLIENT_CANCELED,
CLINIC_CANCELED_REFUNDED,
CLINIC_CANCELED_CREDITED,
FAILED_SEND_TO_VENDOR,
SENT_TO_VENDOR,
TRIAGED,
VENDOR_CANCELED,
FULLY_SHIPPED,
PARTIALLY_SHIPPED,
DELIVERED
ids
integer[] | null

When provided, filters to objects with these IDs.

starting_after
integer | null

A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as ending_before.

limit
integer
default:10

The maximum number of items to return per page.

Required range: 1 <= x <= 100

Response

200 - application/json

OK

data
Order · object[]
required

A single page of data contained within this list.

next_page
string
required

A URL linking to the next page of this list.

has_more
boolean
default:false

Whether there are more pages or data in this list.

type
string
default:list

Type of this object. Always list.