Remove store credit from an order - Spree Commerce documentation

DELETE

api

admin

orders

{order_id}

store_credits

Spree Admin SDK

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

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

await client.orders.storeCredits.remove('or_UkLWZg9DAJ')

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

Response

204

store credit removed

Apply customer's store credit to an order

List orders

⌘I

Spree Admin SDK

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

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

await client.orders.storeCredits.remove('or_UkLWZg9DAJ')