DraftOrders
Returns a list of saved draft orders.
Select
The component uses the Shopify API to process WHERE clause conditions built with the following column and operator. The component processes other filters client-side within the component.
- Id supports the '=,IN' comparison operators.
- Status supports the '=,!=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- CustomerId supports the '=,!=' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM DraftOrders
SELECT * FROM DraftOrders WHERE Id = 'Val1'
SELECT * FROM DraftOrders WHERE Status = 'Val1'
SELECT * FROM DraftOrders WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM DraftOrders WHERE UpdatedAt = '2023-01-01 11:10:00'
SELECT * FROM DraftOrders WHERE CustomerId = 'Val1'
Insert
Insert statements are mapped to the 'draftOrderCreate' GraphQL mutation.
The following columns can be used to create a new record:
Email, CustomerId, BillingAddressId, BillingAddressFirstName, BillingAddressLastName, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressProvinceCode, BillingAddressCountryCodeV2, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2, AppliedDiscountTitle, AppliedDiscountDescription, AppliedDiscountValue, AppliedDiscountValueType, AppliedDiscountAmountV2Amount, DraftOrderLineItems
Update
Update statements are mapped to the 'draftOrderUpdate' GraphQL mutation.
The following columns can be updated:
Id, Email, CustomerId, BillingAddressId, BillingAddressFirstName, BillingAddressLastName, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressProvinceCode, BillingAddressCountryCodeV2, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2, AppliedDiscountTitle, AppliedDiscountDescription, AppliedDiscountValue, AppliedDiscountValueType, AppliedDiscountAmountV2Amount, DraftOrderLineItems
Delete
Delete statements are mapped to the 'draftOrderDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
A globally-unique ID. | |
LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
Name | String | True |
The identifier for the draft order, which is unique within the store. For example, _#D1223_. | |
MarketName | String | True |
The name of the selected market. | |
String | False |
Email address of the customer, which is used to send notifications to. | ||
Note2 | String | True |
The text from an optional note attached to the draft order. | |
Phone | String | True |
The phone number assigned to the draft order. | |
Ready | Bool | True |
Whether the Draft Order is ready and can be completed. Draft Orders might have asynchronous operations that can take time to finish. | |
Status | String | True |
Status of the draft order. | |
Tags | String | True |
A comma separated list of tags associated with the draft order. Updating 'tags' overwrites any existing tags that were previously added to the draft order. To add new tags without overwriting existing tags, use the mutation. | |
CompletedAt | Datetime | True |
The date and time when the draft order converted to a new order, and the draft order's status changed to **Completed**. | |
CurrencyCode | String | True |
The three letter code for the currency of the store at the time of the most recent update to the draft order. | |
DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
InvoiceUrl | String | True |
The link to the checkout, which is sent to the customer in the invoice email. | |
SubtotalPrice | Decimal | True |
The subtotal of the line items and their discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes. | |
TaxExempt | Bool | True |
Whether the draft order is tax exempt. | |
TaxesIncluded | Bool | True |
Whether the line item prices include taxes. | |
TotalPrice | Decimal | True |
The total amount of the draft order, including taxes, shipping charges, and discounts. | |
TotalTax | Decimal | True |
The total amount of taxes for the draft order. | |
TotalWeight | String | True |
The total weight in grams of the draft order. | |
HasTimelineComment | Bool | True |
Whether the merchant has added timeline comments to the draft order. | |
InvoiceSentAt | Datetime | True |
The date and time when the invoice was last emailed to the customer. | |
PresentmentCurrencyCode | String | True |
The payment currency of the customer for this draft order. | |
ReserveInventoryUntil | Datetime | True |
The time after which inventory will automatically be restocked. | |
TotalShippingPrice | Decimal | True |
The total shipping charge for the draft order. | |
VisibleToCustomer | Bool | True |
Whether the draft order will be visible to the customer on the self-serve portal. | |
InvoiceEmailTemplateSubject | String | True |
The subject defined for the draft invoice email template. | |
MarketRegionCountryCode | String | True |
The selected market region country code for the draft order. | |
BillingAddressMatchesShippingAddress | Bool | True |
Whether the billing address matches the shipping address. | |
CreatedAt | Datetime | True |
The date and time when the draft order was created in Shopify. | |
UpdatedAt | Datetime | True |
The date and time when the draft order was last changed. The format is YYYY-MM-DD HH: mm: ss. For example, 2016-02-05 17: 04: 01. | |
OrderId | String | True |
A globally-unique ID. | |
PurchasingEntityCustomerId | String | True |
A globally-unique ID. | |
PurchasingEntityCompanyCompanyId | String | True |
A globally-unique ID. | |
CustomerId | String | False |
Customers.Id |
Customer who will be sent an invoice for the draft order, if there is one. |
BillingAddressId | String | False |
A globally-unique ID. | |
BillingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
BillingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
BillingAddressFirstName | String | False |
The first name of the customer. | |
BillingAddressLastName | String | False |
The last name of the customer. | |
BillingAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
BillingAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
BillingAddressCity | String | False |
The name of the city, district, village, or town. | |
BillingAddressCompany | String | False |
The name of the customer's company or organization. | |
BillingAddressCountry | String | False |
The name of the country. | |
BillingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
BillingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
BillingAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
BillingAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
BillingAddressZip | String | False |
The zip or postal code of the address. | |
BillingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
BillingAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
BillingAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
ShippingAddressId | String | False |
A globally-unique ID. | |
ShippingAddressCoordinatesValidated | Bool | True |
Whether the address coordinates are valid. | |
ShippingAddressName | String | True |
The full name of the customer, based on firstName and lastName. | |
ShippingAddressFirstName | String | False |
The first name of the customer. | |
ShippingAddressLastName | String | False |
The last name of the customer. | |
ShippingAddressAddress1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
ShippingAddressAddress2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
ShippingAddressCity | String | False |
The name of the city, district, village, or town. | |
ShippingAddressCompany | String | False |
The name of the customer's company or organization. | |
ShippingAddressCountry | String | False |
The name of the country. | |
ShippingAddressLatitude | Double | True |
The latitude coordinate of the customer address. | |
ShippingAddressLongitude | Double | True |
The longitude coordinate of the customer address. | |
ShippingAddressPhone | String | False |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
ShippingAddressProvince | String | False |
The region of the address, such as the province, state, or district. | |
ShippingAddressZip | String | False |
The zip or postal code of the address. | |
ShippingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
ShippingAddressProvinceCode | String | False |
The two-letter code for the region. For example, ON. | |
ShippingAddressCountryCodeV2 | String | False |
The two-letter code for the country of the address. For example, US. | |
ShippingLineId | String | True |
A globally-unique ID. | |
ShippingLineCarrierIdentifier | String | True |
A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service. | |
ShippingLineTitle | String | True |
Returns the title of the shipping line. | |
ShippingLineCode | String | True |
A reference to the shipping method. | |
ShippingLineCustom | Bool | True |
Whether the shipping line is custom or not. | |
ShippingLinePhone | String | True |
The phone number at the shipping address. | |
ShippingLineSource | String | True |
Returns the rate source for the shipping line. | |
ShippingLineDeliveryCategory | String | True |
The general classification of the delivery method. | |
ShippingLineShippingRateHandle | String | True |
A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users. | |
ShippingLineRequestedFulfillmentServiceId | String | True |
The ID of the fulfillment service. | |
AppliedDiscountTitle | String | False |
Name of the order-level discount. | |
AppliedDiscountDescription | String | False |
Description of the order-level discount. | |
AppliedDiscountValue | Double | False |
Amount of the order level discount (when value_type is percentage, the value in this field is the percentage discount). | |
AppliedDiscountValueType | String | False |
Type of the order-level discount. | |
PaymentTermsId | String | True |
A globally-unique ID. | |
PaymentTermsTranslatedName | String | True |
The payment terms name, translated into the shop admin's preferred language. | |
PaymentTermsPaymentTermsName | String | True |
The name of the payment terms template used to create the payment terms. | |
PaymentTermsOverdue | Bool | True |
Whether the payment terms have overdue payment schedules. | |
PaymentTermsDueInDays | Int | True |
Duration of payment terms in days based on the payment terms template used to create the payment terms. | |
PaymentTermsPaymentTermsType | String | True |
The payment terms template type used to create the payment terms. | |
PaymentTermsOrderId | String | True |
A globally-unique ID. | |
AppliedDiscountAmountV2Amount | Decimal | False |
Decimal money amount. | |
AppliedDiscountAmountV2CurrencyCode | String | True |
Currency of the money. | |
LineItemsSubtotalPricePresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
LineItemsSubtotalPricePresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
LineItemsSubtotalPriceShopMoneyAmount | Decimal | True |
Decimal money amount. | |
LineItemsSubtotalPriceShopMoneyCurrencyCode | String | True |
Currency of the money. | |
SubtotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
SubtotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
SubtotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
SubtotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
TotalDiscountsSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
TotalDiscountsSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
TotalDiscountsSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
TotalDiscountsSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
TotalLineItemsPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
TotalLineItemsPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
TotalLineItemsPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
TotalLineItemsPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
TotalPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
TotalPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
TotalPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
TotalPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
TotalShippingPriceSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
TotalShippingPriceSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
TotalShippingPriceSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
TotalShippingPriceSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
TotalTaxSetPresentmentMoneyAmount | Decimal | True |
Decimal money amount. | |
TotalTaxSetPresentmentMoneyCurrencyCode | String | True |
Currency of the money. | |
TotalTaxSetShopMoneyAmount | Decimal | True |
Decimal money amount. | |
TotalTaxSetShopMoneyCurrencyCode | String | True |
Currency of the money. | |
DraftOrderLineItems | String | False |
The list of the line items in the draft order. |