Retrieve a list of orders

Retrieve a list of orders.

Authorizations:Token, JWT

Query Parameters

page	integerDefault: 1The collection page number
date[before]	string
date[strictly_before]	string
date[after]	string
date[strictly_after]	string
order[date]	stringEnum: "asc""desc"
order[lastRenewDate]	stringEnum: "asc""desc"
paymentStatus.code	string
paymentStatus.code[]	Array of strings
shippingStatus.code	string
shippingStatus.code[]	Array of strings
profile.login	string
vendor.profile_id	integer
vendor.profile_id[]	Array of integers
children.vendor.profile_id	integer
children.vendor.profile_id[]	Array of integers
exists[vendor]	boolean
exists[children.vendor]	boolean

Responses

200Order collection

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Order collection

Array

used_coupons	Array of objects
Array id integer>= 0 code string[1 .. 16] characters value number type string1 character coupon_id integer>= 0
recovered	integer>= 0
cart_reminders_sent	integer>= 0
cart_reminder_date	string
cart_reminder_emails	Array of objects
Array id integer>= 0 date_sent string date_clicked string date_placed string date_paid string reminder_id integer>= 0
cart_recovery_email	object or null
object id integer>= 0 date_sent string or null date_clicked string or null date_placed string or null date_paid string or null reminder_id integer>= 0
lost	integer>= 0
last_visit_date	string
gross_profit	number
parent_id	integer
order_number	string[1 .. 255] characters
mobile_order	boolean
mailchimp_store_id	string
selected_multi_currency	string
selected_multi_currency_rate	number
id	integer>= 0
total	number
sub_total	number
email	string
items	Array of objects
Array vendor_id integer variant integer id integer>= 0 product_id integer>= 0 sku string update_date string name string price number item_net_price number discounted_subtotal number amount integer backordered_amount integer surcharges Array of objects Array id integer>= 0 type string[1 .. 8] characters code string[1 .. 128] characters class string[1 .. 255] characters include boolean available booleanDefault: true value number name string[1 .. 255] characters weight integer
billing_address	object or null
object id integer>= 0 is_billing boolean is_shipping boolean is_work boolean type string title string firstname string lastname string phone string address1 string address2 string address3 string zipcode string<= 32 characters city string country_code string2 characters state integer or null state_name string custom_fields Array of objects Array name string value string
shipping_address	object or null
object id integer>= 0 is_billing boolean is_shipping boolean is_work boolean type string title string firstname string lastname string phone string address1 string address2 string address3 string zipcode string<= 32 characters city string country_code string2 characters state integer or null state_name string custom_fields Array of objects Array name string value string
create_date	string
update_date	string
payment_status	object or null
object id integer>= 0 code string[1 .. 4] characters name string[1 .. 255] characters customer_name string[1 .. 255] characters
shipping_status	object or null
object id integer>= 0 code string[1 .. 4] characters name string[1 .. 255] characters customer_name string[1 .. 255] characters
customer_id	integer>= 0
order_profile_id	integer>= 0
shipping_id	integer>= 0
shipping_method_name	string
notes	string
admin_notes	string
currency	string
stock_status	string
surcharges	Array of objects
Array id integer>= 0 type string[1 .. 8] characters code string[1 .. 128] characters class string[1 .. 255] characters include boolean available booleanDefault: true value number name string[1 .. 255] characters weight integer
tracking_numbers	Array of objects
Array id integer>= 0 date string value string

401Unauthorized

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Unauthorized

type	string
title	string
detail	string or null
instance	string or null

500Internal error

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Internal error

type	string
title	string
detail	string or null
instance	string or null