GET /track/{orderId}
Refresh and return transit status for an existing order.
Scope: shipments:track
Path parameters
| Name | Required | Description |
|---|---|---|
orderId | Yes | Order UUID from ship metadata.orderId |
Request body
None.
Preconditions
- Order exists.
order.companyIdmatches the API key organization.
The carrier track service is called and the order’s transitStatus may be updated.
Success response (200)
{
"data": {
"transitStatus": "intransit",
"updated": true
}
}
| Field | Type | Description |
|---|---|---|
transitStatus | string | Current status from carrier (e.g. pending, intransit, delivered, cancelled, unknown) |
updated | boolean | true if the order record was updated this call; false if unchanged or status is pending / unknown |
Error responses
| HTTP | Condition |
|---|---|
400 | Missing orderId |
401 | API key auth failure |
403 | Order belongs to another company |
404 | Order not found |
500 | Carrier track failure or server error |