Zid Docs

List Data

GET

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

Loyalty Program

Retrieves list data relevant to the loyalty program configuration.

🔑Scopes

loyalty_program.read - Loyalty Program Read

Request

Header Params

string

required

Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.

Default:

application/json

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

User-Agent

string

optional

The User-Agent header contains information about the user agent (browser or app) making the request. It allows the server to provide a tailored response depending on the user agent's capabilities and preferences.

Example:

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

X-Manager-Token

string

required

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Request 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 'Accept;' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'User-Agent;' \
--header 'Accept-Language;' \
--header 'X-Manager-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Content-Type: text/plain' \
--data-raw ''

Responses

🟢200OK

application/json

Loyalty program list data is retrieved successfully.

Body

status

string

optional

Indicates the overall status of the API response.

cashback_rules

array [object {10}]

optional

The cashback_rules array contains the rules related to earning cashback points.

string

optional

A unique identifier for each specific cashback rule.

Example:

b1e3ca5d-2a89-4993-89bf-0f31a4b70b00

external_id

string

optional

An identifier used by external systems to track or reference the rule.

Example:

pos

store_id

string

optional

The unique identifier of the store where this rule applies.

Example:

3dfc16e6-ad19-4126-9c2a-5e4a7fb73051

points_rewarded

integer

optional

The number of points awarded for spending a certain amount.

Example:

amount_to_spend

integer

optional

The amount of money that needs to be spent to earn the points.

Example:

available_to

null

optional

Specifies if the rule is available to certain tags or levels.

is_active

boolean

optional

A boolean value (true or false) indicating whether the cashback rule is currently active.

Default:

false

created_at

string

optional

The timestamp indicating when the cashback rule was created.

Example:

2023-12-28T10:32:13.000000Z

updated_at

string

optional

The timestamp indicating when the cashback rule was last updated.

Example:

2023-12-28T10:32:13.000000Z

deleted_at

null

optional

he timestamp indicating when the cashback rule was deleted, or null if it hasn’t been deleted.

redemption_rules

array [object {12}]

optional

The redemption_rules array contains the rules related to redeeming points for rewards.

string

optional

A unique identifier for each specific redemption rule.

Example:

efc450a4-3f09-4544-bcdd-80ddcbde23c8

external_id

null

optional

An identifier used by external systems to track or reference the rule, which may be null.

store_id

string

optional

The unique identifier of the store where this redemption rule applies.

Example:

3dfc16e6-ad19-4126-9c2a-5e4a7fb73051

name

string

optional

The name given to this redemption rule, which might be numeric or descriptive.

Example:

points_to_redeem

integer

optional

The number of points required to redeem the specified reward.

Example:

rule_type

string

optional

The type of rule, often defining how the reward is calculated or applied, such as "fixed_rate_settings."

Example:

fixed_rate_settings

reward

object

optional

conditions

null

optional

Any specific conditions or restrictions that apply to this redemption rule, which might be null if there are none.

is_active

boolean

optional

A boolean value (true or false) indicating whether the redemption rule is currently active.

Default:

false

created_at

string

optional

The timestamp indicating when the redemption rule was created.

Example:

2023-10-26T10:59:16.000000Z

updated_at

string

optional

The timestamp indicating when the redemption rule was last updated.

Example:

2023-04-26T10:59:16.000000Z

deleted_at

null

optional

The timestamp indicating when the redemption rule was deleted, or null if it hasn’t been deleted.

total_earned_points

integer

optional

The cumulative number of points that have been earned by all customers within the loyalty program.

Example:

1271060

total_redemed_points

integer

optional

he total number of points that have been redeemed by customers for rewards.

Example:

2004

total_pending_points

integer

optional

The number of points that are pending or not yet available for redemption, possibly due to conditions like waiting periods.

Example:

51419

total_customers_with_points

integer

optional

The total number of customers who have earned points within the loyalty program.

Example:

expiration_peroid

integer

optional

The time period (likely in months or years) after which the earned points expire if not redeemed.

Example:

is_active

boolean

optional

A boolean value (true or false) indicating whether the overall loyalty program is active.

Default:

true

message

object

optional

Contains detailed information about the message.

type

string

optional

Specifies the type of message.

code

null

optional

A specific code representing the type.

name

null

optional

A short, human-readable title or name for the message.

description

null

optional

A detailed description of the message, providing more context.

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": null,
      "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": null,
      "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

Modified at 2025-01-31 07:41:36

Customer Profile

Customer Points History