Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Create Custom Options

POST

https://api.zid.sa/v1/products/{product_id}/custom_options_fields/

Adds custom options to a product, allowing customers to choose from a predefined set of options while making a purchase. Custom options can be used to offer choices such as gift wrapping, warranty options, or other additional services.

🔑Scopes

products.read_write - Products Read & Write

Request

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "type": "CHECKBOX",
    "label": {
        "ar": "خيار مخصص",
        "en": "custom option"
    },
    "hint": {
        "ar": "يرجى اختيار الخيار المناسب",
        "en": "Please select a suitable option"
    },
    "min_choices": 1,
    "max_choices": 100,
    "can_choose_multiple_options": true,
    "is_published": true,
    "is_required": true,
    "display_order": 2,
    "choices": [
        {
            "price": 66.5,
            "id": "",
            "ar": "قيمة 1",
            "en": "value 1"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa/v1/products/e0ad7a76-ba42-4c59-94c9-0da600117fbf/custom_options_fields/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Store-Id: {{StoreId}}' \
--header 'Role: Manager' \
--header 'Accept-Language: en' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "CHECKBOX",
    "label": {
        "ar": "خيار مخصص",
        "en": "custom option"
    },
    "hint": {
        "ar": "يرجى اختيار الخيار المناسب",
        "en": "Please select a suitable option"
    },
    "min_choices": 1,
    "max_choices": 100,
    "can_choose_multiple_options": true,
    "is_published": true,
    "is_required": true,
    "display_order": 2,
    "choices": [
        {
            "price": 66.5,
            "id": "",
            "ar": "قيمة 1",
            "en": "value 1"
        }
    ]
}'

Responses

🟢201Created

application/json

Body

Example

{
    "id": "string",
    "type": "string",
    "label": {
        "ar": "string",
        "en": "string"
    },
    "hint": {
        "ar": "string",
        "en": "string"
    },
    "min_choices": 0,
    "max_choices": 0,
    "can_choose_multiple_options": true,
    "is_published": true,
    "is_required": true,
    "display_order": 0,
    "choices": [
        {
            "ar": "string",
            "en": "string",
            "price": 0,
            "id": "string"
        }
    ],
    "visibility_condition": {}
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-03-09 14:00:06

Create Variants

Update Custom Option