Troubleshooting Guide

Introduction

Troubleshooting is the process of resolving issues or errors that arise during the execution of a process or operation. This page provides step-by-step troubleshooting instructions for all the errors (HTTP Status - Error Code) mentioned in the responses of Shipping APIs.

Troubleshoot an Error Message

Troubleshooting an Error Message: If your API request returns an error message, follow these steps to troubleshoot the issue:
- Check the Error Codes tables on the Errors page to find the error details, such as the error code and error description.
- Identify the specific error code and refer to the corresponding resolution provided. For more information, view Errors.
Troubleshooting HTTP 4XX Errors: If you encounter a 4XX error, follow these steps to troubleshoot the issue:
- Verify the request for any corruption or incorrect formatting.
- Correct the request according to the specific error resolution.
- Retry the request after making the necessary changes.
- To view the relevant 4XX error, please check the section Troubleshoot HTTP 4XX Error Code.
Troubleshooting HTTP 5XX Errors: If you receive a 5XX error, follow these steps to troubleshoot the issue:
- If you encounter an "Internal Server Error" (500), contact the API provider or support team for assistance.
- For a "Bad Gateway" (502) error, refresh the page or retry the request after some time as it might be temporary.
- In the case of a "Service Unavailable" (503) error, retry the request later when the server becomes available.
- If you receive a "Gateway Timeout" (504) error, refresh the page or retry the request after some time.
- Check the HTTP version being used for the request and ensure compatibility with the server if you encounter a "HTTP Version Not Supported" (505) error.
- For an "Insufficient Storage" (507) error, seek assistance from the API provider or support team to resolve the storage issue.
- To view the relevant 5XX error, please check the section Troubleshoot HTTP 5XX Error Code.
Contacting Support: If the problem persists or you are unable to resolve the issue using the provided troubleshooting steps, please contact our support team for further assistance. Provide them with relevant error details, including the error code, description, and any steps already taken to troubleshoot the problem.

Troubleshoot 4XX HTTP Error Code

Error Code	Description	Cause	Resolution
400	Bad Request	The server cannot process the request due to bad syntax	- Verify the request parameters, headers, and syntax. - Ensure the request follows the API documentation. - Validate input data and format.
401	Unauthorized	Authentication is required to access the resource	- Provide valid credentials (e.g., username and password). - Check if the authentication method is correct. - Refresh expired or invalid tokens.
403	Forbidden	Access to the resource is denied	- Ensure proper permissions and authorization to access the resource. - Contact the system administrator for access. - Check if IP whitelisting or firewall rules are blocking access.
404	Not Found	The requested resource does not exist	- Verify the URL or endpoint and ensure the resource exists. - Check for typos or outdated links. - Review routing configurations or server configurations.
405	Method Not Allowed	The HTTP method used is not allowed for the resource	- Check if the HTTP method (e.g., GET, POST) is correct for the resource. - Review server configurations and allowed methods. - Consider using a different HTTP method.
406	Not Acceptable	The server cannot respond with the requested format	- Ensure the server can provide a response in an acceptable format for the client. - Check the Accept headers in the request. - Provide alternative content types if available.
408	Request Timeout	The server timed out waiting for the request	- Check the network connection and server responsiveness. - Optimize the request or server configurations to reduce processing time. - Consider increasing the server timeout settings.
409	Conflict	The request conflicts with the current state of the server	- Resolve conflicts with the resource's state or data. - Implement optimistic concurrency control. - Retry the request after resolving conflicts.
410	Gone	The requested resource is no longer available	- Remove the resource or update the client to use an alternative resource. - Provide relevant information or suggestions for alternative resources. - Implement redirection if necessary.
429	Too Many Requests	The user has sent too many requests in a given amount of time	- Implement rate limiting or throttle the requests. - Provide informative error responses with rate limit information. - Consider using caching or optimizing the requests.

Important

In case you are unable to resolve the 4xx error, we kindly ask you to include the Transaction ID when submitting a support ticket.

The Transaction ID can be found within the Header tab. Configure environment

Troubleshoot 5XX HTTP Error Code

Error Code	Description	Cause	Resolution
500	Internal Server Error	An unexpected error occurred on the server	- Check server logs for more details about the error. - Ensure proper error handling and exception management on the server. - Fix the issue causing the internal error.
501	Not Implemented	The server does not support the functionality requested	- Verify the server capabilities and supported features. - Check if the requested functionality is implemented or available. - Consider updating the server or API implementation.
502	Bad Gateway	The server acting as a gateway received an invalid response from an upstream server	- Check the configuration of the upstream server. - Verify network connectivity and server dependencies. - Retry the request after resolving the gateway issue.
503	Service Unavailable	The server is temporarily unable to handle the request	- Check if the server is undergoing maintenance or upgrades. - Scale up server resources to handle the load. - Provide a meaningful error message with a retry-after header if possible.
504	Gateway Timeout	The server acting as a gateway did not receive a timely response from an upstream server	- Check the configuration of the upstream server. - Review server timeout settings and increase if necessary. - Optimize network connectivity and server dependencies.
505	HTTP Version Not Supported	The server does not support the HTTP protocol version used in the request	- Verify the HTTP version used in the request and server compatibility. - Consider updating server configurations or software to support the requested HTTP version. - Use a compatible HTTP version in the request.
507	Insufficient Storage	The server is unable to store the representation needed to complete the request	- Check available disk space and storage capacity on the server. - Optimize storage usage and delete unnecessary data. - Increase server storage capacity if necessary.
508	Loop Detected	The server detected an infinite loop while processing the request	- Review the request handling and processing logic. - Identify and resolve the infinite loop or circular references. - Implement appropriate loop break conditions.
509	Bandwidth Limit Exceeded	The server has exceeded its bandwidth limit	- Monitor server bandwidth usage and identify the cause of the exceeded limit. - Optimize resource usage and reduce bandwidth consumption. - Upgrade server bandwidth capacity if necessary.
510	Not Extended	Further extensions to the request are required	- Verify the server's supported extensions and request requirements. - Update the request with the required extensions. - Review server configurations and extensions for compatibility.