Zid Docs
  1. Store Events
Zid Docs
  • Merchant API
    • 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
        • Order Notes
      • 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
          • List Product Reviews
        • 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
          • Change Review Status
          • Bulk Change all Review Statuses
          • Delete Review
          • Import Product Reviews
          • Reply to Review
          • Delete Reply
          • Update Reply to Review
        • 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
          • Customer Wallet
          • Customer Points
          • Loyalty Program Points per Order
          • Store Loyalty Status
          • Redemption Methods
          • Cashback Rules
          • Add Redemption to Cart
          • Remove Redemption from Cart
          • 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
          • List Data
          • Customer Points History
          • Info Page - Managers
          • Update Info Page
          • Adjust Customer Points
      • Customers
        • Customer Profile
        • 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
  • Payment API
    • Merchant Activation
    • Submitting
    • Gateway Error Codes
    • Webhooks
      • Link Merchant Event
      • Payment Paid Event
      • Refund Event
    • Payment
      • Embedded Payment
      • Execute Payment Request
      • Get payment status
      • Direct Payment
    • ApplePay
      • ApplePay Checkout
      • On Payment Authorized
      • Register ApplePay Domain
      • On Providing Merchant Validation
    • Refund
      • Request Refund
  • Apps
    • Create your First App
    • Embedded Apps
    • App Scripts
    • App Events
    • App Subscription
      • Get Subscription Details
      • Update Usage-Based Charges
  • Themes
    • 🚨 Important Update: Zid Themes
    • Adding Video URL Feature to Third-Party Themes
    • Landing Page Development
    • 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
    • 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
  1. Store Events

Product

Product
is_external_product
boolean 
optional
This property is used to indicate whether the product is sourced externally.
Default:
false
id
null 
optional
Unique identifier for the product. (Set to null if is_external_product is true)
parent_id
null 
optional
Unique identifier for the parent product, if any. This product could be a variant of the parent product. (Set to null if is_external_product is true)
product_class
string 
optional
Set to "grouped_product" to indicate it's a group of sub-products.
sku
string 
optional
Stock Keeping Unit - unique identifier that allows a product to be tracked for inventory purposes.
barcode
string 
optional
This field allows you to specify a barcode associated with the product, if applicable.
name
object 
optional
Localized product name in Arabic (ar) and English (en).
ar
string 
optional
en
string 
optional
slug
string 
optional
SEO friendly URL, usually derived from the product name.
price
integer 
optional
Base price of the grouped product (100.0).
short_description
null 
optional
This field is optional and can be used to provide a brief description of the product.
sale_price
integer 
optional
If the product is on sale, this field specifies the discounted price in the smallest currency unit.
Example:
50
formatted_price
string 
optional
This field contains the base price formatted according to the currency settings.
Example:
10$
formatted_sale_price
string 
optional
If applicable, this field holds the formatted discounted price.
Example:
8$
currency
string 
optional
currency_symbol
string 
optional
Shows the currency type.
attributes
array [object] 
optional
categories
array [object] 
optional
display_order
null 
optional
This field is currently unused but might be reserved for future functionalities related to product display order.
has_options
boolean 
optional
This flag indicates whether the product has options (variations) available. (e.g., different sizes or colors).
Default:
false
has_fields
boolean 
optional
This flag signifies whether the product has custom form fields associated with it.
images
array [object] 
optional
This array stores information about the product images.
is_draft
boolean 
optional
Indicates if the product is a draft (False - published).
quantity
null 
optional
Shows the quanitity of the product.
is_infinite
boolean 
optional
html_url
string 
optional
This field contains the URL for the product page on your storefront.
weight
object 
optional
Weight of the product.
value
integer  | null 
optional
Currently set to null, indicating the weight value might need to be provided elsewhere.
Example:
100
unit
string 
optional
This field allows you to specify the unit of weight (e.g., "g", "kg", "lb").
Example:
kg
keywords
array [object] 
optional
This array allows you to define a list of relevant keywords associated with the product for better search optimization.
requires_shipping
boolean 
optional
is_taxable
boolean 
optional
Indicates if the product is taxable.
Default:
false
structure
string 
optional
seo
object 
optional
SEO-related data for the product.
title
object 
optional
SEO title for the product page.
description
object 
optional
SEO description for the product page.
rating
object 
optional
This object provides average product rating information.
average
integer 
optional
Average rating score.
Example:
3.9
total_count
integer 
optional
Total number of ratings received.
Example:
400
1_ratings
object 
optional
2_ratings
object 
optional
3_ratings
object 
optional
4_ratings
object 
optional
5_ratings
object 
optional
store_id
integer 
optional
Unique identifier of the store in which the product is listed.
purchase_restrictions
object 
optional
min_quantity_per_cart
null 
optional
max_quantity_per_cart
null 
optional
availability_period_start
null 
optional
availability_period_end
null 
optional
sale_price_period_start
string 
optional
This parameter indicates the start date and time for the sale price of the product. It is represented in ISO 8601 format (YYYY-MM-DDTHH:MM
.sssZ) and determines when the discounted sale price becomes effective.
Example:
2024-09-18T21:00:00.000000Z
sale_price_period_end
string 
optional
This parameter represents the end date and time for the sale price of the product. It is also in ISO 8601 format and defines when the discounted sale price ends.
Example:
2024-09-19T20:59:59.000000Z
metafields
null 
optional
meta
object 
optional
badge
object 
optional
body
object 
optional
icon
object 
optional
related_products_settings
string 
optional
related_products_title
null 
optional
variants
array [object] 
optional
options
array [object] 
optional
cost
integer 
optional
is_published
boolean 
optional
Indicates if the product is published and visible (true).
waiting_customers_count
null 
optional
description
object 
optional
custom_user_input_fields
array [object] 
optional
custom_option_fields
array [object] 
optional
related_products
array [object] 
optional
next_product
null 
optional
previous_product
null 
optional
group_products
array [object {6}] 
optional
An array of objects representing the sub-products included in the grouped product. Only required when product_class is set to "grouped_product". Refer to the Update Existing Product documentation for details on the "group_products" fields.
id
string 
optional
ID of the sub-product within the group.
Example:
143
item
object 
optional
origin_product_id
string 
optional
item_id
string 
optional
item_quantity
integer 
optional
in_stock
boolean 
optional
stocks
array [object {4}] 
optional
This array provides details about product stock.
id
string 
optional
location
object 
optional
Details about the storage location (ID and name).
available_quantity
null 
optional
Quantity of the product in stock.
is_infinite
boolean 
optional
Flag to indicate if the product quantity is infinite.
sold_products_count
null 
optional
created_at
string 
optional
Date and time the product was created.
updated_at
string 
optional
Date and time the product was last updated.
Modified at 2025-01-08 05:37:32
Previous
Order
Next
Abandoned Cart
Built with