An Order represents an order for your Liftoff account.
Properties
Name | Type | Description |
|---|---|---|
Id | int | The ID of the order. If you have configured custom order numbers for your Liftoff account, the Id value will be distinct from the OrderNumber. |
AccountId | int | The ID of the Liftoff account that the order belongs to. (Note: This account ID will always correspond to the account code you use in your authentication credentials.) |
Account (via $expand) | The Liftoff account that the order belongs to. | |
CustomerId | int | The ID of the customer who placed the order. |
Customer (via $expand) | The customer who placed the order. | |
CreateDate | datetimeoffset | The date/time the order was begun. |
LastModifiedDate | datetimeoffset | The date/time the order was most recently modified. |
SubmissionDate | datetimeoffset | The date/time the order was submitted. |
InProcessDate | datetimeoffset | The date/time the order was placed in process. Will differ from SubmissionDate only for orders that require post-submission approval before being placed in process. |
StatusDate | datetimeoffset | The date/time the order's current Status was set. |
Status | OrderStatus | The status of the order. Valid values are CustomerDraft, Saved, Pending, Declined, InProcess, PartiallyShipped, Shipped, Canceled, and Deleted. |
OrderNumber | string | The order number of the order that is displayed in My Liftoff and on your Liftoff account's site. |
CartTotal | decimal(18,2) | The total of all items in the order, in USD. Does not include shipping, taxes, or discounts. |
ShippingTotal | decimal(18,2) | The total shipping and handling price for the order, in USD. |
TaxTotal | decimal(18,2) | The total taxes for the order, in USD. |
DiscountTotal | decimal(18,2) | The total discount amount for the order, in USD. |
OrderTotal | decimal(18,2) | The total order amount, in USD. Includes all items, shipping, taxes, and discounts. |
DisplayName | string | The customer-assigned display name of the cart. Typically only used for saved orders. |
DiscountId | int | The ID of the discount applied to the order. |
Discount (via $expand) | The discount applied to the order. | |
DiscountCode | string | The discount code applied to the order. |
DiscountDescription | string | The description of the discount applied to the order. |
Billing | The billing address for the order. | |
Items (via $expand) | Item array | The collection of items in the order. |
OrderFields (via $expand) | OrderField array | The collection of order field values for the order. |
Shipments (via $expand) | Shipment array | The collection of shipments for the order. |
BudgetTransactions (via $expand) | BudgetTransaction array | The collection of budget transactions applied to the order. |
PaymentTransactions (via $expand) | PaymentTransaction array | The collection of payment transactions issued for the order. |