Errors
ShipperGuide TMS uses standard HTTP response codes to indicate the status of API calls. Understanding these codes will allow you to efficiently manage responses in your integration.
Response Code categories
- 2xx codes: Indicate successful requests.
- 4xx codes: Indicate issues caused by the information provided in the request (e.g., missing arguments or failed operations).
- 5xx codes: Represent server-side problems (these are uncommon).
Error Handling
Some 4xx errors that can be managed programmatically (such as validation failures) and contain a specific error code in the response body. This error code provides a brief explanation of the reported issue, allowing for more precise error handling in your application.
HTTP Status Code Summary
Code | Status | Description |
---|---|---|
200 | OK | The request was successful. |
400 | Bad Request | The request couldn't be processed due to missing or invalid parameters. |
401 | Unauthorized | The API key provided is not valid. |
402 | Request Failed | The request was correct, but the server couldn't fulfill it. |
403 | Forbidden | The API key doesn't have permission to access the requested resource. |
404 | Not Found | The requested resource could not be found. |
409 | Conflict | The request could not be completed due to a conflict with the current state of the resource. |
429 | Too Many Requests | Too many requests have been made in a short period. Consider slowing down the request rate. |
500, 502, 503, 504 | Server Errors | The server encountered an error. These errors are typically rare. |