List all gift cards of a guest

Provide unique identifier of the guest as guest_id and this api will retrieve the gift cards history of the respective guest.

Response Details

NameTypeDescription
gift_cardsobjectObject containing the gift cards information of the guest.
invoiceobjectObject containing the invoice details of the guest's gift cards.
centerobjectObject containing the center details where the gift card was purchased.
page_infoobjectObject containing the page info of the API response.

gift_cards Object

nametypedescription
idguidunique identifier of the gift card user
codestringcode of the gift card
typeenumgift card type
1 - Amount
2 - Service/Package
sale_datedatesale date of the gift card
expiry_datedateexpiry date of the gift card
pricedoubleprice of gift card
valuedoublevalue of gift card
balancedoublebalance in gift card
tipsdoubletips in gift card
notesstringnotes provided during gift card sale
sourceenumsource from which invoice is generated.
Web = 0
CustomerApp = 1
WebStore = 2
Imports = 3
Offline = 4
Dunning = 5
EmployeeApp = 6
ManagerApp = 7
AutoCollection = 8
Take5 = 11
TherapistAppAndroid = 12
TherapistAppIos = 13
MobilePosAndroid = 14
MobilePosiOS = 15
InstoreApp = 19
ApiDirect = 20
Unknown = 21
Extension = 22
Queue = 23
Kiosk = 24
KioskCMA = 25
KioskWeb = 26
is_closedbooleanif gift card is refunded
is_one_time_usebooleanif gift card is one time usable gift card.
is_receivedbooleanif gift card is received
occasionstringrepresents the occasion of the gift card.
gifted_byguidby whom the gift card is gifted by
benefitsobjectcontains details of the gift card benefits.

invoice Object

NameTypeDescription
idguidunique identifier of the
sourceenumsource from which invoice is generated.
Web = 0
CustomerApp = 1
WebStore = 2
Imports = 3
Offline = 4
Dunning = 5
EmployeeApp = 6
ManagerApp = 7
AutoCollection = 8
Take5 = 11
Therapis
statusstringcurrent statu
invoice_numberstringunique number us
receipt_numberstringunique numbe
invoice_item_idguidunique

center Object

NameTypeDescription
idguidunique identifier
namestringname of the ce
Language
Credentials
Header
Click Try It! to start a request and see the response here!