Option Template Details

This endpoint allows you to fetch the product options' templates by passing the id as a path parameter.

Scopes

products.read - Products Read only

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.

Example:

5541564

Query Params

with

enum<string>

optional

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

Allowed value:

details

Example:

details

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": "اللون",
        "type": "radio",
        "display_type": "color",
        "translations": {
            "en": {
                "name": "color"
            },
            "fr": {
                "name": "couleur"
            }
        }
    }
}

🟢200With Details

🟠404Not found

🟠401Unauthorized

Request

Request samples

Responses