Skip to content

Events

Each time something you can see on a shipment changes, we record an event. You can fetch events whenever you like, or have them sent to you (Webhooks). Both give the same events.

curl "https://api.ga-oms.com/v1/events?limit=50" \
-H "Authorization: Bearer ga_live_YOUR_KEY"

Oldest first, so you can walk forward. Parameters, both optional:

Parameter Meaning
limit How many to return, 1 to 100. Default 50
after The id of the last event you have: only the ones after it

A simple loop: remember the id of the last event you processed, call with after set to it about once a minute, and process what comes back in order. While has_more is true, call again at once.

{
"id": "evt_e3-01JCX7M4Z9Q8R6T5V3W2Y1N0AB",
"object": "event",
"type": "shipment.updated",
"created_at": "2026-11-12T22:05:11Z",
"changed": ["phase", "checkpoints.in_warehouse", "lines"],
"data": {
"object": {
"id": "shp_0a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
"object": "shipment",
"phase": "warehouse"
}
}
}
Field Meaning
id Unique. The same id is used if we send the event again
type shipment.created (a shipment is new on your account) or shipment.updated
created_at When we recorded it, UTC
changed The shipment fields that differ from the event before, each checkpoint by name
data.object The whole shipment as it stood. The sample above is shortened
  • An event is the whole shipment, not a difference. If you miss one, the next one still brings you up to date.
  • Order. Events are listed in the order we recorded them. Sent as webhooks they can arrive out of order: keep the shipment with the newest updated_at.
  • What makes an event. Only changes you can see in the shipment object. Our internal notes never make one.
  • Shipments from before your first key make no events. List your shipments once (Quickstart), then follow events from there.
  • Events are kept 90 days. If your after id is older than that, leave after out to start from the oldest one kept.
  • More types can be added. Ignore a type you do not know.