Salla Docs

Update Option Template

Production

PUT

https://api.salla.dev/admin/v2/products/options/templates/{id}

Product Option Templates

Last modified:2025-02-04 09:20:03

This endpoint allows you to update a specific product option template by passing the id as a path parameter.

Scopes

products.read_write - Products Read and Write

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Path Params

integer

required

A unique identifier of the option template. List of option template IDs can be found here

Example:

956236464

Body Params application/json

name

string

optional

Option name.

display_type

enum<string>

optional

The manner in which product choices or attributes are presented.

Allowed values:

textimagecolor

translations

object

optional

Options presented in different languages.

object

optional

object

optional

details

object

required

Option Details. Visible if with=details query paramter is passed

number

required

option ID

name

string

required

option value name

is_default

boolean

required

indicates if the value is default or not

display_value

string

required

Option Display value

translation

object

required

Option display value translations

Example

{
  "name": "اللون",
  "display_type": "color",
  "translations": {
    "en": {
      "name": "color"
    },
    "fr": {
      "name": "color"
    }
  },
  "details": [
    {
      "name": "احمر غامق",
      "is_default": false,
      "display_value": "#3245",
      "translations": {
        "en": {
          "name": "dark red"
        },
        "fr": {
          "name": "dagc ged"
        }
      }
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.salla.dev/admin/v2/products/options/templates/956236464' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "اللون",
    "display_type": "color",
    "translations": {
        "en": {
            "name": "color"
        },
        "fr": {
            "name": "color"
        }
    },
    "details": [
        {
            "name": "احمر غامق",
            "is_default": false,
            "display_value": "#3245",
            "translations": {
                "en": {
                    "name": "dark red"
                },
                "fr": {
                    "name": "dagc ged"
                }
            }
        }
    ]
}'

Responses

🟢200Success

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 (OptionsTemplate)

optional

string

required

A unique identifier of the options template.

name

string

required

Option name.

type

enum<string>

required

Type of product option.

Allowed values:

checkboxradio

display_type

enum<string>

required

The manner in which product choices or attributes are presented.

Allowed values:

textimagecolor

translations

object

required

Options presented in different languages based on the store's enabled locales.

Example

{
  "status": 200,
  "success": true,
  "data": {
    "id": 956236464,
    "name": "color 1",
    "feature_type": "text",
    "translations": [
      {
        "id": 1473353380,
        "name": "color",
        "locale": "en"
      },
      {
        "id": 566146469,
        "name": "color",
        "locale": "fr"
      }
    ]
  }
}

🟠401Unauthorized

Modified at 2025-02-04 09:20:03

Delete Option Template

Create Option Template