get https://api.zenoti.com/v1/guests//points/
Purpose: Use this API to retrieve the details of loyalty points that are either earned or redeemed by the guest.
To retrieve the loyalty points of a guest - earned, you must pass one of the following parameters:
invoice_id
program_id
manual_guest_points_id
associated_guest_points_id
Note: You can pass multiple associated_guest_points_id parameters as comma-separated values.
To retrieve the loyalty points of a guest - redeemed, you must pass the following parameter:
invoice_id (mandatory)
Response Object
| Name | Type | Description |
|---|---|---|
| earned | object | The total points earned by the guest. |
| redeemed | object | The total points redeemed by the guest. |
earned Object
| Name | Type | Description |
|---|---|---|
| action | string | The action because of which the guest earned the points in Zenoti. This action could be a purchase of a service, a product, or referring a guest. |
| points | string | The number of points earned for the corresponding action. |
| tier | string | The tier of the guest's loyalty program. Learn more about the types of Loyalty Programs in Zenoti. |
redeemed Object
| Name | Type | Description |
|---|---|---|
| invoice_no | string | The invoice number in which the guest's loyalty points are redeemed. |
| receipt_no | string | The receipt number of the redeemed loyalty points. |
| points | string | The total points that are redeemed by the guest in the corresponding invoice. |