Create Tracking Order
starshipit_create_tracking_orderCreate tracking-only orders in StarShipIt for shipments dispatched outside the platform, enabling centralized tracking, notifications, and reporting for carrier-booked parcels.
Instructions
Create tracking-only orders in StarShipIt for shipments dispatched outside the platform.
When to use: Use this tool when you have shipments that were booked or dispatched through a carrier directly (not via StarShipIt) and you want to import them into StarShipIt to enable centralised tracking, notifications, and reporting. At least one of name or order_number should be provided per order entry.
Parameters:
orders(required): Array of tracking order objects to create. Each object requires:carrier(required): Carrier code for the shipment (e.g."AUSPOST","DHL","UPS").tracking_number(required): The carrier-assigned tracking number (e.g."1Z999AA10123456784").name(optional but recommended): Recipient or customer name associated with the shipment.order_number(optional but recommended): Your internal order/reference number.
Note: At least one of name or order_number must be supplied per entry to make tracking orders identifiable in the StarShipIt dashboard.
Returns: An array of created order records, each with the new StarShipIt order ID, order number, tracking number, and carrier. Individual entries that fail will include an error field.
Example success response:
{
"success": true,
"orders": [
{
"order_id": 55001,
"order_number": "ORD-9901",
"tracking_number": "1Z999AA10123456784",
"carrier": "UPS"
},
{
"order_id": 55002,
"order_number": "ORD-9902",
"tracking_number": "EJ123456789AU",
"carrier": "AUSPOST"
}
]
}Error cases: 400 if carrier or tracking_number is missing for any entry; 409 if a tracking number already exists in the platform.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| orders | Yes | Array of tracking orders to create. Each must have carrier and tracking_number; supply name or order_number for identification. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | Validation or processing errors returned by StarShipIt | |
| object | No | The response payload when StarShipIt returns a non-object value | |
| success | No | StarShipIt success flag (a boolean on most endpoints) |