Error handling

The API returns errors as part of a normal response, alongside any data that was still resolved. A request can partially succeed, so checking the HTTP status code alone is not enough to detect an error.

Errors

Each error is returned in the top-level errors array, alongside data.

message · String

A human-readable description of the error.

locations · Array

The line and column in the request where the error occurred.

path · Array

The path to the field that caused the error, for example ["vehicleList"].

extensions.exception.code · String

A machine-readable error code. Use this field to handle errors programmatically, rather than matching on message.

extensions.exception.status · Integer

The HTTP status code that corresponds to the error, for example 403.

extensions.exception.message · String

A human-readable description of the error, matching the top-level message field.

extensions.exception.response · String

The response body of the underlying exception, often the same as message.

Localization

To properly handle and localize error messages, use extensions.exception.code rather than message. For a description of what each code means, see the operation’s page in the API reference. message should only be used for developer context, not shown to end users.

Thank you for your feedback.

Was this content helpful?