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​

channel ● String​

Slug of a channel in which to create a checkout.

lines ● [CheckoutLineInput!]!​

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

email ● String​

The customer's email address.

saveShippingAddress ● Boolean​

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

shippingAddress ● AddressInput​

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.

saveBillingAddress ● Boolean​

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

billingAddress ● AddressInput​

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

languageCode ● LanguageCodeEnum​

Checkout language code.

validationRules ● CheckoutValidationRules​

The checkout validation rules that can be changed.

metadata ● [MetadataInput!]​

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

privateMetadata ● [MetadataInput!]​

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

Member Of​

checkoutCreate mutation