Themes
Copy Page
Zid Docs
Default module
Payment API
Our custom MCP server
Overview
Merchant Activation
Payment
Overview
Embedded Payment
Gateway Error Codes
Direct Payment
Execute Payment Request
Get payment status
ApplePay
ApplePay Checkout
Register ApplePay Domain
Providing Merchant Validation
Refund
Request Refund
Webhooks
Overview
Link Merchant Event
Payment Paid Event
Refund Event
Apps
🗂️ Overview
🚀 Start Here
Create your First App
Responses
Rate Limiting
Authorization
StoreFront Events
Zid MUI
Zid SDKs
Merchant APIs
Orders
Create Order
Change Order Status
Add Order Comment
Bulk Create/Update Custom Statuses
View Order
List Orders
List Custom Order Statuses
List Order Credit Notes
Reverse Orders
Create Reverse Orders
Create Reverse Orders Waybill
Add Reverse Order Reasons
List Reverse Reasons
Calculate Reverse Totals
Create refund for reverse order
Upload bank transfer receipt
Update return products
Order Details – View for Return
Abandoned Carts
List Carts
View Cart
Products
Managing Products
List Products
View Product
List Product Settings
Create Product
Update Product
Bulk Update Products
Delete Product
Digital Vouchers
List Vouchers
Order Vouchers
Create Voucher
Import Vouchers
Export Vouchers
Update Voucher
Remove Voucher
Product Categories
List Categories
View Category
Create Category
Create Subcategory
Update Category
Assign Product to Category
Bulk Assign Products to Category
Publish Category
Detach Category from All Products
Remove Product from Category
Product Badge
List Badges
Product Attributes
List Attributes
List Product Attributes for Product
View Attribute
Create Attribute
Create Product Attribute for Product
Update Attribute
Delete Attribute
Product Attribute Presets
List Presets
Create Preset
Update Preset
Delete Preset
Product Variants
Add Product Variants Copy
Create Variants
Create Custom Option
Update Custom Option
Delete Custom Option Field
Create Custom Input Field
Update Custom Input Field
Delete Custom Input Field
Product Sorting
Set Manual Product Order
Reset Manual Product Order
Product Images
List Images
Upload Image
Update Image Order
Delete Image
Product Availability Notifications
Notification Stats
Noticiation Settings
List Notifications
Create Notification
Update Settings
Send Notification Email
Export Notifications
Product Export
Email All Products to Store Owner
Import Products via CSV or xlsx File
Product Stock
Retrieve Product Stock
List Product Stock Records
Create Product Stock
Update Product Stock
Bulk Update Product Stock Records
Product Questions & Answers
Retrieve Product Question
Retrieve Product Answer
List Product Questions
List Answers for Question
Create Product Question
Create Product Answer
Update Product Question
Update Product Answer
Delete Product Question
Delete Product Answer
Product Reviews
List Reviews
Count Reviews
Update Review Status
Bulk Update Review Statuses
Delete Review
Import Product Reviews
Reply to Review
Delete Reply
Update Reply to Review
Digital Products
Create Downloadable Product
Generate Upload URL
Upload File to S3
Create Product Downloadable
Get Product Downloadables
Delete Product Downloadable
List Store Downloadables
Create Store Downloadable
Delete Store Downloadable
Inventories
Create Location
Update Location
Update Product Stock for Location
List Locations
View Location
Shipping
List Store Shipping Methods
Add Shipping Option
Marketing
Gift Cards
Apply Gift Card to Cart
Remove Gift Card from Cart
Get Store Settings
Update Gift Card Settings
Upload Gift Card Designs
Coupons
List Coupons
View Coupon
Create Coupon
Update Coupon
Delete Coupon
Bundle Offers
List Bundle Offers
Loyalty Program
Customer Wallet
Customer Points
Calculate Loyalty Points for Order
Retrieve Store Loyalty Status
Redemption Methods
Cashback Rules
Add Redemption to Cart
Remove Redemption from Cart
Arc | Retrieve Loyalty Info Page
Loyalty Program Status
Loyalty Program Details
Loyalty Program Info
Customer Loyalty Summary
Customer Points History
Activate Loyalty Program
Set Points Expiration Rules
Update Cashback Rule
Create Points Redemption Method
Update Points Redemption Method
Delete Points Redemption Method
Adjust Customer Points
Update Cashback Rule Status
Update Redemption Method Status
Update Loyalty Info Page
Customers
List Customers
View Customer
Store Settings
📄 User Roles and Permissions
Retrieve Store Manager Profile
Retrieve VAT Settings
List Payment Methods
List Store Operating Countries
Countries and Cities
List Countries
List Cities for Country
Webhooks
Overview
Events
Order
Product
Abandoned Cart
Customer
Product Category
APIs
List Webhooks
Create Webhook
Delete Webhook
Delete Webhook By subscriber
App Management
Embedded Apps
Events
APIs
Subscription Details
Update Usage-Based Charges
MCP
MCP
Orders Management
Products Management
Categories Management
Product Attributes & Customization
Inventory & Locations
Customer Engagement & Analytics
Digital Products & Downloadables
Geographic Data & Shipping
Bulk Operations & Export Functions
Product Vouchers & Digital Codes
Product Images & Media Management
Product Badges & Settings
Rough 1
Rough
Vitrin Copy
Getting Started
Introduction
Theme Development
🔁 Vitrin Changelog
Creating and Managing Theme Presets
Legacy Theme Migration
Store Settings Mapping
Moving to Vitrin Using LLMs
Twig to Jinja
Breaking Changes
Key Concepts
Architecture
Theme Editor
Templates
Overview
Overridable Templates
Legacy Templates
Template Replacements
Templates Library
home.jinja
product.jinja
cart.jinja
category.jinja
products.jinja
categories.jinja
page.jinja
blog.jinja
faqs.jinja
reviews.jinja
questions.jinja
shipping_payment.jinja
404_not_found.jinja
Settings
Input Settings
Media Settings
Form Controls Settings
Products Settings
Additional Settings
Conditional Visibility
Migrating twig settings schema
Schema files
Localization
localization (jinja v. twig)
Building with Vitrin
Jinja Basics
Vitrin's Jinja Extensions
Objects Reference
Common pitfalls
Vitrin CLI
Introduction
CLI Commands
Tips & Tricks
Performance
JS Integration
Cart
Products
Responses & Errors
Categories
Store
Account
Supporting both Vitrin and Legacy themes
Blogs
Options
Events
Features
Gift Card as a Popup
Login as a Popup
Custom Styles Guide
Addresses as a Popup
Checkout as a Popup
Apple Pay Quick Checkout
Region & Language Popup
Dynamic bundle products
SDK Popups – Integration Guidelines
Select Branch Dialog
Mobile Apps
Scripts
API's
Authentication
Logout
Products
List Products
Search Products
Calculate Product Options Price
Notify Product Stock Availability
Fetch Bundle Offers
Fetch Bundle Offers for a Product
List My Product Reviews
List Product Reviews
Create Product Review
Update Product Review
Delete Product Review
List Product Questions
Create Product Question
Get Product by Slug
Get Selection Groups
Categories
List Categories
Checkout
Get Cart
Remove Cart
Duplicate Cart
Add Cart Item
Empty Cart
Update Cart Item
Remove Cart Item
Upload Cart Input Field
Add Gift Card
Remove Gift Card
Apply Coupon
Remove Coupon From Cart
Check Coupon Validity
Apply Loyalty Points
Remove Loyalty Points
Preview Rewarded Points
List Redemption Methods for Cart
Customer’s Loyalty Wallet
Customer’s Current Points Balance
Account
Get Profile
Delete Account
Update Customer Profile
Get Addresses
Create an Address
Get an Address by ID
Update an Existing Address
Delete Address
Get Orders
Get Shareable Wishlist Link
Get Wishlist
Add Products to Wishlist
Remove Product from Wishlist
Get Address Form Schema
Check Product Purchase Status
Storefront
Store Settings
Store Scripts
Pages
Blogs
Countries
Get Countries
Get Cities By Country
Themes
🚨 Important Update: Zid Themes
Adding Video URL Feature to Third-Party Themes
Getting Started with Zid Themes
Introduction to Theme Development
Manage your Themes
Building Themes in Zid
Theme File Structure
Twig Syntax and Features
Zid Theme Packager
Landing Page Development
Templates
Layout
Home Page
Products
Cart
Store Language and Currency
Settings Schema
Text
Number
Text-Area
Select
Radio Buttons
Checkbox
Range
Color
Image
Product
Category
List
Fieldset
Code Snippets
Apple Pay Quick Checkout
Custom CSS Injection
Displaying the Store's Business Center Logo
Customizing Copyright Text
Store's Main Navigation Menu
Customer Wishlist
Store Social Media
Products
Products Badges
Product Ratings
Remaining Product Stock
Sold Items Count
Product Filtration by Attributes
Grouped Products
Product Questions & Answers
Product Restock Notfication
SEO
Images alt text
Themes SEO Marketing Tags
Marketing
Metafields
Gift Feature
Loyalty Program
Zid Themes Library: API Integration
Products
Product Categories
Cart
Blog
Customer
Store Settings
Data Reference
Locals
Store
Cart
Product
Products List
Category
Categories List
Session
FAQs
Customer
Blogs
Page
Main Menu
Main Navigation Menu
Request
Orders
Addresses
Store Payment Methods
Store Shipping Methods
Store Banks
Asset URL
Header Meta Tags
Loyalty pogram Wallet
Themes CLI
CLI Authentication
Theme Create
Theme Package
Theme Update
Themes List
Theme Preview
Themes (Vitrin)
Getting Started
Introduction
Theme Development
🔁 Vitrin Changelog
Creating and Managing Theme Presets
Legacy Theme Migration
Store Settings Mapping
Moving to Vitrin Using LLMs
Twig to Jinja
Breaking Changes
Key Concepts
Architecture
Theme Editor
Templates
Overview
Overridable Templates
Legacy Templates
Template Replacements
Templates Library
home.jinja
product.jinja
cart.jinja
category.jinja
products.jinja
categories.jinja
page.jinja
blog.jinja
faqs.jinja
reviews.jinja
questions.jinja
shipping_payment.jinja
404_not_found.jinja
Settings
Schema files
Input Settings
Media Settings
Form Controls Settings
Products Settings
Additional Settings
Conditional Visibility
Migrating twig settings schema
Localization
localization (jinja v. twig)
Building with Vitrin
Jinja Basics
Vitrin's Jinja Extensions
Objects Reference
Common pitfalls
Vitrin CLI
Introduction
CLI Commands
Tips & Tricks
Performance
JS Integration
Supporting both Vitrin and Legacy themes
Responses & Errors
Cart
Products
Categories
Store
Account
Blogs
Options
Events
Features
SDK Popups – Integration Guidelines
Custom Styles Guide
Gift Card as a Popup
Addresses as a Popup
Login as a Popup
Checkout as a Popup
Apple Pay Quick Checkout
Region & Language Popup
Dynamic bundle products
Select Branch Dialog
Mobile Apps
Scripts
API's
Authentication
Logout
Products
List Products
Search Products
Calculate Product Options Price
Notify Product Stock Availability
Fetch Bundle Offers
Fetch Bundle Offers for a Product
List My Product Reviews
List Product Reviews
Create Product Review
Update Product Review
Delete Product Review
List Product Questions
Create Product Question
Get Product by Slug
Get Selection Groups
Categories
List Categories
Checkout
Get Cart
Remove Cart
Duplicate Cart
Add Cart Item
Empty Cart
Update Cart Item
Remove Cart Item
Upload Cart Input Field
Add Gift Card
Remove Gift Card
Apply Coupon
Remove Coupon From Cart
Check Coupon Validity
Apply Loyalty Points
Remove Loyalty Points
Preview Rewarded Points
List Redemption Methods for Cart
Customer’s Loyalty Wallet
Customer’s Current Points Balance
Account
Get Profile
Delete Account
Update Customer Profile
Get Addresses
Create an Address
Get an Address by ID
Update an Existing Address
Delete Address
Get Orders
Get Shareable Wishlist Link
Get Wishlist
Add Products to Wishlist
Remove Product from Wishlist
Get Address Form Schema
Check Product Purchase Status
Storefront
Store Settings
Store Scripts
Pages
Blogs
Countries
Get Countries
Get Cities By Country
Themes
Copy Page
Data Reference
Locals
From keys and values added in locals/ar.json and locals/en.json, you can access locals with a key to print the value. locals/ar.json { "ho...
Store
{ "store": { "id": 1011, "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx", "name": "Mys...
Cart
"cart": { "id": 57784, "session_id": "XXXXXXXXXXXXXXXXXXXXXX", "phase": "address&qu...
Product
"product": { "id": "99631cc2-3a25-43e9-bc28-55a555c4f8c0", "sku": "Z.1.16006938458861678", ...
Products List
List of available filters and sorting for products list. Filters This is the available filters for product list: search (filter products search in p...
Category
"category": { "id": 453, "name": "الورد البلدى", "slug": "الورد-البلدى", &...
Categories List
{ "categories": [ { "id": xxxx, "name": "رجال", "slug": "mens", ...
Session
You can change app language and shipping country, by making a POST Call to '/customer/lang-shipping-country'`using below Params: redirect_to ...
FAQs
"faqs":[{ "id": 3, "question": "هل ممكن أجرب كل أنواع العسل؟", "answer": "<div cla...
Customer
Use auth/login?redirect_to= to redirect to the customer's page when login is successful. { "id": 6, "name": "تجربة ب...
Blogs
The data on this page is a reference for those who want to create Blog/s. Example 1: "blogs":[{ "id": 111XXX, "title&quo...
Page
"page":{ "title": "test", "content": "<p>test pagetest pagetest pagetest page. test pagetest pa...
Main Menu
Deprecated use the main_menu_navigation that will support menus of types: categories, products, blogs and custom urls "main_menu":{ &q...
Main Navigation Menu
"main_navigation_menu":{ "items": [ //max 40 items { "id": XXXXX, "name": "name", ...
Request
"request":{ "path":"/products" "query":"page=1&page_size=24" }
Orders
"orders": [ { "id": 4005734, "code": "XXXXXXX", "store_id": 3, "order_url&quo...
Addresses
"addresses": [ { "id": 3164XX, "name": "محمد", "address_street": "test", ...
Store Payment Methods
"store_payment_methods": [ { "id": 14028, "enabled": 1, "code": "zid_bank_transfer&...
Store Shipping Methods
"store_shipping_methods": [ { "id": 72710, "name": "زدشب سريع", "service_enabled&qu...
Store Banks
"store_banks": [ { "id": 1, "account_number": "1234526789290287262", "iban": &...
Asset URL
All the asset files uploaded in the asset folder can be accessed through the asset_url variable. For more information, Check Theme File Structure. E...
Header Meta Tags
use header_meta_tags to render meta data for: Title description keywords icon google data structure twitter card facebook open graph <head> ...
Loyalty pogram Wallet
{ "wallet": { "points_balance": 5485, "pending_points_balance": 20340, "available_poitns": 5485,...
Previous
Store Settings
Next
Locals