Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Orders

Search 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.

get/orders

Query parameters

order_idstring

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

customer_idinteger

Return orders that are tied to a specific customer ID.

customer_emailstring

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

customer_phonestring

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

date_created_fromstring date-time
Example:2023-04-01 00:00:00

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_tostring date-time
Example:2023-04-01 00:00:00

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

date_ordered_fromstring date-time
Example:2023-04-01 00:00:00

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_tostring date-time
Example:2023-04-01 00:00:00

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

date_modified_fromstring date-time
Example:2023-04-01 00:00:00

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_tostring date-time
Example:2023-04-01 00:00:00

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

campaign_idinteger

Orders for specific campaign IDs.

offer_idinteger

Offer IDs that would be associated with order offers.

status_type_idnull | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 nullable
  • 1 - Active
  • 2 - Cancelled
  • 3 - Complete
  • 4 - Partial
  • 5 - Declined
  • 6 - Archive
  • 7 - Rejected
  • 8 - Removed
  • 9 - Paused
  • 10 - Expired

Limit orders that have order offers with a particular status.

tracking1-20string

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

with'order_offers' | 'order_gift_cards' | 'order_revisions' | 'customer' | 'customer_card' | 'customer_address_billing' | 'customer_address_shipping' | 'transactions' | 'shipments' | 'campaign' | 'cart' | 'route_logs'

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

limitinteger

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

offsetinteger

Offset the results

sort_bystring

Field to sort result by

order'asc' | 'desc'

Order by asc or desc

Response

OK

totalinteger