get https://api.zenoti.com/v1/guests//coupons
Provide unique identifier of the guest as guest_id and this api will retrieve the coupon history of the respective guest.
you can also use pagination by passing page and size query parameters if guest has huge number of records. By default page is set to 1 and size is set to 10. Size cannot be more than 100 which means maximum records per page cannot be more than 100.
Response Details
| Name | Type | Description |
|---|---|---|
| coupons | object | Object containing the details of the guest's coupons. |
| page_info | object | Object containing the page info of the API response. |
coupons Object
| Name | Type | Description |
|---|---|---|
| id | guid | unique identifier of the coupon. |
| number | string | unique number given to the coupon. |
| invoice_id | guid | unique identifier of the invoice. |
| invoice_number | string | unique number generated to identify the invoice. |
| reciept_number | string | unique number generated to identify the receipt. |
| description | string | represents description of the guest coupon. |
| issue_date | datetime | date on which the coupon is issued to the guest. |
| issued_center | string | name of the center at which the coupon is issued to the guest. |
| expiry_date | datetime | date on which the coupon will expire. |
| redemption | string | represents redemption status of the coupon. |
| redeemed_center | string | name of the center at which the coupon is redeemed by the guest. |
| redeemable_by_all | string | represents whether the coupon is redeemed by anyone or only the specific guest. |
| status | string | represents the status of the invoice. |