Retrieve order by id
Retrieve order by id
Authorizations:Token
Query Parameters
id required | integerId value of the Order object |
Responses
200Success
Response schema:
Success uspsShipment | ArrayUSPS Shipments | ||||||||||||||
capostParcels | ArrayCanada Post parcels (reference to the Canada Post parcels model) | ||||||||||||||
capostReturns | ArrayReference to the Canada Post returns model | ||||||||||||||
capostOffice | |||||||||||||||
mailchimpStoreId | stringMailchimp store id | ||||||||||||||
not_finished_order | |||||||||||||||
demo | booleanFlag, if the product participates in the sale | ||||||||||||||
is_opened_dispute | booleanHas opened disputes flag | ||||||||||||||
conversation | |||||||||||||||
children | ArrayList of carts by vendors | ||||||||||||||
parent | |||||||||||||||
vendor | |||||||||||||||
commission | |||||||||||||||
profileTransactions | ArrayProfile transactions for shop owner | ||||||||||||||
vendorRatings | Array of objects (Vendor ratings for the order)Vendor ratings for the order | ||||||||||||||
Array
| |||||||||||||||
usedCoupons | ArrayUsed coupons | ||||||||||||||
reviewKey | |||||||||||||||
order_id | integerOrder unique id | ||||||||||||||
profile | |||||||||||||||
orig_profile | |||||||||||||||
shipping_id | integerShipping method unique id | ||||||||||||||
shipping_method_name | stringShipping method name | ||||||||||||||
payment_method_name | stringPayment method name | ||||||||||||||
tracking | stringShipping tracking code | ||||||||||||||
date | integerOrder creation timestamp | ||||||||||||||
lastRenewDate | integerLast order renew date | ||||||||||||||
paymentStatus | object | ||||||||||||||
| |||||||||||||||
shippingStatus | object | ||||||||||||||
| |||||||||||||||
notes | stringCustomer notes | ||||||||||||||
adminNotes | stringAdmin notes | ||||||||||||||
details | ArrayOrder details | ||||||||||||||
trackingNumbers | ArrayOrder tracking numbers | ||||||||||||||
events | ArrayOrder events queue | ||||||||||||||
items | ArrayOrder items | ||||||||||||||
surcharges | ArrayOrder surcharges | ||||||||||||||
payment_transactions | ArrayPayment transactions | ||||||||||||||
currency | |||||||||||||||
orderNumber | stringUnique order identificator (it is working for orders only, not for cart entities) | ||||||||||||||
recent | booleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false | ||||||||||||||
xcPendingExport | booleanFlag to exporting entities | ||||||||||||||
backorderCompetitors | ArrayProfiles | ||||||||||||||
total | stringTotal | ||||||||||||||
subtotal | stringSubtotal |