Product Details

Product Details 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.
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.
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 in English.
keywords_ar	String	The keywords associated with the product in Arabic.
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.
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.
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 favourite 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	Integer	A boolean indicating whether the product is active or not.
amount	Integer	The quantity of the product in the cart
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.
cart_step	Integer	The quantity of the product required to add it to the cart.
long_description_en	Integer	the longer description of the product in English.
long_description_ar	Integer	the longer description of the product in Arabic.
related_skus	Integer	an array of SKUs of related products.
optional_category	Integer	information about an optional category the product belongs to.
description_en	Integer	the description of the product in English.
description_ar	Integer	the description of the product in Arabic.
video_url	Integer	the URL of a video associated with the product.
video_thumbnail_url	Integer	the URL of a thumbnail image for the product video.

Product Variant Resource

Key	Type	Description
id	Integer	a unique identifier for the product variant.
slug	String	a URL-friendly version of the product variant name.
share_link	String	the URL link to share the product variant.
name_en	String	the name of the product variant in English.
name_ar	String	the name of the product variant in Arabic.
description_en	String	the description of the product variant in English.
description_ar	String	the description of the product variant in Arabic.
video_url	String	the URL of a video associated with the product variant.
video_thumbnail_url	String	the URL of the thumbnail image for the video associated with the product variant.
long_description_en	String	the long description of the product variant in English.
long_description_ar	String	the long description of the product variant in Arabic.
sku	String	a stock keeping unit code that uniquely identifies the product variant.
barcode	String	the barcode associated with the product variant.
price	Integer	the price of the product variant.
discount_price	Integer	the discounted price of the product variant.
stock	Integer	the quantity of the product variant in stock.
stock_alert	Integer	a notification or alert related to the stock availability of the product variant.
options	Integer	options or attributes associated with the product variant.
default_variant	Integer	the default variant of the product variant.
order	Integer	the order of the product variant in a list or category.
video	Integer	a video associated with the product variant.
is_favourite	Boolean	a boolean value indicating whether the product variant is marked as a favorite by the customer.
is_compare	Boolean	a boolean value indicating whether the product variant is marked for comparison by the customer.
keywords	String	keywords associated with the product variant in English.
keywords_ar	String	keywords associated with the product variant in Arabic.
available_soon	Boolean	a boolean value indicating whether the product variant will be available soon.
preorder	Integer	a boolean value indicating whether the product variant is available for pre-order.
preorder_price	Integer	the price of the product variant during the pre-order period.
payment_methods_discount_name_en	String	the name of the payment method in English associated with specific items discount.
payment_methods_discount_name_ar	String	the name of the payment method in Arabic associated with specific items discount.
payment_method_discount_ids	Array	the IDs of the payment methods associated with the discount.
discount_start_date	String	the start date of the discount period for the product variant.
discount_end_date	String	the end date of the discount period for the product variant.
discount_max_per_period	String	the maximum quantity of the product variant that can be purchased at a discounted price within a specific period.
discount_period_cycle_days	Integer	the number of days in the discount period cycle for the product variant.
max_per_order	Integer	the maximum quantity of the product variant allowed per order.
value_ids	Array	the IDs of the values associated with the product variant.
image	String	the URL of the image for the product variant.
parent_id	Integer	the ID of the parent product to which this variant belongs.
commission_amount	Integer	the commission amount associated with the product variant.
affiliate_commission	Integer	the affiliate commission associated with the product variant.
images	Array	an array of URLs of additional images for the product variant.
in_stock	Boolean	a boolean value indicating whether the product variant is in stock.
active	Boolean	a boolean value indicating whether the product variant is active.
amount	Integer	the quantity or amount of the product variant.
free_delivery	Boolean	a boolean value indicating whether the product variant is eligible for free delivery.
promotion_en	String	the promotion associated with the product variant in English.
promotion_ar	String	the promotion associated with the product variant in Arabic.
cart_step	Integer	the step or stage at which the product variant appears in the shopping cart.

Images Resource

Key	Type	Description
id	Integer	The unique identifier of the image.
product_id	Integer	The identifier of the product to which the image belongs.
url	Integer	The URL of the image. It represents the full-size version of the image.
thumbnail	Integer	The URL of the thumbnail version of the image. Thumbnails are typically smaller and optimized versions of the original image, suitable for preview or display purposes.