> ## 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.

# Split a fulfillment

> Transfers items from this shipment to a new shipment at a different stock location.

**Required scope:** `write_fulfillments` (for API-key authentication).



## OpenAPI

````yaml /api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{id}/split
openapi: 3.0.3
info:
  title: Admin API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: >
    Spree Admin API v3 - Administrative API for managing products, orders, and
    store settings.


    ## Authentication


    The Admin API requires a secret API key passed in the `x-spree-api-key`
    header.

    Secret API keys can be generated in the Spree admin dashboard.


    ## Response Format


    All responses are JSON. List endpoints return paginated responses with
    `data` and `meta` keys.

    Single resource endpoints return a flat JSON object.


    ## Resource IDs


    Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,

    `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,

    request bodies, and Ransack filters all accept them directly.


    ## Error Handling


    Errors return a consistent format:

    ```json

    {
      "error": {
        "code": "validation_error",
        "message": "Validation failed",
        "details": { "name": ["can't be blank"] }
      }
    }

    ```
  version: v3
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Authentication
    description: Admin user login, logout, token refresh, and current user profile
  - name: Allowed Origins
    description: CORS allowlist for storefront and admin client origins
  - name: API Keys
    description: Secret and publishable API keys
  - name: Categories
    description: >-
      Hierarchical product categories — tree management, repositioning, and
      product assignments
  - name: Channels
    description: >-
      Sales channels, product publication across channels, and per-channel order
      routing rules
  - name: Custom Fields
    description: >-
      Custom field definitions for products, variants, customers, and other
      resources
  - name: Customer Groups
    description: >-
      Customer groups for segmenting customers (e.g. wholesale, VIP) used by
      pricing and promotions
  - name: Customers
    description: Customer profiles, addresses, credit cards, and store credits
  - name: Email Templates
    description: >-
      Customer email templates, the email layout and shared partials: drafts,
      previews, publishing and history
  - name: Exports
    description: Async CSV exports of admin resources
  - name: Files
    description: Uploading the files that product media, imports, logos and documents use
  - name: Fulfillments
    description: Order fulfillments — shipments, fulfill, cancel, resume, split
  - name: Gift Cards
    description: Gift cards and gift card batches
  - name: Imports
    description: >-
      Async CSV imports of admin resources, with per-row status and failed-row
      retry
  - name: Maintenance Tasks
    description: >-
      Operator-run data work — backfills, reindexes and upgrade steps — and the
      record of every run
  - name: Markets
    description: >-
      Markets — geographic groupings of countries used for pricing, tax, and
      fulfillment rules
  - name: Option Types
    description: >-
      Option types and option values used to build product variants (e.g. Size,
      Color)
  - name: Orders
    description: Orders, order items, applied gift cards, and applied store credits
  - name: Payment Methods
    description: Configured payment providers and their available types
  - name: Payments
    description: Order payments — list, capture, void
  - name: Pricing
    description: >-
      Prices and price lists for currency-, market-, and customer-group-specific
      pricing
  - name: Products
    description: >-
      Products, taxons/categories, product custom field values, and bulk product
      operations
  - name: Policies
    description: The store's legal documents — terms of service, privacy, returns, shipping
  - name: Reasons
    description: >-
      Merchant-owned vocabularies for why a return, claim, refund, cancellation
      or tax exemption happened
  - name: Promotions
    description: Promotions, promotion rules, promotion actions, and coupon codes
  - name: Refunds
    description: Order refunds
  - name: Settings
    description: Store-level settings — store profile, tags, and configuration
  - name: Staff
    description: Admin users, roles, and invitations to the store
  - name: Stock Locations
    description: Warehouses and physical fulfillment locations
  - name: Store Credits
    description: Prepaid customer balances across all customers, and each balance's ledger
  - name: Variants
    description: >-
      Product variants — the individual SKUs (size/color combinations) sold
      under a product
  - name: Webhooks
    description: Webhook endpoints and webhook delivery history
paths:
  /api/v3/admin/orders/{order_id}/fulfillments/{id}/split:
    patch:
      tags:
        - Fulfillments
      summary: Split a fulfillment
      description: >-
        Transfers items from this shipment to a new shipment at a different
        stock location.


        **Required scope:** `write_fulfillments` (for API-key authentication).
      parameters:
        - name: x-spree-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          description: Bearer token for admin authentication
          schema:
            type: string
        - name: order_id
          in: path
          required: true
          description: Order ID
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: Fulfillment ID
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FulfillmentSplitParams'
        required: true
      responses:
        '200':
          description: fulfillment split
          content:
            application/json:
              example:
                data:
                  - id: ful_gbHJdmfrXB
                    number: R1001-F1
                    tracking: null
                    tracking_url: null
                    pickup_point_data: null
                    selected_delivery_rate_id: dr_EfhxLZ9ck8
                    unpriced: false
                    cost: '10.00'
                    total: '10.00'
                    discount_total: '0.00'
                    additional_tax_total: '0.00'
                    included_tax_total: '0.00'
                    tax_total: '0.00'
                    status: unfulfilled
                    fulfillment_type: shipping
                    fulfilled_at: null
                    delivered_at: null
                    items:
                      - item_id: li_UkLWZg9DAJ
                        variant_id: variant_UkLWZg9DAJ
                        quantity: 1
                    deliveries: []
                    external_references: {}
                    metadata: {}
                    created_at: '2026-01-15T12:00:00.000Z'
                    updated_at: '2026-01-15T12:00:00.000Z'
                    adjustment_total: '0.00'
                    pre_tax_amount: '0.00'
                    order_id: or_UkLWZg9DAJ
                    stock_location_id: sloc_gbHJdmfrXB
                    documents: []
                    labels: []
                    provider_generates_labels: false
      security:
        - api_key: []
          bearer_auth: []
      x-codeSamples:
        - lang: javascript
          label: Spree Admin SDK
          source: >-
            import { createAdminClient } from '@spree/admin-sdk'


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


            // Splitting moves a quantity of one variant into its own
            fulfillment, so the

            // response is the order's full set: the source is re-shaped, and
            disappears

            // when the split drains it. Pass stock_location_id to send the new

            // fulfillment out from a different origin.

            const { data: fulfillments } = await
            client.orders.fulfillments.split(
              'or_UkLWZg9DAJ',
              'ful_UkLWZg9DAJ',
              {
                variant_id: 'variant_86Rf07xd4z',
                quantity: 1,
              },
            )
        - lang: bash
          label: Spree CLI
          source: >-
            spree api patch /orders/{order_id}/fulfillments/{id}/split -d
            '{"variant_id":"variant_86Rf07xd4z","quantity":1}'
components:
  schemas:
    FulfillmentSplitParams:
      type: object
      properties:
        variant_id:
          type: string
          description: The variant being moved out.
        quantity:
          type: integer
        stock_location_id:
          type: string
          description: >-
            Origin of the new fulfillment. Defaults to the source fulfillment's
            location.
      required:
        - variant_id
        - quantity
  securitySchemes:
    api_key:
      type: apiKey
      name: x-spree-api-key
      in: header
      description: Secret API key for admin access
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token for admin user authentication

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.