Cart preview: theme data reference
Reading the data tables. Presence varies by page and state; this is not a requirement to populate every field.
| Field | Type | Meaning | Availability |
|---|---|---|---|
viewModel.cartPreview |
object | Cart preview data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.cartPreview.amountType |
string | Amount type value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.cartPreview.cartId |
number | cart identifier; do not load data with it. | When the parent is provided; check optional fields. |
viewModel.cartPreview.cartKey |
string | Cart key value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.cartPreview.checkoutBlocked |
boolean | Whether checkout blocked applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.cartPreview.currencyIsoCode |
string | Currency iso code value supplied for this context. | When the parent is provided; check optional fields. |
viewModel.cartPreview.fulfillment |
object | Fulfillment data; check child fields before use. | When the parent is provided; check optional fields. |
viewModel.cartPreview.fulfillment.hasPickupOnlyItems |
boolean | Whether pickup only items applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.cartPreview.hasAvailabilityIssues |
boolean | Whether availability issues applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.cartPreview.hasNotReservedNotice |
boolean | Whether not reserved notice applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.cartPreview.hasPickupOnlyItems |
boolean | Whether pickup only items applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.cartPreview.hasPricingGaps |
boolean | Whether pricing gaps applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.cartPreview.isEmpty |
boolean | Whether empty applies; use for display only. | When the parent is provided; check optional fields. |
viewModel.cartPreview.itemCount |
number | Item count numeric value. | When the parent is provided; check optional fields. |
viewModel.cartPreview.items |
array | Prepared items collection; may be empty. | When the parent is provided; check optional fields. |
viewModel.cartPreview.items[].amountType |
string | Amount type value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availability |
object | Availability data; check child fields before use. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availability.alwaysAvailable |
boolean | Whether always available applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availability.availableQuantity |
number | Available quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availability.backorderAllowed |
boolean | Whether backorder allowed applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.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.cartPreview.items[].availability.hasInventoryItem |
boolean | Whether inventory item applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availability.isOrderable |
boolean | Whether orderable applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availability.maxOrderQuantity |
number | Max order quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availability.quantityOnHand |
number | Quantity on hand numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availability.requestedQuantity |
number | Requested quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availability.reservedQuantity |
number | Reserved quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availability.status |
string | Status value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availabilityChecked |
boolean | Whether availability checked applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].availabilityIssueType |
string | Availability issue type value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].canCheckout |
boolean | Whether checkout applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].cartItemId |
number | cart item identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].configurationDisplayGroups |
array | Prepared configuration display groups collection; may be empty. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].displayName |
string | Display name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].fulfillmentMode |
string | Fulfillment mode value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].hasPersonalizationSurcharge |
boolean | Whether personalization surcharge applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].hasPrice |
boolean | Whether price applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].hasProductUrl |
boolean | Prepared has product URL; use unchanged. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].hasVariant |
boolean | Whether variant applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.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.cartPreview.items[].imageUrl |
string | Prepared image URL; use unchanged. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].isPickupOnly |
boolean | Whether pickup only applies; use for display only. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.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.cartPreview.items[].lineTotalLabel |
string | Prepared line total display text. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].maxOrderQuantity |
number | Max order quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].minimumOrderQuantity |
number | Minimum order quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].name |
string | Name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.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.cartPreview.items[].personalizationSurchargeLabel |
string | Prepared personalization surcharge display text. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].productId |
number | product identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].productUrl |
string | Prepared product URL; use unchanged. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].productVariantId |
number | product variant identifier; do not load data with it. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].quantity |
number | Quantity numeric value. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].sku |
string | Sku value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].unitPriceBaseLabel |
string | Prepared unit price base display text. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].unitPriceLabel |
string | Prepared unit price display text. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.items[].variantName |
string | Variant name value supplied for this context. | For each existing item; optional child fields depend on item type. |
viewModel.cartPreview.quantityTotal |
number | Quantity total numeric value. | When the parent is provided; check optional fields. |
viewModel.cartPreview.subtotalAmount |
number | subtotal amount; use the corresponding prepared label for display. | When the parent is provided; check optional fields. |
viewModel.cartPreview.subtotalLabel |
string | Prepared subtotal display text. | When the parent is provided; check optional fields. |