Skip to main content
GET
/
api
/
v3
/
admin
/
gift_card_batches
/
{id}
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const batch = await client.giftCardBatches.get('gcb_K3zr8x')
{
  "id": "gcb_UkLWZg9DAJ",
  "codes_count": 2,
  "currency": "USD",
  "prefix": "WELCOME",
  "created_at": "2026-05-24T17:36:58.593Z",
  "updated_at": "2026-05-24T17:36:58.593Z",
  "amount": "50.0",
  "expires_at": null,
  "created_by_id": null
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Path Parameters

id
string
required

Gift card batch prefixed ID

Response

gift card batch found

id
string
required
codes_count
number
required
currency
string | null
required
prefix
string | null
required
created_at
string
required
updated_at
string
required
amount
string | null
required
expires_at
string | null
required
created_by_id
string | null
required