Checkout
A full reference to a checkout type for the Liquid Commerce Prepare API.
CheckoutType
token: string
Unique identifier for the checkout session
cartId: string
Associated cart identifier
Customer information
hasAgeVerify: boolean
Should the checkout verify age
hasSubstitutionPolicy: boolean
Should the checkout allow for substitutions
isGift: boolean
When the order is set as gift (isGift is set to true), the system adds gift messaging, special packaging, and gift receipts with optional sender anonymity.
createdAt: dateString
Checkout date of creation
updatedAt: dateString
Checkout last updated at date
isPresaleLocked: boolean
Indicates if the checkout is locked to a single presale item
presaleExpiresAt: Date | null
billingSameAsShipping: boolean
Checkout billing address same as shipping address
acceptedAccountCreation: boolean
Whether customer accepted account creation
Checkout gift options
Checkout marketing opt-ins
Checkout shipping address info, (this is address is propagated from the address set in the cart, if you need to update it you must update the cart. Address changes might produce price changes)
Checkout total amounts info
All checkout items
All checkout retailers
payment: string [optional]
Payment method identifier
Gift card codes to apply as payment methods
Events related to the checkout process
promoCode: string
Promotional code to apply a discount to the checkout
Customer
id: string
Customer's identifier
firstName: string
Customer's first name
lastName: string
Customer's last name
email: string
Customer's email
company:string
Customer's company
phone: string
Customer's phone
birthDate: string
Customer's birthDate
profileImage: string
Customer's profile image
Should the checkout verify age
createdAt: Date
Customer's creation time
updatedAt: Date
Customer's profile updated time
GiftOptions
message: string
Checkout gift order message
Checkout gift order recipient
GiftRecipient
name: string
Checkout gift order recipient name
email: string
Checkout gift order recipient email
phone: string
Checkout gift order recipient phone
MarketingPreferences
canEmail: boolean
Checkout marketing opt-in for email
canSms: boolean
Checkout marketing opt-in for sms
DeliveryTip
fulfillmentId: boolean
Identifier of fulfillment
tip: number
The value of the tip
CheckoutGiftCard
code: string
The unique code of the gift card used for identification
applied: number
The amount deducted from the gift card during the current transaction
balance: number
The remaining balance on the gift card after the applied amount is deducted
CheckoutEvents
type: string
The type of the checkout event
message: string
A message providing additional context or details about the event
BillingAddress
firstName: string
Billing address's recipient first name
lastName: string
Billing address's recipient last name
email: string
Billing address's recipient email
phone: string
Billing address's recipient phone
one: string
Billing address street address
two: string
Billing address apt, suite, floor, etc
city: string
Billing address city
state: string
Billing address state, 2 letter code
zip: string
Billing address zip code
country: string
Billing address country
Checkout BillingAddress
id: string
Billing address's recipient identifier
firstName: string
Billing address's recipient first name
lastName: string
Billing address's recipient last name
email: string
Billing address's recipient email
company: string
Billing address's recipient company
phone: string
Billing address's recipient phone
one: string
Billing address street address
two: string
Billing address apt, suite, floor, etc
city: string
Billing address city
state: string
Billing address state, 2 letter code
zip: string
Billing address zip code
country: string
Billing address country
CheckoutAmounts
subtotal: number
Amounts total subtotal
engraving: number
Amounts total engraving
service: number
Amounts total service
shipping: number
Amounts total shipping
delivery: number
Amounts total delivery
platform: number
Amounts total platform
discounts: number
Amounts total discounts
giftCards: number
Amounts total giftCards
tax: number
Amounts total tax
tip: number
Amounts total tip
total: number
Amounts total
Total amounts details, tax and discount breakdown
AmountsDetails
Amounts total taxes breakdown
Amounts total discounts breakdown
AmountsDetailsTaxes
bag: number
Amounts total bag tax fee, ex: Checkout bag fees are required for certain states
bottleDeposits: number
Amounts total bottle deposit tax fee, ex: bottle deposit fees are required for certain states
retailDelivery: number
Amounts total retail delivery tax fee, only required for the state of Colorado (CO)
delivery: number
Amounts total delivery tax fee, for on demand delivery only
shipping: number
Amounts total shipping tax fee, for shipping based order only
products: number
Amounts total product sales tax fee
AmountsDetailsDiscounts
engraving: number
Amounts total engraving fee discounts
delivery: number
Amounts total delivery fee discounts, for on demand delivery only
shipping: number
Amounts total shipping fee discounts, for shipping based order only
products: number
Amounts total product discounts
service: number
Amounts total service discounts
CheckoutItem
variantId: string
Unique retailer item ID for the checkout item
retailerId: string
Item's retailer id
liquidId: string
Internal product identifier
salsifyPid: string
Salsify product identifier
salsifyGrouping: string
Salsify grouping identifier
uom: string
Unit of measure
mainImage: string
Main product image URL
unitTax: number
Tax per unit
partNumber: string
Product part number
fulfillmentId: string
Item's fulfillment id
cartItemId: string
Unique cart item ID
pack: boolean
If the product is a pack, then true
packDesc: string
Product pack description
container: string
Product container, ex: Bottle
containerType: string
Product container type, ex: Glass
Indicates fulfillment type
name: string
Product name
brand: string
Product brand
upc: string
Product upc
abv: string
Product's alcohol by volume
proof: string
Product's alcohol proof
volume: string
Product's volume
size: string
Product size
catPath: string
quantity: number
Item's quantity
unitPrice: number
Individual item price
price: number
Total item price according to the quantity added
bottleDeposits: number
Total item's bottle deposit tax fee
tax: number
Total item's sales tax
Item configuration attributes
ItemAttributes
item giftcard configurations
item engraving configurations
item presale configurations
ItemGiftCard
sender: string
name of the gift card sender
message: string
message from the gift card sender
recipients: string[]
recipients to receive the gift card
sendDate: date
date in which to send the gift card
ItemEngraving
isEngravable: boolean
true when the item allows engraving
hasEngraving: boolean
true when the item is engraved
maxCharsPerLine: number
maximum of characters per engraving line
maxLines: number
max of engraving lines
location: string
location of the engraving
fee: number
fee of the engraving
lines: string[]
engraving message lines, ex:
ItemPresale
canPurchaseOn: Date | null
the date when the product can be purchased
estimatedShipBy: Date | null
the date when the product is expected to ship
isActive: boolean
whether the presale is currently active
language: string
the language associated with the product presale
CheckoutRetailer
Checkout retailer includes accumulated totals using all the same properties from the CheckoutAmounts type for all their available fulfillments. Below are all the values additional to the amounts values.
id: string
Retailers identifier
name: string
Retailers name
subtotal: number
Amounts total subtotal
engraving: number
Amounts total engraving
service: number
Amounts total service
shipping: number
Amounts total shipping
delivery: number
Amounts total delivery
discounts: number
Amounts total discounts
platform : number
Amounts total platform
giftCards: number
Amounts total gifts card
tax: number
Amounts total tax
tip: number
Amounts total tip
total: number
Amounts total
Total amounts details, tax and discount breakdown
Retailers address
Retailers fulfillment methods
CheckoutRetailerFulfillments
Checkout retailer fulfillments includes accumulated totals using all the same properties from the CheckoutAmounts type for the fulfillments. Below are all the values additional to the amounts values.
id: string
Fulfillment identifier
scheduledFor: string | Date
If the fulfillment method is type: onDemand the scheduled date and time in an ISO date string
type: string
Fulfillment type, "onDemand" | "shipping"
Fulfillment expectation configurations
items: string[]
Fulfillment item ids
CheckoutFulfillmentExpectation
detail: string
detailed expectation of fulfillment, ex: Ships in 3 days
short: string
short expectation of fulfillment, ex: 3 days
Sample checkout
checkoutLast updated