Salla Docs
Create Product
POST/productsProducts can be created within your store at Salla by providing the required data in this endpoint.
:::tip[Note]
You can list available categories from List Categories endpoint.
:::
:::caution[Alert]
- Created products status will be set to
hiddentill attaching one image at least. - Created products status will be set to
outtill adding a value in quantity parameter. - Created products type cannot be changed after a product is created.
:::
Request
A Product Name is a succinct label for a specific item, aiding in easy identification and categorization within a product listing. List of products can be found here.
Product price is the specified cost assigned to a particular item, determining its value in a commercial transaction.
Product status refers to the current condition or state of availability of a particular item within a product catalog or inventory. Available values 'hidden','sale','out'.
Product type categorizes items based on shared attributes or characteristics, aiding in effective organization and search within a product inventory. Available values are, 'product', 'service', 'group_products', 'codes', 'digital', 'food', and 'donating'
Product quantity indicates the numerical count of a specific item available in inventory, representing its availability for sale or distribution.
The specific place or site where a reservation or booking is made.
Booking Type. Required if booking_details != null
The length of time that a particular session. Required if type = date_
The period of time between two consecutive sessions or events, indicating the duration between the end of one session and the start of the next.. 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
Whether or not the product is of unlimited quantity.
A product description provides detailed information about an item, helping customers understand its features, benefits, and intended use.
A list of categories ID's, that will be associated with the product. List of categories can be found here.
The minimum amount to donate.
The maximum amount to donate.
Product sale price value.
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
Require shipping indicates whether the product necessitates a physical delivery process or can be provided digitally without shipping.
Maximum quantity per order for the customer or the maximum quantity for the product.
The weight of the product represented in numerical form if applicable.
Weight Type
Sku of the product.
Manufacturer Part Number.
Global Trade Item Number. If product_type is set to any of the following: product, group_products, codes, digital, donating
then value can be set. Otherwise, it can be set to null
Calories Value. If product_type is set tofood, value can bet set. Otherwise, it can be set to null
weather to hide the quantity or not.
Whether or not to change the product's status to hidden if set to true or sale if set to false
Whether or not to enable upload image for the product when the customer add it to cart.
Whether or not to enable add note for the product when customer add it to cart.
Whether or not the product is pinned in the categories page.
Whether or not to activate product advanced option.
Subtitle of the product will display under product name in pages.
A label to display in the main image.
A sublabel to display in the main image.
The page title for product will display in search engine results.
The page description for product will display in search engine results.
The page url for product will display in search engine results.
The brand id for product.
The product tag, list of product tags can be founf here.
The Product is under a Group of Products.
Consisted Product ID
Consisted Product Quantity
Original Quality Image
Thumbnail Image
Alternative Text for the Image
Whether or not the image is the default one for the product
Image's position in a list of other images within the product.
The product to appear in specific channels
A distinctive label or title assigned to a specific item or commodity, serving as an identifier and often conveying essential information about the product.
Whether or not the product option is required.
Product option field visibilty.
Visibility condition type. Required if the visibility variable is set to on_condition
The product option's ID for the condition. Required if the variable visibility is set to on_condition.
The product option value's ID for the condition. Required if the variable visibility is set to on_condition
The various choices or variations of a product are visually presented to customers, typically categorized as text, image, or color representations.
{
"name": "T-Shirt Blue",
"price": 96.33,
"status": "out",
"product_type": "product",
"quantity": 4,
"booking_details": {
"location": "Medina",
"type": "date",
"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"
}
]
},
"description": "textophonious",
"categories": [
1032561074,
256950451
],
"min_amount_donating": 1,
"max_amount_donating": 5,
"sale_price": 43,
"cost_price": 35,
"sale_end": "2025-08-13",
"require_shipping": false,
"maximum_quantity_per_order": 0,
"weight": 12,
"weight_type": "kg",
"sku": "23-4324432",
"mpn": "45344432343",
"gtin": "58636897",
"hide_quantity": false,
"enable_upload_image": true,
"enable_note": true,
"pinned": true,
"active_advance": true,
"subtitle": "Collection 2020",
"promotion_title": "New",
"metadata_title": "T-Shirt blue - collection 2020",
"metadata_description": "T-Shirt blue - collection 2020",
"brand_id": 1097509908,
"tags": [
1366932222,
591845887
],
"images": [
{
"original": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg",
"thumbnail": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg",
"alt": "image",
"default": true,
"sort": 5
}
],
"options": [
{
"name": "option2",
"display_type": "text",
"values": [
{
"name": "الأزرق",
"price": 120,
"quantity": 10
},
{
"name": "الاحمر",
"price": 120,
"quantity": 10
},
{
"name": "الاصفر",
"price": 120,
"quantity": 10
}
]
},
{
"name": "option3",
"display_type": "text",
"values": [
{
"name": "كبير",
"price": 120,
"quantity": 10
},
{
"name": "صغير",
"price": 120,
"quantity": 10
},
{
"name": "متوسط",
"price": 120,
"quantity": 10
}
]
}
]
}Request samples
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": 207865447,
"promotion": {
"title": "New",
"sub_title": "Collection 2020"
},
"sku": null,
"mpn": "45344432343",
"gtin": "58636897",
"type": "product",
"name": "T-Shirt Blue",
"short_link_code": "xxwWwo",
"urls": {
"customer": "https://salla.sa/dev-wofftr4xsra5xtlv/t-shirt-blue-collection-2020/p207865447",
"admin": "https://s.salla.sa/products/207865447"
},
"price": {
"amount": 43,
"currency": "SAR"
},
"taxed_price": {
"amount": 43,
"currency": "SAR"
},
"pre_tax_price": {
"amount": 43,
"currency": "SAR"
},
"tax": {
"amount": 0,
"currency": "SAR"
},
"description": "textophonious",
"quantity": 4,
"status": "sale",
"is_available": true,
"views": 0,
"sale_price": {
"amount": 43,
"currency": "SAR"
},
"sale_end": "2025-08-13",
"require_shipping": true,
"cost_price": "35.00",
"weight": 12,
"weight_type": "kg",
"with_tax": true,
"url": "https://salla.sa/dev-wofftr4xsra5xtlv/t-shirt-blue-collection-2020/p207865447",
"main_image": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg",
"channels": [
"web",
"app"
],
"images": [
{
"id": 712603963,
"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": 1,
"rate": 0
},
"regular_price": {
"amount": 96.33,
"currency": "SAR"
},
"max_items_per_user": 0,
"maximum_quantity_per_order": null,
"show_in_app": true,
"notify_quantity": null,
"hide_quantity": false,
"unlimited_quantity": false,
"managed_by_branches": false,
"services_blocks": {
"installments": []
},
"calories": null,
"starting_price": null,
"metadata": {
"title": "T-Shirt blue - collection 2020",
"description": "T-Shirt blue - collection 2020"
},
"allow_attachments": false,
"is_pinned": true,
"pinned_date": "2022-06-23 01:04:38",
"sort": 0,
"enable_upload_image": true,
"updated_at": "2022-06-23 01:04:38",
"options": [
{
"id": 319461767,
"name": "option2",
"description": null,
"type": "text",
"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": "option2",
"description": null
}
},
"values": [
{
"id": 1663429593,
"name": "الأزرق",
"price": {
"amount": 0,
"currency": "SAR"
},
"formatted_price": "(11 ر.س)",
"display_value": null,
"advance": true,
"option_id": 319461767,
"image_url": null,
"hashed_display_value": null,
"translations": {
"ar": {
"option_details_name": "الأزرق"
}
},
"is_default": false,
"is_out_of_stock": false
},
{
"id": 1023544026,
"name": "الاحمر",
"price": {
"amount": 0,
"currency": "SAR"
},
"formatted_price": null,
"display_value": null,
"advance": true,
"option_id": 319461767,
"image_url": null,
"hashed_display_value": null,
"translations": {
"ar": {
"option_details_name": "الاحمر"
}
},
"is_default": false,
"is_out_of_stock": false
},
{
"id": 250554843,
"name": "الاصفر",
"price": {
"amount": 0,
"currency": "SAR"
},
"formatted_price": null,
"display_value": null,
"advance": true,
"option_id": 319461767,
"image_url": null,
"hashed_display_value": null,
"translations": {
"ar": {
"option_details_name": "الاصفر"
}
},
"is_default": false,
"is_out_of_stock": false
}
]
},
{
"id": 1826076800,
"name": "option3",
"description": null,
"type": "text",
"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": "option3",
"description": null
}
},
"values": [
{
"id": 1488209956,
"name": "كبير",
"price": {
"amount": 0,
"currency": "SAR"
},
"formatted_price": null,
"display_value": null,
"advance": true,
"option_id": 1826076800,
"image_url": null,
"hashed_display_value": null,
"translations": {
"ar": {
"option_details_name": "كبير"
}
},
"is_default": false,
"is_out_of_stock": false
},
{
"id": 714168101,
"name": "صغير",
"price": {
"amount": 0,
"currency": "SAR"
},
"formatted_price": null,
"display_value": null,
"advance": true,
"option_id": 1826076800,
"image_url": null,
"hashed_display_value": null,
"translations": {
"ar": {
"option_details_name": "صغير"
}
},
"is_default": false,
"is_out_of_stock": false
},
{
"id": 75396646,
"name": "متوسط",
"price": {
"amount": 0,
"currency": "SAR"
},
"formatted_price": null,
"display_value": null,
"advance": true,
"option_id": 1826076800,
"image_url": null,
"hashed_display_value": null,
"translations": {
"ar": {
"option_details_name": "متوسط"
}
},
"is_default": false,
"is_out_of_stock": false
}
]
}
],
"skus": [
{
"id": 112657257,
"price": {
"amount": 43,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
1663429593,
1488209956
],
"related_option_values": [
1663429593,
1488209956
],
"weight": null,
"weight_type": "kg",
"weight_label": "١٢ كجم",
"is_user_subscribed_to_sku": false,
"is_default": true
},
{
"id": 1352409706,
"price": {
"amount": 43,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
1663429593,
714168101
],
"related_option_values": [
1663429593,
714168101
],
"weight": null,
"weight_type": "kg",
"weight_label": "١٢ كجم",
"is_user_subscribed_to_sku": false,
"is_default": true
},
{
"id": 578371947,
"price": {
"amount": 43,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
1663429593,
75396646
],
"related_option_values": [
1663429593,
75396646
],
"weight": null,
"weight_type": "kg",
"weight_label": "١٢ كجم",
"is_user_subscribed_to_sku": false,
"is_default": true
},
{
"id": 2084986996,
"price": {
"amount": 43,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
1023544026,
1488209956
],
"related_option_values": [
1023544026,
1488209956
],
"weight": null,
"weight_type": "kg",
"weight_label": "١٢ كجم",
"is_user_subscribed_to_sku": false,
"is_default": true
},
{
"id": 1311543157,
"price": {
"amount": 43,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
1023544026,
714168101
],
"related_option_values": [
1023544026,
714168101
],
"weight": null,
"weight_type": "kg",
"weight_label": "١٢ كجم",
"is_user_subscribed_to_sku": false,
"is_default": true
},
{
"id": 403287670,
"price": {
"amount": 43,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
1023544026,
75396646
],
"related_option_values": [
1023544026,
75396646
],
"weight": null,
"weight_type": "kg",
"weight_label": "١٢ كجم",
"is_user_subscribed_to_sku": false,
"is_default": true
},
{
"id": 1977011575,
"price": {
"amount": 43,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
250554843,
1488209956
],
"related_option_values": [
250554843,
1488209956
],
"weight": null,
"weight_type": "kg",
"weight_label": "١٢ كجم",
"is_user_subscribed_to_sku": false,
"is_default": true
},
{
"id": 1202973808,
"price": {
"amount": 43,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
250554843,
714168101
],
"related_option_values": [
250554843,
714168101
],
"weight": null,
"weight_type": "kg",
"weight_label": "١٢ كجم",
"is_user_subscribed_to_sku": false,
"is_default": true
},
{
"id": 295177073,
"price": {
"amount": 43,
"currency": "SAR"
},
"regular_price": {
"amount": 0,
"currency": "SAR"
},
"sale_price": null,
"has_special_price": false,
"stock_quantity": null,
"unlimited_quantity": true,
"barcode": null,
"sku": null,
"mpn": null,
"gtin": null,
"related_options": [
250554843,
75396646
],
"related_option_values": [
250554843,
75396646
],
"weight": null,
"weight_type": "kg",
"weight_label": "١٢ كجم",
"is_user_subscribed_to_sku": false,
"is_default": true
}
],
"booking_details": {
"id": 1219318081,
"type": "date_time",
"session_duration": 50,
"session_gap": 3,
"sessions_count": 10,
"location": "Medina",
"time_strict_type": "days",
"time_strict": 5,
"overrides": [
{
"id": 520625452,
"date": "2023-04-09"
},
{
"id": 1758805037,
"date": "2023-04-10"
}
],
"availabilities": [
{
"id": 1995455874,
"day": "sunday",
"times": [
{
"from": "09:30",
"to": "13:00"
},
{
"from": "12:00",
"to": "22:00"
}
],
"is_available": true
},
{
"id": 314211212,
"day": "monday",
"times": [
{
"from": "09:30",
"to": "13:00"
}
],
"is_available": true
}
]
},
"categories": [
{
"id": 1032561074,
"name": "الفساتين",
"urls": {
"customer": "https://salla.sa/dev-wofftr4xsra5xtlv/الفساتين/c1032561074",
"admin": "https://s.salla.sa/categories"
},
"items": [],
"parent_id": 0,
"status": "active",
"sort_order": 1,
"update_at": {
"date": "2022-04-25 19:46:26.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
}
},
{
"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"
}
}
],
"brand": {
"id": 1097509908,
"name": "بوما",
"description": "بوما وصف بالعربي",
"banner": "https://cdn.salla.sa/bYQEn/69QZx9DHUIQDLCoN7YAq9htHBH0tzD5luk5Rob7w.png",
"logo": "https://cdn.salla.sa/bYQEn/QqxF15HPwXw92PPsI7xSZ6F8ONWlOPojoWl48y4W.png",
"ar_char": "ب",
"en_char": "B"
},
"tags": [
{
"id": 1366932222,
"name": "tag1"
},
{
"id": 591845887,
"name": "tag2"
}
]
}
}