Zid Docs
AppsThemes
Payments
AppsThemes
Payments
Help Center
Slack
  1. Settings
  • 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
    • Templates
      • Overview
      • Overridable Templates
      • Legacy Templates
      • Template Replacements
      • Templates Library
        • home.jinja
        • product.jinja
        • cart.jinja
        • category.jinja
        • products.jinja
        • categories.jinja
        • page.jinja
        • blogs.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)
    • Theme Editor
      • Overview
  • Building with Vitrin
    • Jinja Basics
    • Vitrin's Jinja Extensions
  • 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
    • Progressive Discounts
    • Customer Wallet & Cashback
    • Add Preorder Support to Your Theme
  • Mobile Apps
    • Scripts
  • API's
    • Authentication
      • Logout
      • Login Status
      • SMS Login
      • Verify SMS Login
      • WhatsApp Login
      • Verify WhatsApp Login
      • Email Login
      • Verify Email Login
      • Register
      • Register Guest
    • 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 Scripts
      • Pages
      • Blogs
    • Countries
      • Get Countries
      • Get Cities By Country
  1. Settings

Additional Settings

Common fields
FieldTypeDescription
idstringUnique identifier of the setting (e.g., "images", "title").
labelobject {ar,en}Input label shown to the merchant.
typestringInput type (e.g., "text", "textarea", "image", "number", "color", "list").
defaultanyDefault value when none is provided.
icontextOptional reference to an icon (e.g. fal fa-box).

List#

Extra fields
FieldTypeDescription
settingslist[Any]List of settings.
max_itemsintMaximum number of items allowed. Useful to not clutter the UI in some cases.
List of settings. For example a list of images.
{
  "type": "list",
  "id": "list_of_settings",
  "label": {
    "ar": "",
    "en": "List of Settings"
  },
  "max_items": 4,
  "settings": [
    {
        "type": <Any Setting Type>
        ...
    }, 
    ...
  ]
}

Fieldset#

Extra fields
FieldTypeDescription
settingslist[Any]List of settings.
expandableboolFlag to make the grouping expandable.
A grouping of settings. Similar to List, but is different in that the user is not allowed to add settings, its just an organizational grouping of the settings.
{
  "type": "fieldset",
  "id": "links",
  "label": {
    "ar": "روابط مهمة",
    "en": "Links"
  },
  "expandable": true,
  "settings": [
    {...}, 
    ...
  ]
}

Snippet#

Accepts arbitrary HTML values.
{
  "type": "snippet",
  "id": "some_snippet",
  "label": {
      "ar": "",
      "en": "Some HTML"
  }
}
Modified at 2026-02-17 07:02:10
Previous
Products Settings
Next
Conditional Visibility
Built with