List Gift Cards
curl --request GET \
--url https://ipos.dev.nowbookit.com/GiftCards \
--header 'X-API-KEY: <api-key>'import requests
url = "https://ipos.dev.nowbookit.com/GiftCards"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://ipos.dev.nowbookit.com/GiftCards', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ipos.dev.nowbookit.com/GiftCards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ipos.dev.nowbookit.com/GiftCards"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ipos.dev.nowbookit.com/GiftCards")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ipos.dev.nowbookit.com/GiftCards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"from": 123,
"to": 123,
"length": 123,
"items": [
{
"issuedDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"amount": 123,
"remainingAmount": 123,
"status": "<string>",
"paymentType": "<string>",
"cardFormat": "<string>",
"experienceCardName": "<string>",
"experienceCardDetails": "<string>",
"purchaserFirstName": "<string>",
"purchaserLastName": "<string>",
"purchaserEmail": "<string>",
"recipientFirstName": "<string>",
"recipientLastName": "<string>",
"recipientEmail": "<string>"
}
]
}Gift Cards
GET /GiftCards
Search and retrieve a paginated list of gift cards.
GET
/
GiftCards
List Gift Cards
curl --request GET \
--url https://ipos.dev.nowbookit.com/GiftCards \
--header 'X-API-KEY: <api-key>'import requests
url = "https://ipos.dev.nowbookit.com/GiftCards"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://ipos.dev.nowbookit.com/GiftCards', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ipos.dev.nowbookit.com/GiftCards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ipos.dev.nowbookit.com/GiftCards"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ipos.dev.nowbookit.com/GiftCards")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ipos.dev.nowbookit.com/GiftCards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"from": 123,
"to": 123,
"length": 123,
"items": [
{
"issuedDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"amount": 123,
"remainingAmount": 123,
"status": "<string>",
"paymentType": "<string>",
"cardFormat": "<string>",
"experienceCardName": "<string>",
"experienceCardDetails": "<string>",
"purchaserFirstName": "<string>",
"purchaserLastName": "<string>",
"purchaserEmail": "<string>",
"recipientFirstName": "<string>",
"recipientLastName": "<string>",
"recipientEmail": "<string>"
}
]
}Search and retrieve a paginated list of gift cards. Use filters to narrow results by SKU, issue date, or status flags.
Response is a paginated result with
Example 200 Response
string
required
Your API key
string
Filter by SKU
string
Filter by issue date (start). Format:
yyyy-MM-ddTHH:mm:ss.fffZstring
Filter by issue date (end). Format:
yyyy-MM-ddTHH:mm:ss.fffZboolean
Include cancelled cards. Default:
falseboolean
Include fully redeemed cards. Default:
falseboolean
Include expired cards. Default:
falseinteger
Number of records to return
integer
Zero-based offset for pagination
curl --location '[BASE_URL]/GiftCards?Limit=20&StartIndex=0&IncludeCancelled=false' \
--header 'X-API-KEY: your_api_key_here'
from, to, length, and items (array of GiftCard).
GiftCard fields
| Field | Type | Description |
|---|---|---|
cardNumber | string | Format: XXXXX-XXXXXXXX-XXXX |
issuedDate | datetime | UTC issue date |
expiryDate | datetime | UTC expiry date |
amount | number | Original balance |
remainingAmount | number | Remaining balance after redemptions |
status | string | Active, Cancelled, Redeemed, AwaitingPayment, PendingPostage, Expired |
paymentType | string | InHouse, Online, Complimentary |
cardFormat | string | EGiftCard, PhysicalCard, ExperienceGiftCard, LSEGiftCard, LSExperienceGiftCard |
experienceCardName | string | Experience cards only |
experienceCardDetails | string | Experience cards only |
purchaserFirstName | string | Purchaser first name |
purchaserLastName | string | Purchaser last name |
purchaserEmail | string | Purchaser email |
recipientFirstName | string | Recipient first name |
recipientLastName | string | Recipient last name |
recipientEmail | string | Recipient email |
{
"from": 0,
"to": 1,
"length": 1,
"items": [
{
"cardNumber": "ABCDE-12345678-WXYZ",
"issuedDate": "2024-01-10T09:00:00Z",
"expiryDate": "2025-01-10T09:00:00Z",
"amount": 100.00,
"remainingAmount": 75.00,
"status": "Active",
"paymentType": "Online",
"cardFormat": "EGiftCard",
"purchaserFirstName": "John",
"purchaserLastName": "Doe",
"purchaserEmail": "[email protected]",
"recipientFirstName": "Jane",
"recipientLastName": "Doe",
"recipientEmail": "[email protected]"
}
]
}
| Status | Description |
|---|---|
200 | Gift cards returned |
400 | API key not associated with a venue |
400 | No Venue Subscribed to your App. |
401 | X-API-KEY missing or invalid |
429 | Rate limit exceeded |
Authorizations
Headers
API Key authentication header
Query Parameters
The Gift Card Sku.
Filter on Gift Card Issued Start Date (UTC).
Filter on Gift Card Issued End Date (UTC).
Include Cancelled cards in the range. Default true.
Include Redeemed cards in the range. Default true.
Include Expired cards in the range. Default true.
Max number of records to return, default is 100, max is 100.
Required range:
1 <= x <= 100Number of matching records to skip before returning the matches, default is 0.