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

Create Voucher

POST

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

Adds a new voucher for a specified product.

🔑Scopes

products.read_write - Products Read & Write

Request

Path Params

Header Params

Body Params application/json

Example

{
    "key": "key-2",
    "serial_number": "serial-number-2",
    "pin_code": "pin-code-example-2",
    "expires_at": "2026-10-10 00:00:00",
    "status": "SOLD"
}

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/a1477bb2-72ea-4be9-b2cf-093cefc721bb/vouchers/' \
--header 'Authorization: {{Autherization}}' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Store-Id: {{StoreId}}' \
--header 'Role: Manager' \
--header 'Accept-Language: en' \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "key-2",
    "serial_number": "serial-number-2",
    "pin_code": "pin-code-example-2",
    "expires_at": "2026-10-10 00:00:00",
    "status": "SOLD"
}'

Responses

🟢201Created

application/json

Body

Example

{
    "id": "3663992f-989e-4056-9a71-02a9109ec7fa",
    "product_id": "a1477bb2-72ea-4be9-b2cf-093cefc721bb",
    "status": "AVAILABLE",
    "order": null,
    "serial_number": "serial-number-1",
    "key": "key-1",
    "pin_code": "pin-code-example",
    "expires_at": "2026-10-10T00:00:00Z",
    "updated_at": "2026-02-11T12:39:55.597191Z",
    "created_at": "2026-02-11T12:39:55.597152Z"
}

🟠415Unsupported Media Type

🟠401Unauthorized

🔴500Internal Server error

🟠400Bad Request

Modified at 2026-02-11 12:43:33

Order Vouchers

Import Vouchers