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

# Create a fulfillment

> Manually creates a fulfillment on a completed order, bypassing order routing — for example to mirror a shipment handled by an external carrier or 3PL. Moves the requested line item quantities out of their current fulfillments; when `items` is omitted, every not-yet-shipped unit is moved. Pass `status: 'shipped'` to register an already-shipped fulfillment (fires shipped webhooks and freezes cost/carrier). When `delivery_method_id` is omitted, the fulfillment inherits the delivery method and cost of the source fulfillment(s) it fully drains — keeping the order total unchanged; partially drained splits get no carrier when shipped, and pending fulfillments are otherwise (re)priced by the standard rate engine, which selects the lowest-cost available rate. Pass `cost` to set an explicit shipping cost instead (e.g. the 3PL price) — note this changes the order total and payment state, and is guaranteed to persist only with `status: 'shipped'` (pending fulfillments are re-priced by the rate engine).

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



## OpenAPI

````yaml /api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/fulfillments
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: Exports
    description: Async CSV exports of admin resources
  - 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: 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: Promotions
    description: Promotions, promotion rules, promotion actions, and coupon codes
  - name: Refunds
    description: Order refunds
  - name: Settings
    description: Store-level settings — store profile, tags, store credit categories
  - name: Staff
    description: Admin users, roles, and invitations to the store
  - name: Stock Locations
    description: Warehouses and physical fulfillment locations
  - 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:
    post:
      tags:
        - Fulfillments
      summary: Create a fulfillment
      description: >-
        Manually creates a fulfillment on a completed order, bypassing order
        routing — for example to mirror a shipment handled by an external
        carrier or 3PL. Moves the requested line item quantities out of their
        current fulfillments; when `items` is omitted, every not-yet-shipped
        unit is moved. Pass `status: 'shipped'` to register an already-shipped
        fulfillment (fires shipped webhooks and freezes cost/carrier). When
        `delivery_method_id` is omitted, the fulfillment inherits the delivery
        method and cost of the source fulfillment(s) it fully drains — keeping
        the order total unchanged; partially drained splits get no carrier when
        shipped, and pending fulfillments are otherwise (re)priced by the
        standard rate engine, which selects the lowest-cost available rate. Pass
        `cost` to set an explicit shipping cost instead (e.g. the 3PL price) —
        note this changes the order total and payment state, and is guaranteed
        to persist only with `status: 'shipped'` (pending fulfillments are
        re-priced by the rate engine).


        **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
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - stock_location_id
              properties:
                stock_location_id:
                  type: string
                  description: Stock location the fulfillment ships from
                tracking:
                  type: string
                  example: INPOST-12345
                  description: >-
                    Carrier tracking number, or a full https:// tracking link —
                    a full URL is served back as tracking_url unchanged instead
                    of being templated into the delivery method tracking URL
                delivery_method_id:
                  type: string
                  description: >-
                    Delivery method (carrier) to attach as the selected rate.
                    Defaults to the delivery method of the fully drained source
                    fulfillment(s)
                cost:
                  type: string
                  example: '7.42'
                  description: >-
                    Explicit shipping cost. Defaults to the summed cost of the
                    fully drained source fulfillment(s), which keeps the order
                    total unchanged; an explicit cost changes the order total
                    and payment state. Guaranteed to persist only with status:
                    'shipped' — pending fulfillments are re-priced by the rate
                    engine
                status:
                  type: string
                  enum:
                    - shipped
                  description: >-
                    Pass 'shipped' to register the fulfillment as already
                    shipped
                items:
                  type: array
                  description: >-
                    Line item quantities to fulfill. Omit to fulfill every
                    not-yet-shipped unit.
                  items:
                    type: object
                    required:
                      - item_id
                      - quantity
                    properties:
                      item_id:
                        type: string
                        description: Line item ID
                      quantity:
                        type: integer
                        example: 1
                metadata:
                  type: object
                  additionalProperties: true
      responses:
        '201':
          description: fulfillment created
          content:
            application/json:
              example:
                id: ful_gbHJdmfrXB
                number: H45341821349
                tracking: INPOST-12345
                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: shipped
                fulfillment_type: shipping
                fulfilled_at: '2026-07-24T18:11:18Z'
                items:
                  - item_id: li_UkLWZg9DAJ
                    variant_id: variant_UkLWZg9DAJ
                    quantity: 1
                metadata: {}
                adjustment_total: '0.0'
                pre_tax_amount: '0.0'
                created_at: '2026-07-24T18:11:18.223Z'
                updated_at: '2026-07-24T18:11:18.339Z'
                order_id: or_UkLWZg9DAJ
                stock_location_id: sloc_UkLWZg9DAJ
        '422':
          description: order not completed
          content:
            application/json:
              example:
                error:
                  code: processing_error
                  message: >-
                    Fulfillments can only be created manually on completed
                    orders
      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',
            })


            const fulfillment = await
            client.orders.fulfillments.create('or_UkLWZg9DAJ', {
              stock_location_id: 'sloc_UkLWZg9DAJ',
              tracking: 'INPOST-12345',
              delivery_method_id: 'dm_UkLWZg9DAJ',
              status: 'shipped',
              items: [{ item_id: 'li_UkLWZg9DAJ', quantity: 1 }],
            })
        - lang: bash
          label: Spree CLI
          source: >-
            spree api post /orders/{order_id}/fulfillments -d
            '{"stock_location_id":"sloc_UkLWZg9DAJ","tracking":"INPOST-12345","delivery_method_id":"dm_UkLWZg9DAJ","status":"shipped","items":[{"item_id":"li_UkLWZg9DAJ","quantity":1}]}'
components:
  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

````