These pages list the exact data fields available to hosted Vascula themes. Add a root name such as product to a section's ctx_needs, then read it directly as product.title in the template. The ctx. prefix shown here identifies the public contract; do not include that prefix in a Vascula expression. Required fields are present whenever their containing object is present. Optional fields may be absent, and nullable fields may be present as null. [] marks an array item and {key} marks a key selected at runtime. Named types such as Price and Media are detailed on Shared data shapes.
ctx.cart#
The current cart. Header use receives counts; rich cart surfaces receive line, price, discount, limit, and shipping data. Loaded when a section declares it in ctx_needs.
Field |
Type |
Requirement |
|---|---|---|
|
Object |
Declared root |
|
Array of object |
Optional |
|
Number |
Optional |
|
Decimal string |
Optional |
|
String |
Optional |
|
Integer |
Optional |
|
Integer |
Optional |
|
String |
Optional |
|
Number |
Optional |
|
String |
Required |
|
Boolean |
Required |
|
Timestamp |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Required |
|
String |
Optional |
|
Boolean |
Required |
|
String |
Required |
|
Decimal string |
Optional |
|
String |
Required |
|
Decimal string |
Required |
|
String |
Optional |
|
String |
Optional |
|
Decimal string |
Optional |
|
String |
Required |
|
Number |
Optional |
|
Object |
Optional |
|
Boolean |
Required |
|
Boolean |
Required |
|
Money input |
Optional |
|
Money input |
Optional |
|
Boolean |
Required |
|
Money input |
Optional |
|
Boolean |
Required |
|
Money input |
Optional |
|
Boolean |
Required |
|
Array of string |
Optional |
|
String |
Optional |
|
Array of object |
Optional |
|
Object |
Optional |
|
Array of object |
Required |
|
Cart media or null |
Required; may be null |
|
Integer |
Required |
|
Integer |
Required |
|
String |
Required |
|
Presented money or null |
Required; may be null |
|
URL |
Required |
|
Integer or null |
Required; may be null |
|
Presented money or null |
Required; may be null |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
Object |
Optional |
|
Boolean |
Required |
|
Boolean |
Required |
|
String |
Required |
|
Integer |
Required |
|
Integer |
Required |
|
String |
Required |
|
Presented money |
Optional |
|
Array of object |
Optional |
|
String |
Required |
|
Decimal string |
Required |
|
String |
Optional |
|
Boolean |
Required |
|
String |
Optional |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Optional |
|
String |
Required |
|
String |
Optional |
|
Object |
Optional |
|
Integer |
Required |
|
Boolean |
Required |
|
Money input |
Required |
|
Money input |
Required |
|
Money input |
Required |
|
Array of object |
Optional |
|
Integer |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
Object or null |
Required; may be null |
|
Integer |
Required |
|
Cart media or null |
Required; may be null |
|
String or null |
Required; may be null |
|
String or null |
Required; may be null |
|
String or null |
Required; may be null |
|
Integer |
Required |
|
Integer |
Required |
|
Integer |
Required |
|
Object or null |
Required; may be null |
|
Integer |
Required |
|
Cart media or null |
Required; may be null |
|
Array of object |
Required |
|
String |
Required |
|
String |
Required |
|
String or null |
Required; may be null |
|
String or null |
Required; may be null |
|
Integer or null |
Required; may be null |
|
Array of object |
Optional |
|
String |
Required |
|
String |
Required |
|
Integer |
Required |
|
Array of object |
Optional |
|
String or null |
Required; may be null |
|
String |
Optional |
|
Boolean |
Required |
|
Integer |
Required |
|
Object or null |
Required; may be null |
|
String or null |
Required; may be null |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
Boolean |
Required |
|
Boolean |
Required |
|
Presented money or null |
Required; may be null |
|
String |
Required |
|
Presented money or null |
Required; may be null |
|
Integer or null |
Required; may be null |
|
Integer or null |
Required; may be null |
|
Boolean |
Required |
|
Boolean |
Required |
|
Object or null |
Required; may be null |
|
Integer |
Required |
|
Cart media or null |
Required; may be null |
|
String or null |
Required; may be null |
|
String or null |
Required; may be null |
|
String or null |
Required; may be null |
|
Integer |
Required |
|
Line properties or null |
Required; may be null |
|
Array of object |
Optional |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
Integer |
Required |
|
Boolean |
Required |
|
Integer or null |
Required; may be null |
|
Integer or null |
Required; may be null |
|
Presented money or null |
Required; may be null |
|
Presented money or null |
Required; may be null |
|
Boolean |
Required |
|
Object |
Optional |
|
Integer |
Required |
|
Integer |
Required |
|
String |
Required |
|
Cart media |
Optional |
|
Integer |
Required |
|
Money input |
Optional |
|
String or null |
Optional; may be null |
|
String or null |
Optional; may be null |
|
URL |
Optional |
|
Presented money or null |
Required; may be null |
|
Presented money or null |
Required; may be null |
|
Object or null |
Required; may be null |
|
Integer |
Required |
|
Cart media or null |
Required; may be null |
|
Array of object |
Required |
|
String |
Required |
|
String |
Required |
|
String or null |
Required; may be null |
|
String or null |
Required; may be null |
|
Integer or null |
Required; may be null |
|
String |
Optional |
|
Integer |
Optional |
|
Array of object |
Optional |
|
Presented money |
Optional |
|
String ( |
Required |
|
String |
Required |
|
String ( |
Required |
|
String |
Required |
|
String |
Required |
|
Decimal string |
Optional |
|
Boolean |
Required |
|
Presented money |
Optional |
|
Presented money |
Optional |
|
Integer |
Required |
ctx.wishlist#
The visitor's wishlist state and, for rich surfaces, its sellable product rows. Loaded when a section declares it in ctx_needs.
Field |
Type |
Requirement |
|---|---|---|
|
Object |
Declared root |
|
Boolean |
Required |
|
String or null |
Required; may be null |
|
Integer |
Required |
|
Array of object |
Optional |
|
String or null |
Required; may be null |
|
String |
Optional |
|
Boolean |
Required |
|
String |
Optional |
|
Boolean |
Required |
|
Boolean |
Required |
|
Presented money |
Optional |
|
Object or null |
Required; may be null |
|
Boolean |
Optional |
|
String or null |
Optional; may be null |
|
URL or null |
Optional; may be null |
|
Media or null |
Optional; may be null |
|
Integer |
Required |
|
String |
Optional |
|
Boolean |
Optional |
|
Object or null |
Required; may be null |
|
String or null |
Required; may be null |
|
Boolean |
Required |
|
URL |
Required |
|
Metafields |
Optional |
|
Array of listing option |
Optional |
|
Price or null |
Optional; may be null |
|
Price range or null |
Optional; may be null |
|
Timestamp or null |
Optional; may be null |
|
String |
Optional |
|
Rating |
Optional |
|
Integer |
Optional |
|
Media or null |
Optional; may be null |
|
Object |
Optional |
|
Object |
Required |
|
Integer |
Required |
|
Integer |
Required |
|
Integer |
Required |
|
Integer |
Required |
|
Object |
Required |
|
Integer |
Required |
|
Boolean |
Required |
|
Integer |
Required |
|
Boolean |
Required |
|
String or null |
Optional; may be null |
|
String or null |
Required; may be null |
|
String or null |
Required; may be null |
|
String |
Optional |
|
URL |
Optional |
|
Array of object |
Optional |
|
Boolean |
Required |
|
Integer |
Required |
|
Object |
Optional |
|
Money input |
Required |
|
Boolean |
Required |
|
Money input |
Required |
|
Array of object |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
Object |
Optional |
|
Object |
Required |
|
Integer |
Required |
|
Integer |
Required |
|
Integer |
Required |
|
Integer |
Required |
|
Object |
Required |
|
Integer |
Required |
|
Boolean |
Required |
|
Integer |
Required |
|
Boolean |
Required |
|
String |
Required |
|
String or null |
Optional; may be null |
|
URL or null |
Optional; may be null |
|
Integer |
Required |
|
Line properties |
Optional |
|
String |
Required |
|
Object or null |
Required; may be null |
|
Integer |
Required |
|
Object or null |
Required; may be null |
|
String or null |
Required; may be null |
|
Boolean |
Required |
|
URL |
Required |
|
Array of object |
Required |
|
String |
Required |
|
String |
Required |
|
String or null |
Required; may be null |
|
String or null |
Required; may be null |
|
Integer or null |
Required; may be null |
|
Boolean |
Required |
ctx.reviews#
Product review availability, aggregates, filters, and approved review rows. Loaded when a section declares it in ctx_needs.
Field |
Type |
Requirement |
|---|---|---|
|
Object |
Declared root |
|
Boolean |
Required |
|
Boolean |
Optional |
|
Array of object |
Optional |
|
String |
Required |
|
String |
Required |
|
Timestamp |
Required |
|
Boolean |
Required |
|
Integer |
Required |
|
String |
Required |
|
Array of object |
Optional |
|
Integer |
Required |
|
URL |
Required |
|
Integer |
Required |
|
Boolean |
Required |
|
Integer |
Required |
|
String |
Required |
|
Object |
Optional |
|
String |
Required |
|
String |
Optional |
|
Timestamp |
Optional |
|
String |
Optional |
|
Integer |
Required |
|
Integer |
Optional |
|
Boolean |
Required |
|
Integer |
Optional |
|
Integer |
Optional |
|
Integer |
Optional |
|
String |
Optional |
|
Object |
Optional |
|
Number |
Required |
|
Integer |
Required |
|
Object keyed by name |
Required |
|
Integer |
Dynamic key |
|
Integer |
Optional |
ctx.store_reviews#
Store-wide approved reviews with product links and pagination. Loaded when a section declares it in ctx_needs.
Field |
Type |
Requirement |
|---|---|---|
|
Object |
Declared root |
|
Boolean |
Required |
|
Array of object |
Optional |
|
String |
Required |
|
String |
Required |
|
Timestamp |
Required |
|
Boolean |
Required |
|
Integer |
Required |
|
String |
Required |
|
Array of object |
Optional |
|
Integer |
Required |
|
URL |
Required |
|
Integer |
Required |
|
Boolean |
Required |
|
Object |
Required |
|
Integer |
Required |
|
String |
Required |
|
URL |
Required |
|
Integer |
Required |
|
String |
Required |
|
Object |
Optional |
|
String |
Required |
|
String |
Optional |
|
Timestamp |
Optional |
|
String |
Optional |
|
Integer |
Required |
|
Integer |
Optional |
|
Boolean |
Required |
|
Integer |
Optional |
|
Integer |
Optional |
|
String |
Optional |
|
Object |
Optional |
|
Number |
Required |
|
Integer |
Required |
|
Object keyed by name |
Required |
|
Integer |
Dynamic key |
|
Integer |
Optional |
|
Integer |
Optional |