Zid Docs
Merchant APIApp APIThemes
Merchant APIApp APIThemes
Help Center
Slack
  1. APIs
  • Start Here 🚀
  • Overview to Zid Apps
  • Authorization
  • Responses
  • Webhooks
  • Rate Limiting
  • APIs
    • Orders
      • Update Order by ID
      • Get Order Credit Notes
      • Get Order by ID
      • List of Orders
    • Reverse Orders
      • Reverse Order Reasons
      • Create Reverse Orders
      • Create Reverse Orders Waybill
      • Add Reverse Order Reasons
    • Carts
      • Get Abandoned Cart Details
      • List Abandoned Carts
    • Products
      • Managing Products
        • Get a Product by ID
        • Retrieve a list of products
        • Create a new product
        • Update an existing product.
        • Bulk update of products using their IDs or SKUs
        • Delete a product.
        • Product Setting
      • Digital Vouchers
        • Product Vouchers
        • Order Voucher
        • Add Product Voucher
        • Import Vouchers
        • Export Vouchers
        • Update Product Voucher
        • Remove Product Voucher
      • Product Categories
        • Get Single Category Details
        • Get all categories
        • Create Store Category
        • Update a Store Category
        • Add a product to a certain category
        • Publish/Unpublish a Category
        • Detach Category from All Products
        • Remove Category from Product
      • Product Badge
        • Product Badge
      • Product Attributes
        • Get Product Attributes
        • Get Product Attributes
        • Retrieve a product attribute
        • Add a New Product Attribute
        • Add a New Product Attribute
        • Update a product attribute
        • Delete a product attribute
      • Product Attribute Presets
        • Get attribute presets
        • Create Attribute Preset
        • Update Attribute Preset
        • Delete an attribute preset
      • Product Customizations
        • Add Product Variants
        • Insert Custom Options to a Product
        • Insert Custom User-Input Fields to a Product
      • Product Manual Sorting
        • Set Custom Product Order
        • Reset the manual sorting of all products
      • Product Images
        • Get List of images of a product.
        • Add an image to a product
        • Update a product Image Order
        • Delete a product image
      • Product Notifications
        • Availability Notification Stats
        • Availability Notifications Settings
        • List Availability Notifications
        • Add Availability Notification
        • Save Availability Notifications Settings
        • Manually Send Availability Notification Email
        • Export Availability Notifications
      • Product Import
        • Email All Products to Store Owner
        • Import Products via CSV or xlsx File
      • Product Stock (Multi-Inventory)
        • Get Product Stock by ID
        • List Product Stocks
        • Add Product Stock
        • Update Single Product Stock
        • Bulk Update Product Stocks
      • Product Questions & Answers
        • Get Question
        • Get Answer
        • Get All Questions
        • List Question Answers
        • Create Question
        • Create Answer
        • Update Question
        • Update Answer
        • Delete Question
        • Delete Answer
      • Product Reviews
        • List Reviews
        • New Reviews Total
      • Digital Products
        • Create Downloadable Product
        • Generate an Upload URL
        • Upload File to S3
        • Create Product Downloadables
        • Get Product Downloadables
        • Delete Product Downloadables
        • Get Store Downloadables
        • Create Store Downloadables
        • Delete Store Downloadables
    • Inventories
      • Get Store Location by ID
      • List Store Locations
      • Add a New Location
      • Update a Location by ID
      • Update Products Stock by Location ID
    • Shipping
      • List Store Delivery Options
      • Add Shipping Option
    • Marketing
      • Gift Cards
        • Get Store Settings
        • Add gift card to the cart
        • Update Store Settings
        • Upload gift card designs
        • Remove gift card from the cart
      • Coupons
        • Create a New Coupon
        • List Coupons
        • Get Coupon Details
        • Update Coupon
        • Delete Coupon
      • Bundle Offers
        • Retrieve all Bundle Offers
      • Loyalty Program
        • Loyalty Program Points per Order
        • Store Loyalty Status
        • Info Page
        • Loyalty Program Activation
        • Loyalty Status
        • Set Points Expiration
        • Cashback Rule Method Update
        • Cashback Rule Method Update Status
        • Add Points Redemption Method
        • Update Points Redemption Method
        • Delete Points Redemption Method
        • Toggle Redemption Method Status
        • Show Loyalty Points Info for Specific Customer
        • Customer Profile
        • List Data
        • Customer Points History
        • Info Page - Managers
        • Update Info Page
        • Adjust Customer Points
    • Customers
      • List of Customers
      • Get Customer by ID
    • Store Settings
      • 📄 User Roles and Permissions
      • Get Manager's Profile
      • Get VAT Settings
      • List of Payment Method
    • Countries and Cities
      • Retrieve Store Operating Countries
      • Retrieve Cities by Country ID
      • Countries List
    • Webhook
      • List of Webhooks
      • Create a Webhook
      • Delete a Webhook by OriginalId
      • Delete a Webhook by Subscriber
  • Store Events
    • Order
    • Product
    • Abandoned Cart
    • Customer
    • Product Category
  1. APIs

Products

Product Attributes, Options, and Variants#

In this guide, we will explain the concepts of Product Attributes, Product Options, and Product Variants in Zid's system. These concepts are crucial in defining the different variations of a product and how they are displayed on the storefront.

Product Attributes#

A product attribute is a characteristic or feature of a product, such as its color, size, or material. Each product attribute has a name and a corresponding value. For example, a product attribute could be "Color" with a value of "Red".

Product Options#

A product option is a specific type of attribute that has a set of possible values. For instance, "Color" could be a product option with possible values of "Red", "Blue", and "Green". Each product can have multiple options, and the combination of these options defines the available variants of the product.
In the storefront, product options are displayed as dropdowns or selectors, allowing customers to choose their preferred variant based on their preferred values for each option.

Product Variants#

A product variant is a specific combination of product attributes that defines a unique variant of a product. If a product has multiple options (like color and size), then each combination of values for these options (like "Red, Large" or "Blue, Small") would be a distinct variant of the product.
Here's an example of a product with a set of options and variants:
{
  "options": [
    {
      "name": {"en": "Color", "ar": "اللون"},
      "slug": "color",
      "values": {"en": ["Red", "Blue"], "ar": ["أحمر", "أزرق"]}
    },
    {
      "name": {"en": "Size", "ar": "الحجم"},
      "slug": "size",
      "values": {"en": ["Small", "Medium", "Large"], "ar": ["صغير", "متوسط", "كبير"]}
    }
  ],
  "variants": [
    {
      "attributes": [
        {
          "name": {"en": "Color", "ar": "اللون"},
          "slug": "color",
          "value": {"en": "Red", "ar": "أحمر"}
        },
        {
          "name": {"en": "Size", "ar": "الحجم"},
          "slug": "size",
          "value": {"en": "Small", "ar": "صغير"}
        }
      ]
    },
    {
      "attributes": [
        {
          "name": {"en": "Color", "ar": "اللون"},
          "slug": "color",
          "value": {"en": "Blue", "ar": "أزرق"}
        },
        {
          "name": {"en": "Size", "ar": "الحجم"},
          "slug": "size",
          "value": {"en": "Medium", "ar": "متوسط"}
        }
      ]
    }
  ]
}
In the above example, the product has two options:
Color, with possible values of "Red" and "Blue"
Size, with possible values of "Small" and "Medium".
Furthermore, these options combine to form two variants - one with a "Red" color and "Small" size, and another with a "Blue" color and "Medium" size.
Modified at 2024-08-27 21:17:46
Previous
List Abandoned Carts
Next
Managing Products
Built with