Request Status Codes
You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support). A successful request will be returned with status code 200.
Before reaching out to support with an error, please be aware that 99% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting Protocol support.
Status codes
Here is a list of the different categories of status codes returned by the zipcodestack.com API. Use these to understand if a request was successful.
- Name
200- Type
- Description
A 200 status code indicates a successful response.
- Name
403- Type
- Description
A 403 status code indicates that you are not allowed to use this endpoint, please upgrade your plan.
- Name
404- Type
- Description
A 404 status code indicates that a requested endpoint does not exist.
- Name
422- Type
- Description
A validation error has occured.
- Name
429- Type
- Description
A 429 status code indicates that you have hit your rate limit or your monthly limit. For more requests please upgrade your plan.
- Name
500- Type
- Description
A 500 status code indicates a internal server error - let us know: [email protected]
Validation Errors
- Name
Invalid country- Type
- Description
The selected country is invalid. Should be an ISO Alpha 2 Country Code (e.g., US, DE, FR).
- Name
Invalid postal code format- Type
- Description
The provided postal code format is invalid. Check that the postal code format is correct for the specified country.
- Name
Missing required parameter- Type
- Description
A required parameter is missing. Check that you've included the codes parameter in your request.