General information

API clients informed of both the high-level error class (using the status code) and the finer-grained details of the problem (using Problem Details JSON Object).

Members of a Problem Details Object

A problem details object can have the following members:

• "type" (string) - A URI reference [RFC3986] that identifies the problem type.

• "title" (string) - A short, human-readable summary of the problem type.

• "status" (number) - The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

• "detail" (string) - A human-readable explanation specific to this occurrence of the problem.

• "errors" (dictionary(string, string[])) - Gets the validation errors.

• "instance" (string) - A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

• "extensions" (dictionary(string, object)) - Problem type definitions may extend the problem details object with additional members.

Basic Problem Details Object types

• "Product errors"
• "Shipping information has errors"
• "Payment information has errors"
• "Errors occurred during execution"
• "Payment attempt has been delayed"

Defining New Problem Types

API can define a new problem type