Skip to main content
PATCH
/
api
/
v3
/
admin
/
orders
/
{order_id}
/
fulfillments
/
{id}
/
split
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

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

const fulfillment = await client.orders.fulfillments.split('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ', {
  quantity: 1,
})
{
  "data": [
    {
      "id": "ful_gbHJdmfrXB",
      "number": "H90633868146",
      "tracking": null,
      "tracking_url": null,
      "cost": "10.0",
      "display_cost": "$10.00",
      "total": "10.0",
      "display_total": "$10.00",
      "discount_total": "0.0",
      "display_discount_total": "$0.00",
      "additional_tax_total": "0.0",
      "display_additional_tax_total": "$0.00",
      "included_tax_total": "0.0",
      "display_included_tax_total": "$0.00",
      "tax_total": "0.0",
      "display_tax_total": "$0.00",
      "status": "ready",
      "fulfillment_type": "shipping",
      "fulfilled_at": null,
      "items": [
        {
          "item_id": "li_UkLWZg9DAJ",
          "variant_id": "variant_UkLWZg9DAJ",
          "quantity": 1
        }
      ],
      "metadata": {},
      "adjustment_total": "0.0",
      "pre_tax_amount": "0.0",
      "created_at": "2026-05-21T18:11:11.340Z",
      "updated_at": "2026-05-21T18:11:11.385Z",
      "order_id": "or_UkLWZg9DAJ",
      "stock_location_id": "sloc_gbHJdmfrXB"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

id
string
required

Fulfillment ID

Body

application/json
variant_id
string
required

Variant ID

quantity
integer
required
Example:

1

stock_location_id
string

Target stock location ID

Response

200 - application/json

fulfillment split