Error Handling

A JSON error object is returned by all errors produced by the API. This error contains an error code and a unique trace ID that can be used in trouble shooting the problem.

The Error object

{
  "trace_id" : "1b8dbb92-1f09-4498-8359-c64720abdb80",
  "code" : "unknown_error",
  "message" : "Failed to estimate sales"
}

All API errors contain a JSON response message with the following properties:

Key	Type	Description
trace_id	string	A unique code for tracing an error.
code	string	Error code
message	string	Error description

Integrators should include the trace_id value in any relevant support request.

Last modified: 3 months ago