List Gift Cards
Gift Cards
GET /GiftCards
Search and retrieve a paginated list of gift cards.
GET
List Gift Cards
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
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
from, to, length, and items (array of GiftCard).
GiftCard fields
Example 200 Response
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.