v1

latestOpenAPI 3.0.02026-07-247251950.2 KB

Loyalty Program

Fetch a guest's vouchers

Overview

Retrieve all vouchers available to a specific guest, including discount codes, validity periods, and usage limits.

When to Use

Voucher display - Show available vouchers on a guest's account page
Discount management - Check which vouchers a guest can use
Validity checking - Verify if vouchers are still active
Usage tracking - Monitor voucher usage counts

What You Get

Voucher list - All vouchers assigned to the guest
Discount details - Type (percentage/fixed), value, and currency
Validity period - Start and end dates for each voucher
Usage information - Current usage count and usage limits
Status - Active/inactive status of each voucher

Quick Start

Provide the guest ID in the URL path. Returns all vouchers available to that guest.

get/guests/{guestId}/vouchers

Path parameters

guestIdinteger required

Example:1

Numeric ID of the guest to fetch vouchers for

Response

List of vouchers

Example response

{
  "data": [
    {
      "id": 1,
      "voucher_code": "0193f948",
      "user_id": 1,
      "guest_id": 1,
      "discount_type": "fixed_amount",
      "discount_value": 0.1,
      "minimum_spend": 0,
      "maximum_discount_amount": 0,
      "currency": "USD",
      "validity_start": "2026-07-24T00:00:00+01:00",
      "validity_end": "2026-12-24T00:00:00+01:00",
      "usages": 6,
      "usages_limit": 1,
      "status": "active",
      "terms_and_conditions": "",
      "category": "",
      "created_at": "2026-07-24T19:28:49+01:00",
      "updated_at": "2026-07-24T19:28:52+01:00",
      "deleted_at": null
    },
    {
      "id": 2,
      "voucher_code": "0193f969",
      "user_id": 1,
      "guest_id": 1,
      "discount_type": "fixed_amount",
      "discount_value": 0.1,
      "minimum_spend": 0,
      "maximum_discount_amount": 0,
      "currency": "USD",
      "validity_start": "2026-07-24T00:00:00+01:00",
      "validity_end": "2026-12-24T00:00:00+01:00",
      "usages": 0,
      "usages_limit": 1,
      "status": "active",
      "terms_and_conditions": "",
      "category": "redemption",
      "created_at": "2026-07-24T20:04:14+01:00",
      "updated_at": "2026-07-24T20:04:14+01:00",
      "deleted_at": null
    }
  ]
}