Choose a version:

DraftOrder

object

A draft order for the customer. Any fields related to money are in the presentment currency. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to Fields and connectionsFields and connections

Anchor to billingAddressbillingAddress •CustomerAddress: The billing address of the customer.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the draft order was created in Shopify.
Anchor to currencyCodecurrencyCode •CurrencyCode! non-null: The three-letter code for the currency of the store at the time that the invoice is sent.
Anchor to customercustomer •Customer: The customer who placed the order.
Anchor to discountInformationdiscountInformation •DraftOrderDiscountInformation! non-null: The discount information for the draft order.
Anchor to emailemail •String: The email address of the customer, which is used to send notifications to.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to inReviewinReview •Boolean! non-null: Whether the draft order is created from the online store and is open.
Anchor to invoiceUrlinvoiceUrl •URL: The link to the checkout, which is sent to the customer in the invoice email.
Anchor to lineItemslineItems •DraftOrderLineItemConnection! non-null: The list of the line items in the draft order.
Anchor to lineItemsSummarylineItemsSummary •DraftOrderLineItemsSummary: The summary of draft order line items quantity.
Anchor to namename •String! non-nullPre-auth accessible: The unique identifier for the draft order, which is unique within the store. For example, #D1223.
Anchor to orderorder •Order: The order that was created from this draft order.
Anchor to phonephone •String: The phone number assigned to the draft order.
Anchor to purchasingEntitypurchasingEntity •PurchasingEntity: The purchasing entity for the draft order.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether the draft order requires shipping or not.
Anchor to shippingAddressshippingAddress •CustomerAddress: The shipping address of the customer.
Anchor to statusstatus •DraftOrderStatus! non-null: The status of the draft order.
Anchor to subtotalPricesubtotalPrice •MoneyV2! non-null: The subtotal of the line items (doesn't include shipping charges, shipping discounts, or taxes).
Anchor to taxesIncludedtaxesIncluded •Boolean! non-null: Whether the line item prices include taxes.
Anchor to taxExempttaxExempt •Boolean! non-null: Indicates whether the draft order is tax exempt.
Anchor to totalLineItemsPricetotalLineItemsPrice •MoneyV2! non-null: The total price of line items for this draft order.
Anchor to totalPricetotalPrice •MoneyV2! non-null: The total amount of the draft order (includes taxes, shipping charges, and discounts).
Anchor to totalShippingPricetotalShippingPrice •MoneyV2! non-null: The total shipping charge for the draft order.
Anchor to totalTaxtotalTax •MoneyV2! non-null: The total amount of taxes for the draft order.
Anchor to totalWeighttotalWeight •UnsignedInt64! non-null: The total weight (in grams) of the draft order.
Anchor to updatedAtupdatedAt •DateTime! non-null: 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).

Was this section helpful?

Anchor to QueriesQueries

Anchor to draftOrder draftOrder •query: Returns a draft order resource by ID. Apps using the Customer Account API must meet the protected customer data requirements.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?