GET Shipments
Gebruik dit endpoint om shipments op te halen.
Gebruikersniveau: Gevorderd
Endpoint
GET /v1/{branchId}/shipments| Eigenschap | Waarde |
|---|---|
| Method | GET |
| Scope ID | Branch UUID |
| Authenticatie | Authorization: Bearer <access_token> |
Queryparameters
| Parameter | Type | Default | Max | Beschrijving |
|---|---|---|---|---|
limit | integer | 50 | 1000 | Aantal records per pagina. |
offset | integer | 0 | - | Paginatie-offset. |
sort | string | - | Sorteerexpressie in het formaat field:asc of field:desc. | |
filter | string | - | Filterexpressie in het formaat field:operator:value. Herhaal filter om meerdere filters te combineren. |
Filteren en sorteren
Syntax
sort=field:asc
sort=field:desc
filter=field:operator:valueJe kunt filter meerdere keren in dezelfde request gebruiken.
Ondersteunde operators
| Operator | Betekenis |
|---|---|
eq | Exact gelijk aan |
ne | Niet gelijk aan |
in | Waarde zit in een lijst |
gt | Groter dan |
gte | Groter dan of gelijk aan |
lt | Kleiner dan |
lte | Kleiner dan of gelijk aan |
like | Hoofdlettergevoelige tekstmatch |
ilike | Niet-hoofdlettergevoelige tekstmatch |
isnull | Controle op nullwaarde |
Resource-regels
- Filteren en sorteren is per resource gewhitelist.
organization_idenbranch_idzijn gereserveerd voor server-side scoping en kunnen niet door clients gefilterd worden.- Tenant-scope blijft server-controlled.
- Gebruik voor deze resource een branch UUID in
{scopeId}.
Voorbeeldfilters voor shipments
?filter=status:eq:planned
?filter=shipment_number:ilike:%SHP%
?sort=shipment_number:ascVoorbeeldrequest
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..."Voorbeeldresponse voor 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"
}Velden
| Veld | Beschrijving |
|---|---|
id | UUID van de shipment. |
shipment_number | Shipmentnummer. |
account_id | UUID van het gekoppelde account. |
order_id | UUID van de gekoppelde order. |
trip_id | UUID van de gekoppelde trip. |
status | Huidige status van de shipment. |
total_weight_kg | Totaalgewicht in kilogram. |
total_volume_m3 | Totaalvolume in kubieke meter. |
Responseformaat
Succes: lijstresponse
{
"data": [],
"pagination": { "limit": 50, "offset": 0, "total": 123 },
"version": "v1"
}Foutresponse
{
"error": "insufficient_scope",
"error_description": "Token does not contain the required scope for shipments"
}Gerelateerde pagina’s
- API integratie
- API calls en voorbeelden
- Setup guide
Last updated on
