{
  "name": "GATH Agent Rate API",
  "version": "1.0.0",
  "reviewed": "2026-10-29",
  "base_url": "https://api.gathlogistics.com",
  "documentation": "https://developers.gathlogistics.com/",
  "mode": "read-only",
  "authentication": {
    "type": "Bearer",
    "header": "Authorization",
    "example": "Bearer YOUR_AUTHORIZED_KEY",
    "unsupported": [
      "X-API-Key",
      "query-string key",
      "portal session cookie"
    ]
  },
  "endpoints": [
    {
      "method": "GET",
      "path": "/",
      "authentication": "none",
      "response": "metadata"
    },
    {
      "method": "GET",
      "path": "/docs",
      "authentication": "none",
      "response": "metadata"
    },
    {
      "method": "GET",
      "path": "/health",
      "authentication": "none",
      "response_keys": [
        "status",
        "timestamp"
      ]
    },
    {
      "method": "GET",
      "path": "/rates",
      "authentication": "Bearer",
      "response_keys": [
        "success",
        "query",
        "total",
        "rates"
      ]
    },
    {
      "method": "GET",
      "path": "/rates/stats",
      "authentication": "Bearer",
      "response_keys": [
        "success",
        "total_rates",
        "carriers",
        "top_origins",
        "top_destinations"
      ]
    }
  ],
  "rate_filters": {
    "origin": "case-insensitive substring on origin",
    "destination": "case-insensitive substring on destination",
    "pol": "case-insensitive substring on pol",
    "pod": "case-insensitive substring on pod",
    "carrier": "case-insensitive exact"
  },
  "filter_combination": "AND",
  "pagination": false,
  "rate_row_schema": "Stored objects; no required-field guarantee.",
  "statistics": "Unfiltered; name/count buckets; top_origins and top_destinations limited to ten.",
  "not_implemented": [
    "WordPress wp-json v1/v2 contract",
    "service listing",
    "quote creation",
    "bulk quote",
    "order creation",
    "order status update",
    "API space-inventory retrieval"
  ],
  "caveats": [
    "Anonymous 401 does not prove route existence.",
    "Generic OPTIONS advertising POST does not imply write support.",
    "Health does not establish freshness; source read failure currently returns empty rates.",
    "No universal BAF/CAF percentage or all-in price formula is supported."
  ],
  "product_policy": {
    "daily_reports": "all logged-in users",
    "portal_rates": "all users; external API still requires Bearer",
    "orders": "retired; historical records retained",
    "spot_rate_requests": "withdrawn; records retained",
    "new_energy": "withdrawn pending redesign; records retained",
    "space_inventory": "informational; no inquiry or booking action",
    "legacy_cms": "retired; not an API integration target"
  },
  "agent_policy": [
    "Use authorized documented GET only.",
    "Do not create credentials or business records.",
    "Do not publish keys, private rates or account/import metadata."
  ]
}
