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/json

Example

{
    "label": {
        "ar": "خيار مخصص"
    },
    "choices": [
        {
            "ar": "اختيار 1",
            "en": "Option 1",
            "price": "50.00"
        }
    ],
    "hint": {
        "ar": "يرجى اختيار الخيار المناسب",
        "en": "Please select a suitable option"
    }
}

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 'Accept-Language: en' \
--header 'Content-Type: application/json' \
--data-raw '{
    "label": {
        "ar": "خيار مخصص"
    },
    "choices": [
        {
            "ar": "اختيار 1",
            "en": "Option 1",
            "price": "50.00"
        }
    ],
    "hint": {
        "ar": "يرجى اختيار الخيار المناسب",
        "en": "Please select a suitable option"
    }
}'

Responses

🟢200Custom options are added

application/json

Body

Example

{
    "type": "string",
    "hint": {
        "ar": "يرجى اختيار الخيار المناسب",
        "en": "Please select a suitable option"
    },
    "label": {
        "ar": "لون مخصص"
    },
    "id": "12345abcd"
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-02-15 16:07:31

Create Variants

Create Custom Fields