Applies the order customer’s available store credit. When amount is omitted, applies up to the order outstanding balance.
Required scope: write_store_credits (for API-key authentication).
POST
/
api
/
v3
/
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',
})
const order = await client.orders.storeCredits.apply('or_UkLWZg9DAJ', {
amount: '25.00',
})spree api post /orders/{order_id}/store_credits -d '{"amount":"25.00"}'{
"id": "or_UkLWZg9DAJ",
"market_id": "mkt_UkLWZg9DAJ",
"cart_id": null,
"channel_id": "ch_UkLWZg9DAJ",
"number": "R484055636",
"email": "haydee.kemmer@reichertmetz.us",
"customer_note": null,
"currency": "USD",
"locale": "en",
"total_quantity": 1,
"coupon_code": null,
"fulfillment_status": null,
"payment_status": null,
"completed_at": null,
"item_total": "10.0",
"display_item_total": "$10.00",
"adjustment_total": "0.0",
"display_adjustment_total": "$0.00",
"discount_total": "0.0",
"display_discount_total": "$0.00",
"tax_total": "0.0",
"display_tax_total": "$0.00",
"included_tax_total": "0.0",
"display_included_tax_total": "$0.00",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"total": "110.0",
"display_total": "$110.00",
"gift_card_total": "0.0",
"display_gift_card_total": "$0.00",
"amount_due": "60.0",
"display_amount_due": "$60.00",
"delivery_total": "100.0",
"display_delivery_total": "$100.00",
"store_credit_total": "50.0",
"display_store_credit_total": "-$50.00",
"covered_by_store_credit": false,
"gift_card": null,
"market": {
"id": "mkt_UkLWZg9DAJ",
"name": "United States of America",
"currency": "USD",
"default_locale": "en",
"tax_inclusive": false,
"default": true,
"country_isos": [
"US"
],
"supported_locales": [
"en"
],
"created_at": "2026-08-10T07:56:25.958Z",
"updated_at": "2026-08-10T07:56:25.958Z"
},
"status": "draft",
"last_ip_address": null,
"considered_risky": false,
"confirmation_delivered": false,
"store_owner_notification_delivered": null,
"payment_total": "0.0",
"display_payment_total": "$0.00",
"metadata": {},
"canceled_at": null,
"approved_at": null,
"created_at": "2026-08-10T07:56:36.590Z",
"updated_at": "2026-08-10T07:56:36.638Z",
"preferred_stock_location_id": null,
"tags": [],
"internal_note": null,
"internal_note_html": null,
"approver_id": null,
"canceler_id": null,
"created_by_id": null,
"customer_id": "cust_UkLWZg9DAJ"
}Authorizations
Secret API key for admin access
JWT token for admin user authentication
Headers
Bearer token for admin authentication
Path Parameters
Order ID
Body
application/json
Optional explicit amount; defaults to order outstanding balance
Response
201 - application/json
store credit applied
Was this page helpful?
⌘I
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'
const client = createAdminClient({
baseUrl: 'https://your-store.com',
secretKey: 'sk_xxx',
})
const order = await client.orders.storeCredits.apply('or_UkLWZg9DAJ', {
amount: '25.00',
})spree api post /orders/{order_id}/store_credits -d '{"amount":"25.00"}'{
"id": "or_UkLWZg9DAJ",
"market_id": "mkt_UkLWZg9DAJ",
"cart_id": null,
"channel_id": "ch_UkLWZg9DAJ",
"number": "R484055636",
"email": "haydee.kemmer@reichertmetz.us",
"customer_note": null,
"currency": "USD",
"locale": "en",
"total_quantity": 1,
"coupon_code": null,
"fulfillment_status": null,
"payment_status": null,
"completed_at": null,
"item_total": "10.0",
"display_item_total": "$10.00",
"adjustment_total": "0.0",
"display_adjustment_total": "$0.00",
"discount_total": "0.0",
"display_discount_total": "$0.00",
"tax_total": "0.0",
"display_tax_total": "$0.00",
"included_tax_total": "0.0",
"display_included_tax_total": "$0.00",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"total": "110.0",
"display_total": "$110.00",
"gift_card_total": "0.0",
"display_gift_card_total": "$0.00",
"amount_due": "60.0",
"display_amount_due": "$60.00",
"delivery_total": "100.0",
"display_delivery_total": "$100.00",
"store_credit_total": "50.0",
"display_store_credit_total": "-$50.00",
"covered_by_store_credit": false,
"gift_card": null,
"market": {
"id": "mkt_UkLWZg9DAJ",
"name": "United States of America",
"currency": "USD",
"default_locale": "en",
"tax_inclusive": false,
"default": true,
"country_isos": [
"US"
],
"supported_locales": [
"en"
],
"created_at": "2026-08-10T07:56:25.958Z",
"updated_at": "2026-08-10T07:56:25.958Z"
},
"status": "draft",
"last_ip_address": null,
"considered_risky": false,
"confirmation_delivered": false,
"store_owner_notification_delivered": null,
"payment_total": "0.0",
"display_payment_total": "$0.00",
"metadata": {},
"canceled_at": null,
"approved_at": null,
"created_at": "2026-08-10T07:56:36.590Z",
"updated_at": "2026-08-10T07:56:36.638Z",
"preferred_stock_location_id": null,
"tags": [],
"internal_note": null,
"internal_note_html": null,
"approver_id": null,
"canceler_id": null,
"created_by_id": null,
"customer_id": "cust_UkLWZg9DAJ"
}
