Giftcards

Get Gift Cards for a store

get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Query parameters
limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterinteger · int64Optional

Returns items after the specified ID. Used for forward pagination through results.

beforeinteger · int64Optional

Returns items before the specified ID. Used for backward pagination through results.

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

CodestringOptional
IncludeCanceledbooleanOptional
Responses
200
OK
application/json
get
GET /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-08-01T19:15:07.451Z",
    "expires_at": "2025-08-01T19:15:07.451Z",
    "created_at": "2025-08-01T19:15:07.451Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "updated_at": "2025-08-01T19:15:07.451Z",
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "canceled_at": "2025-08-01T19:15:07.451Z",
    "canceled_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

Create a Gift Card for a store

post
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Body
enabledbooleanRequired
codestringRequired
notestringOptional
balanceinteger · int64Required
usable_atstring · date-timeRequired
expires_atstring · date-timeOptional
Responses
200
OK
application/json
post
POST /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-08-01T19:15:07.451Z",
  "expires_at": "2025-08-01T19:15:07.451Z"
}
{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "enabled": true,
  "code": "GIFT-2024-ABCD1234",
  "note": "text",
  "balance": 2500,
  "starting_balance": 5000,
  "usable_at": "2025-08-01T19:15:07.451Z",
  "expires_at": "2025-08-01T19:15:07.451Z",
  "created_at": "2025-08-01T19:15:07.451Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-01T19:15:07.451Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "canceled_at": "2025-08-01T19:15:07.451Z",
  "canceled_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Get a Gift Card By ID for a store

get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
giftCardIdstring · flake-idRequiredExample: 411486491630370816
Responses
200
OK
application/json
get
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-08-01T19:15:07.451Z",
  "expires_at": "2025-08-01T19:15:07.451Z",
  "created_at": "2025-08-01T19:15:07.451Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-01T19:15:07.451Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "canceled_at": "2025-08-01T19:15:07.451Z",
  "canceled_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Delete a Gift Card By ID for a store

delete
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
giftCardIdstring · flake-idRequiredExample: 411486491630370816
Responses
200
OK
application/json
delete
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-08-01T19:15:07.451Z",
  "expires_at": "2025-08-01T19:15:07.451Z",
  "created_at": "2025-08-01T19:15:07.451Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-01T19:15:07.451Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "canceled_at": "2025-08-01T19:15:07.451Z",
  "canceled_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Update a Gift Card By ID for a store

patch
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
giftCardIdstring · flake-idRequiredExample: 411486491630370816
Body
enabledbooleanOptional
codestringOptional
notestringOptional
balanceinteger · int64Optional
usable_atstring · date-timeOptional
expires_atstring · date-timeOptional
Responses
200
OK
application/json
patch
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-08-01T19:15:07.451Z",
  "expires_at": "2025-08-01T19:15:07.451Z"
}
{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "enabled": true,
  "code": "GIFT-2024-ABCD1234",
  "note": "text",
  "balance": 2500,
  "starting_balance": 5000,
  "usable_at": "2025-08-01T19:15:07.451Z",
  "expires_at": "2025-08-01T19:15:07.451Z",
  "created_at": "2025-08-01T19:15:07.451Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-01T19:15:07.451Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "canceled_at": "2025-08-01T19:15:07.451Z",
  "canceled_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}
PreviousDownloadable FilesNextGlobal Commands

Was this helpful?