API Reference

Create gift card

post
https://{domain_prefix}.retail.lightspeed.app/api/2026-04/gift_cards

Creates and activates a new gift card. The gift card will be created with one transaction with status "ACTIVATION" which contains the initial balance of the gift card.

🔒 Requires: gift_cards:write:issue scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create gift card parameters

The parameters for creating and activating a new gift card.

string
required

The initial balance to be loaded onto the gift card. Represented as a string for precision (e.g. "100.00").

string

The expiry date of the gift card in YYYY-MM-DD format. If omitted, the expiry will be calculated based on the validity period configured in the Lightspeed Retail UI, or will be null if expiry is not enabled.

string
required

The unique number to assign to the gift card.

string

The timezone to use when interpreting the expires_at date (e.g. "Pacific/Auckland"). See the list of tz database time zones for valid values.

string

The ID of the user creating the gift card. If omitted, the authenticated user will be used.

Responses

Updated 10 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago