We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

draftOrderCalculate

Version 2019-04

Calculates the properties of a draft order. Useful for determining information such as total taxes or price without actually creating a draft order.

Required access

write_draft_orders access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( DraftOrderInput! ) required

The fields for the draft order.

Input Fields

appliedDiscount (DraftOrderAppliedDiscountInput)

The discount that will be applied to the draft order. A draft order line item can have one discount. A draft order can also have one order-level discount.

billingAddress (MailingAddressInput)

The mailing address associated with the payment method.

customAttributes ([AttributeInput!])

Extra information added to the customer.

customerId (ID)

Customer associated with the draft order.

email (String)

The customer's email address.

lineItems ([DraftOrderLineItemInput!])

Product variant line item or custom line item associated to the draft order. Each draft order must include at least one line item.

metafields ([MetafieldInput!])

Metafields attached to the draft order.

note (String)

The text of an optional note that a shop owner can attach to the draft order.

shippingAddress (MailingAddressInput)

The mailing address to where the order will be shipped.

shippingLine (ShippingLineInput)

A shipping line object, which details the shipping method used.

tags ([String!])

Additional short descriptors, commonly used for filtering and searching, formatted as a string of comma-separated values.

taxExempt (Boolean)

Whether or not taxes are exempt for the draft order. If false, then Shopify will refer to the taxable field for each line item. If a customer is applied to the draft order, then Shopify will use the customer's tax exempt field instead.

useCustomerDefaultAddress (Boolean)

Sent as part of a draft order object to load customer shipping information.

Return Fields

calculatedDraftOrder (CalculatedDraftOrder)

The calculated properties for a draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Latest)

Calculates the properties of a draft order. Useful for determining information such as total taxes or price without actually creating a draft order.

Required access

write_draft_orders access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( DraftOrderInput! ) required

The fields for the draft order.

Input Fields

appliedDiscount (DraftOrderAppliedDiscountInput)

The discount that will be applied to the draft order. A draft order line item can have one discount. A draft order can also have one order-level discount.

billingAddress (MailingAddressInput)

The mailing address associated with the payment method.

customAttributes ([AttributeInput!])

Extra information added to the customer.

customerId (ID)

Customer associated with the draft order.

email (String)

The customer's email address.

lineItems ([DraftOrderLineItemInput!])

Product variant line item or custom line item associated to the draft order. Each draft order must include at least one line item.

metafields ([MetafieldInput!])

Metafields attached to the draft order.

note (String)

The text of an optional note that a shop owner can attach to the draft order.

shippingAddress (MailingAddressInput)

The mailing address to where the order will be shipped.

shippingLine (ShippingLineInput)

A shipping line object, which details the shipping method used.

tags ([String!])

Additional short descriptors, commonly used for filtering and searching, formatted as a string of comma-separated values.

taxExempt (Boolean)

Whether or not taxes are exempt for the draft order. If false, then Shopify will refer to the taxable field for each line item. If a customer is applied to the draft order, then Shopify will use the customer's tax exempt field instead.

useCustomerDefaultAddress (Boolean)

Sent as part of a draft order object to load customer shipping information.

Return Fields

calculatedDraftOrder (CalculatedDraftOrder)

The calculated properties for a draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Release candidate)

Calculates the properties of a draft order. Useful for determining information such as total taxes or price without actually creating a draft order.

Required access

write_draft_orders access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( DraftOrderInput! ) required

The fields for the draft order.

Input Fields

appliedDiscount (DraftOrderAppliedDiscountInput)

The discount that will be applied to the draft order. A draft order line item can have one discount. A draft order can also have one order-level discount.

billingAddress (MailingAddressInput)

The mailing address associated with the payment method.

customAttributes ([AttributeInput!])

Extra information added to the customer.

customerId (ID)

Customer associated with the draft order.

email (String)

The customer's email address.

lineItems ([DraftOrderLineItemInput!])

Product variant line item or custom line item associated to the draft order. Each draft order must include at least one line item.

metafields ([MetafieldInput!])

Metafields attached to the draft order.

note (String)

The text of an optional note that a shop owner can attach to the draft order.

shippingAddress (MailingAddressInput)

The mailing address to where the order will be shipped.

shippingLine (ShippingLineInput)

A shipping line object, which details the shipping method used.

tags ([String!])

Additional short descriptors, commonly used for filtering and searching, formatted as a string of comma-separated values.

taxExempt (Boolean)

Whether or not taxes are exempt for the draft order. If false, then Shopify will refer to the taxable field for each line item. If a customer is applied to the draft order, then Shopify will use the customer's tax exempt field instead.

useCustomerDefaultAddress (Boolean)

Sent as part of a draft order object to load customer shipping information.

Return Fields

calculatedDraftOrder (CalculatedDraftOrder)

The calculated properties for a draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up