DraftOrderInput

Show definition

input DraftOrderInput {
  # Discount which 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.
  appliedDiscount: DraftOrderAppliedDiscountInput

# The mailing address associated with the payment method. billingAddress: MailingAddressInput

# Customer associated with the draft order. customerId: ID

# Extra information added to the customer. customAttributes: [AttributeInput!]

# The customer's email address. email: String

# Product variant line item or custom line item associated to the draft order. # Each draft order must include at least one line item. lineItems: [DraftOrderLineItemInput!]

# Metafields attached to the draft order. metafields: [MetafieldInput!]

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

# The mailing address to where the order will be shipped. shippingAddress: MailingAddressInput

# A shipping line object, which details the shipping method used. shippingLine: ShippingLineInput

# Additional short descriptors, commonly used for filtering and searching, # formatted as a string of comma-separated values. tags: [String!]

# 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. taxExempt: Boolean

# Sent as part of a draft order object to load customer shipping information. useCustomerDefaultAddress: Boolean }

Input Fields

appliedDiscount   (DraftOrderAppliedDiscountInput)

Discount which 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.

Sign up for a Partner account to get started.

Sign up