Delete a gift card - Spree Commerce documentation

DELETE

api

admin

gift_cards

{id}

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

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

await client.giftCards.delete('gc_K3zr8x')

{
  "error": {
    "code": "validation_error",
    "message": "Gift card cannot be deleted"
  }
}

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

string

required

Gift card prefixed ID

Response

gift card deleted

Get a gift card

Update a gift card

⌘I

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

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

await client.giftCards.delete('gc_K3zr8x')

{
  "error": {
    "code": "validation_error",
    "message": "Gift card cannot be deleted"
  }
}