Create a gift card sale invoice after using a gift card template

You must specify appropriate details for the request body parameters, and this API generates an invoice by booking the gift cards and returns a unique invoice ID as the response.

Request Model

Json PropertyData TypeDescription
center_idGuidUnique ID of the center
guest_idGuidUnique ID of the guest
online_guest_idGuid? (nullable)Unique online ID of the guest
giftcardsList<GiftCardInfo>List of gift card objects

giftcards object (GiftCardInfo)

Json PropertyData TypeDescription
template_idGuidUnique ID of the gift card
schedule_timeDateTime? (nullable)Scheduled time of the occasion
occassionGiftCardOccasionInfoGift card occasion object
recepientGiftCardRecepientGift card recipient details

occassion object (GiftCardOccasionInfo)

Json PropertyData TypeDescription
idGuidUnique ID of the occasion
image_idGuidUnique ID of the image
messagestringMessage associated with the occasion

recepient object (GiftCardRecepient)

Json PropertyData TypeDescription
namestringName of the recipient
emailstringEmail ID of the recipient

Response Model

Json PropertyData TypeDescription
invoice_idGuidUnique identifier of the invoice
invoice_numberstringInvoice number of the invoice (optional, may be null)
errorApiErrorModelError details (optional, null when the request succeeds)

ApiErrorModel

Json PropertyData TypeDescription
codeintError code
messagestringError message
Language
Credentials
Header
Click Try It! to start a request and see the response here!