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

Loyalty Program Details

GET

https://api.zid.sa/v1/managers/loyalty-program/list-data

Retrieves list data relevant to the loyalty program configuration.

🔑Scopes

loyalty_program.read - Loyalty Program Read

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zid.sa/v1/managers/loyalty-program/list-data' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en'

Responses

🟢200OK

application/json

Loyalty program list data is retrieved successfully.

Body

Example

{
    "status": "string",
    "cashback_rules": [
        {
            "id": "b1e3ca5d-2a89-4993-89bf-0f31a4b70b00",
            "external_id": "pos",
            "store_id": "3dfc16e6-ad19-4126-9c2a-5e4a7fb73051",
            "points_rewarded": 1,
            "amount_to_spend": 1,
            "available_to": {
                "tags": [
                    "string"
                ],
                "level": {
                    "levelId": "string",
                    "levelName": "string"
                }
            },
            "is_active": false,
            "created_at": "2023-12-28T10:32:13.000000Z",
            "updated_at": "2023-12-28T10:32:13.000000Z",
            "deleted_at": null
        }
    ],
    "redemption_rules": [
        {
            "id": "efc450a4-3f09-4544-bcdd-80ddcbde23c8",
            "external_id": "string",
            "store_id": "3dfc16e6-ad19-4126-9c2a-5e4a7fb73051",
            "name": "3",
            "points_to_redeem": 3,
            "rule_type": "fixed_rate_settings",
            "reward": {
                "discount_value": 1
            },
            "conditions": null,
            "is_active": false,
            "created_at": "2023-10-26T10:59:16.000000Z",
            "updated_at": "2023-04-26T10:59:16.000000Z",
            "deleted_at": null
        }
    ],
    "total_earned_points": 1271060,
    "total_redemed_points": 2004,
    "total_pending_points": 51419,
    "total_customers_with_points": 48,
    "expiration_peroid": 5,
    "is_active": true,
    "message": {
        "type": "string",
        "code": null,
        "name": null,
        "description": null
    }
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-03-02 12:50:52

Loyalty Program Status

Loyalty Program Info