CheckoutCreateInput

input

The input fields for creating a checkout.

Fields

lineItems ● [CheckoutLineItemInput]

A list of line items.

email ● String

The email address of the associated customer.

orderFrom ● Int

The order source. Valid values are:

0: Placed by the customer
1: Placed by the merchant

Deprecated

This field has been deprecated since v20251201.

buyerIdentity ● CheckoutBuyerIdentityInput

The information about the associated customer identity.

customAttributes ● [AttributeInput]

A list of custom attributes attached to the checkout, used to collect additional business information.

note ● String

The note that the merchant adds to the checkout.

shippingAddress ● ShippingAddressInput

The associated shipping address.

allowPartialAddresses ● Boolean

Whether an incomplete shipping address is allowed.

true: Allowed. The system will skip required field validation for recipient name fields (firstName and lastName) and detailed address fields (zip, city, address1, and address2), allowing them to be omitted, null, or an empty string "".
false: Disallowed.

cartId ● ID

The unique ID of the cart, used to locate the cart whose items will be converted into checkout line items. This field is mutually exclusive with lineItems. Providing cartId and lineItems at the same time will result in an error.

language ● String

The language code for the checkout page, following the IETF BCP 47 standard.
Example: en

Map

Argument from

Mutation.checkoutCreate

CheckoutCreateInput

Was this article helpful to you?

SHOPLINE

Legal