Product

Product Simple Resource

Key	Type	Description
id	Integer	The unique identifier for the product.
parent_id	Integer	The ID of the parent product if this product is a variant.
sku	String	The Stock Keeping Unit number for the product.
barcode	String	The barcode number for the product.
name_en	String	The name of the product in English.
name_ar	String	The name of the product in Arabic.
encoded_name_en	String	The URL-encoded name of the product in English.
encoded_name_ar	String	The URL-encoded name of the product in Arabic.
featured	Boolean	A boolean indicating whether the product is featured or not.
description	String	A brief description of the product.
meta_title	String	The meta title for the product.
slug	String	The slug for the product.
meta_description	String	The meta description for the product.
keywords	String	The keywords associated with the product.
preorder	Boolean	A boolean indicating whether the product is available for pre-order or not.
preorder_price	Integer	The price of the product during the pre-order period.
preorder_start_date	Integer	The start date of the pre-order period.
preorder_end_date	Integer	The end date of the pre-order period.
image	String	The main image for the product.
images	Array	An array of additional images for the product.
thumbnail_image	String	The thumbnail image for the product.
video	String	A video URL associated with the product.
available_soon	Boolean	A boolean indicating whether the product will be available soon or not.
price	Integer	The price of the product.
brand	Object	The brand details associated with the product.
discount_price	Integer	The discounted price of the product.
has_promotion	Boolean	A boolean indicating whether the product has a promotion or not.
discount_start_date	DataTime	The start date of the promotion.
discount_end_date	DataTime	The end date of the promotion.
discount_max_per_period	Integer	The maximum number of times a customer can use the promotion during the promotion period.
discount_period_cycle_days	Integer	The number of days for the promotion period.
direct_discount	Integer	A boolean indicating whether the discount is directly applied to the product price or not.
downloadable	Object	The downloadable items associated with the product.
category	Object	The category associated with the product.
optional_sub_category_id	Integer	The ID of the optional sub-category associated with the product.
in_stock	Integer	A boolean indicating whether the product is in stock or not.
stock	Integer	The current stock level of the product.
promotion	String	The promotion associated with the product.
promotion_en	String	The promotion description in English.
promotion_ar	String	The promotion description in Arabic.
is_favourite	Boolean	A boolean indicating whether the product is marked as a favorite or not.
is_compare	Boolean	A boolean indicating whether the product is marked for comparison or not.
share_link	Integer	The link to share the product.
rate	Integer	The rating for the product.
payment_methods_discount_name_en	String	The name of the payment method discount in English.
payment_methods_discount_name_ar	String	The name of the payment method discount in Arabic.
promos	Array	An array of promotions associated with the product.
product_variants_options	Array	The variant options for the product.
product_variants	Array	The variant products associated with the main product.
order	Integer	The display order for the product.
weight	Integer	The weight of the product.
active	Boolean	A boolean indicating whether the product is active or not.
amount	Integer	The quantity of the product in the cart
variants_stock_count	Integer	The total number of the product variants available in stock.
can_buy	Integer	The maximum quantity of the product that can be added to a single order.
soft_deleted	Boolean	A boolean value indicating whether the product has been marked as deleted but is still available in the database.
max_per_order	Integer	The maximum quantity of the product that can be added to a single order.
type	Integer	the type of the product (e.g. Single or Bundle).
commission_amount	Integer	The amount of commission that will be charged for the sale of the product.
affiliate_commission	Integer	The commission amount that will be paid to the affiliate who promotes the product.
free_delivery	Integer	A boolean value indicating whether the product is eligible for free delivery.
variant_max_price	Integer	The maximum price of the product variant.
exclusive_price	Integer	The exclusive price of the product.
cart_step	Integer	The quantity of the product required to add it to the cart.

Downloadable Object

The downloadable object JSON keys are used to provide information about any downloadable content associated with a product. Here is an explanation of each key:

Key	Type	Description
downloadable_url	String	the URL where the downloadable content can be accessed. If there is no downloadable content associated with the product, the value for this key will be null.
downloadable_url_ar	String	the Arabic version of the downloadable_url. It is useful for e-commerce websites that support multiple languages.
downloadable_label	String	a label for the downloadable content. It can be used to describe the content and help customers understand what they will be downloading. If there is no downloadable content associated with the product, the value for this key will be null.
downloadable_label_ar	String	the Arabic version of the downloadable_label. It is useful for e-commerce websites that support multiple languages.