Update Product Option Value - Salla Merchants APIs

This endpoint allows you to update value details in a specific option for a specific product by passing the value 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

value

integer

required

Unique identification number assigned to the Option Value. List of Product Option Value IDs can be found here.

Body Params application/json

name

string

required

A descriptive label or title given to a specific attribute, feature, or characteristic associated with a product, helping to define and differentiate its various qualities or options.

price

number

optional

The additional price which will be added to the product price when the customer adds/selects this value. Alternatively the value is set 0 if there is no additional price.

quantity

integer

optional

The specific quantity or number of units available for a particular option or variation of a product.

Example:

display_value

string

optional

The display value in UI based on display type of option, by default will use the name of value as display value when the 'display_value=text', but in case you used 'image' then you need to set the image id as value You can upload a new image to product using attach image endpoint then use 'image' id from response, otherwise when use 'color' as display type you need to pass the color for example '#000' for black color

is_default

boolean

optional

The option to indicate if this value is the default value of the product option.

Example

{
  "name": "XzL",
  "price": 121,
  "display_value": "xzzl"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Updated 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 (ProductValue)

optional

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

number

required

A unique identifier assigned to a value associated with a product.

name

string

required

Identifying label for a product attribute.

price

object

required

The product price.

formatted_price

string

required

The extra formatted price added when a customer selects a specific value.

display_value

string

required

The UI displays values based on the option's display type. By default, it shows the name when display_value=text. For image, use the image ID (uploaded via the attach image endpoint). For color, provide a value like #000 for black.

advance

boolean

required

Is the option value is advanced or not

option_id

number

required

A unique identifier assigned to a specific choice.

image_url

string

required

The web address where the corresponding image is hosted.

hashed_display_value

string

required

if option.type = image then hashed display value return image id.
if option.type = text then hashed display value return value name

translations

object

read-onlyrequired

Translation of option values in different languages

is_default

boolean

required

This option will be enabled when this particular value is the default value.

is_out_of_stock

boolean

read-onlyrequired

Whether or not the option value is out of stock.

Example

{
  "status": 201,
  "success": true,
  "data": {
    "id": 667315336,
    "name": "salvalueupdated",
    "price": {
      "amount": 0,
      "currency": "SAR"
    },
    "display_value": "",
    "option_id": 1833119338,
    "image_url": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
    "hashed_display_value": "",
    "skus": [
      {
        "id": 652911549,
        "price": {
          "amount": 110,
          "currency": "SAR"
        },
        "regular_price": {
          "amount": 234,
          "currency": "SAR"
        },
        "sale_price": {
          "amount": 100,
          "currency": "SAR"
        },
        "stock_quantity": 13,
        "barcode": "barcode-ABC",
        "sku": "sku-variant-1551119600",
        "related_option_values": [
          667315336,
          322122678,
          569679762,
          1318371393
        ]
      },
      {
        "id": 1966914519,
        "price": {
          "amount": 9.9,
          "currency": "SAR"
        },
        "regular_price": {
          "amount": 0,
          "currency": "SAR"
        },
        "sale_price": {
          "amount": 100,
          "currency": "SAR"
        },
        "stock_quantity": 20,
        "barcode": "",
        "sku": "23-TD23-32",
        "related_option_values": [
          667315336,
          322122678,
          1552401892,
          1318371393
        ]
      },
      {
        "id": 1799056677,
        "price": {
          "amount": 9.9,
          "currency": "SAR"
        },
        "regular_price": {
          "amount": 0,
          "currency": "SAR"
        },
        "sale_price": {
          "amount": 100,
          "currency": "SAR"
        },
        "stock_quantity": 20,
        "barcode": "",
        "sku": "23-TD23-32",
        "related_option_values": [
          667315336,
          322122678,
          1209980149,
          1318371393
        ]
      },
      {
        "id": 673658412,
        "price": {
          "amount": 9.9,
          "currency": "SAR"
        },
        "regular_price": {
          "amount": 0,
          "currency": "SAR"
        },
        "sale_price": {
          "amount": 100,
          "currency": "SAR"
        },
        "stock_quantity": 20,
        "barcode": "",
        "sku": "23-TD23-32",
        "related_option_values": [
          667315336,
          322122678,
          393917653,
          1318371393
        ]
      }
    ]
  }
}

🟠404Not Found

🟠422Error Validation

🟠401Unauthorized