FaxStore

Our Discord

Weblutions Documentation / FaxStore / Gift cards API

Gift cards API

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.

Table of Contents

Get All Gift cards

GET/api/giftcards

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

Authorization

Name	Type	Required	Description
authorization	String	required

Responses

200OKjson

View response body

[
  {
    "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"
  }
]

404Not Foundplaintext

View response body

Gift cards table not found.

Examples

curl -X GET 'https://api.example.com/api/giftcards' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/giftcards', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/giftcards', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/giftcards', false, $context);
$data = json_decode($response, true);

Get Single Gift card

GET/api/giftcards/:id

Returns a single gift card with the provided ID.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required

Responses

200OKjson

View response body

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

404Not Foundplaintext

View response body

Gift cards table not found.

Examples

curl -X GET 'https://api.example.com/api/giftcards/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/giftcards/123', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/giftcards/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/giftcards/123', false, $context);
$data = json_decode($response, true);

Delete Gift card

DELETE/api/giftcards/:id

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

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required

Responses

201OKplaintext

View response body

(no content)

404Not Foundplaintext

View response body

Gift card ID not found.

Examples

curl -X DELETE 'https://api.example.com/api/giftcards/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/giftcards/123', {
  "method": "DELETE",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.delete('https://api.example.com/api/giftcards/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'DELETE',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/giftcards/123', false, $context);
$data = json_decode($response, true);

Document History

Loading version history...