本文档由 Apifox 自动生成，推荐使用 Apifox - API 文档、API 调试、API Mock、API 自动化测试！

Create Option Template

Develop Env

https://echo.apifox.com/anything

POST

/products/options/templates

Product Option Templates

Last modified:2025-02-20 07:53:20

Maintainer:Not configured

This endpoint allows you create a new option template.

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 ********************

Query Params

with

enum<string>

optional

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

Allowed value:

details

Example:

details

Body Params 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.

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": "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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://echo.apifox.com/anything/products/options/templates' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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"
                }
            }
        }
    ]
}'

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": 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"
                }
            ]
        }
    ]
}

🟢200With Details

🟠422Validation

🟠401Unauthorized

Update Option Template

Taxes