BrainerceShipments and tracking history for an order
Returns the shipments recorded for the order with their tracking events. An unknown order returns an empty array.
AuthorizationBearer <token>
Admin API key (server-to-server). Issue via the dashboard at Settings → API keys. Plain-text key is shown once — store in a secret manager. Format: Authorization: Bearer brainerce_xxxxxxxxx.
In: header
Path Parameters
idstring
Order ID
curl -X GET "https://api.brainerce.com/api/v1/orders/string/shipments"[
{
"id": "clx1a2b3c4d5e6f7g8h9",
"carrier": "ups",
"service": "ground",
"status": "IN_TRANSIT",
"trackingNumber": "1Z999AA10123456784",
"trackingUrl": "https://carrier.example.com/track/1Z999AA10123456784",
"labelUrl": "https://labels.example.com/label-1042.pdf",
"labelFormat": "PDF",
"estimatedDeliveryDate": "2019-08-24T14:15:22Z",
"actualDeliveryDate": "2019-08-24T14:15:22Z",
"rate": "15.00",
"rateCurrency": "USD",
"createdAt": "2019-08-24T14:15:22Z",
"events": [
{
"status": "in_transit",
"statusDetail": "arrived_at_facility",
"message": "Package departed the facility",
"location": {
"city": "string",
"state": "string",
"country": "string",
"zip": "string"
},
"occurredAt": "2019-08-24T14:15:22Z"
}
]
}
]{
"statusCode": 401,
"code": "UNAUTHORIZED",
"message": "Invalid or expired credential",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/v1/orders/{id}/shipments"
}{
"statusCode": 403,
"code": "INSUFFICIENT_SCOPE",
"message": "API key does not have the required scope: products:write",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/v1/orders/{id}/shipments"
}{
"statusCode": 429,
"code": "RATE_LIMITED",
"message": "Too many requests",
"details": {
"retryAfterSeconds": 12
},
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/v1/store"
}