DraftOrderInput Input Type

No description

input DraftOrderInput {
  billingAddress: AddressInput
  saveBillingAddress: Boolean
  user: ID
  userEmail: String
  discount: PositiveDecimal @deprecated
  shippingAddress: AddressInput
  saveShippingAddress: Boolean
  shippingMethod: ID
  voucher: ID
  voucherCode: String
  customerNote: String
  channelId: ID
  redirectUrl: String
  externalReference: String
  metadata: [MetadataInput!]
  privateMetadata: [MetadataInput!]
  languageCode: LanguageCodeEnum
}

Fields

billingAddress ● AddressInput

Billing address of the customer.

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.

Added in Saleor 3.21

user ● ID

Customer associated with the draft order.

userEmail ● String

Email address of the customer.

shippingAddress ● AddressInput

Shipping address of the customer.

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.

Added in Saleor 3.21

shippingMethod ● ID

ID of a selected shipping method.

voucher ● ID

ID of the voucher associated with the order.

voucherCode ● String

A code of the voucher associated with the order.

Added in Saleor 3.18

customerNote ● String

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

channelId ● ID

ID of the channel associated with the order.

redirectUrl ● String

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

externalReference ● String

External ID of this order.

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 ● [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 ● LanguageCodeEnum

Order language code.

Added in Saleor 3.21

Show deprecated

Member Of

draftOrderUpdate mutation