GGATH Developers

Read-only endpoint contract

Service version 1.0.0; no version segment in the URL. All paths below are relative to https://api.gathlogistics.com.

Method / 方法Path / 路径Auth / 认证Response / 响应
GET/Public / 公开Metadata / 元数据
GET/docsPublic / 公开Same metadata / 同元数据
GET/healthPublic / 公开status, timestamp
GET/ratesBearersuccess, query, total, rates
GET/rates/statsBearersuccess, total_rates, carriers, top_origins, top_destinations

GET /rates filters

  • origin, destination, pol, pod: case-insensitive substring match on the field of that exact name.
  • carrier: case-insensitive exact match.
  • All supplied filters are ANDed. origin and pol (and destination and pod) are separate fields, not fallback aliases, despite the metadata wording.
  • No pagination, sort or date filtering is implemented. Repeated query names use their last value; unknown parameters are echoed in query but ignored by filtering.

Response fields

/rates: success boolean; query object of string parameters; total number of matching rows; rates array of raw stored row objects. Rows are not normalized by this API.

Observed row fields (all observed values were strings; not all fields are guaranteed on every row): 20GP, 40GP, 40HQ, 45HC, cargoType, carrier, country, currency, destination, directOrTs, freeTime, id, importedAt, importedBy, note, origin, pod, pol, price, remark, serviceMode, source, transitDays, validFrom, validTo, validity.

Prices and container amounts can be text or empty; do not coerce blanks to zero. Do not infer valid dates from free-text validity. Import metadata is not part of a stable required schema and should not be republished.

/rates/stats: success boolean, total_rates number, and arrays carriers, top_origins, top_destinations, each containing {name: string, count: number}. Arrays are descending by count; origin/destination arrays are capped at 10. Statistics are unfiltered and use origin/destination, not pol/pod.

/health: status string ok and ISO timestamp string. / and /docs: name, version, description, endpoints, authentication, query_parameters.

Method and legacy warnings

OPTIONS currently returns generic 204 for any path and advertises GET, POST, OPTIONS. This is CORS behavior, not evidence that POST or a path is implemented. No write operation is documented. Former /wp-json/gath/v1/* quote and order paths are not routes of this deployed service.