API errors

The REST API reports each failed request with an HTTP status code and a JSON body that says what went wrong.

Error response format

Most endpoint errors use the RFC 7807 problem details format, usually with the application/problem+json content type.

{
  "type": "com.getredo.api:return/not-found",
  "title": "Return does not exist",
  "detail": "Return {returnId} does not exist"
}

Some errors use other shapes, listed in Other error shapes.

string

Identifier for the problem type, such as com.getredo.api:store/not-found.

string

Short, human-readable summary of the problem.

string

Explanation of this occurrence of the problem.

integer

HTTP status code of the response. Some responses include it.

Status	Meaning
`200 OK`	The request succeeded.
`201 Created`	The request created a resource.
`202 Accepted`	The request was accepted for processing.
`204 No Content`	The request succeeded and returns no body.

Status	Meaning
`400 Bad Request`	The request format or parameters are invalid.
`401 Unauthorized`	The API token is missing or invalid.
`403 Forbidden`	The token is missing a required access scope, or the action is not allowed yet, such as processing a claim that Redo is still reviewing.
`404 Not Found`	The resource does not exist, or the token cannot access it.
`409 Conflict`	The request conflicts with the current state of the resource.
`413 Content Too Large`	The request body is larger than 1 MB.
`422 Unprocessable Content`	The request is well formed but cannot be applied.
`429 Too Many Requests`	The request exceeded a rate limit. Custom event endpoints can return it when they receive more than 100 requests per second for one store.

Status	Meaning
`500 Internal Server Error`	An unexpected error occurred on the server.

These errors use bodies that differ from the format above:

Case	Status	Body
Errors from some endpoints, such as custom order, coverage, and return processing	`4xx` or `5xx`	`{ "error": "<message>" }`, sometimes with extra fields such as `details`
Missing, malformed, unknown, or revoked API token	`401`	`{ "error": "Authorization required" }`, `{ "error": "Invalid authorization: <reason>" }`, or `{ "error": "No client with bearer token" }`
Request body is not valid JSON	`400`	`{ "error": { "title": "Malformed JSON body", "data": "<details>" } }`
Request body is larger than 1 MB	`413`	`{ "error": { "title": "Request body too large", "data": "The JSON request body exceeds the 1 MB limit" } }`
Request does not match the API schema	`4xx`	`{ "type": "com.getredo.api:<code>", "detail": "<path> - <message>" }`
Unhandled server error	`500`	`{ "title": "Internal Server Error", "detail": "An unexpected error occurred", "correlationId": "<correlationId>" }`

When you contact support@getredo.com about a 500 response, send its correlationId if it has one.