DraftOrderCreateInput Input Type

No description

input DraftOrderCreateInput {
  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
  lines: [OrderLineCreateInput!]
}

Expand ▼

Fields

DraftOrderCreateInput.billingAddress ● AddressInput input miscellaneous

Billing address of the customer.

DraftOrderCreateInput.saveBillingAddress ● Boolean scalar miscellaneous

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 (unreleased)

DraftOrderCreateInput.user ● ID scalar miscellaneous

Customer associated with the draft order.

DraftOrderCreateInput.userEmail ● String scalar miscellaneous

Email address of the customer.

DraftOrderCreateInput.discount ● PositiveDecimal deprecated scalar miscellaneous

DEPRECATED

Providing a value for the field has no effect. Use orderDiscountAdd mutation instead.

Discount amount for the order.

DraftOrderCreateInput.shippingAddress ● AddressInput input miscellaneous

Shipping address of the customer.

DraftOrderCreateInput.saveShippingAddress ● Boolean scalar miscellaneous

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 (unreleased)

DraftOrderCreateInput.shippingMethod ● ID scalar miscellaneous

ID of a selected shipping method.

DraftOrderCreateInput.voucher ● ID scalar miscellaneous

ID of the voucher associated with the order.

DraftOrderCreateInput.voucherCode ● String scalar miscellaneous

A code of the voucher associated with the order.

Added in Saleor 3.18

DraftOrderCreateInput.customerNote ● String scalar miscellaneous

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

DraftOrderCreateInput.channelId ● ID scalar miscellaneous

ID of the channel associated with the order.

DraftOrderCreateInput.redirectUrl ● String scalar miscellaneous

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

DraftOrderCreateInput.externalReference ● String scalar miscellaneous

External ID of this order.

DraftOrderCreateInput.metadata ● [MetadataInput!] list input miscellaneous

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.

DraftOrderCreateInput.privateMetadata ● [MetadataInput!] list input miscellaneous

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.

DraftOrderCreateInput.languageCode ● LanguageCodeEnum enum miscellaneous

Order language code.

Added in Saleor 3.21 (unreleased)

DraftOrderCreateInput.lines ● [OrderLineCreateInput!] list input orders

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

Member Of

draftOrderCreate mutation