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.21CheckoutCreateInput.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.21CheckoutCreateInput.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.21CheckoutCreateInput.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.21Member Ofβ
checkoutCreate
mutation