Giftcards
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816Query parameters
limitinteger · int32 · min: 1 · max: 100Optional
The maximum number of items to return in a single request.
afterstring · flake-idOptionalExample:
Returns items after the specified ID. Used for forward pagination through results.
411486491630370816beforestring · flake-idOptionalExample:
Returns items before the specified ID. Used for backward pagination through results.
411486491630370816ascbooleanOptional
Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.
codestringOptional
A gift card code to filter by.
include_canceledbooleanOptional
Should canceled gift cards be included in the response?
Responses
200
OK
application/json
default
Error response
application/json
get
/v1/stores/{storeId}/giftcardsGET /v1/stores/{storeId}/giftcards HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"enabled": true,
"code": "GIFT-2024-ABCD1234",
"note": "text",
"balance": 2500,
"starting_balance": 5000,
"usable_at": "2025-10-30T00:43:40.771Z",
"expires_at": "2025-10-30T00:43:40.771Z",
"created_at": "2025-10-30T00:43:40.771Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-10-30T00:43:40.771Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"canceled_at": "2025-10-30T00:43:40.771Z",
"canceled_by": {
"type": "anonymous",
"id": "411486491630370816"
}
}
]Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816Body
enabledbooleanRequired
codestringRequired
notestringOptional
balanceinteger · int64Required
usable_atstring · date-timeRequired
expires_atstring · date-timeOptional
Responses
200
OK
application/json
default
Error response
application/json
post
/v1/stores/{storeId}/giftcardsPOST /v1/stores/{storeId}/giftcards HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 135
{
"enabled": true,
"code": "text",
"note": "text",
"balance": 1,
"usable_at": "2025-10-30T00:43:40.771Z",
"expires_at": "2025-10-30T00:43:40.771Z"
}{
"id": "411486491630370816",
"store_id": "411486491630370816",
"enabled": true,
"code": "GIFT-2024-ABCD1234",
"note": "text",
"balance": 2500,
"starting_balance": 5000,
"usable_at": "2025-10-30T00:43:40.771Z",
"expires_at": "2025-10-30T00:43:40.771Z",
"created_at": "2025-10-30T00:43:40.771Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-10-30T00:43:40.771Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"canceled_at": "2025-10-30T00:43:40.771Z",
"canceled_by": {
"type": "anonymous",
"id": "411486491630370816"
}
}Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816giftCardIdstring · flake-idRequiredExample:
411486491630370816Responses
200
OK
application/json
default
Error response
application/json
get
/v1/stores/{storeId}/giftcards/{giftCardId}GET /v1/stores/{storeId}/giftcards/{giftCardId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"enabled": true,
"code": "GIFT-2024-ABCD1234",
"note": "text",
"balance": 2500,
"starting_balance": 5000,
"usable_at": "2025-10-30T00:43:40.771Z",
"expires_at": "2025-10-30T00:43:40.771Z",
"created_at": "2025-10-30T00:43:40.771Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-10-30T00:43:40.771Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"canceled_at": "2025-10-30T00:43:40.771Z",
"canceled_by": {
"type": "anonymous",
"id": "411486491630370816"
}
}Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816giftCardIdstring · flake-idRequiredExample:
411486491630370816Responses
200
OK
application/json
default
Error response
application/json
delete
/v1/stores/{storeId}/giftcards/{giftCardId}DELETE /v1/stores/{storeId}/giftcards/{giftCardId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"enabled": true,
"code": "GIFT-2024-ABCD1234",
"note": "text",
"balance": 2500,
"starting_balance": 5000,
"usable_at": "2025-10-30T00:43:40.771Z",
"expires_at": "2025-10-30T00:43:40.771Z",
"created_at": "2025-10-30T00:43:40.771Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-10-30T00:43:40.771Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"canceled_at": "2025-10-30T00:43:40.771Z",
"canceled_by": {
"type": "anonymous",
"id": "411486491630370816"
}
}Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816giftCardIdstring · flake-idRequiredExample:
411486491630370816Body
enabledbooleanOptional
codestringOptional
notestringOptional
balanceinteger · int64Optional
usable_atstring · date-timeOptional
expires_atstring · date-timeOptional
Responses
200
OK
application/json
default
Error response
application/json
patch
/v1/stores/{storeId}/giftcards/{giftCardId}PATCH /v1/stores/{storeId}/giftcards/{giftCardId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 135
{
"enabled": true,
"code": "text",
"note": "text",
"balance": 1,
"usable_at": "2025-10-30T00:43:40.771Z",
"expires_at": "2025-10-30T00:43:40.771Z"
}{
"id": "411486491630370816",
"store_id": "411486491630370816",
"enabled": true,
"code": "GIFT-2024-ABCD1234",
"note": "text",
"balance": 2500,
"starting_balance": 5000,
"usable_at": "2025-10-30T00:43:40.771Z",
"expires_at": "2025-10-30T00:43:40.771Z",
"created_at": "2025-10-30T00:43:40.771Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-10-30T00:43:40.771Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"canceled_at": "2025-10-30T00:43:40.771Z",
"canceled_by": {
"type": "anonymous",
"id": "411486491630370816"
}
}Was this helpful?
