Retrieve an order by order number
Retrieve an order by order number.
Authorizations:Token, JWT
Query Parameters
orderNumber required | string |
Responses
200Order resource
Response schema:
Order resource used_coupons | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||
recovered | integer>= 0 | ||||||||||||||||||||||||||||||||||||||||||||||
cart_reminders_sent | integer>= 0 | ||||||||||||||||||||||||||||||||||||||||||||||
cart_reminder_date | string or null | ||||||||||||||||||||||||||||||||||||||||||||||
cart_reminder_emails | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||
cart_recovery_email | object or null | ||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
lost | integer>= 0 | ||||||||||||||||||||||||||||||||||||||||||||||
last_visit_date | string or null | ||||||||||||||||||||||||||||||||||||||||||||||
gross_profit | number | ||||||||||||||||||||||||||||||||||||||||||||||
parent_id | integer or null | ||||||||||||||||||||||||||||||||||||||||||||||
order_number | string[1 .. 255] characters | ||||||||||||||||||||||||||||||||||||||||||||||
mobile_order | boolean | ||||||||||||||||||||||||||||||||||||||||||||||
mailchimp_store_id | string | ||||||||||||||||||||||||||||||||||||||||||||||
selected_multi_currency | string or null | ||||||||||||||||||||||||||||||||||||||||||||||
selected_multi_currency_rate | number | ||||||||||||||||||||||||||||||||||||||||||||||
id | integer>= 0 | ||||||||||||||||||||||||||||||||||||||||||||||
total | number | ||||||||||||||||||||||||||||||||||||||||||||||
sub_total | number | ||||||||||||||||||||||||||||||||||||||||||||||
string | |||||||||||||||||||||||||||||||||||||||||||||||
items | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||
billing_address | object or null | ||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
shipping_address | object or null | ||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
create_date | string | ||||||||||||||||||||||||||||||||||||||||||||||
update_date | string | ||||||||||||||||||||||||||||||||||||||||||||||
payment_status | object or null | ||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
shipping_status | object or null | ||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
customer_id | integer or null>= 0 | ||||||||||||||||||||||||||||||||||||||||||||||
order_profile_id | integer or null>= 0 | ||||||||||||||||||||||||||||||||||||||||||||||
shipping_id | integer or null>= 0 | ||||||||||||||||||||||||||||||||||||||||||||||
shipping_method_name | string or null | ||||||||||||||||||||||||||||||||||||||||||||||
notes | string | ||||||||||||||||||||||||||||||||||||||||||||||
admin_notes | string | ||||||||||||||||||||||||||||||||||||||||||||||
currency | string | ||||||||||||||||||||||||||||||||||||||||||||||
stock_status | string | ||||||||||||||||||||||||||||||||||||||||||||||
surcharges | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||
tracking_numbers | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||
Array
|
401Unauthorized
Response schema:
Unauthorized type | string |
title | string |
detail | string or null |
instance | string or null |
404Resource not found
Response schema:
Resource not found type | string |
title | string |
detail | string or null |
instance | string or null |
500Internal error
Response schema:
Internal error type | string |
title | string |
detail | string or null |
instance | string or null |