Requires access scope.
An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:
- Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created.
- Send invoices to customers to pay with a secure checkout link.
- Use custom items to represent additional costs or products that aren't displayed in a shop's inventory.
- Re-create orders manually from active sales channels.
- Sell products at discount or wholesale rates.
- Take pre-orders.
- Save an order as a draft and resume working on it later.
For draft orders in multiple currencies is the source of truth for what a customer is going to be charged and is an estimate of what the merchant might receive in their shop currency.
Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Fields and connections
Whether or not to accept automatic discounts on the draft order during calculation. If false, only discount codes and custom draft order discounts (see
) will be applied. If true, eligible automatic discounts will be applied in addition to discount codes and custom draft order discounts.Whether discount codes are allowed during checkout of this draft order.
Whether all variant prices have been overridden.
Whether any variant prices have been overridden.
The custom order-level discount applied.
The billing address of the customer.
Whether the billing address matches the shipping address.
The date and time when the draft order was converted to a new order, and had it's status changed to Completed.
The date and time when the draft order was created in Shopify.
The shop currency used for calculation.
The custom information added to the draft order on behalf of the customer.
The customer who will be sent an invoice.
A default cursor that returns the single next record, sorted ascending by ID.
All discount codes applied.
The email address of the customer, which is used to send notifications.
The list of events associated with the draft order.
Whether the merchant has added timeline comments to the draft order.
A globally-unique ID.
The subject defined for the draft invoice email template.
The date and time when the invoice was last emailed to the customer.
The link to the checkout, which is sent to the customer in the invoice email.
The ID of the corresponding resource in the REST Admin API.
The list of the line items in the draft order.
A subtotal of the line items and corresponding discounts, excluding include shipping charges, shipping discounts, taxes, or order discounts.
List of localization extensions for the resource.
The name of the selected market.
The selected country code that determines the pricing.
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.A list of custom fields that a merchant associates with a Shopify resource.
The metafields associated with the resource matching the supplied list of namespaces and keys.
The identifier for the draft order, which is unique within the store. For example, #D1223.
The text from an optional note attached to the draft order.
The order that was created from the draft order.
The associated payment terms for this draft order.
The assigned phone number.
The list of platform discounts applied.
The purchase order number.
The payment currency used for calculation.
The purchasing entity.
Whether the draft order is ready and can be completed. Draft orders might have asynchronous operations that can take time to finish.
The time after which inventory will automatically be restocked.
The shipping address of the customer.
The line item containing the shipping information and costs.
The status of the draft order.
The subtotal, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.
The comma separated list of tags associated with the draft order. Updating
tagsoverwrites any existing tags that were previously added to the draft order. To add new tags without overwriting existing tags, use the tagsAdd mutation.Whether the line item prices include taxes.
Whether the draft order is tax exempt.
The list of of taxes lines charged for each line item and shipping line.
Total discounts.
Total price of line items.
The total price, includes taxes, shipping charges, and discounts.
The sum of individual line item quantities. If the draft order has bundle items, this is the sum containing the quantities of individual items in the bundle.
The total shipping price.
The total tax.
The total weight in grams of the draft order.
Fingerprint of the current cart. In order to have bundles work, the fingerprint must be passed to each request as it was previously returned, unmodified.
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.
Whether the draft order will be visible to the customer on the self-serve portal.
The list of warnings raised while calculating.
Returns a DraftOrder resource by ID.
List of saved draft orders.
Mutations
Completes a draft order and creates an order.
Creates a draft order from order.
Creates a draft order.
Duplicates a draft order.
Sends an email invoice for a draft order.
Updates a draft order.
If a checkout has been started for a draft order, any update to the draft will unlink the checkout. Checkouts are created but not immediately completed when opening the merchant credit card modal in the admin, and when a buyer opens the invoice URL. This is usually fine, but there is an edge case where a checkout is in progress and the draft is updated before the checkout completes. This will not interfere with the checkout and order creation, but if the link from draft to checkout is broken the draft will remain open even after the order is created.