Weblutions Documentation
Weblutions Main Site Contact Us Our Discord
FaxStore IconFaxStore

Weblutions Documentation / FaxStore / Gift cards

Updated

Gift cards

By Josh M. 1 mins 44

The Gift Card API for FaxStore manages the creation, retrieval, and deletion of gift cards. It enables seamless handling of digital gift card balances and redemptions. > To add a gift card to an account. Refer to the <a href='/c/faxstore/api-accounts' class='convertLink' target='_blank'>accounts API</a> (/api/accounts/:id/giftcards). <div class='mdhttpRequest'> <p><span class='mdhttpBlue'>GET</span><span class='mdhttpEndpoint'> /api/giftcards</span></p> <p class='mdhttpDesc'>Returns an array of all gift cards that are in the store.</p> <h3>Parameters:</h3><table class='mdhttpParam'><tr><td><code>authorization</code></td><td>[Header] A valid API token</td></tr></table> <h3 id='httpReqRes-4808b6fa-a7b7-468c-8c8b-734b6482e61c'>Response: <sup>[Expand]</sup></h3> <div id='4808b6fa-a7b7-468c-8c8b-734b6482e61c' style='display: none;'>3eecb44e-cc57-4102-8d1c-61403e1bb07f</div> </div> <div class='mdhttpRequest'> <p><span class='mdhttpBlue'>GET</span><span class='mdhttpEndpoint'> /api/giftcards/:id</span></p> <p class='mdhttpDesc'>Returns a single gift card with the provided ID.</p> <h3>Parameters:</h3><table class='mdhttpParam'><tr><td><code>authorization</code></td><td>[Header] A valid API token</td></tr><tr><td><code>id</code></td><td>[URL] The gift card internal ID</td></tr></table> <h3 id='httpReqRes-d725bf56-01a0-42c0-b2b5-b7741b02be97'>Response: <sup>[Expand]</sup></h3> <div id='d725bf56-01a0-42c0-b2b5-b7741b02be97' style='display: none;'>a2950ad5-16d9-42e7-bb0d-20615a71dcee</div> </div> <div class='mdhttpRequest'> <p><span class='mdhttpRed'>DELETE</span><span class='mdhttpEndpoint'> /api/giftcards/:id</span></p> <p class='mdhttpDesc'>Delete an assigned gift card from the attached customer and from the store entirely</p> <h3>Parameters:</h3><table class='mdhttpParam'><tr><td><code>authorization</code></td><td>[Header] A valid API token</td></tr><tr><td><code>id</code></td><td>[URL] The gift card internal ID</td></tr></table> <h3 id='httpReqRes-9c3d3011-9f46-40fb-a35f-9a4d5f6960a3'>Response: <sup>[Expand]</sup></h3> <div id='9c3d3011-9f46-40fb-a35f-9a4d5f6960a3' style='display: none;'>e9154740-4a4e-4509-862d-eed4169f4434</div> </div>