Create shipment
create_shipmentAdd a parcel with items, carrier, tracking, and status to an order to mark fulfillment and update delivery status.
Instructions
Add a parcel to an order: the items it carries, carrier, tracking and status. This is also how an order is marked fulfilled. The order's fulfillment and delivery status follow its parcels; a pending parcel (no label yet) fulfils nothing.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"orderId": "<orderId>"
},
"name": "create_shipment"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Saved in the parcel's status history | |
| items | No | Lines and quantities in this parcel. Omit to send every unit not yet in a shipment | |
| status | No | Defaults to label_purchased with a tracking number, else pending. Use delivered for an order handed over in person, in_transit for one sent without tracking | |
| carrier | No | ||
| orderId | Yes | ||
| labelUrl | No | http(s) link to the printable shipping label | |
| trackingUrl | No | http(s) link to track the parcel | |
| trackingNumber | No |