Checkout template
Login, address, shipping, payment, review and order confirmation.
Output: page body inside the storefront layout.
Shared structures available in recorded contexts: shop, branding, theme, urls, page, navigation, languageSwitcher, currencySwitcher, headerActionContributions, labels, security, footer, cartPreview, accountHeader.
| Field | Type | Meaning | Availability |
|---|---|---|---|
viewModel.checkout |
object | Checkout data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses |
object | Addresses data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing |
object | Billing data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.addressLine2 |
string | Address line2 value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.addressMode |
string | Address mode value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.addressRole |
string | Address role value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.checkoutAddressId |
number | checkout address identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.city |
string | City value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.company |
string | Company value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.companyAddition |
string | Company addition value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.countryId |
number | country identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.countryIsoCode |
string | Country iso code value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.customeraddresscustomfields |
array | Prepared customeraddresscustomfields collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.customerAddressId |
number | customer address identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.customercompanyaddresscustomfields |
array | Prepared customercompanyaddresscustomfields collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.customerCompanyAddressId |
number | customer company address identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.firstName |
string | First name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.lastName |
string | Last name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.mobile |
string | Mobile value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.phone |
string | Phone value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.postcode |
string | Postcode value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.salutation |
string | Salutation value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.salutationId |
number | salutation identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.shippingonlycustomeraddresscustomfields |
array | Prepared shippingonlycustomeraddresscustomfields collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.shippingonlycustomercompanyaddresscustomfields |
array | Prepared shippingonlycustomercompanyaddresscustomfields collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.sourceType |
string | Source type value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.state |
string | State value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.street |
string | Street value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.streetNumber |
string | Street number value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.billing.titleId |
number | title identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.hasBillingAddress |
boolean | Whether billing address applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.hasrequiredcustomfieldscomplete |
boolean | Whether hasrequiredcustomfieldscomplete applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.hasShippingAddress |
boolean | Whether shipping address applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping |
object | Shipping data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.addressLine2 |
string | Address line2 value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.addressMode |
string | Address mode value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.addressRole |
string | Address role value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.checkoutAddressId |
number | checkout address identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.city |
string | City value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.company |
string | Company value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.companyAddition |
string | Company addition value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.countryId |
number | country identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.countryIsoCode |
string | Country iso code value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.customeraddresscustomfields |
array | Prepared customeraddresscustomfields collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.customerAddressId |
number | customer address identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.customercompanyaddresscustomfields |
array | Prepared customercompanyaddresscustomfields collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.customerCompanyAddressId |
number | customer company address identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.firstName |
string | First name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.lastName |
string | Last name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.mobile |
string | Mobile value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.phone |
string | Phone value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.postcode |
string | Postcode value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.salutation |
string | Salutation value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.salutationId |
number | salutation identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.sourceType |
string | Source type value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.state |
string | State value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.street |
string | Street value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.streetNumber |
string | Street number value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shipping.titleId |
number | title identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.addresses.shippingSameAsBilling |
boolean | Whether shipping same as billing applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.auth |
object | Auth data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.accountStatus |
string | Account status value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.canGuestCheckout |
number | Can guest checkout numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.canRegister |
number | Can register numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.canRegisterCompany |
number | Can register company numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.companyCustomFields |
array | Prepared company custom fields collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.customerId |
number | customer identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.customerShopId |
number | customer shop identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.isPendingApproval |
boolean | Whether pending approval applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.isPendingVerification |
boolean | Whether pending verification applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.isRegisteredCheckout |
boolean | Whether registered checkout applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.registeredEmail |
string | Registered email value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.auth.showNewsletterOptIn |
number | Show newsletter opt in numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.canContinueToReview |
boolean | Whether continue to review applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.cart |
object | Cart data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.amountType |
string | Amount type value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.cartId |
number | cart identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.cartKey |
string | Cart key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.checkoutBlocked |
boolean | Whether checkout blocked applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.currencyIsoCode |
string | Currency iso code value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.fulfillment |
object | Fulfillment data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.fulfillment.hasPickupOnlyItems |
boolean | Whether pickup only items applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.hasAvailabilityIssues |
boolean | Whether availability issues applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.hasNotReservedNotice |
boolean | Whether not reserved notice applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.hasPickupOnlyItems |
boolean | Whether pickup only items applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.hasPricingGaps |
boolean | Whether pricing gaps applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.isEmpty |
boolean | Whether empty applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.itemCount |
number | Item count numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.items |
array | Prepared items collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.items[].amountType |
string | Amount type value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability |
object | Availability data; check child fields before use. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability.alwaysAvailable |
boolean | Whether always available applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability.availableQuantity |
number | Available quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability.backorderAllowed |
boolean | Whether backorder allowed applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability.canFulfillRequestedQuantity |
boolean | Whether fulfill requested quantity applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability.hasInventoryItem |
boolean | Whether inventory item applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability.isOrderable |
boolean | Whether orderable applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability.maxOrderQuantity |
number | Max order quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability.quantityOnHand |
number | Quantity on hand numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability.requestedQuantity |
number | Requested quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability.reservedQuantity |
number | Reserved quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availability.status |
string | Status value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availabilityChecked |
boolean | Whether availability checked applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].availabilityIssueType |
string | Availability issue type value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].canCheckout |
boolean | Whether checkout applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].cartItemId |
number | cart item identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].configurationDisplayGroups |
array | Prepared configuration display groups collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].displayName |
string | Display name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].fulfillmentMode |
string | Fulfillment mode value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].hasPersonalizationSurcharge |
boolean | Whether personalization surcharge applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].hasPrice |
boolean | Whether price applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].hasProductUrl |
boolean | Prepared has product URL; use unchanged. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].hasVariant |
boolean | Whether variant applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].imageMediaAssetId |
number | image media asset identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].imageUrl |
string | Prepared image URL; use unchanged. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].isPickupOnly |
boolean | Whether pickup only applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].lineTotalAmount |
number | line total amount; use the corresponding prepared label for display. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].lineTotalLabel |
string | Prepared line total display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].maxOrderQuantity |
number | Max order quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].minimumOrderQuantity |
number | Minimum order quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].name |
string | Name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].personalizationSurchargeAmount |
number | personalization surcharge amount; use the corresponding prepared label for display. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].personalizationSurchargeLabel |
string | Prepared personalization surcharge display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].productId |
number | product identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].productUrl |
string | Prepared product URL; use unchanged. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].productVariantId |
number | product variant identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].quantity |
number | Quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].sku |
string | Sku value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].unitPriceBaseLabel |
string | Prepared unit price base display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].unitPriceLabel |
string | Prepared unit price display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.items[].variantName |
string | Variant name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.cart.quantityTotal |
number | Quantity total numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.subtotalAmount |
number | subtotal amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.cart.subtotalLabel |
string | Prepared subtotal display text. | When the parent is provided; check optional fields. |
viewModel.checkout.customer |
object | Customer data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.customer.customerCompanyId |
number | customer company identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.customer.customerCompanyMemberId |
number | customer company member identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.customer.customerCompanyName |
string | Customer company name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.customer.customerMode |
string | Customer mode value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.customer.customerShopId |
number | customer shop identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.customer.customFields |
array | Prepared custom fields collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.customer.guestEmail |
string | Guest email value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.customer.hasCustomerContext |
boolean | Whether customer context applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.customer.isGuest |
boolean | Whether guest applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display |
object | Display data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.activeStep |
string | Active step value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth |
object | Auth data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.accountStatus |
string | Account status value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.activeView |
string | Active view value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.canGuestCheckout |
number | Can guest checkout numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.canOpenAddressStep |
boolean | Whether open address step applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.canOpenShippingStep |
boolean | Whether open shipping step applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.canRegister |
number | Can register numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.canRegisterCompany |
number | Can register company numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.canSwitchAddressMode |
boolean | Whether switch address mode applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.canUseCompanyAddress |
boolean | Whether use company address applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.companyCustomFieldGroups |
array | Prepared company custom field groups collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.companyName |
string | Company name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.hasStatusNotice |
boolean | Whether status notice applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.isPendingApproval |
boolean | Whether pending approval applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.isPendingVerification |
boolean | Whether pending verification applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.isRegisteredCheckout |
boolean | Whether registered checkout applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.loginEmail |
string | Login email value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.newsletterOptIn |
boolean | Whether newsletter opt in applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.registerAsCompany |
boolean | Whether register as company applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.registeredEmail |
string | Registered email value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.registerEmail |
string | Register email value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.showNewsletterOptIn |
number | Show newsletter opt in numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.statusNotice |
string | Status notice value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.urls |
object | Urls data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.urls.guestAddress |
string | Guest address value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.urls.guestSubmit |
string | Guest submit value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.urls.loginSubmit |
string | Login submit value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.urls.passwordReset |
string | Password reset value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.auth.urls.registerSubmit |
string | Register submit value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.cart |
object | Cart data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.cart.isEmpty |
boolean | Whether empty applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.cart.items |
array | Prepared items collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.cart.items[].configurationDisplayGroups |
array | Prepared configuration display groups collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].displayName |
string | Display name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].hasPersonalizationSurcharge |
boolean | Whether personalization surcharge applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].hasProductUrl |
boolean | Prepared has product URL; use unchanged. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].imageUrl |
string | Prepared image URL; use unchanged. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].isPickupOnly |
boolean | Whether pickup only applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].lineTotalLabel |
string | Prepared line total display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].personalizationSurchargeLabel |
string | Prepared personalization surcharge display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].productUrl |
string | Prepared product URL; use unchanged. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].quantity |
number | Quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].sku |
string | Sku value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].unitPriceBaseLabel |
string | Prepared unit price base display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].unitPriceLabel |
string | Prepared unit price display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.items[].variantName |
string | Variant name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.cart.subtotalLabel |
string | Prepared subtotal display text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.codes |
object | Codes data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.codes.couponCodes |
string | Coupon codes value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.codes.primaryCode |
string | Primary code value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.codes.voucherCodes |
string | Voucher codes value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.errors |
array | Prepared errors collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms |
object | Forms data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing |
object | Billing data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address |
object | Address data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.addressLine2 |
string | Address line2 value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.addressMode |
string | Address mode value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.city |
string | City value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.company |
string | Company value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.companyAddition |
string | Company addition value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.countryId |
number | country identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.countryLabel |
string | Prepared country display text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.firstName |
string | First name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.lastName |
string | Last name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.mobile |
string | Mobile value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.phone |
string | Phone value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.postcode |
string | Postcode value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.salutationId |
number | salutation identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.salutationLabel |
string | Prepared salutation display text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.street |
string | Street value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.streetNumber |
string | Street number value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.titleId |
number | title identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.address.titleLabel |
string | Prepared title display text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.companyAddressCustomFieldGroups |
array | Prepared company address custom field groups collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.countryId |
number | country identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.customerAddressCustomFieldGroups |
array | Prepared customer address custom field groups collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.hasSavedAddressSelection |
boolean | Whether saved address selection applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.mode |
string | Mode value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.salutationId |
number | salutation identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.sameAddressShippingCompanyAddressCustomFieldGroups |
array | Prepared same address shipping company address custom field groups collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.sameAddressShippingCustomerAddressCustomFieldGroups |
array | Prepared same address shipping customer address custom field groups collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.savedAddressOptions |
array | Prepared saved address options collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.savedAddressOptions[].addressId |
number | address identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.billing.savedAddressOptions[].customFieldGroups |
array | Prepared custom field groups collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.billing.savedAddressOptions[].customFields |
array | Prepared custom fields collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.billing.savedAddressOptions[].isDefaultBilling |
boolean | Whether default billing applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.billing.savedAddressOptions[].isDefaultShipping |
boolean | Whether default shipping applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.billing.savedAddressOptions[].label |
string | Label value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.billing.savedAddressOptions[].sameAsShippingCustomFieldGroups |
array | Prepared same as shipping custom field groups collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.billing.savedAddressOptions[].sameasshippingcustomfields |
array | Prepared sameasshippingcustomfields collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.billing.selectedSavedAddressId |
number | selected saved address identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.billing.titleId |
number | title identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.countryOptions |
array | Prepared country options collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.countryOptions[].countryId |
number | country identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.countryOptions[].isoCode |
string | Iso code value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.countryOptions[].isoCode3 |
string | Iso code3 value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.countryOptions[].label |
string | Label value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.countryOptions[].name |
string | Name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.customer |
object | Customer data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.customer.customFieldGroups |
array | Prepared custom field groups collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.customer.guestEmail |
string | Guest email value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.order |
object | Order data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.order.customFieldGroups |
array | Prepared custom field groups collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.salutationOptions |
array | Prepared salutation options collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.salutationOptions[].key |
string | Key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.salutationOptions[].label |
string | Label value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.salutationOptions[].name |
string | Name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.salutationOptions[].salutationId |
number | salutation identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.shipping |
object | Shipping data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address |
object | Address data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.addressLine2 |
string | Address line2 value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.addressMode |
string | Address mode value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.city |
string | City value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.company |
string | Company value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.companyAddition |
string | Company addition value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.countryId |
number | country identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.countryLabel |
string | Prepared country display text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.firstName |
string | First name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.lastName |
string | Last name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.mobile |
string | Mobile value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.phone |
string | Phone value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.postcode |
string | Postcode value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.salutationId |
number | salutation identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.salutationLabel |
string | Prepared salutation display text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.street |
string | Street value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.streetNumber |
string | Street number value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.titleId |
number | title identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.address.titleLabel |
string | Prepared title display text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.companyAddressCustomFieldGroups |
array | Prepared company address custom field groups collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.countryId |
number | country identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.customerAddressCustomFieldGroups |
array | Prepared customer address custom field groups collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.hasSavedAddressSelection |
boolean | Whether saved address selection applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.mode |
string | Mode value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.salutationId |
number | salutation identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.savedAddressOptions |
array | Prepared saved address options collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.savedAddressOptions[].addressId |
number | address identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.shipping.savedAddressOptions[].customFieldGroups |
array | Prepared custom field groups collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.shipping.savedAddressOptions[].customFields |
array | Prepared custom fields collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.shipping.savedAddressOptions[].isDefaultBilling |
boolean | Whether default billing applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.shipping.savedAddressOptions[].isDefaultShipping |
boolean | Whether default shipping applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.shipping.savedAddressOptions[].label |
string | Label value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.shipping.savedAddressOptions[].sameAsShippingCustomFieldGroups |
array | Prepared same as shipping custom field groups collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.shipping.selectedSavedAddressId |
number | selected saved address identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shipping.titleId |
number | title identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.shippingSameAsBilling |
boolean | Whether shipping same as billing applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.titleOptions |
array | Prepared title options collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.forms.titleOptions[].key |
string | Key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.titleOptions[].label |
string | Label value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.titleOptions[].name |
string | Name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.forms.titleOptions[].titleId |
number | title identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.hasErrors |
boolean | Whether errors applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels |
object | Labels data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.accountBenefitFastCheckout |
string | Translated account benefit fast checkout text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.accountBenefitLists |
string | Translated account benefit lists text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.accountBenefitOrders |
string | Translated account benefit orders text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.accountBenefitsTitle |
string | Translated account benefits title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.accountPendingApprovalNotice |
string | Translated account pending approval notice text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.accountPendingVerificationApprovalNotice |
string | Translated account pending verification approval notice text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.accountPendingVerificationNotice |
string | Translated account pending verification notice text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.addressLine2 |
string | Translated address line2 text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.addressTitle |
string | Translated address title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.adjustmentCoupon |
string | Translated adjustment coupon text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.adjustmentDiscount |
string | Translated adjustment discount text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.adjustmentPayment |
string | Translated adjustment payment text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.adjustmentShipping |
string | Translated adjustment shipping text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.adjustmentSurcharge |
string | Translated adjustment surcharge text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.adjustmentVoucher |
string | Translated adjustment voucher text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.backToCart |
string | Translated back to cart text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.backToHome |
string | Translated back to home text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.billingSummary |
string | Translated billing summary text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.city |
string | Translated city text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.cityRequired |
string | Translated city required text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.close |
string | Translated close text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.code |
string | Translated code text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.company |
string | Translated company text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.companyAddition |
string | Translated company addition text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.companyName |
string | Translated company name text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.companyNameRequired |
string | Translated company name required text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.contactPerson |
string | Translated contact person text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.contactSummary |
string | Translated contact summary text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.continue |
string | Translated continue text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.country |
string | Translated country text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.countryRequired |
string | Translated country required text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.couponCode |
string | Translated coupon code text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.couponCodes |
string | Translated coupon codes text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.customerNote |
string | Translated customer note text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.customerNotePlaceholder |
string | Translated customer note placeholder text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.customerTypeCompany |
string | Translated customer type company text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.customerTypePrivate |
string | Translated customer type private text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.deliverySummary |
string | Translated delivery summary text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.deliveryTime |
string | Translated delivery time text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.differentShippingAddress |
string | Translated different shipping address text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.editCart |
string | Translated edit cart text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.editSection |
string | Translated edit section text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.email |
string | Translated email text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.emailRequired |
string | Translated email required text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.emailSummary |
string | Translated email summary text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.emptyCart |
string | Translated empty cart text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.firstName |
string | Translated first name text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.firstNameRequired |
string | Translated first name required text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.giftCards |
string | Translated gift cards text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.goToAccount |
string | Translated go to account text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.guestSubmit |
string | Translated guest submit text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.guestUnavailable |
string | Translated guest unavailable text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.invoiceAmount |
string | Translated invoice amount text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.lastName |
string | Translated last name text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.lastNameRequired |
string | Translated last name required text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.loginSubmit |
string | Translated login submit text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.loginTitle |
string | Translated login title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.mobile |
string | Translated mobile text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.newAddress |
string | Translated new address text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.newsletterOptIn |
string | Translated newsletter opt in text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.noPaymentOptions |
string | Translated no payment options text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.noShippingOptions |
string | Translated no shipping options text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.number |
string | Translated number text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.orderAdditionalInformation |
string | Translated order additional information text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.orderReference |
string | Translated order reference text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.orderReferencePlaceholder |
string | Translated order reference placeholder text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.orderTotal |
string | Translated order total text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.password |
string | Translated password text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.passwordForgotten |
string | Translated password forgotten text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.passwordRepeat |
string | Translated password repeat text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.paymentSummary |
string | Translated payment summary text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.paymentTitle |
string | Translated payment title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.phone |
string | Translated phone text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.phoneSummary |
string | Translated phone summary text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.pickupOnlyBadge |
string | Translated pickup only badge text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.pickupOnlyNotice |
string | Translated pickup only notice text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.placeOrder |
string | Translated place order text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.postcode |
string | Translated postcode text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.postcodeRequired |
string | Translated postcode required text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.powerNumber |
string | Translated power number text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.price |
string | Translated price text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.product |
string | Translated product text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.quantity |
string | Translated quantity text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.redeem |
string | Translated redeem text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.registerAsCompany |
string | Translated register as company text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.registeredCheckoutText |
string | Translated registered checkout text text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.registeredCheckoutTitle |
string | Translated registered checkout title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.registerSubmit |
string | Translated register submit text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.registerTitle |
string | Translated register title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.registrationUnavailable |
string | Translated registration unavailable text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.reservationNotice |
string | Translated reservation notice text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.rounding |
string | Translated rounding text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.salutationRequired |
string | Translated salutation required text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.sameShippingAddress |
string | Translated same shipping address text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.savedBillingAddress |
string | Translated saved billing address text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.savedShippingAddress |
string | Translated saved shipping address text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.shippingAddressTitle |
string | Translated shipping address title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.shippingPricePending |
string | Translated shipping price pending text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.shippingSummary |
string | Translated shipping summary text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.shippingTitle |
string | Translated shipping title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.showLogin |
string | Translated show login text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.showRegister |
string | Translated show register text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.stepAddress |
string | Translated step address text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.stepLogin |
string | Translated step login text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.stepPayment |
string | Translated step payment text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.stepShipping |
string | Translated step shipping text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.stepSummary |
string | Translated step summary text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.street |
string | Translated street text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.streetNumber |
string | Translated street number text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.streetRequired |
string | Translated street required text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.summaryPageTitle |
string | Translated summary page title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.summarySubtotal |
string | Translated summary subtotal text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.summaryTax |
string | Translated summary tax text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.summaryTaxIncluded |
string | Translated summary tax included text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.summaryTitle |
string | Translated summary title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.termsConfirm |
string | Translated terms confirm text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.termsText |
string | Translated terms text text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.thankYouOrderNumber |
string | Translated thank you order number text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.thankYouText |
string | Translated thank you text text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.thankYouTitle |
string | Translated thank you title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.title |
string | Translated title text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.titleLabel |
string | Translated title label text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.total |
string | Translated total text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.voucherCode |
string | Translated voucher code text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.voucherCodes |
string | Translated voucher codes text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.labels.withoutSurcharge |
string | Translated without surcharge text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps |
object | Steps data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.address |
object | Address data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.address.isActive |
boolean | Whether active applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.address.key |
string | Key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.login |
object | Login data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.login.isActive |
boolean | Whether active applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.login.key |
string | Key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.payment |
object | Payment data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.payment.isActive |
boolean | Whether active applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.payment.key |
string | Key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.shipping |
object | Shipping data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.shipping.isActive |
boolean | Whether active applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.shipping.key |
string | Key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.summary |
object | Summary data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.summary.isActive |
boolean | Whether active applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.steps.summary.key |
string | Key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.submit |
object | Submit data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.submit.canSubmitOrder |
boolean | Whether submit order applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.submit.customerNote |
string | Customer note value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.submit.isDisabled |
boolean | Whether disabled applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.submit.orderReference |
string | Order reference value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.submit.termsAccepted |
boolean | Whether terms accepted applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary |
object | Summary data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.billingLines |
array | Prepared billing lines collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.cards |
array | Prepared cards collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.cards[].editLabel |
string | Prepared edit display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.summary.cards[].editUrl |
string | Prepared edit URL; use unchanged. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.summary.cards[].key |
string | Key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.summary.cards[].lines |
array | Prepared lines collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.summary.cards[].title |
string | Title value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.summary.contactName |
string | Contact name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.deliveryName |
string | Delivery name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.deliveryPriceLabel |
string | Prepared delivery price display text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.email |
string | Email value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.hasBillingAddress |
boolean | Whether billing address applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.hasShippingAddress |
boolean | Whether shipping address applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.paymentName |
string | Payment name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.paymentPriceLabel |
string | Prepared payment price display text. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.phone |
string | Phone value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.shippingLines |
array | Prepared shipping lines collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.summary.shippingSameAsBilling |
boolean | Whether shipping same as billing applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.terms |
object | Terms data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.terms.bodyHtml |
string | Prepared HTML; preserve the supplied markup. | When the parent is provided; check optional fields. |
viewModel.checkout.display.terms.isAvailable |
boolean | Whether available applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.terms.title |
string | Title value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.thankYou |
object | Thank you data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.thankYou.hasOrder |
boolean | Whether order applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.thankYou.orderId |
number | order identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.display.thankYou.orderNumber |
string | Order number value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.totals |
object | Totals data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.totals.hasLines |
boolean | Whether lines applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.display.totals.lines |
array | Prepared lines collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.display.totals.lines[].isGrandTotal |
boolean | Whether grand total applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.totals.lines[].key |
string | Key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.totals.lines[].kind |
string | Kind value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.totals.lines[].label |
string | Label value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.totals.lines[].valueLabel |
string | Prepared value display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.display.urls |
object | Urls data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.account |
string | Account value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.address |
string | Address value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.addressSubmit |
string | Address submit value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.cart |
string | Cart value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.codesSubmit |
string | Codes submit value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.guestAddress |
string | Guest address value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.guestSubmit |
string | Guest submit value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.home |
string | Home value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.login |
string | Login value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.orderSubmit |
string | Order submit value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.payment |
string | Payment value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.paymentSubmit |
string | Payment submit value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.registerSubmit |
string | Register submit value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.shipping |
string | Shipping value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.shippingSubmit |
string | Shipping submit value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.summary |
string | Summary value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.display.urls.thankYou |
string | Thank you value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.formOptions |
object | Form options data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.formOptions.countries |
array | Prepared countries collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.formOptions.countries[].countryId |
number | country identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.countries[].isoCode |
string | Iso code value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.countries[].isoCode3 |
string | Iso code3 value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.countries[].label |
string | Label value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.countries[].name |
string | Name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.salutations |
array | Prepared salutations collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.formOptions.salutations[].key |
string | Key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.salutations[].label |
string | Label value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.salutations[].name |
string | Name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.salutations[].salutationId |
number | salutation identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.titles |
array | Prepared titles collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.formOptions.titles[].key |
string | Key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.titles[].label |
string | Label value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.titles[].name |
string | Name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.formOptions.titles[].titleId |
number | title identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.orderCustomFields |
array | Prepared order custom fields collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.payment |
object | Payment data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.hasOptions |
boolean | Whether options applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.hasSelection |
boolean | Whether selection applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.hasValidSelection |
boolean | Whether valid selection applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.options |
array | Prepared options collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.options[].adjustmentAmount |
number | adjustment amount; use the corresponding prepared label for display. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].adjustmentDirection |
string | Adjustment direction value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].adjustmentGrossAmount |
number | adjustment gross amount; use the corresponding prepared label for display. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].adjustmentLabel |
string | Prepared adjustment display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].adjustmentNetAmount |
number | adjustment net amount; use the corresponding prepared label for display. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].adjustmentTaxAmount |
number | adjustment tax amount; use the corresponding prepared label for display. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].adjustmentTaxBreakdown |
array | Prepared adjustment tax breakdown collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].description |
string | Description value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].descriptionHtml |
string | Prepared HTML; preserve the supplied markup. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].hasAdjustment |
boolean | Whether adjustment applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].hasLogo |
boolean | Whether logo applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].isSelected |
boolean | Whether selected applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].logoFallbackInitial |
string | Logo fallback initial value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].logoMediaAssetId |
number | logo media asset identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].logoUrl |
string | Prepared logo URL; use unchanged. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].name |
string | Name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].paymentMethodId |
number | payment method identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].position |
number | Position numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].priceLabel |
string | Prepared price display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].providerKey |
string | Provider key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].providerMethodKey |
string | Provider method key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.options[].technicalKey |
string | Technical key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.payment.selectedOption |
object | Selected option data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.adjustmentAmount |
number | adjustment amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.adjustmentDirection |
string | Adjustment direction value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.adjustmentGrossAmount |
number | adjustment gross amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.adjustmentLabel |
string | Prepared adjustment display text. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.adjustmentNetAmount |
number | adjustment net amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.adjustmentTaxAmount |
number | adjustment tax amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.adjustmentTaxBreakdown |
array | Prepared adjustment tax breakdown collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.description |
string | Description value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.descriptionHtml |
string | Prepared HTML; preserve the supplied markup. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.hasAdjustment |
boolean | Whether adjustment applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.hasLogo |
boolean | Whether logo applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.isSelected |
boolean | Whether selected applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.logoFallbackInitial |
string | Logo fallback initial value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.logoMediaAssetId |
number | logo media asset identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.logoUrl |
string | Prepared logo URL; use unchanged. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.name |
string | Name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.paymentMethodId |
number | payment method identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.position |
number | Position numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.priceLabel |
string | Prepared price display text. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.providerKey |
string | Provider key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.providerMethodKey |
string | Provider method key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedOption.technicalKey |
string | Technical key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.payment.selectedPaymentMethodId |
number | selected payment method identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.reservation |
object | Reservation data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.reservation.expiresAt |
date or empty string | Reservation expiry timestamp. No prepared localized display label is supplied. | Populated for a reservation; otherwise empty. The reference package omits the expiry notice. |
viewModel.checkout.reservation.hasReservation |
boolean | Whether reservation applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals |
object | Review totals data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.adjustments |
array | Prepared adjustments collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.amountType |
string | Amount type value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.currencyDecimalPlaces |
number | Currency decimal places numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.currencyId |
number | currency identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.currencyIsoCode |
string | Currency iso code value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.currencyRoundingIncrement |
number | Currency rounding increment numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.currencySymbol |
string | Currency symbol value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.orderTotal |
object | Order total data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.orderTotal.amount |
number | Amount numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.orderTotal.grossAmount |
number | gross amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.orderTotal.hasValue |
boolean | Whether value applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.orderTotal.netAmount |
number | net amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.orderTotal.valueLabel |
string | Prepared value display text. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.payment |
object | Payment data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.payment.amount |
number | Amount numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.payment.grossAmount |
number | gross amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.payment.hasValue |
boolean | Whether value applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.payment.netAmount |
number | net amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.payment.valueLabel |
string | Prepared value display text. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.rejectedAdjustments |
array | Prepared rejected adjustments collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.rounding |
object | Rounding data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.rounding.amount |
number | Amount numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.rounding.grossAmount |
number | gross amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.rounding.hasValue |
boolean | Whether value applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.rounding.netAmount |
number | net amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.rounding.valueLabel |
string | Prepared value display text. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.shipping |
object | Shipping data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.shipping.amount |
number | Amount numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.shipping.grossAmount |
number | gross amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.shipping.hasValue |
boolean | Whether value applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.shipping.netAmount |
number | net amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.shipping.valueLabel |
string | Prepared value display text. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.subtotal |
object | Subtotal data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.subtotal.amount |
number | Amount numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.subtotal.grossAmount |
number | gross amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.subtotal.hasValue |
boolean | Whether value applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.subtotal.netAmount |
number | net amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.subtotal.valueLabel |
string | Prepared value display text. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.taxBreakdown |
array | Prepared tax breakdown collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.reviewTotals.totalTaxAmount |
number | total tax amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.savedAddresses |
object | Saved addresses data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.savedAddresses.available |
boolean | Whether available applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.savedAddresses.billingOptions |
array | Prepared billing options collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.savedAddresses.billingOptions[].addressId |
number | address identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.savedAddresses.billingOptions[].customFields |
array | Prepared custom fields collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.savedAddresses.billingOptions[].isDefaultBilling |
boolean | Whether default billing applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.savedAddresses.billingOptions[].isDefaultShipping |
boolean | Whether default shipping applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.savedAddresses.billingOptions[].label |
string | Label value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.savedAddresses.billingOptions[].sameasshippingcustomfields |
array | Prepared sameasshippingcustomfields collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.savedAddresses.selectedBillingAddressId |
number | selected billing address identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.savedAddresses.selectedShippingAddressId |
number | selected shipping address identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.savedAddresses.shippingOptions |
array | Prepared shipping options collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.savedAddresses.shippingOptions[].addressId |
number | address identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.savedAddresses.shippingOptions[].customFields |
array | Prepared custom fields collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.savedAddresses.shippingOptions[].isDefaultBilling |
boolean | Whether default billing applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.savedAddresses.shippingOptions[].isDefaultShipping |
boolean | Whether default shipping applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.savedAddresses.shippingOptions[].label |
string | Label value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.savedAddresses.sourceType |
string | Source type value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.selection |
object | Selection data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.selection.couponCodeList |
array | Prepared coupon code list collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.selection.couponCodes |
string | Coupon codes value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.selection.customerCustomFieldValues |
object | Customer custom field values data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.selection.paymentMethodId |
number | payment method identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.selection.requestedCouponCodes |
array | Prepared requested coupon codes collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.selection.requestedVoucherCodes |
array | Prepared requested voucher codes collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.selection.shopShippingMethodId |
number | shop shipping method identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.selection.voucherCodeList |
array | Prepared voucher code list collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.selection.voucherCodes |
string | Voucher codes value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping |
object | Shipping data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.hasOptions |
boolean | Whether options applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.hasSelection |
boolean | Whether selection applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.hasValidSelection |
boolean | Whether valid selection applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.options |
array | Prepared options collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.options[].amountType |
string | Amount type value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].currencyIsoCode |
string | Currency iso code value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].deliveryTimeName |
string | Delivery time name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].description |
string | Description value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].freeFromApplied |
boolean | Whether free from applied applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].hasPrice |
boolean | Whether price applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].isPickupMethod |
boolean | Whether pickup method applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].isSelected |
boolean | Whether selected applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].name |
string | Name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].position |
number | Position numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].priceAmount |
number | price amount; use the corresponding prepared label for display. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].priceGrossAmount |
number | price gross amount; use the corresponding prepared label for display. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].priceLabel |
string | Prepared price display text. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].priceNetAmount |
number | price net amount; use the corresponding prepared label for display. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].providerKey |
string | Provider key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].providerMethodKey |
string | Provider method key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].rateResolved |
boolean | Whether rate resolved applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].rateType |
string | Rate type value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].shippingMethodId |
number | shipping method identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].shippingMethodRateId |
number | shipping method rate identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].shopShippingMethodId |
number | shop shipping method identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].taxRateAmount |
number | tax rate amount; use the corresponding prepared label for display. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].taxRateId |
number | tax rate identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].taxRateName |
string | Tax rate name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.options[].technicalKey |
string | Technical key value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.checkout.shipping.requiresPickup |
boolean | Whether requires pickup applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption |
object | Selected option data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.amountType |
string | Amount type value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.currencyIsoCode |
string | Currency iso code value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.deliveryTimeName |
string | Delivery time name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.description |
string | Description value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.freeFromApplied |
boolean | Whether free from applied applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.hasPrice |
boolean | Whether price applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.isPickupMethod |
boolean | Whether pickup method applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.isSelected |
boolean | Whether selected applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.name |
string | Name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.position |
number | Position numeric value. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.priceAmount |
number | price amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.priceGrossAmount |
number | price gross amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.priceLabel |
string | Prepared price display text. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.priceNetAmount |
number | price net amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.providerKey |
string | Provider key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.providerMethodKey |
string | Provider method key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.rateResolved |
boolean | Whether rate resolved applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.rateType |
string | Rate type value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.shippingMethodId |
number | shipping method identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.shippingMethodRateId |
number | shipping method rate identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.shopShippingMethodId |
number | shop shipping method identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.taxRateAmount |
number | tax rate amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.taxRateId |
number | tax rate identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.taxRateName |
string | Tax rate name value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedOption.technicalKey |
string | Technical key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedShippingMethodId |
number | selected shipping method identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.shipping.selectedShopShippingMethodId |
number | selected shop shipping method identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.thankYou |
object | Thank you data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.checkout.thankYou.orderId |
number | order identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.checkout.thankYou.orderNumber |
string | Order number value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.checkout.thankYou.placedAt |
string | placed timestamp; may be empty. | When the parent is provided; check optional fields. |
viewModel.search |
object | Search data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.search.isEnabled |
boolean | Whether enabled applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.wishlist |
object | Wishlist data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.wishlist.isEmpty |
boolean | Whether empty applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.wishlist.itemCount |
number | Item count numeric value. | When the parent is provided; check optional fields. |
viewModel.wishlist.items |
array | Prepared items collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.wishlist.productIdMap |
object | Product id map data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.wishlist.productIds |
array | Prepared product ids collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.wishlist.wishlistId |
number | wishlist identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.wishlist.wishlistKey |
string | Wishlist key value supplied for this context. | When the parent is provided; check optional fields. |
Included templates
Section titled “Included templates”Assets
Section titled “Assets”The reference package uses its bundled theme CSS, Bootstrap and theme JavaScript. Account and checkout controls use the bundled checkout script. Additional page scripts: /theme/reference/checkout-js. Partials use their caller’s resolved assets.
Example
Section titled “Example”<cfset viewModel = routeConfig.viewModel><cfoutput><h1>#encodeForHtml(viewModel.page.title)#</h1></cfoutput>Use the page-specific structures above for the remaining content.
Behaviour
Section titled “Behaviour”Use prepared form actions, field names and CSRF inputs from the reference implementation. Access checks, validation and commerce decisions remain outside the theme.
Step-specific data
Section titled “Step-specific data”Use checkout.display.activeStep for login, address, shipping, payment, summary or thankYou presentation. Available actions are supplied by checkout.display.auth and checkout.display.submit; shipping and payment options depend on the cart and address. Do not infer eligibility from array length alone. The localized reservation expiry notice is a documented contract gap.