Skip to main content

CheckoutCreateInput Input Type

No description

input CheckoutCreateInput {
  channel: String
  lines: [CheckoutLineInput!]!
  email: String
  saveShippingAddress: Boolean
  shippingAddress: AddressInput
  saveBillingAddress: Boolean
  billingAddress: AddressInput
  languageCode: LanguageCodeEnum
  validationRules: CheckoutValidationRules
  metadata: [MetadataInput!]
  privateMetadata: [MetadataInput!]
}

Fields​

CheckoutCreateInput.channel ● String scalar miscellaneous​

Slug of a channel in which to create a checkout.

CheckoutCreateInput.lines ● [CheckoutLineInput!]! non-null input checkout​

A list of checkout lines, each containing information about an item in the checkout.

CheckoutCreateInput.email ● String scalar miscellaneous​

The customer's email address.

CheckoutCreateInput.saveShippingAddress ● Boolean scalar miscellaneous​

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

Added in Saleor 3.21 (unreleased)

CheckoutCreateInput.shippingAddress ● AddressInput input miscellaneous​

The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items. skipValidation requires HANDLE_CHECKOUTS and AUTHENTICATED_APP permissions.

CheckoutCreateInput.saveBillingAddress ● Boolean scalar miscellaneous​

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

Added in Saleor 3.21 (unreleased)

CheckoutCreateInput.billingAddress ● AddressInput input miscellaneous​

Billing address of the customer. skipValidation requires HANDLE_CHECKOUTS and AUTHENTICATED_APP permissions.

CheckoutCreateInput.languageCode ● LanguageCodeEnum enum miscellaneous​

Checkout language code.

CheckoutCreateInput.validationRules ● CheckoutValidationRules input checkout​

The checkout validation rules that can be changed.

CheckoutCreateInput.metadata ● [MetadataInput!] list input miscellaneous​

Checkout public metadata. 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.

Added in Saleor 3.21 (unreleased)

CheckoutCreateInput.privateMetadata ● [MetadataInput!] list input miscellaneous​

Checkout private metadata. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_CHECKOUTS

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.

Added in Saleor 3.21 (unreleased)

Member Of​

checkoutCreate mutation