Gift cards

FaxStore

Prerequisites
Installation & Setup
API
Cache
Config File
Developer Mode
Developer Tools
Enable Debug Mode
Events
Extensions
Features
Integrations
License System Extension
Permissions
Updating FaxStore

Weblutions Documentation > FaxStore > API > Gift cards

Gift cards

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 accounts API (/api/accounts/:id/giftcards).

GET /api/giftcards

Returns an array of all gift cards that are in the store.

Parameters:

authorization [Header] A valid API token

Response: ^[Expand]

2xx:

[
  {
    "id": 4,
    "giftId": "cmaAv3yFf2iYiGqeWoWo6x9MPO66LlXPbGCZB4ratmHrB",
    "cost": "10.00",
    "userId": "1679886138722",
    "username": "User One",
    "remainingAmount": "0.01"
  },
  {
    "id": 6,
    "giftId": "QCcvDZzjRcCycKyVw293eMWO1H-1vP7aMaY8mNJeRYFzO",
    "cost": "99.99",
    "userId": "1679886138745",
    "username": "User Two",
    "remainingAmount": "1966.01"
  },
  {
    "id": 7,
    "giftId": "mquTuameT-_jqUGpjQrXpys9AwGAvhWxK-u8RlvchZBxz",
    "cost": "10.00",
    "userId": "1679886138974",
    "username": "User Three",
    "remainingAmount": "10.00"
  }
]

4xx:

404: Gift cards not found.

GET /api/giftcards/:id

Returns a single gift card with the provided ID.

Parameters:

`authorization`	[Header] A valid API token
`id`	[URL] The gift card internal ID

Response: ^[Expand]

2xx:

{
    "id": 4,
    "giftId": "cmaAv3yFf2iYiGqeWoWo6x9MPO66LlXPbGCZB4ratmHrB",
    "cost": "10.00",
    "userId": "1679886138722",
    "username": "User One",
    "remainingAmount": "0.01"
}

4xx:

404: Gift card not found.

DELETE /api/giftcards/:id

Delete an assigned gift card from the attached customer and from the store entirely

Parameters:

`authorization`	[Header] A valid API token
`id`	[URL] The gift card internal ID

Response: ^[Expand]

2xx:

OK

4xx:

Gift card ID not found.

Suggest an edit

Review this page

faxes

3 days ago - updated (3 days ago)

Parameters:

Response: [Expand]

Parameters:

Response: [Expand]

Parameters:

Response: [Expand]

gift api card api.balance api

Response: ^[Expand]

Response: ^[Expand]

Response: ^[Expand]