Product

Product

is_external_product

boolean

optional

This property is used to indicate whether the product is sourced externally.

Default:

false

id

null

optional

Unique identifier for the product. (Set to null if is_external_product is true)

parent_id

null

optional

Unique identifier for the parent product, if any. This product could be a variant of the parent product. (Set to null if is_external_product is true)

product_class

string

optional

Set to "grouped_product" to indicate it's a group of sub-products.

sku

string

optional

Stock Keeping Unit - unique identifier that allows a product to be tracked for inventory purposes.

barcode

string

optional

This field allows you to specify a barcode associated with the product, if applicable.

name

object

optional

Localized product name in Arabic (ar) and English (en).

ar

string

optional

en

string

optional

slug

string

optional

SEO friendly URL, usually derived from the product name.

price

integer

optional

Base price of the grouped product (100.0).

short_description

null

optional

This field is optional and can be used to provide a brief description of the product.

sale_price

integer

optional

If the product is on sale, this field specifies the discounted price in the smallest currency unit.

Example:

50

formatted_price

string

optional

This field contains the base price formatted according to the currency settings.

Example:

10$

formatted_sale_price

string

optional

If applicable, this field holds the formatted discounted price.

Example:

8$

currency

string

optional

currency_symbol

string

optional

Shows the currency type.

attributes

array [object]

optional

categories

array [object]

optional

display_order

null

optional

This field is currently unused but might be reserved for future functionalities related to product display order.

has_options

boolean

optional

This flag indicates whether the product has options (variations) available. (e.g., different sizes or colors).

Default:

false

has_fields

boolean

optional

This flag signifies whether the product has custom form fields associated with it.

images

array [object]

optional

This array stores information about the product images.

is_draft

boolean

optional

Indicates if the product is a draft (False - published).

quantity

null

optional

Shows the quanitity of the product.

is_infinite

boolean

optional

html_url

string

optional

This field contains the URL for the product page on your storefront.

weight

object

optional

Weight of the product.

value

integer | null

optional

Currently set to null, indicating the weight value might need to be provided elsewhere.

Example:

100

unit

string

optional

This field allows you to specify the unit of weight (e.g., "g", "kg", "lb").

Example:

kg

keywords

array [object]

optional

This array allows you to define a list of relevant keywords associated with the product for better search optimization.

requires_shipping

boolean

optional

is_taxable

boolean

optional

Indicates if the product is taxable.

Default:

false

structure

string

optional

seo

object

optional

SEO-related data for the product.

title

object

optional

SEO title for the product page.

description

object

optional

SEO description for the product page.

rating

object

optional

This object provides average product rating information.

average

integer

optional

Average rating score.

Example:

3.9

total_count

integer

optional

Total number of ratings received.

Example:

400

1_ratings

object

optional

2_ratings

object

optional

3_ratings

object

optional

4_ratings

object

optional

5_ratings

object

optional

store_id

integer

optional

Unique identifier of the store in which the product is listed.

purchase_restrictions

object

optional

min_quantity_per_cart

null

optional

max_quantity_per_cart

null

optional

availability_period_start

null

optional

availability_period_end

null

optional

sale_price_period_start

string

optional

This parameter indicates the start date and time for the sale price of the product. It is represented in ISO 8601 format (YYYY-MM-DDTHH:MM
.sssZ) and determines when the discounted sale price becomes effective.

Example:

2024-09-18T21:00:00.000000Z

sale_price_period_end

string

optional

This parameter represents the end date and time for the sale price of the product. It is also in ISO 8601 format and defines when the discounted sale price ends.

Example:

2024-09-19T20:59:59.000000Z

metafields

null

optional

meta

object

optional

badge

object

optional

body

object

optional

icon

object

optional

related_products_settings

string

optional

related_products_title

null

optional

variants

array [object]

optional

options

array [object]

optional

cost

integer

optional

is_published

boolean

optional

Indicates if the product is published and visible (true).

waiting_customers_count

null

optional

description

object

optional

custom_user_input_fields

array [object]

optional

custom_option_fields

array [object]

optional

related_products

array [object]

optional

next_product

null

optional

previous_product

null

optional

group_products

array [object {6}]

optional

An array of objects representing the sub-products included in the grouped product. Only required when product_class is set to "grouped_product". Refer to the Update Existing Product documentation for details on the "group_products" fields.

id

string

optional

ID of the sub-product within the group.

Example:

143

item

object

optional

origin_product_id

string

optional

item_id

string

optional

item_quantity

integer

optional

in_stock

boolean

optional

stocks

array [object {4}]

optional

This array provides details about product stock.

id

string

optional

location

object

optional

Details about the storage location (ID and name).

available_quantity

null

optional

Quantity of the product in stock.

is_infinite

boolean

optional

Flag to indicate if the product quantity is infinite.

sold_products_count

null

optional

created_at

string

optional

Date and time the product was created.

updated_at

string

optional

Date and time the product was last updated.