Documentation · v1
Errors
The API uses standard HTTP status codes. 2xx codes indicate success; 4xx/5xx codes indicate a problem with the request or the server.
Status codes
| Status | Meaning | Description |
|---|---|---|
| 400 | Bad Request | The request was malformed, e.g. an invalid query string or an unparsable value was supplied.(general REST convention) |
| 401 | Unauthorized | The request is missing a valid Authorization header, or the supplied API key is invalid or expired.(general REST convention) |
| 403 | Forbidden | The API key is valid but the dealer account is not entitled to access the requested resource (for example, a brand outside of dealer_allowed_brands). |
| 404 | Not Found | The requested resource does not exist, e.g. an unknown SKU was supplied to a path parameter. |
| 409 | Conflict | The request conflicts with the current state of the resource. |
| 422 | Unprocessable Entity | Request validation failed. The response body contains a `detail` array describing which field(s) failed validation and why. |
| 500 | Internal Server Error | An unexpected error occurred while processing the request. Retry later or contact support if it persists.(general REST convention) |
Validation error format (422)
When a request fails validation (for example, an out-of-range query parameter), the API responds with 422 Unprocessable Entity and a body describing every invalid field:
{
"detail": [
{
"loc": [
"query",
"pageSize"
],
"msg": "Input should be less than or equal to 1000",
"type": "less_than_equal"
}
]
}