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

Create Points Redemption Method

POST

https://api.zid.sa/v1/managers/loyalty-program/points-redemption

Creates a new redemption method (e.g., gift certificate) for a store's loyalty program.

🔑Scopes

loyalty_program.read_write - Loyalty Program Read & Write

Request

Header Params

Body Params multipart/form-data

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa/v1/managers/loyalty-program/points-redemption' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--form 'config[type]="fixed_rate_settings"' \
--form 'config[discount]="1"' \
--form 'config[points]="1"'

Responses

🟢200OK

application/json

The redemption method is created successfully.

Body

Example

{
    "status": "object",
    "points_redemption": {
        "status": true,
        "message": "Point redemption method added successfully",
        "redemptionRule": {
            "store_id": "d297fb8b-c322-412e-a2f4-ffa96dc57022",
            "external_id": "202603021311282861",
            "name": "1",
            "points_to_redeem": 1,
            "rule_type": "fixed_rate_settings",
            "reward": {
                "discount_value": 1
            },
            "is_active": true,
            "id": "4890974d-d474-4d08-99a4-a42b856ea71a",
            "updated_at": "2026-03-02T13:11:28.000000Z",
            "created_at": "2026-03-02T13:11:28.000000Z"
        }
    },
    "message": {
        "type": "object",
        "code": "MSG_POPUP_OK",
        "name": "Points redemption",
        "description": "Point redemption method added successfully"
    }
}

🟠401Unauthorized

🔴500Internal Server error

🟢200OK

Modified at 2026-03-02 13:13:10

Update Cashback Rule

Update Points Redemption Method