Shipments
A shipment is one MAWB (or one part of a split MAWB) on your account, however it was booked: through the portal, by email or by our team. It is the same data your dashboard shows.
List shipments
Section titled “List shipments”curl "https://api.ga-oms.com/v1/shipments?limit=25" \ -H "Authorization: Bearer ga_live_YOUR_KEY"Newest first. Parameters, all optional:
| Parameter | Meaning |
|---|---|
limit |
How many to return, 1 to 100. Default 25 |
after |
The id of the last shipment of the page before |
mawb |
One MAWB, NNN-NNNNNNNN |
phase |
Only shipments in this phase |
updated_since |
ISO 8601 time: only shipments changed at or after it |
The answer is { "object": "list", "data": [...], "has_more": true }. While has_more is true, call again with after set to the last id.
Retrieve one shipment
Section titled “Retrieve one shipment”curl https://api.ga-oms.com/v1/shipments/shp_0a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d \ -H "Authorization: Bearer ga_live_YOUR_KEY"An id that is not one of your shipments answers not_found.
The shipment object
Section titled “The shipment object”{ "id": "shp_0a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", "object": "shipment", "mawb": "000-12345675", "part": null, "service_type": "T11", "origin": "HGH", "destination": "LAX", "flight": "CX 880", "cartons": 120, "eta": "2026-11-11T21:40:00-08:00", "ata": "2026-11-11T22:05:00-08:00", "phase": "warehouse", "customs": "released", "hold": false, "flags": [], "status_text": "Ship Out / Breakdown", "checkpoints": { "prealert": { "reached": true, "time": "2026-11-09" }, "booked": { "reached": true, "time": null }, "arrived": { "reached": true, "time": "2026-11-11T22:05:00-08:00" }, "released": { "reached": true, "time": "2026-11-12T06:30:00-08:00" }, "in_warehouse": { "reached": true, "time": "2026-11-12T10:15:00-08:00" }, "breakdown": { "reached": true, "time": "2026-11-12T12:40:00-08:00" }, "shipped": { "reached": false, "time": null } }, "lines": [ { "channel": "UPS", "cartons": 80, "status": "Ship Out", "customer_ref": null, "received_at": "2026-11-12T10:15:00-08:00", "shipped_at": "2026-11-12T13:55:00-08:00" }, { "channel": "FEDEX", "cartons": 40, "status": "Breakdown", "customer_ref": null, "received_at": "2026-11-12T10:15:00-08:00", "shipped_at": null } ], "parts": [], "cancelled": false, "updated_at": "2026-11-12T14:04:00-08:00"}| Field | Meaning |
|---|---|
id |
Ours, and stable: it stays the same if the MAWB number is corrected. Store it |
mawb |
NNN-NNNNNNNN |
part |
The letter of a split MAWB part shown on its own, otherwise null |
service_type |
T01, T11 or Ground Handling |
origin, destination |
Airports. Destination is LAX, ORD, JFK or IAH |
flight |
As booked, or null |
cartons |
Cartons on the MAWB, or null |
eta, ata |
Arrival, estimated and actual |
phase |
Where the cargo is: prealert, flight, customs, released, warehouse, shipped |
customs |
Clearance on its own: not_arrived, pending, released, hold |
hold |
true while a hold is on the shipment. Never true once it has shipped in full |
flags |
What needs attention: hold, pga, action_required (a 7501 draft waits for you on the dashboard) |
status_text |
The status as our operations team wrote it. For display, not for logic |
checkpoints |
Seven fixed steps, each with reached and its time |
lines |
One per last-mile channel, with when it came into and left our warehouse |
parts |
Empty unless the MAWB arrives on more than one flight; then one entry per flight |
cancelled |
The order was cancelled |
updated_at |
The last change on our side |
Rules worth knowing
Section titled “Rules worth knowing”- Times are ISO 8601 with an offset, in the destination airport’s local time. Where only a date is on file (the pre-alert), the value is
YYYY-MM-DD. A reached checkpoint can havetime: nullwhen no time was recorded. - Checkpoints build up. A later one reached means the earlier moves are reached too. Customs release stands apart: cargo can be released before it lands.
- Shipped means all of it.
checkpoints.shippedis reached only when every line has left. Until thenphasestayswarehouse, and each line’sshipped_atshows what went out. - New fields and new values can be added. Ignore a field you do not know, and treat an unknown
flagsvalue as nothing to act on.