The Admin API is in beta today. Please contact us for access.
Get a Gift
The get endpoint allows you to preview information about a gift before redeeming the gift card code, or the checkout URL for merchandise gifts.
Redeem a Gift
The redeem endpoint allows you to retrieve the gift card code, or the checkout URL for merchandise gifts. In many cases, you may want to use the Redeem endpoint instead of the Get endpoint.
The redeem endpoint uses the following format:
Type: POST
URL: https://api.givy.ai/storefront/v1/shops/<shop-id>/gifts/<public-identifier>/redeem
<shop-id> = the Shop Identifier from Givy
<public_identifier> = the giftId from the URL
When successful, the following data will be returned.
Gift Card Payload
{
"data": {
"public_identifier": "ofna56v1b9sk4pe",
"type": "GIFT_CARD",
"redeemed": true,
"recipient_name": "Jenny",
"purchaser_name": "Frederick",
"gif_url": null,
"video_message_url": null,
"message": "Happy birthday! This is a custom message",
"gift_card": {
"code": "afdh8c9d45e76h7c",
"code_last_four": "6h7c",
"gift_card_image_url": "https:\/\/store.com\/gift_card.jpg",
"start_shopping_url": "https:\/\/store.com",
"balance": {
"amount": 999,
"amount_formatted": "CA$9.99"
}
}
}
}