Orders
Create Shipment
Create a shipment for a fulfillment.
POST
/
vendor
/
orders
/
{id}
/
fulfillments
/
{fulfillment_id}
/
shipments
curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/fulfillments/ful_01HXYZABCDEF/shipments' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>' \
-H 'Content-Type: application/json' \
-d '{
"items": [{ "id": "ordli_01HXYZABCDEF", "quantity": 1 }],
"labels": [
{
"tracking_number": "1Z999AA10123456784",
"tracking_url": "https://track.example.com/1Z999AA10123456784",
"label_url": "https://labels.example.com/1Z999AA10123456784.pdf"
}
]
}'
const { order } =
await client.vendor.orders.$id.fulfillments.$fulfillment_id.shipments.mutate({
$id: "order_01HXYZABCDEF",
$fulfillment_id: "ful_01HXYZABCDEF",
items: [{ id: "ordli_01HXYZABCDEF", quantity: 1 }],
labels: [
{
tracking_number: "1Z999AA10123456784",
tracking_url: "https://track.example.com/1Z999AA10123456784",
label_url: "https://labels.example.com/1Z999AA10123456784.pdf",
},
],
})
{
"order": {
"id": "order_01HXYZABCDEF",
"display_id": 42,
"status": "pending",
"fulfillments": [
{
"id": "ful_01HXYZABCDEF",
"shipped_at": "2026-06-04T10:00:00.000Z",
"delivered_at": null
}
]
}
}
Marks the fulfillment as shipped with optional tracking labels and returns the updated order.
Path parameters
string
required
The order’s ID.
string
required
The fulfillment’s ID.
Query parameters
string
Comma-separated list of fields to include in the returned order, prefix with
+/- to add or remove from defaults.Body parameters
object[]
required
object[]
Response
object
curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/fulfillments/ful_01HXYZABCDEF/shipments' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>' \
-H 'Content-Type: application/json' \
-d '{
"items": [{ "id": "ordli_01HXYZABCDEF", "quantity": 1 }],
"labels": [
{
"tracking_number": "1Z999AA10123456784",
"tracking_url": "https://track.example.com/1Z999AA10123456784",
"label_url": "https://labels.example.com/1Z999AA10123456784.pdf"
}
]
}'
const { order } =
await client.vendor.orders.$id.fulfillments.$fulfillment_id.shipments.mutate({
$id: "order_01HXYZABCDEF",
$fulfillment_id: "ful_01HXYZABCDEF",
items: [{ id: "ordli_01HXYZABCDEF", quantity: 1 }],
labels: [
{
tracking_number: "1Z999AA10123456784",
tracking_url: "https://track.example.com/1Z999AA10123456784",
label_url: "https://labels.example.com/1Z999AA10123456784.pdf",
},
],
})
{
"order": {
"id": "order_01HXYZABCDEF",
"display_id": 42,
"status": "pending",
"fulfillments": [
{
"id": "ful_01HXYZABCDEF",
"shipped_at": "2026-06-04T10:00:00.000Z",
"delivered_at": null
}
]
}
}
⌘I
curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/fulfillments/ful_01HXYZABCDEF/shipments' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>' \
-H 'Content-Type: application/json' \
-d '{
"items": [{ "id": "ordli_01HXYZABCDEF", "quantity": 1 }],
"labels": [
{
"tracking_number": "1Z999AA10123456784",
"tracking_url": "https://track.example.com/1Z999AA10123456784",
"label_url": "https://labels.example.com/1Z999AA10123456784.pdf"
}
]
}'
const { order } =
await client.vendor.orders.$id.fulfillments.$fulfillment_id.shipments.mutate({
$id: "order_01HXYZABCDEF",
$fulfillment_id: "ful_01HXYZABCDEF",
items: [{ id: "ordli_01HXYZABCDEF", quantity: 1 }],
labels: [
{
tracking_number: "1Z999AA10123456784",
tracking_url: "https://track.example.com/1Z999AA10123456784",
label_url: "https://labels.example.com/1Z999AA10123456784.pdf",
},
],
})
{
"order": {
"id": "order_01HXYZABCDEF",
"display_id": 42,
"status": "pending",
"fulfillments": [
{
"id": "ful_01HXYZABCDEF",
"shipped_at": "2026-06-04T10:00:00.000Z",
"delivered_at": null
}
]
}
}