Errors
A refusal is a JSON object in the problem details format, with the content type application/problem+json:
{ "type": "https://developers.ga-oms.com/errors/not_found", "title": "Not found", "status": 404, "code": "not_found", "detail": "No such shipment.", "request_id": "req_01JCX7M4Z9Q8R6T5V3W2Y1N0AB"}| Field | Use |
|---|---|
code |
Stable. Make your program decide on this, never on the words |
detail |
A sentence for a person, saying what is wrong |
type |
The page on this site that explains the code |
request_id |
Quote it to us and we can see the exact call. It is also in the Request-Id header of every answer |
The codes
Section titled “The codes”| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request |
A parameter is missing or not valid. detail says which |
| 401 | invalid_key |
No key, or one we do not know |
| 401 | wrong_environment |
A test key on the live address, or the other way round |
| 401 | account_closed |
The account the key belongs to is closed |
| 403 | https_required |
The call was made over plain http |
| 403 | missing_scope |
The key is not allowed to do this |
| 403 | forbidden |
Not allowed for this account |
| 404 | not_found |
No such thing on your account |
| 429 | rate_limited |
More than 120 calls in a minute with one key |
| 429 | too_many_wrong_keys |
Many calls with a wrong key from your address |
| 500 | failed |
Our fault. Try again, and tell us the request_id if it repeats |
More codes can be added. Treat one you do not know by its status: 4xx means fix the call, 5xx means try again later.