Redemption Methods
GETv1/customers/loyalty-program/<<STORE_ID>>/point-redemption-methodsRetrieves a list of available redemption methods (e.g., gift certificates, discounts) associated with a store's loyalty program.
Request
Unique identifier of the store.
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.
Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.
Preferred language for the response. Defaults to en if not specified.
Type of the content.
The X-CUSTOMER-TOKEN is a unique identifier generated when a customer logs in through the customer-login API. This token acts as the standard authorization mechanism, allowing the system to recognize the logged-in customer and grant them access to appropriate resources.
Request samples
Responses
List of available redemption methods retrieved successfully.
Indicates the overall status of the API response.
A list of available methods for redeeming points, each represented as an object with detailed information.
A unique identifier for the point redemption method.
An external identifier associated with the point redemption method.
The unique identifier of the store associated with this redemption method.
The name or label of the redemption method.
The number of points required to redeem this reward.
The type of rule applied to the redemption method, such as "fixed_rate_settings".
Details about the reward associated with the redemption method.
Any conditions or restrictions applicable to the redemption method. Null indicates no specific conditions.
Indicates whether the redemption method is currently active.
The date and time when the redemption method was created, in ISO 8601 format.
The date and time when the redemption method was last updated, in ISO 8601 format.
The date and time when the redemption method was deleted.
Information about the store associated with the redemption method.
Contains additional information or messages related to the API response.
Specifies the type of message.
A code representing any specific message or error.
A short, human-readable title or name for the message.
A detailed description of the message.
{
"status": "string",
"point_redemption_methods": [
{
"id": "d7d31391-dc3e-41f6-888b-ba189b28c732",
"external_id": "581",
"store_id": "266fd313-f39a-4f43-82c5-6069651e32cc",
"name": "1",
"points_to_redeem": 1,
"rule_type": "fixed_rate_settings",
"reward": {
"discount_value": 1
},
"conditions": null,
"is_active": true,
"created_at": "2024-02-04T15:59:44.000000Z",
"updated_at": "2024-03-04T15:59:44.000000Z",
"deleted_at": null,
"store": {
"id": 550,
"uuid": "266fd313-f39a-4f43-82c5-6069651e32cc",
"name": "mohammed basideq",
"url": "https://bandar-dev.zidtest.com/",
"ssl": "https://bandar-dev.zidtest.com/",
"currency": "SAR",
"language_code": "ar",
"quality_flag": 0,
"has_new_products_service": 1,
"has_new_shipping_module": true,
"has_multi_product_inventory": true,
"is_sent_to_odoo": true,
"registration_fields": "{\\\"invoicing_buyer_id\\\": \\\"bda31228-791b-4aac-aa3e-7b35f66178c8\\\", \\\"started_business_before_registration\\\": \\\"0\\\"}",
"has_current_business": null,
"maintenance_mode": 0,
"readiness_completed_at": "2021-09-28T12:57:35.000000Z",
"mobile_verified_at": "2021-09-28T12:59:35.000000Z",
"created_at": "2021-09-28T12:57:35.000000Z",
"updated_at": "2021-09-28T12:58:35.000000Z",
"es_subscription_id": "fefa2f16-d0bb-4b94-816a-73fd8358644d",
"sv3_subscription_id": null,
"deleted_at": null,
"active_domains": [
{
"id": "002b2075-e662-4a55-b1b2-f385379b591d",
"store_id": "266fd313-f39a-4f43-82c5-6069651e32cc",
"domain": "bandar-dev.zidtest.com",
"hash": "2593164025",
"is_active": 1,
"is_custom": 0,
"expires_at": null,
"created_at": "2022-04-05T13:54:53.000000Z",
"updated_at": "2022-06-05T13:54:53.000000Z",
"deleted_at": null,
"dns_status": "connected",
"zone_id": null,
"hostname_id": null
}
]
}
}
],
"message": {
"type": "string",
"code": null,
"name": null,
"description": null
}
}