DraftOrderInput

Anchor to acceptAutomaticDiscountsacceptAutomaticDiscounts

•Boolean

Whether or not to accept automatic discounts on the draft order during calculation. If false, only discount codes and custom draft order discounts (see appliedDiscount) will be applied. If true, eligible automatic discounts will be applied in addition to discount codes and custom draft order discounts.

Anchor to allowDiscountCodesInCheckoutallowDiscountCodesInCheckout

•Boolean

Whether discount codes are allowed during checkout of this draft order.

Anchor to appliedDiscountappliedDiscount

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

Show input fields

Anchor to billingAddressbillingAddress

•MailingAddressInput

The mailing address associated with the payment method.

Show input fields

Anchor to customAttributescustomAttributes

•[AttributeInput!]

The extra information added to the draft order on behalf of the customer.

Show input fields

Anchor to discountCodesdiscountCodes

•[String!]

The list of discount codes that will be attempted to be applied to the draft order. If the draft isn't eligible for any given discount code it will be skipped during calculation.

Anchor to emailemail

•String

The customer's email address.

Anchor to lineItemslineItems

•[DraftOrderLineItemInput!]

The list of product variant or custom line item. Each draft order must include at least one line item. Accepts a maximum of 499 line items.

NOTE: Draft orders don't currently support subscriptions.

Show input fields

Anchor to localizedFieldslocalizedFields

•[LocalizedFieldInput!]

The localized fields attached to the draft order. For example, Tax IDs.

Show input fields

Anchor to metafieldsmetafields

•[MetafieldInput!]

The list of metafields attached to the draft order. An existing metafield can not be used when creating a draft order.

Show input fields

Anchor to notenote

•String

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

Anchor to paymentTermspaymentTerms

•PaymentTermsInput

The fields used to create payment terms.

Show input fields

Anchor to phonephone

•String

The customer's phone number.

Anchor to poNumberpoNumber

•String

The purchase order number.

Anchor to presentmentCurrencyCodepresentmentCurrencyCode

•CurrencyCode

The payment currency of the customer for this draft order.

Show enum values

Anchor to purchasingEntitypurchasingEntity

•PurchasingEntityInput

The purchasing entity for the draft order.

Show input fields

Anchor to reserveInventoryUntilreserveInventoryUntil

•DateTime

The time after which inventory reservation will expire.

Anchor to sessionTokensessionToken

•String

The unique token identifying the draft order.

Anchor to shippingAddressshippingAddress

•MailingAddressInput

The mailing address to where the order will be shipped.

Show input fields

Anchor to shippingLineshippingLine

•ShippingLineInput

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

Show input fields

Anchor to sourceNamesourceName

•String

The source of the checkout. To use this field for sales attribution, you must register the channels that your app is managing. You can register the channels that your app is managing by completing this Google Form. After you've submitted your request, you need to wait for your request to be processed by Shopify. You can find a list of your channels in the Partner Dashboard, in your app's Marketplace extension. You need to specify the handle as the source_name value in your request. The handle is the channel that the order was placed from.

Anchor to tagstags

•[String!]

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

Anchor to taxExempttaxExempt

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

Anchor to transformerFingerprinttransformerFingerprint

•String

Fingerprint to guarantee bundles are handled correctly.

Anchor to useCustomerDefaultAddressuseCustomerDefaultAddress

•Boolean

Whether to use the customer's default address.

Anchor to visibleToCustomervisibleToCustomer

•Boolean

Whether the draft order will be visible to the customer on the self-serve portal.

Deprecated fields

Anchor to customerIdcustomerId

•ID

Deprecated

Anchor to localizationExtensionslocalizationExtensions

•[LocalizationExtensionInput!]

Deprecated

Show input fields

Anchor to marketRegionCountryCodemarketRegionCountryCode

•CountryCode

Deprecated

Show enum values

Anchor to draftOrderCalculate.inputdraftOrderCalculate.input

•MUTATION

Anchor to draftOrderCreate.inputdraftOrderCreate.input

•MUTATION

Anchor to draftOrderUpdate.inputdraftOrderUpdate.input

•MUTATION