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 Input Field

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": {
    "en": "Engraving Text",
    "ar": "نص النقش"
  },
  "hint": {
    "en": "Please enter the engraving you want on the product",
    "ar": "الرجاء إدخال النص المراد نقشه على المنتج"
  },
  "price": 44.5,
  "is_required": false,
  "is_published": true,
  "display_order": 1,
  "configs": {
    "is_multiline": true
  }
}

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 'Role: Manager' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "TEXT",
  "label": {
    "en": "Engraving Text",
    "ar": "نص النقش"
  },
  "hint": {
    "en": "Please enter the engraving you want on the product",
    "ar": "الرجاء إدخال النص المراد نقشه على المنتج"
  },
  "price": 44.5,
  "is_required": false,
  "is_published": true,
  "display_order": 1,
  "configs": {
    "is_multiline": true
  }
}'

Responses

🟢201Created

application/json

Body

Example

{
    "id": "b5364fa7-dda9-4005-aabf-fd20abb82517",
    "type": "TEXT",
    "hint": {
        "en": "Please enter the engraving you want on the product",
        "ar": "الرجاء إدخال النص المراد نقشه على المنتج"
    },
    "label": {
        "en": "Engraving Text",
        "ar": "نص النقش"
    },
    "display_order": 1,
    "is_required": false,
    "price": 44.5,
    "formatted_price": " SAR 44.50",
    "configs": {
        "is_multiline": true
    },
    "visibility_condition": null,
    "is_published": true
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-03-19 11:23:44

Delete Custom Option Field

Update Custom Input Field