Freights API
v1Search, read, and update freights — the grouping entity that bundles multiple orders under one consignor/consignee pair.
A freight groups multiple orders that belong together commercially — same customer, consignor (sender), and consignee (receiver) — under one internalFreightNumber. Orders join a freight at import by sending internalFreightNumber + consignee + consignor.
Where this fits in your operation
- Find a shipment group: search freights by your freight number or the parties involved to see which orders travel under it (
orders[]with their IDs and serial codes). - Correct the parties: the consignee changed after booking —
PATCHthe freight’sconsigneeIdinstead of re-importing every order.
Interactive API Explorer
Loading API Documentation...
Authentication
Authorization: apikey YOUR_API_KEY_HEREBase URLs
- Production:
https://app.zenderatms.com/api/ - Staging:
https://staging.zenderatms.com/api/
Endpoints
Search freights
GET /v1/freights/search?q=FREIGHT-001&page=1&perPage=50
Filters: q (freight number search), customerName, consignorName, consigneeName. Response: freights[] plus page, perPage, total. Each Freight carries freightId, internalFreightNumber, the three party IDs and names, ordersNumber, and its orders[].
Get one freight
GET /v1/freights/{freightId}
Update a freight
PATCH /v1/freights/{freightId}
{
"internalFreightNumber": "FREIGHT-001-B",
"consigneeId": 789
}All body fields are optional (internalFreightNumber, customerId, consignorId, consigneeId) — send only what changes.
Related documentation
- Orders Import — freight fields — how orders join a freight
- Customers — resolve consignor/consignee IDs