Skip to main content
POST
/
api
/
v3
/
admin
/
orders
/
{order_id}
/
gift_cards
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

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

await client.orders.giftCards.apply('or_UkLWZg9DAJ', {
  code: 'GIFT-XXXX-YYYY',
})
{
  "id": "gc_UkLWZg9DAJ",
  "code": "4FE246FA26B40985",
  "status": "active",
  "currency": "USD",
  "amount": "10.0",
  "amount_used": "10.0",
  "amount_authorized": "0.0",
  "amount_remaining": "0.0",
  "display_amount": "$10.00",
  "display_amount_used": "$10.00",
  "display_amount_remaining": "$0.00",
  "expires_at": null,
  "redeemed_at": null,
  "expired": false,
  "active": true,
  "created_at": "2026-05-21T18:11:11.716Z",
  "updated_at": "2026-05-21T18:11:12.007Z"
}

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

Bearer token for admin authentication

Path Parameters

order_id
string
required

Order ID

Body

application/json
code
string
required

Gift card code

Example:

"GIFT-XXXX-YYYY"

Response

201 - application/json

gift card applied