> ## 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. # Create a gift card batch > Issues a batch of gift cards in a single call. The server generates `codes_count` cards inline for small batches (configurable via `Spree.config.gift_card_batch_web_limit`, default 500) or enqueues a background job for larger ones. Each card's code is the batch `prefix` followed by random hex. **Required scope:** `write_gift_cards` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml post /api/v3/admin/gift_card_batches openapi: 3.0.3 info: title: Admin API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Admin API v3 - Administrative API for managing products, orders, and store settings. ## Authentication The Admin API requires a secret API key passed in the `x-spree-api-key` header. Secret API keys can be generated in the Spree admin dashboard. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. Single resource endpoints return a flat JSON object. ## Resource IDs Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`, `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths, request bodies, and Ransack filters all accept them directly. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Admin user authentication - name: Product Catalog description: Products, variants, and option types - name: Orders description: >- Order management — orders, items, payments, fulfillments, refunds, gift cards, store credits - name: Customers description: Customer management — profiles, addresses, store credits, credit cards - name: Configuration description: Store configuration — payment methods, tag autocomplete paths: /api/v3/admin/gift_card_batches: post: tags: - Gift Cards summary: Create a gift card batch description: |- Issues a batch of gift cards in a single call. The server generates `codes_count` cards inline for small batches (configurable via `Spree.config.gift_card_batch_web_limit`, default 500) or enqueues a background job for larger ones. Each card's code is the batch `prefix` followed by random hex. **Required scope:** `write_gift_cards` (for API-key authentication). parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true schema: type: string requestBody: content: application/json: schema: type: object required: - prefix - amount - codes_count properties: prefix: type: string example: WELCOME description: Lowercased and prepended to every generated code. amount: type: string example: '25.00' description: Decimal amount per card, greater than zero. currency: type: string example: USD description: ISO 4217 currency code. Defaults to the store currency. codes_count: type: integer example: 100 description: >- Number of cards to generate. Capped at `gift_card_batch_limit`. expires_at: type: string example: '2030-12-31' nullable: true responses: '201': description: gift card batch created content: application/json: example: id: gcb_gbHJdmfrXB codes_count: 5 currency: USD prefix: NEWCAMP created_at: '2026-06-05T13:12:07.399Z' updated_at: '2026-06-05T13:12:07.399Z' amount: '25.0' expires_at: '2030-12-31' created_by_id: admin_UkLWZg9DAJ schema: $ref: '#/components/schemas/GiftCardBatch' '422': description: validation error content: application/json: example: error: code: validation_error message: Prefix can't be blank details: prefix: - can't be blank schema: $ref: '#/components/schemas/ErrorResponse' security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Admin SDK source: |- import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) const batch = await client.giftCardBatches.create({ prefix: 'WELCOME', amount: '25.00', currency: 'USD', codes_count: 100, expires_at: '2030-12-31', }) components: schemas: GiftCardBatch: type: object properties: id: type: string codes_count: type: number currency: type: string nullable: true prefix: type: string nullable: true created_at: type: string updated_at: type: string amount: type: string nullable: true expires_at: type: string nullable: true created_by_id: type: string nullable: true required: - id - codes_count - currency - prefix - created_at - updated_at - amount - expires_at - created_by_id x-typelizer: true ErrorResponse: type: object properties: error: type: object properties: code: type: string example: record_not_found message: type: string example: Record not found details: type: object description: Field-specific validation errors nullable: true example: name: - is too short - is required email: - is invalid required: - code - message required: - error example: error: code: validation_error message: Validation failed details: name: - is too short email: - is invalid securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Secret API key for admin access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for admin user authentication ````