Skip to main content

Product

Product Simple Resource

KeyTypeDescription
idIntegerThe unique identifier for the product.
parent_idIntegerThe ID of the parent product if this product is a variant.
skuStringThe Stock Keeping Unit number for the product.
barcodeStringThe barcode number for the product.
name_enStringThe name of the product in English.
name_arStringThe name of the product in Arabic.
encoded_name_enStringThe URL-encoded name of the product in English.
encoded_name_arStringThe URL-encoded name of the product in Arabic.
featuredBooleanA boolean indicating whether the product is featured or not.
descriptionStringA brief description of the product.
meta_titleStringThe meta title for the product.
slugStringThe slug for the product.
meta_descriptionStringThe meta description for the product.
keywordsStringThe keywords associated with the product.
preorderBooleanA boolean indicating whether the product is available for pre-order or not.
preorder_priceIntegerThe price of the product during the pre-order period.
preorder_start_dateIntegerThe start date of the pre-order period.
preorder_end_dateIntegerThe end date of the pre-order period.
imageStringThe main image for the product.
imagesArrayAn array of additional images for the product.
thumbnail_imageStringThe thumbnail image for the product.
videoStringA video URL associated with the product.
available_soonBooleanA boolean indicating whether the product will be available soon or not.
priceIntegerThe price of the product.
brandObjectThe brand details associated with the product.
discount_priceIntegerThe discounted price of the product.
has_promotionBooleanA boolean indicating whether the product has a promotion or not.
discount_start_dateDataTimeThe start date of the promotion.
discount_end_dateDataTimeThe end date of the promotion.
discount_max_per_periodIntegerThe maximum number of times a customer can use the promotion during the promotion period.
discount_period_cycle_daysIntegerThe number of days for the promotion period.
direct_discountIntegerA boolean indicating whether the discount is directly applied to the product price or not.
downloadableObjectThe downloadable items associated with the product.
categoryObjectThe category associated with the product.
optional_sub_category_idIntegerThe ID of the optional sub-category associated with the product.
in_stockIntegerA boolean indicating whether the product is in stock or not.
stockIntegerThe current stock level of the product.
promotionStringThe promotion associated with the product.
promotion_enStringThe promotion description in English.
promotion_arStringThe promotion description in Arabic.
is_favouriteBooleanA boolean indicating whether the product is marked as a favorite or not.
is_compareBooleanA boolean indicating whether the product is marked for comparison or not.
share_linkIntegerThe link to share the product.
rateIntegerThe rating for the product.
payment_methods_discount_name_enStringThe name of the payment method discount in English.
payment_methods_discount_name_arStringThe name of the payment method discount in Arabic.
promosArrayAn array of promotions associated with the product.
product_variants_optionsArrayThe variant options for the product.
product_variantsArrayThe variant products associated with the main product.
orderIntegerThe display order for the product.
weightIntegerThe weight of the product.
activeBooleanA boolean indicating whether the product is active or not.
amountIntegerThe quantity of the product in the cart
variants_stock_countIntegerThe total number of the product variants available in stock.
can_buyIntegerThe maximum quantity of the product that can be added to a single order.
soft_deletedBooleanA boolean value indicating whether the product has been marked as deleted but is still available in the database.
max_per_orderIntegerThe maximum quantity of the product that can be added to a single order.
typeIntegerthe type of the product (e.g. Single or Bundle).
commission_amountIntegerThe amount of commission that will be charged for the sale of the product.
affiliate_commissionIntegerThe commission amount that will be paid to the affiliate who promotes the product.
free_deliveryIntegerA boolean value indicating whether the product is eligible for free delivery.
variant_max_priceIntegerThe maximum price of the product variant.
exclusive_priceIntegerThe exclusive price of the product.
cart_stepIntegerThe 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:

KeyTypeDescription
downloadable_urlStringthe 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_arStringthe Arabic version of the downloadable_url. It is useful for e-commerce websites that support multiple languages.
downloadable_labelStringa 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_arStringthe Arabic version of the downloadable_label. It is useful for e-commerce websites that support multiple languages.