ZenotiHelp

Use gift card APIs

ZTZenoti Docs Team Updated March 7, 2026 2 min readGuide

The gift card APIs let you manage gift card templates, create gift card sale invoices, check balances, and send gift card emails. These are the endpoints used in the Sell gift cards using APIs workflow.

For complete endpoint documentation including request/response schemas and code examples, see the individual API reference articles linked below.

Before you begin

Permission: Manage API Keys (under Administrator) -- Required to access Zenoti APIs.

Gift card templates

List all templates

GET /v1/gift_cards/templates

Retrieves all available gift card templates configured in Zenoti.

Create a gift card template with custom amount

POST /v1/gift_cards/templates

Creates a one-time gift card template with a custom monetary value.

Gift card sales

Create a gift card sale invoice

POST /v1/invoices/gift_cards

Creates an invoice for a gift card sale. Supports amount-based, service-based, and predefined gift card types.

Parameter Type Required Description
gift_cards.type enum No 0=CustomAmount, 1=Service, 2=PreDefined (default: 0)
gift_cards.code string Yes Unique gift card identifier
gift_cards.custom_amount.price decimal Yes Purchase price
gift_cards.custom_amount.value decimal Yes Face value of the gift card
gift_cards.expiry object Yes Expiration: days (duration) or date (specific date)
gift_cards.is_onetime_use boolean No Single-use restriction (default: false)
gift_cards.notes string No Transaction notes

Response: invoice_id.

Error codes: 448 (duplicate gift card number), 503 (invalid input), 502 (missing center, guest, or code), 1201 (employee required), 1207 (only one validity period allowed).

Gift card operations

Check gift card balance

GET /v1/gift_cards/{gift_card_id}/balance

Retrieves the current balance of a gift card.

Send gift card email

POST /v1/guests/{guest_id}/email

Sends the gift card details to the recipient's email address using the Send Email to Guest API.

List all gift cards of a guest

GET /v1/guests/{guest_id}/gift_cards

Retrieves all gift cards associated with a guest.

Tips

  • Use the type parameter to specify the gift card type: custom amount (0), service (1), or predefined (2).
  • The price and value fields can differ to support promotional pricing (for example, pay 80 for a gift card worth 100).
  • Set expiration using either days (number of days from purchase) or date (specific expiration date), but not both.

API reference

Was this article helpful?
Your feedback helps us improve our documentation.