Search orders

get

https://api.vrio.app/orders

Search for specific order details or get all existing order details. Expand on the information returned by including 'with' in the query parameters to include additional details of the orders.

Query Params

order_id

string

Search for specific order ID(s). Comma separate for multiple.

customer_id

integer

Return orders that are tied to a specific customer ID.

customer_email

string

Return orders that are associated to a customer with a specific email.

customer_phone

string

Return orders that are associated to a customer with a specific phone number.

date_created_from

date-time

Return only orders that were created on or after this date. A date to and from field is required when not passing order ID(s), a customer ID, or a customer email.

date_created_to

date-time

Return only orders that were created on or before this date. Required when passing date_created_from. Maximum date range: 31 days.

date_ordered_from

date-time

Return only orders that were completed on or after this date. A date to and from field is required when not passing order ID(s), a customer ID, or a customer email.

date_ordered_to

date-time

Return only orders that were completed on or before this date. Required when passing date_ordered_from. Maximum date range: 31 days.

date_modified_from

date-time

Return only orders that were modified on or after this date. A date to and from field is required when not passing order ID(s), a customer ID, or a customer email.

date_modified_to

date-time

Return only orders that were modified on or before this date. Required when passing date_modified_from. Maximum date range: 31 days.

campaign_id

integer

Orders for specific campaign IDs.

offer_id

integer

Offer IDs that would be associated with order offers.

status_type_id

integer | null

enum

Limit orders that have order offers with a particular status.

tracking1-20

string

Custom Tracking Variable Options 1-20 that would be on an order.

with

string

enum

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=customer,order_offers)

limit

integer

Limit the number of results. Default: 100, max: 200.

offset

integer

Offset the results

sort_by

string

Field to sort result by

order

string

enum

Order by asc or desc

Allowed:

Responses

200OK

401Unauthorized response

403Forbidden response

500Error response