DraftOrders
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | Long | True | A unique numeric identifier for the order. |
CustomerId | Long | False | A unique numeric identifier for the customer. |
Currency | String | False | The three letter code (ISO 4217) for the currency used for the payment. |
String | False | The customer's email address. | |
Name | String | True | The customer's order name as represented by a number. |
TotalPrice | Decimal | True | The sum of all the prices of all the items in the order, taxes and discounts included. |
SubtotalPrice | Decimal | True | Price of the order before shipping and taxes. |
TotalTax | Decimal | False | The sum of all the taxes applied to the order. |
TaxesIncluded | Boolean | False | States whether or not taxes are included in the order subtotal. |
InvoiceSentAt | Datetime | True | This auto-generated property is the date and time when the invoice was emailed to the customer. Only available for draft orders. |
Note | String | False | The text of an optional note that a shop owner can attach to the order. |
Tags | String | False | Additional short descriptors. |
InvoiceUrl | String | True | The URL for the invoice. Only available for draft orders. |
TaxExempt | Boolean | True | States whether or not taxes are exempt for this order. Only available for draft orders. |
Status | String | True | The status of the order. Valid values: open: all open orders (default), invoice_sent: show only closed orders, completed: Show only cancelled orders. |
LineAggregate | String | False | A JSON aggregate of line items associated with the draft order. |
BillingAddressFirstName | String | False | The first name of the person associated with the payment method. |
BillingAddressLastName | String | False | The last name of the person associated with the payment method. |
BillingAddressAddress1 | String | False | The street address of the billing address. |
BillingAddressAddress2 | String | False | An optional additional field for the street address of the billing address. |
BillingAddressPhone | String | False | The phone number at the billing address. |
BillingAddressCity | String | False | The city of the billing address. |
BillingAddressCompany | String | False | The company of the person associated with the billing address. |
BillingAddressZip | String | False | The zip or postal code of the billing address. |
BillingAddressProvince | String | False | The name of the state or province of the billing address. |
BillingAddressCountry | String | False | The name of the country of the billing address. |
BillingAddressLatitude | Double | False | The latitude of the billing address. |
BillingAddressLongitude | Double | False | The longitude of the billing address. |
BillingAddressName | String | False | The full name of the person associated with the payment method. |
BillingAddressCountryCode | String | False | The two-letter code for the country of the billing address. |
BillingAddressProvinceCode | String | False | The two-letter abbreviation of the state or province of the billing address. |
BillingAddressDefault | Boolean | False | Whether this address is the default one or not. |
ShippingAddressFirstName | String | False | The first name of the person associated with the shipping method. |
ShippingAddressLastName | String | False | The last name of the person associated with the shipping method. |
ShippingAddressAddress1 | String | False | The street address of the shipping address. |
ShippingAddressAddress2 | String | False | An optional additional field for the street address of the shipping address. |
ShippingAddressPhone | String | False | The phone number at the shipping address. |
ShippingAddressCity | String | False | The city of the shipping address. |
ShippingAddressCompany | String | False | The company of the person associated with the shipping address. |
ShippingAddressZip | String | False | The zip or postal code of the shipping address. |
ShippingAddressProvince | String | False | The name of the state or province of the shipping address. |
ShippingAddressCountry | String | False | The name of the country of the shipping address. |
ShippingAddressLatitude | Double | False | The latitude of the shipping address. |
ShippingAddressLongitude | Double | False | The longitude of the shipping address. |
ShippingAddressName | String | False | The full name of the person associated with the shipping method. |
ShippingAddressCountryCode | String | False | The two-letter code for the country of the shipping address. |
ShippingAddressProvinceCode | String | False | The two-letter abbreviation of the state or province of the shipping address. |
ShippingAddressDefault | Boolean | False | Whether this address is the default one or not. |
AppliedDiscountTitle | String | False | The title of the applied discount for this order. Only available for draft orders. |
AppliedDiscountDescription | String | False | The description of the applied discount for order. Only available for draft orders. |
AppliedDiscountValue | Decimal | False | The value of the applied discount for this order. Only available for draft orders. |
AppliedDiscountValueType | String | False | The value type of the applied discount for order. Only available for draft orders. |
AppliedDiscountAmount | Decimal | False | The amount of the applied discount for this order. Only available for draft orders. |
CreatedAt | Datetime | True | The date and time when the order was created. |
UpdatedAt | Datetime | True | The date and time when the order was last modified. |
CompletedAt | Datetime | True | The date and time when the order was completed at. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
UseCustomerDefaultAddress | Boolean | Optional boolean that you can send as part of a draft order object to load customer shipping information. Valid values: true or false. |
Last updated