ShopifyCheckoutCreateInput

interface

import { ShopifyCheckoutCreateInput } from '@daffodil/driver/shopify'

The input fields required to create a checkout.

interface ShopifyCheckoutCreateInput {
  allowPartialAddresses: boolean
  buyerIdentity: ShopifyCheckoutBuyerIdentityInput
  customAttributes: ShopifyAttributeInput[]
  email: string
  lineItems: ShopifyCheckoutLineItemInput[]
  note: string
  shippingAddress: ShopifyMailingAddressInput
}

Properties

allowPartialAddresses `boolean`
Allows setting partial addresses on a Checkout, skipping the full validation of attributes. The required attributes are city, province, and country. Full validation of addresses is still done at completion time. Defaults to `null`.

buyerIdentity `ShopifyCheckoutBuyerIdentityInput`
The identity of the customer associated with the checkout.

customAttributes `ShopifyAttributeInput[]`
A list of extra information that's added to the checkout. The input must not contain more than `250` values.

customAttributes

ShopifyAttributeInput[]

A list of extra information that's added to the checkout.

The input must not contain more than 250 values.

email `string`
The email with which the customer wants to checkout.

lineItems `ShopifyCheckoutLineItemInput[]`
A list of line item objects, each one containing information about an item in the checkout. The input must not contain more than `250` values.

lineItems

ShopifyCheckoutLineItemInput[]

A list of line item objects, each one containing information about an item in the checkout.

The input must not contain more than 250 values.

note `string`
The text of an optional note that a shop owner can attach to the checkout.

shippingAddress `ShopifyMailingAddressInput`
The shipping address to where the line items will be shipped.