Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

Orders

The available fields in Orders and their corresponding descriptions are listed below.

The available fields in Orders and their corresponding descriptions are listed below.

FieldDescription
Order IDUnique identifier of an order.
Document NumberSerial number of an order.
StatusCurrent status of an order.
Reason CodeReason for an order cancellation.
Payment StatusIndicates if the payment for an order is in a Paid or Not Paid status.
Order TypeIndicates if an order type is Manual or System generated.
Price TypeIndicates if the price of an order is Inclusive or Exclusive of tax.
Reference IDAn ID used to refer to an order in a third-party application.
Fulfillment StatusStatus of an order in a third-party application.
NoteCustom note added for an order.
Tracking IDAn ID that is used to track the status of an order.
Batch IDAn ID that is used to identify a group of orders.
Created ByThe source of order creation.
Shipment CarrierDetails of the Shipment Carrier.
CurrencyCurrency code of an invoice in ISO 4217 format.
Invoice Round Off AmountTotal round off amount of an order's invoice.
Tax AmountTotal tax amount of an order.
Amount PaidTotal amount paid for an order.
Amount AdjustedTotal amount adjusted for an order.
Refundable Credits IssuedTotal amount of refundable credits issued for an order.
Refundable CreditsTotal amount of credits refundable for an order.
Rounding AdjustmentProvides information on the adjustment. If the value is $13.23 and they round off the final price to 13, then the adjustment here is -23 cents.
Order DateThe date when the order was placed.
Shipping DateThis is the date on which the order is/has to be shipped.
Paid OnDate and time of invoice payment for an order.
Shipping Cut Off DateThe time after which an order becomes unserviceable. need info
Created OnDate and time when the order was created.
Last Status Update AtDate and time of the last order update.
Delivered OnDate and time of order delivery.
Shipping OnDate and time of order shipment.
Canceled OnDate and time when the order was cancelled.
Discount AmountTotal amount of discount provided for an order.
Sub TotalSub total amount of an order.
TotalTotal amount charged for an order.
Total (Transaction Currency)Total amount charged in transaction currency for an order.
Is GiftedIndicates if the order is a gift or not.
Shipping First NameFirst Name of the contact person to which the order is shipped.
Shipping Last NameLast Name of the contact person to which the order is shipped.
Shipping Address Line 1This is the line 1 of the Address to which the order is shi pped.
Shipping Address Line 2This is the line 2 of the Address to which the order is shipped.
Shipping CityThis is the city to which the order is/has to be shipped.
Shipping State CodeThis is the state code of the state to which the order is to be shipped.
Shipping StateThis is the state to which the order is to be shipped.
Shipping Zip CodeThis is the Zip code to which the order is to be shipped.
Shipping CountryThis is the Country to which the order is to be shipped.
Shipping Address Validation StatusThis is the status of validation of the address to which the order is to be shipped.

Was this article helpful?