Salla Docs
Update Product
PUT/products/{product}This endpoint allows you to update specific product details by passing the product as a path parameter.
Request
The Product ID
The designated title or label assigned to a particular product. 🌐 Support multi-language
The price of the product.
The current condition or state of a product, indicating whether it is available for sale, out of stock, hidden, deleted. List of Product Statuses can be found here.
Quantity of the product. Will be skippped if unlimted_quantity=true
The specific place or venue where a booking or reservation is made, such as a hotel, restaurant, event venue, or transportation service.
Refers to the category or classification of a reservation or booking, indicating the nature or purpose of the booking. Required if booking_details != null
Booking duration is mandatory when the booking type is set as date_time. Required if type = date_time
Booking session gap is necessary when the booking type is date_time, and it specifies the amount of time between consecutive booking sessions or appointments. Required if type = date_time
Booking Sessions Count, which is the number of sessions allowed for one customer. Required if booking_details != null
A timeframe where it is not applicable to make reservations.
The restriction on making bookings within a specific timeframe is measured in minutes, hours, or days.
Required if booking_details != null
Overwrite availability for a particular day, on a particular date
Option to indicate the product is of unlimited quantity.
A product description provides detailed information about an item, helping customers understand its features, benefits, and intended use. 🌐 Support multi-language
A list of categories IDs, that will be associate with the product. List of Categories ID can be found here.
The minimum amount to donate.
The maximum amount to donate.
The sale price of the product.
Product cost price, the amount a business pays to acquire or manufacture a product before any additional expenses, such as overhead or markup, are applied
Product sale end, refers to the date or time when a promotional sale or discount on a product is scheduled to conclude or expire
determent if the product require shipping or not.
Maximum product quantity for each order.
The weight of the product represented in numerical form if applicable.
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).
Stock Keeping Unit is a unique alphanumeric code used to identify and manage specific products within a company's inventory. The Product SKU. List of Product SKU can be found here.
Manufacturer Part Number, a unique identifier assigned by a manufacturer to a specific product or component, which helps distinguish it from other similar products and facilitates inventory management, product tracking, and ordering processes.
"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.
Calories amount of the product.
The option to indicate that the product price includes tax or not.
The option to hide product quantity.
The option change the product's status to hidden if set to true or sale if set to false
The product to appear in specific channels
To enable upload image for the product when the customer add it to cart.
To enable add note for the product when customer add it to cart.
The option to enable pinning product in categories page.
Option to activate advance product details.
Subtitle of the product will display under product name in pages.
A label to display in the main image. 🌐 Support multi-language
A sublabel to display in the main image. 🌐 Support multi-language
Product de SEO Metadata Title which is a concise label used to optimize search engine results and enhance the visibility of a product details page. 🌐 Support multi-language
The page description for product will display in search engine results. 🌐 Support multi-language
The page url for product will display in search engine results. 🌐 Support multi-language
A unique identifier associated with a specific brand or manufacturer. List of Brand IDs can be found here.
Labels or markers applied to product listings or entries to indicate that they have been recently updated, check tags sections for more details. List of Product Tags can be found here.
{
"name": "T-Shirt Blue",
"price": 96.33,
"quantity": 4,
"description": "textophonious",
"categories": [
1032561074,
256950451
],
"min_amount_donating": 1,
"max_amount_donating": 5,
"sale_price": 43,
"cost_price": 35,
"sale_end": "2024-08-13",
"require_shipping": false,
"maximum_quantity_per_order": 0,
"weight": 12,
"weight_type": "kg",
"sku": "23-TD23-32",
"mpn": "4554343",
"gtin": "74753642",
"calories": "500.00",
"hide_quantity": false,
"channels": [
"web",
"app"
],
"enable_upload_image": true,
"enable_note": true,
"pinned": true,
"active_advance": true,
"subtitle": "Collection 2020",
"promotion_title": "New",
"booking_details": {
"location": "Medina",
"type": "date_time",
"time_strict_value": 5,
"time_strict_type": "days",
"sessions_count": 10,
"session_gap": 3,
"session_duration": 50,
"availabilities": [
{
"day": "sunday",
"is_available": true,
"times": [
{
"from": "09:30",
"to": "13:00"
},
{
"from": "12:00",
"to": "22:00"
}
]
},
{
"day": "monday",
"is_available": true,
"times": [
{
"from": "10:00",
"to": "12:00"
}
]
}
],
"overrides": [
{
"day": "sunday",
"date": "2023-04-09"
},
{
"day": "monday",
"date": "2023-04-10"
}
]
},
"metadata_title": "T-Shirt blue - collection 2020",
"metadata_description": "T-Shirt blue - collection 2020",
"brand_id": 1097509908,
"tags": [
1366932222,
591845887
]
}Request samples
[api.label.responses]
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
Detailed structure of the Product model object showing its fields and data types.
A unique identifier for a specific product within a database, inventory system, or catalog.
Product promotion details
Stock Keeping Unit is a unique alphanumeric code used to identify and manage specific products within a company's inventory.
Manufacturer Part Number (MPN) is a unique identifier assigned by manufacturers to products.
"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.
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
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.
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.
Product price details before the tax is applied.
Product tax price details
A detailed information about an item, helping customers understand its features, benefits, and intended use. 🌐 Support multi-language
The number of items available in stock.
Whether or not the product is of unlimited quantity.
Product status refers to the current condition or state of availability of a particular item within a product catalog or inventory.
Whether or not the product is available.
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.
The information about the discounted price or special pricing for a product.
The date or time when a promotional sale or discount on a product is scheduled to conclude or expire
Whether or not the product necessitates a physical delivery process or can be provided digitally without shipping.
The amount a business pays to acquire or manufacture a product before any additional expenses, such as overhead or markup, are applied
The weight of the product represented in numerical form if applicable.
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).
Whether or not a tax applied to this product or not.
The hyperlink that leads to a specific product's page.
Visual representations or pictures of a product, to showcase its appearance, features, and details to potential customers.
The total number of items of the product that have been purchased or sold over a certain period.
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.
Product regular price details.
The limit set on the number of products that an individual user is allowed to purchase.
Maximum quantity per order for the customer or the maximum quantity for the product.
Whether or not to show the product in the App.
Notify Quantity of the product.
Whether or not to hide the product quantity.
The product to appear in specific channels.
Whether or not to indicate if the product is managed by branches.
External services for the prodcut.
Calories amount of the product.
The merchant owner should activate this feature from his store from here.
Whether or not to allow adding attachments to the prodcut details.
Whether or not to show if the prodcut is pinned.
The date which the product was pinned at.
Sorting order of the product.
Whether or not to activate advance product details.
Whether or not to allow image uploading.
Product last updated date.
The additional choices that can be selected to customize the product according to preferences.
Product Variants SKUs Details
The data that describes other data, providing details on its creation, format, and context.
The information related to a specific booking, such as date, time, location, and other relevant particulars
The various sections or attributes that describe a product, such as name, price, description, specifications, and availability.
Detailed structure of the brand model object showing its fields and data types.
{
"status": 201,
"success": true,
"data": {
"id": 1672908878,
"promotion": {
"title": "ترويجي",
"sub_title": "فرعي"
},
"sku": "shirt-383",
"thumbnail": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg",
"mpn": null,
"gtin": null,
"type": "product",
"name": "T-Shirt",
"short_link_code": "qQvmmRb",
"urls": {
"customer": "https://salla.sa/dev-mvxlkrylzfanmuri/t-shirt/p1672908878",
"admin": "https://s.salla.sa/products/1672908878"
},
"price": {
"amount": 100,
"currency": "SAR"
},
"taxed_price": {
"amount": 100,
"currency": "SAR"
},
"pre_tax_price": {
"amount": 100,
"currency": "SAR"
},
"tax": {
"amount": 0,
"currency": "SAR"
},
"description": "regular t-shirt",
"quantity": null,
"status": "sale",
"is_available": true,
"views": 0,
"sale_price": {
"amount": 0,
"currency": "SAR"
},
"sale_end": null,
"require_shipping": true,
"cost_price": "35",
"weight": 1,
"weight_type": "kg",
"with_tax": true,
"url": "https://salla.sa/dev-mvxlkrylzfanmuri/t-shirt/p1672908878",
"main_image": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg",
"images": [
{
"id": 1699137764,
"url": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg",
"main": false,
"three_d_image_url": "",
"alt": "image",
"video_url": "",
"type": "image",
"sort": 5
}
],
"sold_quantity": 0,
"rating": {
"total": 0,
"count": 0,
"rate": 0
},
"regular_price": {
"amount": 100,
"currency": "SAR"
},
"max_items_per_user": 0,
"maximum_quantity_per_order": null,
"show_in_app": true,
"notify_quantity": null,
"hide_quantity": false,
"unlimited_quantity": true,
"managed_by_branches": false,
"services_blocks": {
"installments": []
},
"calories": null,
"customized_sku_quantity": false,
"channels": [
"web",
"app"
],
"metadata": {
"title": null,
"description": null,
"url": null
},
"allow_attachments": false,
"is_pinned": false,
"pinned_date": "2024-03-06 13:50:32",
"sort": 0,
"enable_upload_image": false,
"updated_at": "2024-03-06 13:50:32",
"options": [
{
"id": 784299854,
"name": "Color",
"description": null,
"type": "radio",
"required": false,
"associated_with_order_time": 0,
"availability_range": false,
"not_same_day_order": false,
"choose_date_time": null,
"from_date_time": null,
"to_date_time": null,
"sort": null,
"advance": true,
"display_type": "text",
"visibility": "always",
"translations": {
"ar": {
"option_name": "Color",
"description": null
}
},
"values": [
{
"id": 410377234,
"name": "Blue",
"price": {
"amount": 0,
"currency": "SAR"
},
"formatted_price": "",
"display_value": null,
"advance": true,
"option_id": 784299854,
"image_url": null,
"hashed_display_value": null,
"translations": {
"ar": {
"option_details_name": "Blue"
}
},
"is_default": false,
"is_out_of_stock": false
},
{
"id": 1783823123,
"name": "Red",
"price": {
"amount": 0,
"currency": "SAR"
},
"formatted_price": "",
"display_value": null,
"advance": true,
"option_id": 784299854,
"image_url": null,
"hashed_display_value": null,
"translations": {
"ar": {
"option_details_name": "Red"
}
},
"is_default": false,
"is_out_of_stock": false
}
]
},
{
"id": 2022020687,
"name": "Size",
"description": null,
"type": "radio",
"required": false,
"associated_with_order_time": 0,
"availability_range": false,
"not_same_day_order": false,
"choose_date_time": null,
"from_date_time": null,
"to_date_time": null,
"sort": null,
"advance": true,
"display_type": "text",
"visibility": "always",
"translations": {
"ar": {
"option_name": "Size",
"description": null
}
},
"values": [
{
"id": 1144986140,
"name": "Small",
"price": {
"amount": 0,
"currency": "SAR"
},
"formatted_price": "",
"display_value": null,
"advance": true,
"option_id": 2022020687,
"image_url": null,
"hashed_display_value": null,
"translations": {
"ar": {
"option_details_name": "Small"
}
},
"is_default": false,
"is_out_of_stock": false
},
{
"id": 369375517,
"name": "Large",
"price": {
"amount": 0,
"currency": "SAR"
},
"formatted_price": "",
"display_value": null,
"advance": true,
"option_id": 2022020687,
"image_url": null,
"hashed_display_value": null,
"translations": {
"ar": {
"option_details_name": "Large"
}
},
"is_default": false,
"is_out_of_stock": false
}
]
}
],
"skus": [
{
"id": 1936825372,
"price": {
"amount": 100,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"cost_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"notify_low": null,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
784299854,
2022020687
],
"related_option_values": [
410377234,
1144986140
],
"weight": null,
"weight_type": "kg",
"weight_label": "١ كجم",
"is_user_subscribed_to_sku": false,
"is_default": false
},
{
"id": 1298053917,
"price": {
"amount": 100,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"cost_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"notify_low": null,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
784299854,
2022020687
],
"related_option_values": [
369375517,
410377234
],
"weight": null,
"weight_type": "kg",
"weight_label": "١ كجم",
"is_user_subscribed_to_sku": false,
"is_default": false
},
{
"id": 524016158,
"price": {
"amount": 100,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"cost_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"notify_low": null,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
784299854,
2022020687
],
"related_option_values": [
1144986140,
1783823123
],
"weight": null,
"weight_type": "kg",
"weight_label": "١ كجم",
"is_user_subscribed_to_sku": false,
"is_default": false
},
{
"id": 1761671455,
"price": {
"amount": 100,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"cost_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"notify_low": null,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
784299854,
2022020687
],
"related_option_values": [
369375517,
1783823123
],
"weight": null,
"weight_type": "kg",
"weight_label": "١ كجم",
"is_user_subscribed_to_sku": false,
"is_default": false
}
],
"categories": [
{
"id": 256950451,
"name": "البلايز",
"urls": {
"customer": "https://salla.sa/dev-wofftr4xsra5xtlv/البلايز/c256950451",
"admin": "https://s.salla.sa/categories"
},
"items": [],
"parent_id": 0,
"status": "active",
"sort_order": 2,
"update_at": {
"date": "2022-01-16 15:35:55.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
}
},
{
"id": 783738494,
"name": "الفساتين",
"urls": {
"customer": "https://salla.sa/dev-wofftr4xsra5xtlv/البلايز/c256950451",
"admin": "https://s.salla.sa/categories"
},
"items": [],
"parent_id": 0,
"status": "active",
"sort_order": 2,
"update_at": {
"date": "2022-01-16 15:35:55.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
}
}
],
"tags": [
1366932222,
591845887
]
}
}