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 Fields

POST

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

Adds custom user-input fields to a product, allowing customers to provide additional information while making a purchase. Custom user input fields can be used to collect data such as personalization details, gift messages, or special instructions.

🔑Scopes

products.read_write - Products Read & Write

Request

Path Params

Header Params

Body Params application/json

Example

{
    "type": "TEXT",
    "label": {
        "ar": "نص مخصص",
        "en": "Custom Text"
    }
}

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_user_input_fields/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Store-Id: {{StoreId}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "TEXT",
    "label": {
        "ar": "نص مخصص",
        "en": "Custom Text"
    }
}'

Responses

🟢200Added

application/json

Body

Example

{
    "id": "abc123",
    "type": "text",
    "hint": {
        "en": "Please enter the desired value",
        "ar": "يرجى إدخال القيمة المطلوبة"
    },
    "label": {
        "en": "Custom Text",
        "ar": "نص مخصص"
    }
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-02-15 16:13:58

Delete Custom Option Field

Product Sorting