本文档由 Apifox 自动生成，推荐使用 Apifox - API 文档、API 调试、API Mock、API 自动化测试！
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:
قطعتين
percent
string
optional
Example:
20%
price
number
optional
Usage
offer object. Using this component, the developer can show both offer.name and offer.description. It contains a list of the related products that include offers. Using for-loop statement such as {% for product in offer.products %} , the list of the offered products can be retrieved and displayed using a slider with cards, for example. Similar Products
Cross-selling, or offer a better and more expensive alternative product, Upsells.Example
Variables
similar-products
products
array[object (Product) {28}]
optional
name
string
required
price
number
required
status
enum<string>
required
Allowed values:
hiddensaleout
product_type
enum<string>
required
Allowed values:
productservicegroup_productscodesdigitalfooddonatingbooking
quantity
number
required
unlimited_quantity
boolean
required
description
string
required
categories
array[string]
required
min_amount_donating
number
required
max_amount_donating
number
required
sale_price
number
required
cost_price
number
required
sale_end
string
required
require_shipping
boolean
required
maximum_quantity_per_order
number
required
weight
number
required
sku
string
required
hide_quantity
boolean
required
enable_upload_image
boolean
required
enable_note
boolean
required
pinned
boolean
required
active_advance
boolean
required
subtitle
string
required
promotion_title
string
required
metadata_title
string
required
metadata_description
string
required
brand_id
number
required
tags
array[number]
required
Usage
products objects, and then display the information for each product in the list.
扫码加入交流群Modified at 2025-02-20 07:53:20