Zid Theme Designer

All the documentation for designing Zid stores is in following:

Zid Docs

Docs

• 🗂️ Overview:
• 🚀 Start Here:
• Create your First App:
• Responses:
• Rate Limiting:
• Authorization:
• StoreFront Events:
• Zid MUI:
• Merchant APIs Orders:
• Merchant APIs Reverse Orders:
• Merchant APIs Abandoned Carts:
• Merchant APIs Products:
• Merchant APIs > Products Managing Products:
• Merchant APIs > Products Digital Vouchers:
• Merchant APIs > Products Product Categories:
• Merchant APIs > Products Product Badge:
• Merchant APIs > Products Product Attributes:
• Merchant APIs > Products Product Attribute Presets:
• Merchant APIs > Products Product Variants:
• Merchant APIs > Products Product Sorting:
• Merchant APIs > Products Product Images:
• Merchant APIs > Products Product Availability Notifications:
• Merchant APIs > Products Product Export:
• Merchant APIs > Products Product Stock:
• Merchant APIs > Products Product Questions & Answers:
• Merchant APIs > Products Product Reviews:
• Merchant APIs > Products Digital Products:
• Merchant APIs Inventories:
• Merchant APIs Shipping:
• Merchant APIs > Marketing Coupons:
• Merchant APIs > Marketing Bundle Offers:
• Merchant APIs > Marketing Loyalty Program:
• Merchant APIs Customers:
• Merchant APIs Store Settings:
• Merchant APIs > Store Settings 📄 User Roles and Permissions:
• Merchant APIs Countries and Cities:
• Webhooks Overview:
• Webhooks > Events Order:
• Webhooks > Events Product:
• Webhooks > Events Abandoned Cart:
• Webhooks > Events Customer:
• Webhooks > Events Product Category:
• App Management Embedded Apps:
• App Management Events:
• Our custom MCP server:
• Overview:
• Merchant Activation:
• Payment Overview:
• Payment Embedded Payment:
• Payment Gateway Error Codes:
• ApplePay:
• ApplePay ApplePay Checkout:
• Webhooks Overview:
• Getting Started Introduction:
• Getting Started Theme Development:
• Getting Started 🔁 Vitrin Changelog:
• Getting Started Creating and Managing Theme Presets:
• Getting Started Legacy Theme Migration:
• Getting Started > Legacy Theme Migration Store Settings Mapping:
• Getting Started > Legacy Theme Migration Moving to Vitrin Using LLMs:
• Getting Started > Legacy Theme Migration Twig to Jinja:
• Getting Started > Legacy Theme Migration Breaking Changes:
• Key Concepts Architecture:
• Key Concepts Theme Editor:
• Key Concepts > Templates Overview:
• Key Concepts > Templates Overridable Templates:
• Key Concepts > Templates Legacy Templates:
• Key Concepts > Templates Template Replacements:
• Key Concepts > Templates > Templates Library home.jinja:
• Key Concepts > Templates > Templates Library product.jinja:
• Key Concepts > Templates > Templates Library cart.jinja:
• Key Concepts > Templates > Templates Library category.jinja:
• Key Concepts > Templates > Templates Library products.jinja:
• Key Concepts > Templates > Templates Library categories.jinja:
• Key Concepts > Templates > Templates Library page.jinja:
• Key Concepts > Templates > Templates Library blog.jinja:
• Key Concepts > Templates > Templates Library faqs.jinja:
• Key Concepts > Templates > Templates Library reviews.jinja:
• Key Concepts > Templates > Templates Library questions.jinja:
• Key Concepts > Templates > Templates Library shipping_payment.jinja:
• Key Concepts > Templates > Templates Library 404_not_found.jinja:
• Key Concepts > Settings Schema files:
• Key Concepts > Settings Input Settings:
• Key Concepts > Settings Media Settings:
• Key Concepts > Settings Form Controls Settings:
• Key Concepts > Settings Products Settings:
• Key Concepts > Settings Additional Settings:
• Key Concepts > Settings Conditional Visibility:
• Key Concepts > Settings Migrating twig settings schema:
• Key Concepts > Localization localization (jinja v. twig):
• Building with Vitrin Jinja Basics:
• Building with Vitrin Vitrin's Jinja Extensions:
• Vitrin CLI Introduction:
• Vitrin CLI CLI Commands:
• Tips & Tricks Performance:
• JS Integration Supporting both Vitrin and Legacy themes:
• JS Integration Responses & Errors:
• JS Integration Cart:
• JS Integration Products:
• JS Integration Categories:
• JS Integration Store:
• JS Integration Account:
• JS Integration Blogs:
• JS Integration Options :
• JS Integration Events:
• Features SDK Popups – Integration Guidelines:
• Features Custom Styles Guide :
• Features Gift Card as a Popup:
• Features Addresses as a Popup:
• Features Login as a Popup:
• Features Checkout as a Popup:
• Features Apple Pay Quick Checkout:
• Features Region & Language Popup:
• Features Dynamic bundle products:
• Mobile Apps Scripts:

API Docs

• Merchant APIs > Orders Create Order: This endpoint allows Partners to create orders on behalf of merchants, including products with required customizable fields.
• Merchant APIs > Orders Change Order Status: Please note that if the order is shipped through an integrated shipping company, then we cannot update the order status from "Ready" to "New".
• Merchant APIs > Orders Add Order Comment: The Add Order Comment API allows shipping and fulfilment partners to post real-time shipment updates directly to an order’s activity.
• Merchant APIs > Orders View Order: Get a specific order by ID. Optionally, when source is provided, the previous_order and next_order fields will be computed among only those orders whose source matches one of the values.
• Merchant APIs > Orders List Orders: Orders can be created either by the customers from the storefronts or by the merchants from their dashboard.
• Merchant APIs > Orders List Custom Order Statuses: Fetch main order statuses with their custom sub-statuses for the authenticated manager’s store.
• Merchant APIs > Orders List Order Credit Notes: The GET Credit Notes endpoint allows you to retrieve a list of credit notes associated with an order from the system. Credit notes are issued for orders that have been cancelled or modified, and this endpoint provides detailed information about each credit note, including customer details, product information, and payment details.
• Merchant APIs > Reverse Orders Create Reverse Orders: Creates an order reverse request.
• Merchant APIs > Reverse Orders Create Reverse Orders Waybill: Creates a waybill for a reversed order.
• Merchant APIs > Reverse Orders Add Reverse Order Reasons: Adds a new reverse order reason.
• Merchant APIs > Reverse Orders List Reverse Reasons: Retrieves a list of order reverse reasons for the store.
• Merchant APIs > Reverse Orders Calculate Reverse Totals: Calculates the refund totals for a reverse order before creating the actual reverse order.
• Merchant APIs > Reverse Orders Create refund for reverse order: Creates a refund for an existing reverse order.
• Merchant APIs > Reverse Orders Upload bank transfer receipt: Uploads a bank transfer receipt for a refund that was created using the
• Merchant APIs > Reverse Orders Update return products: Updates the received status and condition quantities for products included in a reverse order.
• Merchant APIs > Reverse Orders Order Details – View for Return: Retrieves order details formatted specifically for return processing.
• Merchant APIs > Abandoned Carts List Carts: Retrieves a list of abandoned carts for a given store.
• Merchant APIs > Abandoned Carts View Cart: This endpoint fetches comprehensive details about an abandoned cart, identified
• Merchant APIs > Products > Managing Products List Products: Retrieve a list of all products with extensive filtering options.
• Merchant APIs > Products > Managing Products View Product: Get product by ID as Manager or as Customer.
• Merchant APIs > Products > Managing Products List Product Settings: The product setting endpoint allows merchants to retrieve the current product settings status from their dashboard. These settings control various aspects of how products are displayed, including search features, related products, and sold product counts. The endpoint helps merchants manage and fine-tune the visibility and order of products in their stores.
• Merchant APIs > Products > Managing Products Create Product: Use this endpoint to create a new product, with optional support for grouped products, product badges, and inline variant creation.
• Merchant APIs > Products > Managing Products Update Product: This endpoint lets you modify an existing product. You can update various aspects of the product, including:
• Merchant APIs > Products > Managing Products Bulk Update Products: This endpoint allows you to update multiple products at once by specifying their IDs or SKUs along with the new data. This makes managing large inventory updates more efficient.
• Merchant APIs > Products > Managing Products Delete Product: Delete a product by its ID.
• Merchant APIs > Products > Digital Vouchers List Vouchers: Retrieves all vouchers for a specified product.
• Merchant APIs > Products > Digital Vouchers Order Vouchers: Retrieves the voucher details for a specified order.
• Merchant APIs > Products > Digital Vouchers Create Voucher: Adds a new voucher for a specified product.
• Merchant APIs > Products > Digital Vouchers Import Vouchers: Imports multiple vouchers for a specified product from an Excel file.
• Merchant APIs > Products > Digital Vouchers Export Vouchers: Exports vouchers for a specified product to an Excel file.
• Merchant APIs > Products > Digital Vouchers Update Voucher: Updates an existing voucher for a specified product.
• Merchant APIs > Products > Digital Vouchers Remove Voucher: Deletes a specified voucher for a product.
• Merchant APIs > Products > Product Categories List Categories: Fetches all the available categories for a certain store, including details such as their names, status, SEO information, and the number of products they contain. It supports returning both detailed and minimal category information depending on the request parameters.
• Merchant APIs > Products > Product Categories View Category: Retrieves detailed information about a specific category, including its attributes, status, and associated products or subcategories, based on the provided category ID.
• Merchant APIs > Products > Product Categories Create Category: Use this endpoint to add a new store category.
• Merchant APIs > Products > Product Categories Create Subcategory: Use this endpoint to add a new store Sub-category.
• Merchant APIs > Products > Product Categories Update Category: Use this endpoint to update only one store category
• Merchant APIs > Products > Product Categories Assign Product to Category: Use this endpoint to add a new product to a certain category by specifying the product id and providing the category id in the request body.
• Merchant APIs > Products > Product Categories Bulk Assign Products to Category: Adds a product to one or more categories. Provide the product ID as a path parameter and the category ID(s) in the request body.
• Merchant APIs > Products > Product Categories Publish Category: Use this endpoint to either publish or unpublish a certain category.
• Merchant APIs > Products > Product Categories Detach Category from All Products: Detach a specified category from all products in the store. This essentially
• Merchant APIs > Products > Product Categories Remove Product from Category: This endpoint removes a specified category from a particular product. This action
• Merchant APIs > Products > Product Badge List Badges: This endpoint retrieves a list of all predefined store badges available to the merchant.
• Merchant APIs > Products > Product Attributes List Attributes: Use this endpoint to retrieve the Product Attributes of a certain store.
• Merchant APIs > Products > Product Attributes View Attribute: Use this endpoint to retrieve a specific product attribute using its id.
• Merchant APIs > Products > Product Attributes Create Attribute: Add new product attributes for a certain Role.
• Merchant APIs > Products > Product Attributes Update Attribute: Use to update the value of a single attribute for a certain Role.
• Merchant APIs > Products > Product Attributes Delete Attribute: Delete a certain ID using its id.
• Merchant APIs > Products > Product Attribute Presets List Presets: This endpoint retrieves all attribute presets, allowing users to quickly and easily add attributes in a specified language. It provides a list of available presets, each containing attribute values in both Arabic and English.
• Merchant APIs > Products > Product Attribute Presets Create Preset: Use this endpoint to add a new attribute preset, allowing for quick and easy creation of attributes with localized values in both Arabic and English.
• Merchant APIs > Products > Product Attribute Presets Update Preset: Use this endpoint to update an existing attribute preset by specifying both the preset ID and the attribute ID. The request allows you to update the preset values in different languages.
• Merchant APIs > Products > Product Attribute Presets Delete Preset: Delete a defined attribute preset.
• Merchant APIs > Products > Product Variants Create Variants: This endpoint allows adding or creating variants for a given product. If the specified product is a standalone product (does not have any variants), this operation will convert it into a parent product.
• Merchant APIs > Products > Product Variants Create Custom Options: Adds custom options to a product, allowing customers to choose from a predefined set of options while making a purchase. Custom options can be used to offer choices such as gift wrapping, warranty options, or other additional services.
• Merchant APIs > Products > Product Variants Update Custom Option: Updates an existing custom option field. This endpoint will replace the old data with the new data passed in the payload of this endpoint request.
• Merchant APIs > Products > Product Variants Delete Custom Option Field:
• Merchant APIs > Products > Product Variants Create Custom Fields: Adds custom user-input fields to a product, allowing customers to provide additional information while making a purchase. Custom user input fields can be used to collect data such as personalization details, gift messages, or special instructions.
• Merchant APIs > Products > Product Sorting Set Manual Product Order: Sets a custom ordering of products by accepting an ordered list of product IDs. This manual sorting can also be applied to a specific category when the category ID is passed in the body.
• Merchant APIs > Products > Product Sorting Reset Manual Product Order: Delete any manual sorting that was done on any of the store products.
• Merchant APIs > Products > Product Images List Images: Retrieve a list with all images available for a certain product using product id.
• Merchant APIs > Products > Product Images Upload Image: Use this endpoint to add a single image to a product.
• Merchant APIs > Products > Product Images Update Image Order: use this endpoint to reorder an image's appearance for a product.
• Merchant APIs > Products > Product Images Delete Image: Delete a specific product image by using the image id and product id.
• Merchant APIs > Products > Product Availability Notifications Notification Stats: Retrieve statistics on availability notifications.
• Merchant APIs > Products > Product Availability Notifications Noticiation Settings: Retrieve current settings for availability notifications.
• Merchant APIs > Products > Product Availability Notifications List Notifications: Retrieve a list of availability notifications.
• Merchant APIs > Products > Product Availability Notifications Create Notification: Sign up to receive a notification by email when the specified product becomes available again in the store.
• Merchant APIs > Products > Product Availability Notifications Update Settings: Save settings for availability notifications.
• Merchant APIs > Products > Product Availability Notifications Send Notification Email: Manually send an availability notification email.
• Merchant APIs > Products > Product Availability Notifications Export Notifications: Export availability notifications data.
• Merchant APIs > Products > Product Export Email All Products to Store Owner: Sends an email to the store owner containing all the store's products in CSV format.
• Merchant APIs > Products > Product Export Import Products via CSV or xlsx File: Imports products to the store using a CSV or xlsx file. The endpoint accepts a file, a Dropbox folder link for images, and an optional delete_old_products parameter to delete all previous store products upon successful import.
• Merchant APIs > Products > Product Stock Retrieve Product Stock: Retrieve specific product stock data by its unique ID.
• Merchant APIs > Products > Product Stock List Product Stock Records: Retrieve a list of all product stocks for a specific product.
• Merchant APIs > Products > Product Stock Create Product Stock: Add a new product stock for a specific product.
• Merchant APIs > Products > Product Stock Update Product Stock: Update a single product stock by its unique ID. It is not recommended when handling lots of stocks.
• Merchant APIs > Products > Product Stock Bulk Update Product Stock Records: Bulk update product stocks through locations. It is recommended when updating multiple stocks.
• Merchant APIs > Products > Product Questions & Answers Retrieve Product Question: Retrieve details of a specific question for a product.
• Merchant APIs > Products > Product Questions & Answers Retrieve Product Answer: Retrieve details of a specific answer to a question.
• Merchant APIs > Products > Product Questions & Answers List Product Questions: Retrieve a list of all questions for a product.
• Merchant APIs > Products > Product Questions & Answers List Answers for Question: Retrieve a list of all answers for a specific question of a product.
• Merchant APIs > Products > Product Questions & Answers Create Product Question: Create a new question for a specified product.
• Merchant APIs > Products > Product Questions & Answers Create Product Answer: Create a new answer for a specific question of a product.
• Merchant APIs > Products > Product Questions & Answers Update Product Question: Update details of a specific question for a product.
• Merchant APIs > Products > Product Questions & Answers Update Product Answer: Update details of a specific answer to a question.
• Merchant APIs > Products > Product Questions & Answers Delete Product Question: Delete a specific question for a product.
• Merchant APIs > Products > Product Questions & Answers Delete Product Answer: Delete a specific answer for a question.
• Merchant APIs > Products > Product Reviews List Reviews: Retrieves a list of customer reviews for a specified product within a store. Use this endpoint to fetch all available reviews based on the PRODUCT_ID and STORE_ID.
• Merchant APIs > Products > Product Reviews Count Reviews: This API endpoint retrieves the total number of new reviews. It allows you to filter the results based on specific query parameters like search terms, date ranges, or customer IDs.
• Merchant APIs > Products > Digital Products Create Downloadable Product: Here’s the updated description with the additional clarification:
• Merchant APIs > Products > Digital Products Generate Upload URL: The "Generate an Upload URL" endpoint allows users to generate a pre-signed URL for uploading a digital file directly to cloud storage. This URL enables secure, temporary access for uploading files associated with a digital product.
• Merchant APIs > Products > Digital Products Upload File to S3: The "Upload File to S3" endpoint provides a pre-signed URL for secure, temporary access to upload files directly to Amazon S3 storage. This enables clients to upload files without needing direct S3 credentials, ensuring secure and efficient file handling for digital assets.
• Merchant APIs > Products > Digital Products Create Product Downloadable: This endpoint creates downloadable content for a digital product, associating a file with the specified product. The download link is generated and returned, allowing users to access or download the content directly. The response provides information on the uploaded file, including its metadata, access link, and display details.
• Merchant APIs > Products > Digital Products Get Product Downloadables: This endpoint retrieves a list of downloadable files associated with a specific product, providing details about each downloadable file, including access URLs, display names, and status. The response includes pagination information and metadata about the files, allowing the client to manage multiple files for a product.
• Merchant APIs > Products > Digital Products Delete Product Downloadable: This endpoint deletes a specific downloadable file associated with a product. Upon successful deletion, the response returns the details of the deleted file, confirming the operation. This response helps the client verify the removal of the file and provides relevant metadata for record-keeping.
• Merchant APIs > Products > Digital Products List Store Downloadables: This endpoint retrieves a list of downloadable files associated with a specific store. It supports searching by file name and ordering the results by file size or creation date. The response provides details about each downloadable file, including its ID, name, file size, and associated store.
• Merchant APIs > Products > Digital Products Create Store Downloadable: This endpoint allows the creation of downloadable files associated with a specific store. The client uploads a file, and the endpoint returns details about the newly created downloadable item, including its identifier, file name, and size.
• Merchant APIs > Products > Digital Products Delete Store Downloadable: This endpoint deletes a specific downloadable file associated with a store. It requires the unique ID of the downloadable file to be specified in the URL. Upon successful deletion, the server responds with an HTTP status code indicating the operation's success.
• Merchant APIs > Inventories Create Location: Adds a new location to the store.
• Merchant APIs > Inventories Update Location: Updates the details of a specified location.
• Merchant APIs > Inventories Update Product Stock for Location: This endpoint allows store managers to update stock quantities for products at a specific location. Managers can specify the available quantity and whether the stock is infinite or limited.
• Merchant APIs > Inventories List Locations: Returns a list of all store locations.
• Merchant APIs > Inventories View Location: Retrieves details about a specified location.
• Merchant APIs > Shipping List Store Shipping Methods: This endpoint provides the list of all delivery options configured for the store, including custom shipping names, associated cities, and status of each shipping method. It's useful for managing delivery settings and understanding available shipping methods.
• Merchant APIs > Marketing > Coupons List Coupons: Retrieves a list of all available coupons from the system. The response includes active, inactive, and expired coupons along with relevant metadata such as store details, discount type, and validity period.
• Merchant APIs > Marketing > Coupons View Coupon: Fetches detailed information about a specific coupon using its unique coupon_id. This endpoint provides all attributes of a coupon, including usage statistics, conditions, and status.
• Merchant APIs > Marketing > Coupons Create Coupon: Create a new coupon with various options such as discount type, validity period, usage limits, and application conditions.
• Merchant APIs > Marketing > Coupons Update Coupon: This endpoint allows merchants to update details of an existing coupon. Merchants can modify attributes such as discount value, expiration date, and usage limits.
• Merchant APIs > Marketing > Coupons Delete Coupon: This endpoint allows merchants to delete an existing coupon. Once deleted, the coupon will no longer be valid for any transactions.
• Merchant APIs > Marketing > Bundle Offers List Bundle Offers: This endpoint retrieves all available bundle offers for the store. Bundle offers are special promotions where customers can get a discount if they buy a specific bundle of products.
• Merchant APIs > Marketing > Loyalty Program Loyalty Program Status: Retrieves information about the overall status (active/inactive) of a store's loyalty program.
• Merchant APIs > Marketing > Loyalty Program Loyalty Program Details: Retrieves list data relevant to the loyalty program configuration.
• Merchant APIs > Marketing > Loyalty Program Loyalty Program Info: Retrieves information about the store's loyalty program info page content.
• Merchant APIs > Marketing > Loyalty Program Customer Loyalty Summary: Retrieves detailed information about a specific customer's loyalty points, including balance and transaction history.
• Merchant APIs > Marketing > Loyalty Program Customer Points History: Retrieves the transaction history of a specific customer's loyalty points activity.
• Merchant APIs > Marketing > Loyalty Program Activate Loyalty Program: Activates a loyalty program for a store.
• Merchant APIs > Marketing > Loyalty Program Set Points Expiration Rules: Sets the expiration period for loyalty points within a store's program.
• Merchant APIs > Marketing > Loyalty Program Update Cashback Rule: Updates the configuration of a cashback rule within a store's loyalty program.
• Merchant APIs > Marketing > Loyalty Program Create Points Redemption Method: Creates a new redemption method (e.g., gift certificate) for a store's loyalty program.
• Merchant APIs > Marketing > Loyalty Program Update Points Redemption Method: Updates the details of an existing redemption method within a store's loyalty program.
• Merchant APIs > Marketing > Loyalty Program Delete Points Redemption Method: Deletes a specific redemption method from a store's loyalty program.
• Merchant APIs > Marketing > Loyalty Program Adjust Customer Points: Allows manual adjustments to a customer's loyalty points balance.
• Merchant APIs > Customers List Customers: This endpoint will return a list of the store customers along with other metadata such as the total number of customers and the total number of orders for each customer.
• Merchant APIs > Customers View Customer: This endpoint retrieves the details of a certain customer using the Customer's ID.
• Merchant APIs > Store Settings Retrieve Store Manager Profile: Retrieves the profile data of the authenticated Manager. This includes detailed information about the Manager, their role, associated store, and the set of permissions they hold.
• Merchant APIs > Store Settings Retrieve VAT Settings: Return a list of the VAT settings configured on this store. For example, to indicate whether the store VAT is applied on shipping fees or not.
• Merchant APIs > Store Settings List Payment Methods:
• Merchant APIs > Store Settings List Store Operating Countries: Retrieve a list of countries where the store operates. This list includes the country's unique ID, name, ISO codes, and flag image URL.
• Merchant APIs > Countries and Cities List Countries: The endpoint returns all countries' names, cod

…(truncated)