[lightMode]

List Option Templates

GET/products/options/templates

[updatedIn] a month ago

This endpoint allows you to list all option templates related to the product.

`products.read` - Products Read Only

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

Request samples

[api.label.responses]

Success(200)

With Details(200)

HTTP Code: 200

Content Type : JSONapplication/json

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

array[object (OptionsTemplate) {5}]

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.

pagination

object (Pagination)

required

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1473353380,
      "name": "اللون",
      "type": "radio",
      "display_type": "color",
      "translations": {
        "en": {
          "name": "color"
        },
        "fr": {
          "name": "color"
        }
      }
    }
  ],
  "pagination": {
    "count": 1,
    "total": 15,
    "perPage": 1,
    "currentPage": 1,
    "totalPages": 15,
    "links": {
      "next": "https://s.salla.test/admin/v2/options-template?page=2"
    }
  }
}

[updatedIn] a month ago