The following error codes can be returned for invalid API calls. Note that errors during the user authentication process result in a redirect to www.shoeboxed.com.
| Code | Meaning |
|---|---|
| 0 | Response OK |
| 1 | Bad credentials (invalid user and/or app token) |
| 2 | Unknown API call |
| 3 | Restricted IP |
| 4 | XML validation error* |
| 5 | Internal error |
| 20 | API app is not authorized to use this call |
* Ensure that the XML request body is put in a POST parameter called “xml”.
Sample error
<?xml version="1.0" encoding="UTF-8"?> <Error code="2" description="Unknown Api Call"/>
In addition, an API method may return an error specific to it. Such methods will have possible error values listed in their documentation.
