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

Update Voucher

PATCH

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

Updates an existing 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--2",
    "pin_code": "pin-code--2",
    "expires_at": "2026-10-10 00:00:00",
    "status": "AVAAILABLE"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.zid.sa/v1/products/a1477bb2-72ea-4be9-b2cf-093cefc721bb/vouchers/b9a21ac0-0c04-4706-bef9-a05270613092' \
--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--2",
    "pin_code": "pin-code--2",
    "expires_at": "2026-10-10 00:00:00",
    "status": "AVAAILABLE"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "vouchers": [
        {
            "id": "\"0d6dc296-f757-4f11-83b2-6d5fddb6ad85\"",
            "key": "\"ABC123XYZ\"",
            "pin_code": "string",
            "status": "\"AVAILABLE\"",
            "serial_number": "\"SN123456\"",
            "expires_at": "\"2024-12-31\"",
            "created_at": "\"2024-01-01T12:00:00Z\"",
            "updated_at": "\"2024-01-01T12:00:00Z\""
        }
    ]
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-02-11 13:42:26

Export Vouchers

Remove Voucher