Spree Admin SDK

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

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

// Partial receipt is the normal case: ten left, eight arrived intact and two
// crushed. Refused units are recorded, never stocked.
const stockReceipt = await client.stockTransfers.stockReceipts.create('st_1234567890', {
  items: [
    {
      id: 'sti_1234567890',
      quantity_accepted: 8,
      quantity_rejected: 2,
      rejection_reason: 'damaged',
    },
  ],
})

{
  "id": "sr_UkLWZg9DAJ",
  "number": "SR1001",
  "reference": null,
  "notes": null,
  "metadata": {},
  "quantity_accepted_total": 8,
  "quantity_rejected_total": 2,
  "received_at": "2026-01-15T12:00:00.000Z",
  "created_at": "2026-01-15T12:00:00.000Z",
  "updated_at": "2026-01-15T12:00:00.000Z",
  "receivable_type": "stock_transfer",
  "receivable_id": "st_UkLWZg9DAJ",
  "received_by_id": "adm_UkLWZg9DAJ",
  "received_by_type": "admin_user",
  "items_count": 1
}

{
  "error": {
    "code": "processing_error",
    "message": "Only a transfer in transit can be received"
  }
}

Count a delivery in

Records one delivery the destination warehouse counted in, as a stock receipt. Partial receipt is the normal case: ten left, eight arrived, two were crushed in transit. Quantities are this delivery’s counts — a second box adds to the first rather than restating it.

quantity_accepted lands on the destination’s shelf; quantity_rejected is refused and recorded with a rejection_reason (damaged, wrong_item, expired or other), never stocked. A refused unit still arrived, so it counts toward the trip being over. Omit items to count in everything still outstanding, intact.

The transfer stays partially_received while units are still on the road, settles in received once everything has arrived, and in over_received once more arrived than was shipped.

Required scope: write_stock (for API-key authentication).

POST

api

admin

stock_transfers

{stock_transfer_id}

stock_receipts

Spree Admin SDK

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

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

// Partial receipt is the normal case: ten left, eight arrived intact and two
// crushed. Refused units are recorded, never stocked.
const stockReceipt = await client.stockTransfers.stockReceipts.create('st_1234567890', {
  items: [
    {
      id: 'sti_1234567890',
      quantity_accepted: 8,
      quantity_rejected: 2,
      rejection_reason: 'damaged',
    },
  ],
})

{
  "id": "sr_UkLWZg9DAJ",
  "number": "SR1001",
  "reference": null,
  "notes": null,
  "metadata": {},
  "quantity_accepted_total": 8,
  "quantity_rejected_total": 2,
  "received_at": "2026-01-15T12:00:00.000Z",
  "created_at": "2026-01-15T12:00:00.000Z",
  "updated_at": "2026-01-15T12:00:00.000Z",
  "receivable_type": "stock_transfer",
  "receivable_id": "st_UkLWZg9DAJ",
  "received_by_id": "adm_UkLWZg9DAJ",
  "received_by_type": "admin_user",
  "items_count": 1
}

{
  "error": {
    "code": "processing_error",
    "message": "Only a transfer in transit can be received"
  }
}

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

stock_transfer_id

string

required

Stock transfer ID

Body

application/json

reference

string | null

The supplier's delivery note, or the carrier's reference.

Example:

"DN-4471"

received_at

string<date-time> | null

When the goods were counted in. Defaults to now.

notes

string | null

items

object[]

Omit to book in everything still outstanding, intact. Naming lines, even none, records exactly what the dock counted: quantity_accepted reaches the shelf; quantity_rejected is refused, recorded with a rejection_reason and never stocked.

Show child attributes

Response

delivery counted in

string

required

number

string

required

reference

string | null

required

notes

string | null

required

metadata

object

required

quantity_accepted_total

number

required

quantity_rejected_total

number

required

received_at

string

required

created_at

string

required

updated_at

string

required

receivable_type

enum<string>

required

Available options:

purchase_order,

stock_transfer

receivable_id

string

required

received_by_id

string | null

required

received_by_type

required

The values listed are the built-in ones; extensions may add more.

Available options:

admin_user,

api_key

items_count

number

required

received_by

object

Show child attributes

items

object[]

Show child attributes

⌘I

API basics

Endpoints

Count a delivery in

Authorizations

Headers

Path Parameters

Body

Response