draft
Returns a draft order resource by ID. Apps using the Customer Account API must meet the protected customer data requirements.
Arguments
- id (ID!)
- •ID!required
The ID of the draft order to be returned.
Anchor to Possible returnsPossible returns
- DraftOrder (DraftOrder)
- Anchor to DraftOrderDraft•Draft
Order Order 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 billingAddressbilling•Customer
Address Address The billing address of the customer.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the draft order was created in Shopify.
- Anchor to currencyCodecurrency•Currency
Code Code! 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 discountInformationdiscount•Draft
Information Order Discount Information! 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.
- •ID!non-nullPre-auth accessible
A globally-unique ID.
- Anchor to inReviewin•Boolean!
Review non-null Whether the draft order is created from the online store and is open.
- Anchor to invoiceUrlinvoice•URL
Url The link to the checkout, which is sent to the customer in the invoice email.
- Anchor to lineItemsline•Draft
Items Order Line Item Connection! non-null The list of the line items in the draft order.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to lineItemsSummaryline•Draft
Items Summary Order Line Items Summary 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 purchasingEntitypurchasing•Purchasing
Entity Entity The purchasing entity for the draft order.
- Anchor to requiresShippingrequires•Boolean!
Shipping non-null Whether the draft order requires shipping or not.
- Anchor to shippingAddressshipping•Customer
Address Address The shipping address of the customer.
- Anchor to statusstatus•Draft
Order Status! non-null The status of the draft order.
- Anchor to subtotalPricesubtotal•Money
Price V2! non-null The subtotal of the line items (doesn't include shipping charges, shipping discounts, or taxes).
- Anchor to taxesIncludedtaxes•Boolean!
Included non-null Whether the line item prices include taxes.
- Anchor to taxExempttax•Boolean!
Exempt non-null Indicates whether the draft order is tax exempt.
- Anchor to totalLineItemsPricetotal•Money
Line Items Price V2! non-null The total price of line items for this draft order.
- Anchor to totalPricetotal•Money
Price V2! non-null The total amount of the draft order (includes taxes, shipping charges, and discounts).
- Anchor to totalShippingPricetotal•Money
Shipping Price V2! non-null The total shipping charge for the draft order.
- Anchor to totalTaxtotal•Money
Tax V2! non-null The total amount of taxes for the draft order.
- Anchor to totalWeighttotal•Unsigned
Weight Int64! non-null The total weight (in grams) of the draft order.
- Anchor to updatedAtupdated•Date
At Time! 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).