Merchant ID who installed the application on their store. Get details on the Merchant via the ID using the endpoint here
created_at
string
optional
Timestamp of the created Event
data
object(ProductDetails)
optional
Detailed structure of the Product model object showing its fields and data types.
id
number
required
A unique identifier for a specific product within a database, inventory system, or catalog.
promotion
object
required
Product promotion details
sku
string
required
Stock Keeping Unit is a unique alphanumeric code used to identify and manage specific products within a company's inventory.
mpn
string|null
required
Manufacturer Part Number (MPN) is a unique identifier assigned by manufacturers to products.
Example:
45343
gtin
string|null
required
"Global Trade Item Number" (GTIN), a unique and standardized identifier used to uniquely represent products, items, or services in the global marketplace, to enable efficient tracking and management across supply chains and retail sectors.
Example:
14643439
type
enum<string>
required
The categorization of a product based on its characteristics, features, or intended use.
A label for an item, aiding in easy identification and categorization within a product listing. 🌐 Supports multi-language
short_link_code
string
required
A short and simplified alphanumeric code or URL used to provide a quick and easy way to access or share a specific product's webpage or information.
urls
object(Urls)
required
To help companies and merchants, Salla provides a “urls” attribute that has been added to different modules to guide the merchants to have the full URL of this module from both scopes, the dashboard scope as a store admin, and as a customer.
price
object
required
taxed_price
object
required
pre_tax_price
object
required
Product price details before the tax is applied.
tax
object
required
Product tax price details
description
string
required
A detailed information about an item, helping customers understand its features, benefits, and intended use. 🌐 Support multi-language
quantity
integer
required
The number of items available in stock.
unlimited_quantity
boolean
required
Whether or not the product is of unlimited quantity.
status
enum<string>
required
Product status refers to the current condition or state of availability of a particular item within a product catalog or inventory.
Allowed values:
saleouthiddendeleted
is_available
boolean
required
Whether or not the product is available.
views
integer
required
The total number of times a specific product has been viewed by users, often used as a metric to gauge product popularity or user interes.
sale_price
object
required
The information about the discounted price or special pricing for a product.
sale_end
string
required
The date or time when a promotional sale or discount on a product is scheduled to conclude or expire
require_shipping
boolean
required
Whether or not the product necessitates a physical delivery process or can be provided digitally without shipping.
cost_price
number
required
The amount a business pays to acquire or manufacture a product before any additional expenses, such as overhead or markup, are applied
weight
number
required
The weight of the product represented in numerical form if applicable.
weight_type
enum<string>
required
The classification or unit of measurement used to specify the weight of an object or item, such as kilograms (kg), pounds (lb), ounces (oz), or grams (g).
Allowed values:
kgglboz
with_tax
boolean
required
Whether or not a tax applied to this product or not.
url
string
required
The hyperlink that leads to a specific product's page.
images
array [object {9}]
required
Visual representations or pictures of a product, to showcase its appearance, features, and details to potential customers.
sold_quantity
integer
required
The total number of items of the product that have been purchased or sold over a certain period.
rating
object
required
Product rating details, include information about the ratings and reviews provided by customers for a specific product, including the average rating, individual reviews, and any associated comments or feedback, often used to gauge the product's quality and customer satisfaction.
regular_price
object
required
Product regular price details.
max_items_per_user
number
required
The limit set on the number of products that an individual user is allowed to purchase.
maximum_quantity_per_order
number|null
required
Maximum quantity per order for the customer or the maximum quantity for the product.
show_in_app
boolean
required
Whether or not to show the product in the App.
notify_quantity
string|null
required
Notify Quantity of the product.
hide_quantity
boolean
required
Whether or not to hide the product quantity.
channels
array[string]
required
The product to appear in specific channels.
Allowed values:
appweb
managed_by_branches
boolean
required
Whether or not to indicate if the product is managed by branches.
service_blocks
object
required
External services for the prodcut.
calories
string|null
required
Calories amount of the product.
Example:
500.00
starting_price
object
required
The merchant owner should activate this feature from his store from here.
Example:
500.00
allow_attachments
boolean
required
Whether or not to allow adding attachments to the prodcut details.
is_pinned
boolean
required
Whether or not to show if the prodcut is pinned.
pinned_date
string
required
The date which the product was pinned at.
sort
number
required
Sorting order of the product.
active_advance
boolean
required
Whether or not to activate advance product details.
enable_upload_image
boolean
required
Whether or not to allow image uploading.
updated_at
string
required
Product last updated date.
options
array[object (MiniProductOption) {13}]
required
The additional choices that can be selected to customize the product according to preferences.
skus
array[object (ProductVariant) {21}]
required
Product Variants SKUs Details
metadata
object
required
The data that describes other data, providing details on its creation, format, and context.
booking_details
object
required
The information related to a specific booking, such as date, time, location, and other relevant particulars
categories
array[object (Category) {14}]
required
The various sections or attributes that describe a product, such as name, price, description, specifications, and availability.
brand
object(Brand)
required
Detailed structure of the brand model object showing its fields and data types.