DraftOrder - customer - OBJECT

Version: 2025-01

Description:

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](https://shopify.dev/docs/apps/launch/protected-customer-data).

Access Scopes

Fields

  • billingAddress: CustomerAddress - The billing address of the customer.
  • createdAt: DateTime! - The date and time when the draft order was created in Shopify.
  • currencyCode: CurrencyCode! - The three-letter code for the currency of the store at the time that the invoice is sent.
  • customer: Customer - The customer who placed the order.
  • discountInformation: DraftOrderDiscountInformation! - The discount information for the draft order.
  • email: String - The email address of the customer, which is used to send notifications to.
  • id: ID! - A globally-unique ID.
  • inReview: Boolean! - Whether the draft order is created from the online store and is open.
  • invoiceUrl: URL - The link to the checkout, which is sent to the customer in the invoice email.
  • lineItemsSummary: DraftOrderLineItemsSummary - The summary of draft order line items quantity.
  • name: String! - The unique identifier for the draft order, which is unique within the store. For example, _#D1223_.
  • order: Order - The order that was created from this draft order.
  • phone: String - The phone number assigned to the draft order.
  • purchasingEntity: PurchasingEntity - The purchasing entity for the draft order.
  • requiresShipping: Boolean! - Whether the draft order requires shipping or not.
  • shippingAddress: CustomerAddress - The shipping address of the customer.
  • status: DraftOrderStatus! - The status of the draft order.
  • subtotalPrice: MoneyV2! - The subtotal of the line items (doesn't include shipping charges, shipping discounts, or taxes).
  • taxExempt: Boolean! - Indicates whether the draft order is tax exempt.
  • taxesIncluded: Boolean! - Whether the line item prices include taxes.
  • totalLineItemsPrice: MoneyV2! - The total price of line items for this draft order.
  • totalPrice: MoneyV2! - The total amount of the draft order (includes taxes, shipping charges, and discounts).
  • totalShippingPrice: MoneyV2! - The total shipping charge for the draft order.
  • totalTax: MoneyV2! - The total amount of taxes for the draft order.
  • totalWeight: UnsignedInt64! - The total weight (in grams) of the draft order.
  • updatedAt: DateTime! - 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).

Connections

  • lineItems: DraftOrderLineItemConnection!

Related queries

  • draftOrder Returns a draft order resource by ID. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data).

Related mutations

Related Unions

Examples