Skip to main content

Introduction

Below are listed the error codes that the platform can return, either directly within Connect API error responses or set as fields in result objects for async operations (for example inside the command execution object). Listed is a reference of the different places that an error can appear, and then a table of all the errors.

Places where error codes shown

CONNECT_API

Inside API error responses (IE with http status error codes) when calling endpoints in the Connect API, returned in the response in the error field. The full schema is:
FieldTypeDescription
requestIdstringID of the request.
timestampstringAn ISO8601 formatted date and time of error.
errorstringError type (see list below).
messagestringA human-friendly short description of the error.
dataobjectOptional. Any additional data that helps the debug.
View API Reference

VIN_UPLOAD

When connecting a vehicle by uploading a VIN to the Connect API. As the VIN connection is completed async, you can see the results by calling the get upload results endpoint. Any errors are stored at the VIN level in the errors field of that response. View API Reference

COMMANDS

When commands to the device fail. As the commands are completed async, you can see the results by calling the get vehicle command execution endpoints, or by listening to the command update webhook. Any errors are stored in the command’s failedReason field. View API Reference

Table of Error Codes