Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
Products
This page documents the new Vitrin product functions and explains the arguments needed to use them (with the matching old Zid call where relevant).
window.zid.products.Get Product
zid.products.get(product_id)Old:
zid.store.product.fetch(id)Get Product Options
zid.products.getProductOptions(product_id, params?)Arguments
product_id (string, required) — Product identifier.params (object, optional):attributes (object) — Map of attribute_id → attribute_value_id (UUIDs).option_fields (object) — Map of option_group_id → array of selected option_ids (UUIDs).input_fields (string[]) — Array of input_field_ids (UUIDs) that currently have values.Example params (placeholders)
IDs come from the product object (all are UUIDs).
Reviews (Read)
zid.products.reviews(product_id, { page?, page_size? })Old:
zid.store.product.getReviews(id, page)Arguments
product_id (string, required)params (object, optional):page? (number)page_size? (number)Reviews (Create)
zid.products.createReview(product_id, payload)Old:
zid.store.product.addReview(id, reviewForm, rating, is_anonymous)Arguments
product_id (string, required)payload (object, required):rating (number, required) — 1..5comment? (string)is_anonymous? (boolean)order_id? (string)images? (File[])Customer Reviews (Mine)
zid.products.getCustomerReviews({ product_id })Old:
zid.store.product.getCustomerReviews(id, orderId)Arguments
params (object, required):product_id (string, required)Change: orderIdis not used in the new API.
Questions (List)
zid.products.questions(product_id, params?)Parameters
product_id (string, required) — Product identifier.params (object, optional) — Optional query parameters:page (number) — Page number for pagination.page_size (number) — Number of questions per page.Questions (Create)
zid.products.createQuestion(product_id, payload)Old (used):
zid.store.product.addQuestion(id, question, name, email, is_anonymous)Arguments
product_id (string, required)payload (object, required):name (string, required)email (string, required)question (string, required)is_anonymous? (boolean)Bundle Offer (List)
zid.products.bundleOffers(params?)Old (used):
zid.store.product.getProductBundleOffer(id)Arguments
params (object, optional):product_ids (array, optional)Example params (placeholders)
Stock Alerts
zid.products.stockAlerts({ product_id }, payload)Parameters
product_id (string, required) — Product identifier.payload (object, required) — Subscription details containing customer information.Payload Structure
customer_email (string, required) — Customer's email address for notifications.customer_phone_number (string, optional) — Customer's phone number.customer_name (string, optional) — Customer's name.Get Bundle Offer (Single Product)
zid.products.getBundleOffer(product_id)Parameters
product_id (string, required) — Product identifier.Notes
attributes, option_fields, input_fields) are UUIDs from the product object. They are provided dynamically, you don’t hardcode them.Modified at 2025-10-20 14:47:10