Product Option Details

This endpoint allows you to return specific option details for a specific product by passing the option as a path parameter.

Scopes

products.read- Products Read Only

Add the parameter

Authorization

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

Example:

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

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

optional

Detailed structure of the product option model object showing its fields and data types.

number

required

A unique identifier assigned to a specific product configuration or variant.

name

string

required

The label or title used to describe a specific choice or attribute associated with a product.

description

string | null

required

A text or content that provides detailed information about a product.

type

enum<string>

required

Type of the product option, it can be a radio button or checkbox

Allowed values:

radiocheckboxbutton

required

boolean

required

Whether or not the product option is obligatory.

associated_with_order_time

integer | boolean

required

The product option is only relevant to order receiving time when it pertains to date-time selections. ONLY for date time options.

sort

integer | null

required

Product option sort refers to the method or criteria used to arrange or order product options.

display_type

enum<string>

required

The manner in which product choices or attributes are presented.

Allowed values:

textimagecolor

visibility

enum<string>

required

Product option visibility based on condition is applied exclusively to products categorized as 'food' or 'service'.

Allowed values:

alwayson_condition

visibility_condition_type

enum<string>

required

Product option visiblity condition type

Allowed values:

><=!=

visibility_condition_option

integer | null

required

Whether or not Product option is visible.

visibility_condition_value

integer | null

required

A unique identifier associated with a specific value or choice within a product option.

values

array[object (ProductValue) {12}]

required

skus

array[object (ProductVariant) {21}]

required

Example

{
    "status": 200,
    "success": true,
    "data": {
        "id": 1561181168,
        "name": "المنشأ",
        "description": "The origin of the product",
        "type": "radio",
        "required": false,
        "associated_with_order_time": 0,
        "sort": 7,
        "display_type": "text",
        "visibility": "always",
        "values": [
            {
                "id": 931990227,
                "name": "مصري",
                "price": {
                    "amount": 1.5,
                    "currency": "SAR"
                },
                "display_value": "",
                "option_id": 1561181168,
                "image_url": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
                "hashed_display_value": ""
            },
            {
                "id": 23734748,
                "name": "لبناني",
                "price": {
                    "amount": 3,
                    "currency": "SAR"
                },
                "display_value": "",
                "option_id": 1561181168,
                "image_url": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
                "hashed_display_value": ""
            }
        ],
        "skus": [
            {
                "id": 461881338,
                "price": {
                    "amount": 7.5,
                    "currency": "SAR"
                },
                "regular_price": {
                    "amount": 0,
                    "currency": "SAR"
                },
                "stock_quantity": 20,
                "barcode": "",
                "sku": "23-TD23-32",
                "related_option_values": [
                    931990227
                ]
            },
            {
                "id": 1970069243,
                "price": {
                    "amount": 7.5,
                    "currency": "SAR"
                },
                "regular_price": {
                    "amount": 0,
                    "currency": "SAR"
                },
                "stock_quantity": 20,
                "barcode": "",
                "sku": "23-TD23-32",
                "related_option_values": [
                    23734748
                ]
            }
        ]
    }
}

🟠404Not Found

🟠401Unauthorized

Request

Request samples

Responses