Salla Docs
Merchant API
Partner APIs
Storefront
Salla CLI
Salla Docs

    [lightMode]

    Create Option Template

    POST/products/options/templates
    [updatedIn] a month ago

    This endpoint allows you create a new option template.

    `products.read_write` - Products Read and Write

    Request

    Authorization: OAuth 2.0
    Add the parameter
    Authorization
    to [header]    ，whose value is to concatenate the Token after the Bearer.
    [api.label.example]
    Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
    [message.queryParameter]
    with
    enum<string> 
    optional

    Use with=details to fetch list of product option templates with details object.

    Allowed value:
    details
    Example:
    details
    [message.bodyParameter]application/json
    name
    string 
    optional

    Option name.

    type
    enum<string> 
    optional

    Type of product option.

    Allowed values:
    checkboxradio
    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.

    en
    object 
    optional
    fr
    object 
    optional
    details
    object 
    optional

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

    id
    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

    [api.label.example]
    {
  "name": "image url",
  "display_type": "image",
  "translations": {
    "en": {
      "name": "color"
    },
    "fr": {
      "name": "couleur"
    }
  },
  "details": [
    {
      "name": "profile pic",
      "is_default": true,
      "display_value": "fb.com",
      "translations": {
        "en": {
          "name": "pic"
        },
        "fr": {
          "name": "pic"
        }
      }
    }
  ]
}

    Request samples

    [api.label.responses]

    Success(200)
    With Details(200)
    Validation(422)
    Unauthorized(401)
    HTTP Code: 200
    Content Type : JSONapplication/json
    [response.label.jsonSchema]
    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
    id
    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.

    [api.label.example]
    {
  "status": 201,
  "success": true,
  "data": [
    {
      "id": 1473353380,
      "name": "اللون",
      "type": "radio",
      "display_type": "color",
      "translations": [
        {
          "id": 1473353380,
          "name": "color",
          "locale": "en"
        },
        {
          "id": 566146469,
          "name": "color",
          "locale": "fr"
        }
      ]
    }
  ]
}
    [updatedIn] a month ago