Skip to main content

Retrieve an order by order number

Retrieve an order by order number.

Authorizations:Token
Query Parameters
orderNumber
required
string

Responses

200Order resource
Response schema:
Order resource
used_couponsArray of objects
Array
idinteger
codestring[1 .. 16] characters
valuenumber
typestring1 character
coupon_idinteger
usps_shipmentsArray of objects
Array
idinteger
transaction_idstring
request_dataArray of strings
response_dataArray of strings
print_datestring
pricenumber
shipment_idstring<= 32 characters
tracking_numberstring<= 32 characters
tracking_dataArray of strings
label_urlstring
label_contentArray of strings
recoveredinteger
cart_reminders_sentinteger
cart_reminder_datestring or null
cart_reminder_emailsArray of objects
Array
idinteger
date_sentstring
date_clickedstring
date_placedstring
date_paidstring
reminder_idinteger
cart_recovery_emailobject or null
  • object
idinteger
date_sentstring or null
date_clickedstring or null
date_placedstring or null
date_paidstring or null
reminder_idinteger
lostinteger
last_visit_datestring or null
gross_profitnumber
survey_future_send_datestring
surveyobject or null
  • object
idinteger
ratinginteger or null
statusstring1 character
email_datestring or null
init_datestring
feedback_datestring or null
feedback_processed_datestring or null
commentsstring
customer_messagestring
manager_profile_idinteger or null
customer_profile_idinteger or null
answersArray of objects
Array
idinteger
valueinteger
origin_questionstring
tagsArray of objects
Array
idinteger
namestring
hash_keystring64 characters
filledboolean
mobile_orderboolean
mailchimp_store_idstring
selected_multi_currencystring or null
selected_multi_currency_ratenumber
idinteger
order_numberstring[1 .. 255] characters
totalnumber
sub_totalnumber
emailstring
itemsArray of objects
Array
idinteger
product_idinteger
skustring
update_datestring
namestring
pricenumber
item_net_pricenumber
discounted_subtotalnumber
amountinteger
backordered_amountinteger
surchargesArray of objects
Array
idinteger
typestring[1 .. 8] characters
codestring[1 .. 128] characters
classstring[1 .. 255] characters
includeboolean
availablebooleanDefault: true
valuenumber
namestring[1 .. 255] characters
weightinteger
billing_addressobject
idinteger
is_billingboolean
is_shippingboolean
is_workboolean
typestring
titlestring
firstnamestring
lastnamestring
phonestring
streetstring
zipcodestring<= 32 characters
citystring
country_codestring2 characters
stateinteger or null
state_namestring
custom_fieldsArray of objects
Array
namestring
valuestring
shipping_addressobject
idinteger
is_billingboolean
is_shippingboolean
is_workboolean
typestring
titlestring
firstnamestring
lastnamestring
phonestring
streetstring
zipcodestring<= 32 characters
citystring
country_codestring2 characters
stateinteger or null
state_namestring
custom_fieldsArray of objects
Array
namestring
valuestring
create_datestring
update_datestring
payment_status
required
object
idinteger
codestring[1 .. 4] characters
namestring[1 .. 255] characters
customer_namestring[1 .. 255] characters
shipping_status
required
object
idinteger
codestring[1 .. 4] characters
namestring[1 .. 255] characters
customer_namestring[1 .. 255] characters
customer_idinteger
order_profile_idinteger
shipping_idinteger or null
shipping_method_namestring
notesstring
admin_notesstring
currencystring
stock_statusstring
surchargesArray of objects
Array
idinteger
typestring[1 .. 8] characters
codestring[1 .. 128] characters
classstring[1 .. 255] characters
includeboolean
availablebooleanDefault: true
valuenumber
namestring[1 .. 255] characters
weightinteger
tracking_numbersArray of objects
Array
idinteger
datestring
valuestring
404Resource not found