Skip to main content
POST
Spree Admin SDK

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

Body

application/json
amount
string
required

Decimal amount, greater than zero.

Example:

"25.00"

currency
string

ISO 4217 currency code. Defaults to the store currency.

Example:

"USD"

code
string

Optional caller-supplied code. Auto-generated when omitted.

Example:

"WELCOME50"

expires_at
string | null

ISO 8601 date.

Example:

"2030-12-31"

user_id
string | null

Optional customer prefixed ID.

Example:

"cus_UkLWZg9DAJ"

Response

gift card created

id
string
required
code
string
required
status
string
required
currency
string
required
amount
string
required
amount_used
string
required
amount_authorized
string
required
amount_remaining
string
required
display_amount
string
required
display_amount_used
string
required
display_amount_remaining
string
required
expires_at
string | null
required
redeemed_at
string | null
required
expired
boolean
required
active
boolean
required
created_at
string
required
updated_at
string
required
customer_id
string | null
required
created_by_id
string | null
required
customer
object
created_by
object
gift_card_batch
object
orders
object[]