GET Shipments
Use this endpoint to retrieve shipments.
User level: Advanced
Endpoint
GET /v1/{branchId}/shipments| Property | Value |
|---|---|
| Method | GET |
| Scope ID | Branch UUID |
| Authentication | Authorization: Bearer <access_token> |
Query parameters
| Parameter | Type | Default | Max | Description |
|---|---|---|---|---|
limit | integer | 50 | 1000 | Number of records per page. |
offset | integer | 0 | - | Pagination offset. |
sort | string | - | Sort expression in the format field:asc or field:desc. | |
filter | string | - | Filter expression in the format field:operator:value. Repeat filter to combine multiple filters. |
Filtering and sorting
Syntax
sort=field:asc
sort=field:desc
filter=field:operator:valueYou can repeat filter in the same request.
Supported operators
| Operator | Meaning |
|---|---|
eq | Exact match |
ne | Not equal |
in | Value is part of a list |
gt | Greater than |
gte | Greater than or equal |
lt | Less than |
lte | Less than or equal |
like | Case-sensitive text match |
ilike | Case-insensitive text match |
isnull | Null check |
Resource rules
- Filtering and sorting are whitelisted per resource.
organization_idandbranch_idare reserved for server-side scoping and cannot be filtered by clients.- Tenant scope remains server-controlled.
- Use a branch UUID in
{scopeId}for this resource.
Example filters for shipments
?filter=status:eq:planned
?filter=shipment_number:ilike:%SHP%
?sort=shipment_number:ascExample request
curl -X GET "https://api.routix.com/v1/550e8400-e29b-41d4-a716-446655440000/shipments?limit=25&offset=0&sort=shipment_number:asc&filter=status:eq:planned" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."Example response for v1
{
"data": [
{
"id": "4b21ab6b-0a08-4a17-a8f2-1b7cb7b4cf0f",
"shipment_number": "SHP-2026-0042",
"account_id": "7ecf4b8d-8d1f-4a0f-8e57-6d8f14c6a221",
"order_id": "0ea1dd6b-3a97-4284-a2b1-6c0f80a9ec39",
"trip_id": "8c6f6b38-c46c-486d-9ee6-0b2ec458f3f1",
"status": "planned",
"total_weight_kg": 1240,
"total_volume_m3": 5.4
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 1
},
"version": "v1"
}Fields
| Field | Description |
|---|---|
id | Shipment UUID. |
shipment_number | Shipment number. |
account_id | UUID of the linked account. |
order_id | UUID of the linked order. |
trip_id | UUID of the linked trip. |
status | Current shipment status. |
total_weight_kg | Total weight in kilograms. |
total_volume_m3 | Total volume in cubic meters. |
Response format
Success: list response
{
"data": [],
"pagination": { "limit": 50, "offset": 0, "total": 123 },
"version": "v1"
}Error response
{
"error": "insufficient_scope",
"error_description": "Token does not contain the required scope for shipments"
}Related pages
- API integration
- API calls & examples
- Setup guide
Last updated on
