Customer and forms

Customer state, account settings, hosted forms, notices, and phone choices.

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.customer#

The signed-in shopper and, when requested, their account addresses, orders, and routed receipt. Loaded when a section declares it in ctx_needs.

Field	Type	Requirement
`ctx.customer`	Object	Declared root
`ctx.customer.accepts_marketing`	Boolean	Required
`ctx.customer.account_url`	URL	Required
`ctx.customer.address_form`	Object	Optional
`ctx.customer.address_form.blank`	Object	Required
`ctx.customer.address_form.blank.address1`	String	Required
`ctx.customer.address_form.blank.address2`	String	Required
`ctx.customer.address_form.blank.address_type`	String	Required
`ctx.customer.address_form.blank.city`	String	Required
`ctx.customer.address_form.blank.company`	String	Required
`ctx.customer.address_form.blank.country`	String	Required
`ctx.customer.address_form.blank.country_code`	String	Required
`ctx.customer.address_form.blank.first_name`	String	Required
`ctx.customer.address_form.blank.id`	String	Required
`ctx.customer.address_form.blank.is_default`	Boolean	Required
`ctx.customer.address_form.blank.last_name`	String	Required
`ctx.customer.address_form.blank.phone`	String	Required
`ctx.customer.address_form.blank.postal_code`	String	Required
`ctx.customer.address_form.blank.province`	String	Required
`ctx.customer.address_form.blank.province_code`	String	Required
`ctx.customer.address_form.countries`	Array of object	Required
`ctx.customer.address_form.countries[].iso_code`	String	Required
`ctx.customer.address_form.countries[].labels`	Object	Optional
`ctx.customer.address_form.countries[].labels.city`	String	Required
`ctx.customer.address_form.countries[].labels.state`	String	Required
`ctx.customer.address_form.countries[].labels.zip`	String	Required
`ctx.customer.address_form.countries[].name`	String	Required
`ctx.customer.address_form.countries[].required`	Object	Optional
`ctx.customer.address_form.countries[].required.address`	Boolean	Required
`ctx.customer.address_form.countries[].required.city`	Boolean	Required
`ctx.customer.address_form.countries[].required.state`	Boolean	Required
`ctx.customer.address_form.countries[].required.zip`	Boolean	Required
`ctx.customer.address_form.countries[].selected`	Boolean	Required
`ctx.customer.address_form.countries[].subdivisions`	Array of object	Required
`ctx.customer.address_form.countries[].subdivisions[].code`	String	Required
`ctx.customer.address_form.countries[].subdivisions[].name`	String	Required
`ctx.customer.address_form.countries[].zip_example`	String	Optional
`ctx.customer.address_form.labels_by_country`	Object keyed by name	Required
`ctx.customer.address_form.labels_by_country.{key}`	Object	Dynamic key
`ctx.customer.address_form.labels_by_country.{key}.city`	String	Required
`ctx.customer.address_form.labels_by_country.{key}.state`	String	Required
`ctx.customer.address_form.labels_by_country.{key}.zip`	String	Required
`ctx.customer.address_form.required_by_country`	Object keyed by name	Required
`ctx.customer.address_form.required_by_country.{key}`	Object	Dynamic key
`ctx.customer.address_form.required_by_country.{key}.address`	Boolean	Required
`ctx.customer.address_form.required_by_country.{key}.city`	Boolean	Required
`ctx.customer.address_form.required_by_country.{key}.state`	Boolean	Required
`ctx.customer.address_form.required_by_country.{key}.zip`	Boolean	Required
`ctx.customer.address_form.subdivisions_by_country`	Object keyed by name	Required
`ctx.customer.address_form.subdivisions_by_country.{key}`	Array of object	Dynamic key
`ctx.customer.address_form.subdivisions_by_country.{key}[].code`	String	Required
`ctx.customer.address_form.subdivisions_by_country.{key}[].name`	String	Required
`ctx.customer.address_form.zip_example_by_country`	Object keyed by name	Required
`ctx.customer.address_form.zip_example_by_country.{key}`	String	Dynamic key
`ctx.customer.addresses`	Object	Optional
`ctx.customer.addresses.active`	Boolean	Required
`ctx.customer.addresses.items`	Array of object	Required
`ctx.customer.addresses.items[].address1`	String	Required
`ctx.customer.addresses.items[].address2`	String	Required
`ctx.customer.addresses.items[].address_type`	String	Required
`ctx.customer.addresses.items[].city`	String	Required
`ctx.customer.addresses.items[].company`	String	Required
`ctx.customer.addresses.items[].country`	String	Required
`ctx.customer.addresses.items[].country_code`	String	Required
`ctx.customer.addresses.items[].first_name`	String	Required
`ctx.customer.addresses.items[].id`	String	Required
`ctx.customer.addresses.items[].is_default`	Boolean	Required
`ctx.customer.addresses.items[].last_name`	String	Required
`ctx.customer.addresses.items[].name`	String	Required
`ctx.customer.addresses.items[].phone`	String	Required
`ctx.customer.addresses.items[].postal_code`	String	Required
`ctx.customer.addresses.items[].province`	String	Required
`ctx.customer.addresses.items[].province_code`	String	Required
`ctx.customer.addresses.next_url`	String	Required
`ctx.customer.addresses.page`	Integer	Required
`ctx.customer.addresses.page_size`	Integer	Required
`ctx.customer.addresses.pages`	Integer	Required
`ctx.customer.addresses.prev_url`	String	Required
`ctx.customer.addresses.query`	String	Required
`ctx.customer.addresses.search`	Object	Required
`ctx.customer.addresses.search.action`	URL	Required
`ctx.customer.addresses.search.hidden_fields`	Array of object	Required
`ctx.customer.addresses.search.hidden_fields[].name`	String	Required
`ctx.customer.addresses.search.hidden_fields[].value`	String	Required
`ctx.customer.addresses.search.query_param`	String	Required
`ctx.customer.addresses.total`	Integer	Required
`ctx.customer.addresses.type`	String	Required
`ctx.customer.addresses.types`	Array of object	Required
`ctx.customer.addresses.types[].selected`	Boolean	Required
`ctx.customer.addresses.types[].url`	URL	Required
`ctx.customer.addresses.types[].value`	String	Required
`ctx.customer.created_at`	Timestamp	Required
`ctx.customer.date_of_birth`	String	Optional
`ctx.customer.display_name`	String	Required
`ctx.customer.email`	String	Required
`ctx.customer.email_verified`	Boolean	Required
`ctx.customer.first_name`	String	Required
`ctx.customer.id`	String	Required
`ctx.customer.last_name`	String	Required
`ctx.customer.logged_in`	Boolean	Required
`ctx.customer.logout_url`	URL	Required
`ctx.customer.order`	Object	Optional
`ctx.customer.order.billing_address`	Address or null	Required; may be null
`ctx.customer.order.can_cancel`	Boolean	Required
`ctx.customer.order.channel_type`	String	Required
`ctx.customer.order.contact`	Object	Required
`ctx.customer.order.contact.email`	String	Required
`ctx.customer.order.contact.phone`	String	Required
`ctx.customer.order.created_at`	Timestamp	Required
`ctx.customer.order.financial_status`	String	Required
`ctx.customer.order.fulfillment_status`	String	Required
`ctx.customer.order.fulfillment_status_display`	String	Required
`ctx.customer.order.fulfillments`	Array of object	Required
`ctx.customer.order.fulfillments[].carrier`	String	Required
`ctx.customer.order.fulfillments[].created_at`	Timestamp	Required
`ctx.customer.order.fulfillments[].delivered_at`	Timestamp	Optional
`ctx.customer.order.fulfillments[].display_id`	String	Required
`ctx.customer.order.fulfillments[].events`	Array of object	Required
`ctx.customer.order.fulfillments[].events[].description`	String	Required
`ctx.customer.order.fulfillments[].events[].happened_at`	Timestamp	Required
`ctx.customer.order.fulfillments[].events[].happened_at_display`	String	Required
`ctx.customer.order.fulfillments[].events[].location`	String	Required
`ctx.customer.order.fulfillments[].events[].status`	String	Required
`ctx.customer.order.fulfillments[].events[].status_display`	String	Required
`ctx.customer.order.fulfillments[].id`	String	Required
`ctx.customer.order.fulfillments[].items`	Array of object	Required
`ctx.customer.order.fulfillments[].items[].order_item_id`	String	Required
`ctx.customer.order.fulfillments[].items[].quantity`	Integer	Required
`ctx.customer.order.fulfillments[].shipped_at`	Timestamp	Optional
`ctx.customer.order.fulfillments[].status`	String	Required
`ctx.customer.order.fulfillments[].status_display`	String	Required
`ctx.customer.order.fulfillments[].tracking_number`	String	Required
`ctx.customer.order.fulfillments[].tracking_url`	String	Required
`ctx.customer.order.id`	String	Required
`ctx.customer.order.items`	Array of object	Required
`ctx.customer.order.items[].compare_at_price`	Presented money	Optional
`ctx.customer.order.items[].discount_amount`	Presented money	Required
`ctx.customer.order.items[].duty_amount`	Presented money	Required
`ctx.customer.order.items[].fulfilled_quantity`	Integer	Required
`ctx.customer.order.items[].fulfillment_status`	String	Required
`ctx.customer.order.items[].has_tax`	Boolean	Required
`ctx.customer.order.items[].id`	String	Required
`ctx.customer.order.items[].image_url`	String	Required
`ctx.customer.order.items[].product_id`	Integer or null	Required; may be null
`ctx.customer.order.items[].proof_image_url`	URL	Optional
`ctx.customer.order.items[].quantity`	Integer	Required
`ctx.customer.order.items[].refunded_quantity`	Integer	Required
`ctx.customer.order.items[].requires_shipping`	Boolean	Required
`ctx.customer.order.items[].series`	Object	Optional
`ctx.customer.order.items[].series.count`	Integer	Required
`ctx.customer.order.items[].series.has_tax`	Boolean	Required
`ctx.customer.order.items[].series.index`	Integer	Required
`ctx.customer.order.items[].series.key`	String	Required
`ctx.customer.order.items[].series.quantity`	Integer	Required
`ctx.customer.order.items[].series.subtotal`	Presented money	Required
`ctx.customer.order.items[].series.tax_amount`	Presented money	Required
`ctx.customer.order.items[].sku`	String	Required
`ctx.customer.order.items[].tax_amount`	Presented money	Required
`ctx.customer.order.items[].title`	String	Required
`ctx.customer.order.items[].total`	Presented money	Required
`ctx.customer.order.items[].unit_price`	Presented money	Required
`ctx.customer.order.items[].variant_id`	Integer or null	Required; may be null
`ctx.customer.order.items[].variant_title`	String	Required
`ctx.customer.order.order_number`	String	Required
`ctx.customer.order.pricing`	Object	Required
`ctx.customer.order.pricing.checkout_fees`	Array of object	Required
`ctx.customer.order.pricing.checkout_fees[].amount`	Presented money	Required
`ctx.customer.order.pricing.checkout_fees[].has_tax`	Boolean	Required
`ctx.customer.order.pricing.checkout_fees[].id`	String	Required
`ctx.customer.order.pricing.checkout_fees[].name`	String	Required
`ctx.customer.order.pricing.checkout_fees[].source`	String	Required
`ctx.customer.order.pricing.checkout_fees[].tax_lines`	Array of object	Required
`ctx.customer.order.pricing.checkout_fees[].tax_lines[].amount`	Presented money	Required
`ctx.customer.order.pricing.checkout_fees[].tax_lines[].compounded`	Boolean	Required
`ctx.customer.order.pricing.checkout_fees[].tax_lines[].name`	String	Required
`ctx.customer.order.pricing.checkout_fees[].tax_lines[].rate`	Decimal string	Required
`ctx.customer.order.pricing.cod`	Object	Required
`ctx.customer.order.pricing.cod.amount`	Presented money	Required
`ctx.customer.order.pricing.cod.has_tax`	Boolean	Required
`ctx.customer.order.pricing.cod.tax_lines`	Array of object	Required
`ctx.customer.order.pricing.cod.tax_lines[].amount`	Presented money	Required
`ctx.customer.order.pricing.cod.tax_lines[].compounded`	Boolean	Required
`ctx.customer.order.pricing.cod.tax_lines[].name`	String	Required
`ctx.customer.order.pricing.cod.tax_lines[].rate`	Decimal string	Required
`ctx.customer.order.pricing.discount_total`	Presented money	Required
`ctx.customer.order.pricing.discounts`	Array of object	Required
`ctx.customer.order.pricing.discounts[].allocations`	Array of object	Required
`ctx.customer.order.pricing.discounts[].allocations[].amount`	Presented money	Required
`ctx.customer.order.pricing.discounts[].allocations[].is_free`	Boolean	Required
`ctx.customer.order.pricing.discounts[].allocations[].order_item_id`	String	Required
`ctx.customer.order.pricing.discounts[].allocations[].per_unit_amount`	Presented money	Required
`ctx.customer.order.pricing.discounts[].allocations[].product_id`	Integer	Required
`ctx.customer.order.pricing.discounts[].allocations[].quantity`	Integer	Required
`ctx.customer.order.pricing.discounts[].allocations[].variant_id`	Integer or null	Required; may be null
`ctx.customer.order.pricing.discounts[].amount`	Presented money	Required
`ctx.customer.order.pricing.discounts[].code`	String or null	Required; may be null
`ctx.customer.order.pricing.discounts[].id`	String	Required
`ctx.customer.order.pricing.discounts[].name`	String	Required
`ctx.customer.order.pricing.discounts[].source`	String	Required
`ctx.customer.order.pricing.discounts[].type`	String	Required
`ctx.customer.order.pricing.duty`	Object	Required
`ctx.customer.order.pricing.duty.collection_mode`	String	Required
`ctx.customer.order.pricing.duty.de_minimis_applied`	Boolean	Required
`ctx.customer.order.pricing.duty.eligible`	Boolean	Required
`ctx.customer.order.pricing.duty.has_amount`	Boolean	Required
`ctx.customer.order.pricing.duty.lines`	Array of object	Required
`ctx.customer.order.pricing.duty.lines[].amount`	Presented money	Required
`ctx.customer.order.pricing.duty.lines[].country_of_origin`	String	Required
`ctx.customer.order.pricing.duty.lines[].customs_value`	Presented money	Required
`ctx.customer.order.pricing.duty.lines[].dutiable`	Boolean	Required
`ctx.customer.order.pricing.duty.lines[].exclusion_reason`	String	Required
`ctx.customer.order.pricing.duty.lines[].harmonized_code`	String	Required
`ctx.customer.order.pricing.duty.lines[].matched_hs_code`	String	Required
`ctx.customer.order.pricing.duty.lines[].matched_origin`	String	Required
`ctx.customer.order.pricing.duty.lines[].product_id`	Integer	Required
`ctx.customer.order.pricing.duty.lines[].quantity`	Integer	Required
`ctx.customer.order.pricing.duty.lines[].rate_description`	String	Required
`ctx.customer.order.pricing.duty.lines[].variant_id`	Integer or null	Required; may be null
`ctx.customer.order.pricing.duty.overridden`	Boolean	Required
`ctx.customer.order.pricing.duty.total`	Presented money	Required
`ctx.customer.order.pricing.grand_total`	Presented money	Required
`ctx.customer.order.pricing.shipping`	Object	Required
`ctx.customer.order.pricing.shipping.amount`	Presented money	Required
`ctx.customer.order.pricing.shipping.has_tax`	Boolean	Required
`ctx.customer.order.pricing.shipping.method_id`	String	Required
`ctx.customer.order.pricing.shipping.name`	String	Required
`ctx.customer.order.pricing.shipping.tax_lines`	Array of object	Required
`ctx.customer.order.pricing.shipping.tax_lines[].amount`	Presented money	Required
`ctx.customer.order.pricing.shipping.tax_lines[].compounded`	Boolean	Required
`ctx.customer.order.pricing.shipping.tax_lines[].name`	String	Required
`ctx.customer.order.pricing.shipping.tax_lines[].rate`	Decimal string	Required
`ctx.customer.order.pricing.subtotal`	Presented money	Required
`ctx.customer.order.pricing.tax`	Object	Required
`ctx.customer.order.pricing.tax.address_missing`	Boolean	Required
`ctx.customer.order.pricing.tax.basis_applied`	String	Required
`ctx.customer.order.pricing.tax.checkout_fee_breakdowns`	Array of object	Required
`ctx.customer.order.pricing.tax.checkout_fee_breakdowns[].name`	String	Required
`ctx.customer.order.pricing.tax.checkout_fee_breakdowns[].tax_lines`	Array of object	Required
`ctx.customer.order.pricing.tax.checkout_fee_breakdowns[].tax_lines[].amount`	Presented money	Required
`ctx.customer.order.pricing.tax.checkout_fee_breakdowns[].tax_lines[].compounded`	Boolean	Required
`ctx.customer.order.pricing.tax.checkout_fee_breakdowns[].tax_lines[].name`	String	Required
`ctx.customer.order.pricing.tax.checkout_fee_breakdowns[].tax_lines[].rate`	Decimal string	Required
`ctx.customer.order.pricing.tax.cod_lines`	Array of object	Required
`ctx.customer.order.pricing.tax.cod_lines[].amount`	Presented money	Required
`ctx.customer.order.pricing.tax.cod_lines[].compounded`	Boolean	Required
`ctx.customer.order.pricing.tax.cod_lines[].name`	String	Required
`ctx.customer.order.pricing.tax.cod_lines[].rate`	Decimal string	Required
`ctx.customer.order.pricing.tax.exempt`	Boolean	Required
`ctx.customer.order.pricing.tax.has_tax`	Boolean	Required
`ctx.customer.order.pricing.tax.included`	Boolean	Required
`ctx.customer.order.pricing.tax.invoice_only`	Boolean	Required
`ctx.customer.order.pricing.tax.lines`	Array of object	Required
`ctx.customer.order.pricing.tax.lines[].amount`	Presented money	Required
`ctx.customer.order.pricing.tax.lines[].compounded`	Boolean	Required
`ctx.customer.order.pricing.tax.lines[].name`	String	Required
`ctx.customer.order.pricing.tax.lines[].rate`	Decimal string	Required
`ctx.customer.order.pricing.tax.shipping_lines`	Array of object	Required
`ctx.customer.order.pricing.tax.shipping_lines[].amount`	Presented money	Required
`ctx.customer.order.pricing.tax.shipping_lines[].compounded`	Boolean	Required
`ctx.customer.order.pricing.tax.shipping_lines[].name`	String	Required
`ctx.customer.order.pricing.tax.shipping_lines[].rate`	Decimal string	Required
`ctx.customer.order.pricing.tax.total`	Presented money	Required
`ctx.customer.order.pricing.tax.zone_unmatched`	Boolean	Required
`ctx.customer.order.requires_shipping`	Boolean	Required
`ctx.customer.order.shipping_address`	Address or null	Required; may be null
`ctx.customer.order.status`	String	Required
`ctx.customer.order.status_name`	String	Required
`ctx.customer.order.tenders`	Array of object	Required
`ctx.customer.order.tenders[].amount`	Presented money	Required
`ctx.customer.order.tenders[].kind`	String	Required
`ctx.customer.order.total_items`	Integer	Required
`ctx.customer.orders`	Object	Optional
`ctx.customer.orders.active`	Boolean	Required
`ctx.customer.orders.items`	Array of object	Required
`ctx.customer.orders.items[].channel_type`	String	Required
`ctx.customer.orders.items[].created_at`	Timestamp	Required
`ctx.customer.orders.items[].duty_estimate`	Object	Optional
`ctx.customer.orders.items[].duty_estimate.amount`	Presented money	Required
`ctx.customer.orders.items[].duty_estimate.collection_mode`	String	Required
`ctx.customer.orders.items[].financial_status`	String	Required
`ctx.customer.orders.items[].fulfillment_status`	String	Required
`ctx.customer.orders.items[].fulfillment_status_display`	String	Required
`ctx.customer.orders.items[].id`	String	Required
`ctx.customer.orders.items[].order_number`	String	Required
`ctx.customer.orders.items[].status`	String	Required
`ctx.customer.orders.items[].status_label`	Object	Required
`ctx.customer.orders.items[].status_label.name`	String	Required
`ctx.customer.orders.items[].status_label.slug`	String	Required
`ctx.customer.orders.items[].total`	Presented money	Required
`ctx.customer.orders.items[].total_items`	Integer	Required
`ctx.customer.orders.next_url`	String	Required
`ctx.customer.orders.page`	Integer	Required
`ctx.customer.orders.page_links`	Array of object	Required
`ctx.customer.orders.page_links[].current`	Boolean	Required
`ctx.customer.orders.page_links[].number`	Integer	Required
`ctx.customer.orders.page_links[].url`	URL	Required
`ctx.customer.orders.page_size`	Integer	Required
`ctx.customer.orders.pages`	Integer	Required
`ctx.customer.orders.prev_url`	String	Required
`ctx.customer.orders.query`	String	Required
`ctx.customer.orders.search`	Object	Required
`ctx.customer.orders.search.action`	URL	Required
`ctx.customer.orders.search.hidden_fields`	Array of object	Required
`ctx.customer.orders.search.hidden_fields[].name`	String	Required
`ctx.customer.orders.search.hidden_fields[].value`	String	Required
`ctx.customer.orders.search.query_param`	String	Required
`ctx.customer.orders.status`	String	Required
`ctx.customer.orders.statuses`	Array of object	Required
`ctx.customer.orders.statuses[].count`	Integer	Required
`ctx.customer.orders.statuses[].name`	String	Required
`ctx.customer.orders.statuses[].selected`	Boolean	Required
`ctx.customer.orders.statuses[].slug`	String	Required
`ctx.customer.orders.statuses[].url`	URL	Required
`ctx.customer.orders.total`	Integer	Required
`ctx.customer.orders_count`	Integer	Required
`ctx.customer.phone`	String	Required
`ctx.customer.phone_verified`	Boolean	Required

ctx.customer_settings#

Storefront-safe account, sign-in, registration, consent, and customer feature settings. Loaded when a section declares it in ctx_needs.

Field	Type	Requirement
`ctx.customer_settings`	Object	Declared root
`ctx.customer_settings.account_mode`	String	Required
`ctx.customer_settings.account_url`	URL	Required
`ctx.customer_settings.collect_checkout_marketing_consent`	Boolean	Required
`ctx.customer_settings.collect_marketing_consent`	Boolean	Required
`ctx.customer_settings.default_phone_country`	String	Required
`ctx.customer_settings.email_login_available`	Boolean	Required
`ctx.customer_settings.email_otp_enabled`	Boolean	Required
`ctx.customer_settings.guest_cart_duration_days`	Integer	Required
`ctx.customer_settings.guest_checkout_available`	Boolean	Required
`ctx.customer_settings.guest_wishlist_duration_days`	Integer	Required
`ctx.customer_settings.guest_wishlist_enabled`	Boolean	Required
`ctx.customer_settings.login_url`	URL	Required
`ctx.customer_settings.phone_login_available`	Boolean	Required
`ctx.customer_settings.phone_otp_enabled`	Boolean	Required
`ctx.customer_settings.phone_registration_available`	Boolean	Required
`ctx.customer_settings.preferred_auth_method`	String	Required
`ctx.customer_settings.privacy_request_url`	URL	Required
`ctx.customer_settings.register_url`	URL	Required
`ctx.customer_settings.registration_enabled`	Boolean	Required
`ctx.customer_settings.registration_fields`	Array of object	Required
`ctx.customer_settings.registration_fields[].field`	String	Required
`ctx.customer_settings.registration_fields[].required`	Boolean	Required
`ctx.customer_settings.registration_fields[].shown`	Boolean	Optional
`ctx.customer_settings.require_newsletter_double_opt_in`	Boolean	Required
`ctx.customer_settings.wishlist_enabled`	Boolean	Required
`ctx.customer_settings.wishlist_max_items`	Integer	Required

ctx.phone_countries#

Localized phone country options allowed by the store's customer settings. Loaded when a section declares it in ctx_needs.

Field	Type	Requirement
`ctx.phone_countries`	Array of object	Declared root
`ctx.phone_countries[].dial_code`	String	Required
`ctx.phone_countries[].example`	String	Required
`ctx.phone_countries[].flag`	String	Required
`ctx.phone_countries[].iso_code`	String	Required
`ctx.phone_countries[].name`	String	Required

ctx.forms#

Hosted-action field requirements and length or media limits. Loaded when a section declares it in ctx_needs.

Field	Type	Requirement
`ctx.forms`	Object	Declared root
`ctx.forms.comment`	Object	Required
`ctx.forms.comment.author_email`	Object	Required
`ctx.forms.comment.author_email.max_length`	Integer	Optional
`ctx.forms.comment.author_email.min_length`	Integer	Optional
`ctx.forms.comment.author_email.required`	Boolean	Required
`ctx.forms.comment.author_name`	Object	Required
`ctx.forms.comment.author_name.max_length`	Integer	Optional
`ctx.forms.comment.author_name.min_length`	Integer	Optional
`ctx.forms.comment.author_name.required`	Boolean	Required
`ctx.forms.comment.content`	Object	Required
`ctx.forms.comment.content.max_length`	Integer	Optional
`ctx.forms.comment.content.min_length`	Integer	Optional
`ctx.forms.comment.content.required`	Boolean	Required
`ctx.forms.contact`	Object	Required
`ctx.forms.contact.body`	Object	Required
`ctx.forms.contact.body.max_length`	Integer	Optional
`ctx.forms.contact.body.min_length`	Integer	Optional
`ctx.forms.contact.body.required`	Boolean	Required
`ctx.forms.contact.email`	Object	Required
`ctx.forms.contact.email.max_length`	Integer	Optional
`ctx.forms.contact.email.min_length`	Integer	Optional
`ctx.forms.contact.email.required`	Boolean	Required
`ctx.forms.contact.name`	Object	Required
`ctx.forms.contact.name.max_length`	Integer	Optional
`ctx.forms.contact.name.min_length`	Integer	Optional
`ctx.forms.contact.name.required`	Boolean	Required
`ctx.forms.contact.phone`	Object	Required
`ctx.forms.contact.phone.max_length`	Integer	Optional
`ctx.forms.contact.phone.min_length`	Integer	Optional
`ctx.forms.contact.phone.required`	Boolean	Required
`ctx.forms.contact.subject`	Object	Required
`ctx.forms.contact.subject.max_length`	Integer	Optional
`ctx.forms.contact.subject.min_length`	Integer	Optional
`ctx.forms.contact.subject.required`	Boolean	Required
`ctx.forms.newsletter`	Object	Required
`ctx.forms.newsletter.email`	Object	Required
`ctx.forms.newsletter.email.max_length`	Integer	Optional
`ctx.forms.newsletter.email.min_length`	Integer	Optional
`ctx.forms.newsletter.email.required`	Boolean	Required
`ctx.forms.review`	Object	Required
`ctx.forms.review.allow_images`	Boolean	Optional
`ctx.forms.review.content`	Object	Required
`ctx.forms.review.content.max_length`	Integer	Optional
`ctx.forms.review.content.min_length`	Integer	Optional
`ctx.forms.review.content.required`	Boolean	Required
`ctx.forms.review.guests_allowed`	Boolean	Optional
`ctx.forms.review.max_images`	Integer	Optional
`ctx.forms.review.purchase_required`	Boolean	Optional
`ctx.forms.review.reviewer_email`	Object	Required
`ctx.forms.review.reviewer_email.max_length`	Integer	Optional
`ctx.forms.review.reviewer_email.min_length`	Integer	Optional
`ctx.forms.review.reviewer_email.required`	Boolean	Required
`ctx.forms.review.reviewer_name`	Object	Required
`ctx.forms.review.reviewer_name.max_length`	Integer	Optional
`ctx.forms.review.reviewer_name.min_length`	Integer	Optional
`ctx.forms.review.reviewer_name.required`	Boolean	Required
`ctx.forms.review.title`	Object	Required
`ctx.forms.review.title.max_length`	Integer	Optional
`ctx.forms.review.title.min_length`	Integer	Optional
`ctx.forms.review.title.required`	Boolean	Required

ctx.auth_form#

Safe hosted-auth form replay state after a submission. Available after the related hosted action redirects back with a result. Declare it in ctx_needs before reading it.

Field	Type	Requirement
`ctx.auth_form`	Object	Declared root
`ctx.auth_form.email`	String	Optional
`ctx.auth_form.otp_step`	String	Optional
`ctx.auth_form.phone_method`	String	Optional
`ctx.auth_form.phone_number`	String	Optional
`ctx.auth_form.provider`	String	Optional
`ctx.auth_form.purpose`	String	Optional

ctx.form_error#

A localized validation error returned by a hosted form. Available after the related hosted action redirects back with a result. Declare it in ctx_needs before reading it.

Field	Type	Requirement
`ctx.form_error`	Message	Declared root

ctx.auth_notice#

A localized sign-in or registration status message. Available after the related hosted action redirects back with a result. Declare it in ctx_needs before reading it.

Field	Type	Requirement
`ctx.auth_notice`	Message	Declared root

ctx.form_notice#

A localized post-redirect result from a hosted storefront action. Available after the related hosted action redirects back with a result. Declare it in ctx_needs before reading it.

Field	Type	Requirement
`ctx.form_notice`	Object	Declared root
`ctx.form_notice.code`	String	Required
`ctx.form_notice.message`	String	Required
`ctx.form_notice.success`	Boolean	Required