Errors

UltraCart uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

• 2xx codes indicate success.
• 4xx codes indicate an error that failed given the information provided (e.g., a required parameter was omitted, a value is inappropriate, your requests are happening at too fast a rate, etc.).
• 5xx codes indicate an error with UltraCart's servers (these are rare).

Most API responses contain the following attributes:

Attribute	Data Type
success	boolean
error	Error

In addition to returning a non-2xx HTTP response code, the response body is a JSON object with these particular fields populated. This gives you a more granular understanding of the error that is returned.

tip

When you exceed your request quota you'll receive a 429 Too Many Requests response. See Rate Limiting for the limits and how to stay within them.