Use this API to check how many loyalty points and the loyalty amount (in $) that a guest can redeem while paying for an invoice.
You must specify appropriate details for the InvoiceId parameter. Optionally, you can provide the required values for the lp_program_id and redeem_across_programs parameters.
Permission:Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.
Endpoint
GET /v1/guests/{InvoiceId}/payments/loyalty_points/redeemable
Base URL:https://api.zenoti.com
Request
Headers
Header
Required
Description
Authorization
Yes
bearer {{access_token}}
Path parameters
Parameter
Type
Required
Description
InvoiceId
string
Yes
Mandatory Unique 32-character identifier of the invoice for which this API will return the guest's applicable loyalty points.
Query parameters
Parameter
Type
Required
Default
Description
lp_program_id
string
No
—
Optional Unique 32-character identifier of the loyalty program by using which the guest can redeem loyalty points. Default value: null.
redeem_across_programs
integer (int32)
No
0
Optional Indicates whether the guest's loyalty points can be redeemed for all loyalty programs or for a particular loyalty program. 0 - Guest's loyalty points can be redeemed for a particular loyalty program. 1 - Guest's loyalty points can be redeemed for all loyalty programs. Default value: 0. Note: If you specify the value of this parameter as 1, the API does not prioritize the value of the lp_program_id parameter.
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.GetAsync(
"https://api.zenoti.com/v1/guests/{InvoiceId}/payments/loyalty_points/redeemable");
var data = await response.Content.ReadAsStringAsync();