Schema Documentation

CheckoutInput

Description

Input for the checkout mutation

Fields
Input FieldDescription
account - CreateAccountInput

Create new customer account

billing - CustomerAddressInput

Order billing address

clientMutationId - String

This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions.

customerNote - String

Order customer note

isPaid - Boolean

Define if the order is paid. It will set the status to processing and reduce stock items.

metaData - [MetaDataInput]

Order meta data

paymentMethod - String

Payment method ID.

shipToDifferentAddress - Boolean

Ship to a separate address

shipping - CustomerAddressInput

Order shipping address

shippingMethod - [String]

Order shipping method

transactionId - String

Order transaction ID

Example
{"account":CreateAccountInput,"billing":CustomerAddressInput,"clientMutationId":"abc123","customerNote":"xyz789","isPaid":true,"metaData":[MetaDataInput],"paymentMethod":"abc123","shipToDifferentAddress":false,"shipping":CustomerAddressInput,"shippingMethod":["xyz789"],"transactionId":"xyz789"}