Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
Products
Products (Vitrin)
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.vitrin.products.List Products
vitrin.products.list(params?)Old (used):
zid.store.product.fetchAll(filters)Arguments
params (object, optional):page? (number)page_size? (number)q? (string) — search querycategories? (string)price_min? (string), price_max? (string)on_sale? (boolean)attribute_values? (string[])Get Product
vitrin.products.get(product_id)Old:
zid.store.product.fetch(id)Get Product Options
vitrin.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)
vitrin.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)
vitrin.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[])Questions (Create)
vitrin.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)Customer Reviews (Mine)
vitrin.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.
Notes
attributes, option_fields, input_fields) are UUIDs from the product object. They are provided dynamically, you don’t hardcode them.Modified at 2025-09-01 14:13:01