DraftOrderCreateInput Input Type

input DraftOrderCreateInput {
  billingAddress: AddressInput
  saveBillingAddress: Boolean
  user: ID
  userEmail: String
  discount: PositiveDecimal @deprecated(reason: "Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.")
  shippingAddress: AddressInput
  saveShippingAddress: Boolean
  shippingMethod: ID
  voucher: ID @deprecated(reason: "Use `voucherCode` instead.")
  voucherCode: String
  customerNote: String
  channelId: ID
  redirectUrl: String
  externalReference: String
  metadata: [MetadataInput!]
  privateMetadata: [MetadataInput!]
  languageCode: LanguageCodeEnum
  lines: [OrderLineCreateInput!]
}

Fields

billingAddress

billingAddress · AddressInput

Billing address of the customer.

saveBillingAddress

saveBillingAddress · Boolean

Indicates whether the billing address should be saved to the user’s address book upon draft order completion. Can only be set when a billing address is provided. If not specified along with the address, the default behavior is to not save the address.

user

user · ID

Customer associated with the draft order.

userEmail

userEmail · String

Email address of the customer.

discount

discount · PositiveDecimal

Discount amount for the order.

shippingAddress

shippingAddress · AddressInput

Shipping address of the customer.

saveShippingAddress

saveShippingAddress · Boolean

Indicates whether the shipping address should be saved to the user’s address book upon draft order completion.Can only be set when a shipping address is provided. If not specified along with the address, the default behavior is to not save the address.

shippingMethod

shippingMethod · ID

ID of a selected shipping method.

voucher

voucher · ID

ID of the voucher associated with the order.

voucherCode

voucherCode · String

A code of the voucher associated with the order.

customerNote

customerNote · String

A note from a customer. Visible by customers in the order summary.

channelId

channelId · ID

ID of the channel associated with the order.

redirectUrl

redirectUrl · String

URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.

externalReference

externalReference · String

External ID of this order.

metadata

metadata · [MetadataInput!]

Order public metadata.

Added in Saleor 3.21. Can be read by any API client authorized to read the object it’s attached to.

Warning: never store sensitive information, including financial data such as credit card details.

privateMetadata

privateMetadata · [MetadataInput!]

Order private metadata.

Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it’s attached to.

Warning: never store sensitive information, including financial data such as credit card details.

languageCode

languageCode · LanguageCodeEnum

Order language code.

lines

lines · [OrderLineCreateInput!]

Variant line input consisting of variant ID and quantity of products.

Used by

• draftOrderCreate (mutations)

Schema: Saleor 3.23.43. Download SDL.