Zid Docs
List Data
GETv1/managers/loyalty-program/list-dataRetrieves list data relevant to the loyalty program configuration.
Request
Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.
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.
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.
Preferred language for the response. Defaults to en if not specified.
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.
Request samples
Responses
Loyalty program list data is retrieved successfully.
Indicates the overall status of the API response.
The cashback_rules array contains the rules related to earning cashback points.
A unique identifier for each specific cashback rule.
An identifier used by external systems to track or reference the rule.
The unique identifier of the store where this rule applies.
The number of points awarded for spending a certain amount.
The amount of money that needs to be spent to earn the points.
Specifies if the rule is available to certain tags or levels.
A boolean value (true or false) indicating whether the cashback rule is currently active.
The timestamp indicating when the cashback rule was created.
The timestamp indicating when the cashback rule was last updated.
he timestamp indicating when the cashback rule was deleted, or null if it hasn’t been deleted.
The redemption_rules array contains the rules related to redeeming points for rewards.
A unique identifier for each specific redemption rule.
An identifier used by external systems to track or reference the rule, which may be null.
The unique identifier of the store where this redemption rule applies.
The name given to this redemption rule, which might be numeric or descriptive.
The number of points required to redeem the specified reward.
The type of rule, often defining how the reward is calculated or applied, such as "fixed_rate_settings."
Any specific conditions or restrictions that apply to this redemption rule, which might be null if there are none.
A boolean value (true or false) indicating whether the redemption rule is currently active.
The timestamp indicating when the redemption rule was created.
The timestamp indicating when the redemption rule was last updated.
The timestamp indicating when the redemption rule was deleted, or null if it hasn’t been deleted.
The cumulative number of points that have been earned by all customers within the loyalty program.
he total number of points that have been redeemed by customers for rewards.
The number of points that are pending or not yet available for redemption, possibly due to conditions like waiting periods.
The total number of customers who have earned points within the loyalty program.
The time period (likely in months or years) after which the earned points expire if not redeemed.
A boolean value (true or false) indicating whether the overall loyalty program is active.
Contains detailed information about the message.
Specifies the type of message.
A specific code representing the type.
A short, human-readable title or name for the message.
A detailed description of the message, providing more context.
{
"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
}
}