Essentials
Donation Progress Bar
Example

Variables
donation-progress-bar
product
object
optional
donation
object (donation)
optional
Usage
donation
object contains all of the donation related values and messages. For example;product.donation.collected_amount
: shows the collected amount up to date.product.donation.target_amount
: shows the targeted amount to be collected.product.donation.target_percent
: shows the percentage of the targeted amount.
Offer
Example

Variables
offer
id
integer
optional
name
string
optional
description
string
optional
categories
array[object (Category) {14}]
optional
id
number
required
name
string
required
image
string
required
urls
object (Urls)
required
parent_id
integer
required
sort_order
integer | null
required
status
enum<string>
required
active
or intentionally concealed from view hidden
. It essentially controls whether the category is publicly displayed or kept private within the system.Allowed values:
activehidden
show_in
object
required
has_hidden_products
boolean
required
update_at
string
required
metadata
object
required
sub_categories
array[string]
required
translations
object
required
with=translations
query parameter.translations
object will return two entries: ar
for Arabic and en
for English.items
array[object (Category) {14}]
required
with=items
query parameter.products
array[object (Product) {43}]
optional
id
integer
optional
name
string
optional
Example:
HUAWEI Band 6 Smart Band 96
description
string
optional
Example:
Light material for designed to your comfort while exercising.
url
string
optional
promotion_title
string
optional
subtitle
string
optional
type
enum<string>
optional
Allowed values:
productservicegroup_productscodesdigitalfooddonating
status
enum<string>
optional
Allowed values:
saleout
weight
string | null
optional
calories
integer | null
optional
sku
string | null
optional
rating
object
Rating | null
price
number
optional
sale_price
number
optional
regular_price
number
optional
starting_price
number
optional
Example:
Price start from ٨٣٠ ر.س
quantity
integer | null
optional
Example:
500
sold_quantity
integer
optional
Example:
450
max_quantity
integer
optional
Example:
1000
discount_ends
string | null
optional
is_taxable
boolean
optional
category
object
optional
image
object
optional
images
array [object {5}]
optional
brand
object
optional
tags
array [object {2}]
optional
options
object (ProductOption)
optional
notify_availability
object | null
optional
donation
object
object | null
has_read_more
boolean
optional
can_add_note
boolean
optional
can_show_sold
boolean
optional
can_show_remained_quantity
boolean
optional
can_upload_file
boolean
optional
has_custome_form
boolean
optional
Food
or Custom Service
product.has_options
boolean
optional
is_on_sale
boolean
optional
is_hidden_quantity
boolean
optional
is_available
boolean
optional
is_donation
boolean
optional
is_in_wishlist
boolean
optional
is_out_of_stock
boolean
optional
is_require_shipping
boolean
optional
discounts_table
array [object {6}]
optional
show_discounted_price
boolean
optional
regular_price
number
optional
quantity
integer
optional
Example:
2
quantity_text
string
optional
Example: