Retrieve a list of orders

Retrieve a list of orders.

Authorizations:Token

Query Parameters

page	integerDefault: 1The collection page number
itemsPerPage	integer>= 0Default: 30The number of items per page
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

Responses

200Order collection

Response schema: application/jsonapplication/ld+jsontext/html

Order collection

Array

order_number	string[1 .. 255] characters
used_coupons	Array of objects
Array id integer code string[1 .. 16] characters value number type string1 character coupon_id integer
usps_shipments	Array of objects
Array id integer transaction_id string request_data Array of strings response_data Array of strings print_date string price number shipment_id string<= 32 characters tracking_number string<= 32 characters tracking_data Array of strings label_url string label_content Array of strings
recovered	integer
cart_reminders_sent	integer
cart_reminder_date	string
cart_reminder_emails	Array of objects
Array id integer date_sent string date_clicked string date_placed string date_paid string reminder_id integer
cart_recovery_email	object or null
object id integer date_sent string or null date_clicked string or null date_placed string or null date_paid string or null reminder_id integer
lost	integer
last_visit_date	string
gross_profit	number
survey_future_send_date	string
survey	object or null
object id integer rating integer or null status string1 character email_date string or null init_date string feedback_date string or null feedback_processed_date string or null comments string customer_message string manager_profile_id integer or null customer_profile_id integer or null answers Array of objects Array id integer value integer origin_question string tags Array of objects Array id integer name string hash_key string64 characters filled boolean
mobile_order	boolean
mailchimp_store_id	string
selected_multi_currency	string
selected_multi_currency_rate	number
id	integer
total	number
sub_total	number
email	string
items	Array of objects
Array id integer product_id integer 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 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 is_billing boolean is_shipping boolean is_work boolean type string title string firstname string lastname string phone string street 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 is_billing boolean is_shipping boolean is_work boolean type string title string firstname string lastname string phone string street 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 code string[1 .. 4] characters name string[1 .. 255] characters customer_name string[1 .. 255] characters
shipping_status	object or null
object id integer code string[1 .. 4] characters name string[1 .. 255] characters customer_name string[1 .. 255] characters
customer_id	integer
order_profile_id	integer
shipping_id	integer
shipping_method_name	string
notes	string
admin_notes	string
currency	string
stock_status	string
surcharges	Array of objects
Array id integer 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 date string value string