API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

draftOrderCreate mutation

Version unstable

Creates 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 used to create the draft order.

DraftOrderInput 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.

localizationExtensions ([LocalizationExtensionInput!])

The localization extensions attached to the draft order. For example, Tax IDs.

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.

privateMetafields ([PrivateMetafieldInput!])

The private metafields attached 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!])

A comma separated list of tags that have been added to the draft order.

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

draftOrder (DraftOrder)

The created draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Creates 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 used to create the draft order.

DraftOrderInput 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.

privateMetafields ([PrivateMetafieldInput!])

The private metafields attached 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!])

A comma separated list of tags that have been added to the draft order.

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

draftOrder (DraftOrder)

The created draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-10 (Latest)

Creates 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 used to create the draft order.

DraftOrderInput 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.

privateMetafields ([PrivateMetafieldInput!])

The private metafields attached 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!])

A comma separated list of tags that have been added to the draft order.

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

draftOrder (DraftOrder)

The created draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-07

Creates 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 used to create the draft order.

DraftOrderInput 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.

privateMetafields ([PrivateMetafieldInput!])

The private metafields attached 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!])

A comma separated list of tags that have been added to the draft order.

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

draftOrder (DraftOrder)

The created draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-04

Creates 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 used to create the draft order.

DraftOrderInput 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.

privateMetafields ([PrivateMetafieldInput!])

The private metafields attached 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!])

A comma separated list of tags that have been added to the draft order.

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

draftOrder (DraftOrder)

The created draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-01

Creates 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 used to create the draft order.

DraftOrderInput 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.

privateMetafields ([PrivateMetafieldInput!])

The private metafields attached 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!])

A comma separated list of tags that have been added to the draft order.

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

draftOrder (DraftOrder)

The created draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Creates 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 used to create the draft order.

DraftOrderInput 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.

privateMetafields ([PrivateMetafieldInput!])

The private metafields attached 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!])

A comma separated list of tags that have been added to the draft order.

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

draftOrder (DraftOrder)

The created draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Creates 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 used to create the draft order.

DraftOrderInput 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.

privateMetafields ([PrivateMetafieldInput!])

The private metafields attached 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!])

A comma separated list of tags that have been added to the draft order.

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

draftOrder (DraftOrder)

The created draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Creates 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 used to create the draft order.

DraftOrderInput 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.

privateMetafields ([PrivateMetafieldInput!])

The private metafields attached 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!])

A comma separated list of tags that have been added to the draft order.

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

draftOrder (DraftOrder)

The created draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.