Skip to content

Quickstart

You need one thing to start: an API key. Your Golden Arcus contact creates it for your account and sends it to you once. It starts with ga_live_.

  1. Call the API. Put the key in the Authorization header.

    curl "https://api.ga-oms.com/v1/shipments?limit=1" \
    -H "Authorization: Bearer ga_live_YOUR_KEY"
  2. Read the answer. A list has data and has_more. Each shipment has an id, its mawb, its phase, and a checkpoints object with the time each step was reached.

    {
    "object": "list",
    "has_more": true,
    "data": [
    {
    "id": "shp_0a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    "object": "shipment",
    "mawb": "000-12345675",
    "destination": "LAX",
    "phase": "warehouse",
    "customs": "released",
    "hold": false,
    "checkpoints": {
    "arrived": {
    "reached": true,
    "time": "2026-11-11T22:05:00-08:00"
    },
    "released": {
    "reached": true,
    "time": "2026-11-12T06:30:00-08:00"
    }
    }
    }
    ]
    }

    The sample is shortened. Shipments lists every field.

  3. Load everything once. Walk the list a page at a time: pass the last id you received as after until has_more is false.

    curl https://api.ga-oms.com/v1/shipments -G \
    -d limit=100 \
    -d after=shp_0a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d \
    -H "Authorization: Bearer ga_live_YOUR_KEY"
  4. Then follow the changes. Pick one:

    • Ask us. Call GET /v1/events every minute or so with the id of the last event you processed. See Events.
    • Let us tell you. Give us an https address and we send each event there as it happens. See Webhooks.

    Both carry the same events, and each event holds the whole shipment as it stands, so you can simply save what arrives.

Every refusal says what is wrong and carries a request_id. Quote that id to us and we can see the exact call. See Errors.