Update Product By SKU - Salla Merchants APIs

This endpoint allows you to update specific product details by passing the sku as a path parameter.

Scopes

products.read_write- Products Read & Write

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

sku

string

required

The Product SKU. List of Product SKU can be found here.

Body Params application/json

name

string

optional

The designated title or label assigned to a particular product. 🌐 Support multi-language

price

number

optional

The price of the product.

status

enum<string>

optional

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.

Allowed values:

saleouthiddendeleted

quantity

number

optional

Quantity of the product. Will be skippped if unlimted_quantity=true

booking_details

object

optional

location

string

optional

The specific place or venue where a booking or reservation is made, such as a hotel, restaurant, event venue, or transportation service.

Example:

Medina

type

enum<string>

optional

Refers to the category or classification of a reservation or booking, indicating the nature or purpose of the booking. Required if booking_details != null

Allowed values:

date_timedate

Example:

time

session_duration

number

optional

Booking duration is mandatory when the booking type is set as date_time. Required if type = date_time

session_gap

number

optional

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

session_count

number

optional

Booking Sessions Count, which is the number of sessions allowed for one customer. Required if booking_details != null

time_strict_value

number

optional

A timeframe where it is not applicable to make reservations.

Example:

time_strict_type

enum<string>

optional

The restriction on making bookings within a specific timeframe is measured in minutes, hours, or days.

Allowed values:

minuteshoursdays

Default:

days

availabilities

array [object {3}]

optional

Required if booking_details != null

overrides

array [object {2}]

optional

Overwrite availability for a particular day, on a particular date

unlimited_quantity

boolean

optional

Option to indicate the product is of unlimited quantity.

description

string

optional

A product description provides detailed information about an item, helping customers understand its features, benefits, and intended use. 🌐 Support multi-language

tags

array[number]

optional

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.

Example

{
  "name": "T-Shirt Blue",
  "price": 96.33,
  "quantity": 4,
  "description": "<strong>Good snowboard!</strong>",
  "categories": [
    254121314,
    254221314,
    254521314
  ],
  "min_amount_donating": 1,
  "max_amount_donating": 5,
  "sale_price": 43,
  "cost_price": 35,
  "sale_end": "2019-08-13",
  "require_shipping": false,
  "maximum_quantity_per_order": 0,
  "weight": 12,
  "sku": "23-TD23-32",
  "mpn": "45343",
  "gtin": "14643439",
  "calories": "500.00",
  "hide_quantity": false,
  "channels": [
    "web",
    "app"
  ],
  "enable_upload_image": true,
  "enable_note": true,
  "pinned": true,
  "subtitle": "Collection 2020",
  "promotion_title": "New",
  "metadata_title": "T-Shirt blue - collection 2020",
  "metadata_description": "T-Shirt blue - collection 2020",
  "brand_id": 254221314,
  "tags": [
    254121314,
    254221314,
    254521314
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created Successfully

application/json

Body

status

number

optional

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.

success

boolean

optional

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.

data

object (ProductDetails)

optional

Detailed structure of the Product model object showing its fields and data types.

number

required

A unique identifier for a specific product within a database.

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 in the global marketplace.

Example:

14643439

type

enum<string>

required

The categorization of a product based on its characteristics, features, or intended use.

Allowed values:

productservicegroup_productscodesdigitalfooddonatingbooking

name

string

required

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. 🌐 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 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.

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 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.

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

tags

array [object {2}]

required

Example

{
  "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": "45343",
    "gtin": "14643439",
    "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": 90,
    "status": "sale",
    "is_available": true,
    "views": 0,
    "sale_price": {
      "amount": 0,
      "currency": "SAR"
    },
    "sale_end": {},
    "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": 100,
    "show_in_app": true,
    "notify_quantity": "10",
    "hide_quantity": false,
    "unlimited_quantity": true,
    "managed_by_branches": false,
    "services_blocks": {
      "installments": []
    },
    "calories": 50,
    "customized_sku_quantity": false,
    "channels": [
      "web",
      "app"
    ],
    "metadata": {
      "title": "This product is amazing",
      "description": "This Product is one of the amazing things you can buy for yourself",
      "url": "https://salla.sa/dev-mvxlkrylzfanmuri/t-shirt/p1672908878"
    },
    "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": "This Product is one of the amazing things you can buy for yourself",
        "type": "radio",
        "required": false,
        "associated_with_order_time": 0,
        "availability_range": false,
        "not_same_day_order": false,
        "choose_date_time": true,
        "from_date_time": "2025-01-14 14:28:03",
        "to_date_time": "2027-10-14 14:28:03",
        "sort": 6,
        "advance": true,
        "display_type": "text",
        "visibility": "always",
        "translations": {
          "ar": {
            "option_name": "Color",
            "description": "هذا المنتج ممتاز"
          }
        },
        "values": [
          {
            "id": 410377234,
            "name": "Blue",
            "price": {
              "amount": 0,
              "currency": "SAR"
            },
            "formatted_price": "",
            "display_value": "",
            "advance": true,
            "option_id": 784299854,
            "image_url": "https://thisImageLink",
            "hashed_display_value": "",
            "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": "",
            "advance": true,
            "option_id": 784299854,
            "image_url": "https://thisImageLink",
            "hashed_display_value": "",
            "translations": {
              "ar": {
                "option_details_name": "Red"
              }
            },
            "is_default": false,
            "is_out_of_stock": false
          }
        ]
      },
      {
        "id": 2022020687,
        "name": "Size",
        "description": "This Product is one of the amazing things you can buy for yourself",
        "type": "radio",
        "required": false,
        "associated_with_order_time": 0,
        "availability_range": false,
        "not_same_day_order": false,
        "choose_date_time": true,
        "from_date_time": "2024-10-14 14:28:03",
        "to_date_time": "2025-10-14 14:28:03",
        "sort": 6,
        "advance": true,
        "display_type": "text",
        "visibility": "always",
        "translations": {
          "ar": {
            "option_name": "Size",
            "description": "هذا المنتج ممتاز"
          }
        },
        "values": [
          {
            "id": 1144986140,
            "name": "Small",
            "price": {
              "amount": 0,
              "currency": "SAR"
            },
            "formatted_price": "",
            "display_value": "",
            "advance": true,
            "option_id": 2022020687,
            "image_url": "https://thisImageLink",
            "hashed_display_value": "",
            "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": "",
            "advance": true,
            "option_id": 2022020687,
            "image_url": "https://thisImageLink",
            "hashed_display_value": "",
            "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": {},
        "has_special_price": false,
        "stock_quantity": 1000,
        "unlimited_quantity": true,
        "notify_low": "40",
        "barcode": "570cds",
        "sku": "23-TD23-32",
        "mpn": "45343",
        "gtin": "14643439",
        "related_options": [
          784299854,
          2022020687
        ],
        "related_option_values": [
          410377234,
          1144986140
        ],
        "weight": 1,
        "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": {},
        "has_special_price": false,
        "stock_quantity": 1000,
        "unlimited_quantity": true,
        "notify_low": "10",
        "barcode": "10cde",
        "sku": "23-TD23-32",
        "mpn": "45343",
        "gtin": "14643439",
        "related_options": [
          784299854,
          2022020687
        ],
        "related_option_values": [
          369375517,
          410377234
        ],
        "weight": 1,
        "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": {},
        "has_special_price": false,
        "stock_quantity": 9000,
        "unlimited_quantity": true,
        "notify_low": "10",
        "barcode": "106codes",
        "sku": "23-TD23-32",
        "mpn": "45343",
        "gtin": "14643439",
        "related_options": [
          784299854,
          2022020687
        ],
        "related_option_values": [
          1144986140,
          1783823123
        ],
        "weight": 1,
        "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": {},
        "has_special_price": false,
        "stock_quantity": 10000,
        "unlimited_quantity": true,
        "notify_low": "50",
        "barcode": "me12do",
        "sku": "23-TD23-32",
        "mpn": "45343",
        "gtin": "14643439",
        "related_options": [
          784299854,
          2022020687
        ],
        "related_option_values": [
          369375517,
          1783823123
        ],
        "weight": 1,
        "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
    ]
  }
}

🟠404Not Found

🟠422Error Validation

🟠401Unauthorized