Update a shipment

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.update('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ', {
  tracking: '1Z999AA10123456784',
})

{
  "id": "ful_UkLWZg9DAJ",
  "number": "R1001-F1",
  "tracking": "1Z999AA10123456784",
  "tracking_url": "https://www.ups.com/track?tracknum=1Z999AA10123456784",
  "pickup_point_data": null,
  "selected_delivery_rate_id": "dr_gbHJdmfrXB",
  "unpriced": false,
  "cost": "100.00",
  "total": "100.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": [
    {
      "id": "dlv_UkLWZg9DAJ",
      "tracking_number": "1Z999AA10123456784",
      "carrier": "ups",
      "carrier_name": "UPS",
      "service": null,
      "status": "pending",
      "tracking_url": "https://www.ups.com/track?tracknum=1Z999AA10123456784",
      "estimated_delivery_at": null,
      "delivered_at": null,
      "details": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "shipping_label_id": null
    }
  ],
  "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": "100.00",
  "order_id": "or_UkLWZg9DAJ",
  "stock_location_id": "sloc_UkLWZg9DAJ",
  "documents": [],
  "labels": [],
  "provider_generates_labels": false
}

PATCH

api

admin

orders

{order_id}

fulfillments

{id}

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.update('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ', {
  tracking: '1Z999AA10123456784',
})

{
  "id": "ful_UkLWZg9DAJ",
  "number": "R1001-F1",
  "tracking": "1Z999AA10123456784",
  "tracking_url": "https://www.ups.com/track?tracknum=1Z999AA10123456784",
  "pickup_point_data": null,
  "selected_delivery_rate_id": "dr_gbHJdmfrXB",
  "unpriced": false,
  "cost": "100.00",
  "total": "100.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": [
    {
      "id": "dlv_UkLWZg9DAJ",
      "tracking_number": "1Z999AA10123456784",
      "carrier": "ups",
      "carrier_name": "UPS",
      "service": null,
      "status": "pending",
      "tracking_url": "https://www.ups.com/track?tracknum=1Z999AA10123456784",
      "estimated_delivery_at": null,
      "delivered_at": null,
      "details": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "shipping_label_id": null
    }
  ],
  "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": "100.00",
  "order_id": "or_UkLWZg9DAJ",
  "stock_location_id": "sloc_UkLWZg9DAJ",
  "documents": [],
  "labels": [],
  "provider_generates_labels": false
}

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

string

required

Fulfillment ID

Body

application/json

external_references

object

Identities the record has in external systems, keyed by system: the same { system: external_id } map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of { system, external_id } entries is accepted too.

stock_location_id

string

The location the fulfillment ships from. On update, moving it re-prices the fulfillment against that location's rates.

tracking

string

Carrier tracking number, or a full https:// tracking link, which is served back as tracking_url unchanged.

tracking_carrier

string

Which carrier the tracking number belongs to: a slug from the tracking carriers endpoint. Left blank, it is detected from the number's format where possible.

selected_delivery_rate_id

string

Response

200 - application/json

shipment updated

⌘I

API basics

Endpoints

Authorizations

Headers

Path Parameters

Body

Response