Errors

Errors

This section describes error codes used in the Propeller platform REST APIs and their meaning. For details about the API-specific error-codes, consult the documentation dedicated to that API.

Code	Error Type	Status Code	Message	Reason
10005	InvalidJSONPayload	400	Invalid JSON Payload	JSON provided in payload is not valid
10006	InvalidLookupKey	400	Invalid lookup key	Lookup key is not supported in the specific API. Check API specific lookup keys
10007	SchemaValidationException	400	Schema Validation Error	JSON schema validation. Response contains the details of the issue
10008	NotFound	404	Resource not found	Resource deleted, non-existing or insufficient permissions
10015	PaginatedResponseException	400	Pagination not properly initialized	offset or page are not initialized properly. These should be positive integers. Possible maximum limit exceeded on offset
10016	LookupKeyNotFound	400	Lookup key not found in payload	Bulk endpoints by a certain lookup key require that the lookup key is provided in the payload
10017	PayloadValidationError	400	Payload validation error	Server side validation of the payload. Response contains the details of the issue
10018	TranslationNotFound	404	Translation not found	Resource deleted, non-existing or insufficient permissions
10019	WarehouseNotFound	404	Warehouse not found	Resource deleted, non-existing or insufficient permissions
10020	WarehouseInvalidConfiguration	400	Warehouse invalid configuration	Warehouse not properly configured, e.g. not a pick up location

Error Response

When an API call results in an error, the response contains the error property which is an object with the following properties:

Property	Type	Description
code	string	Error code. Generic error codes are listed here, while API specific error codes are listed in each API
status	integer	Status code
type	string	Error type. Generic error types are listed here, while API specific error types are listed in each API
messages	array[string]	An array of error messages
moreInfo	string	URL to a page containing details about the error (under construction)

Example error response:

{
  "error": {
    "code": 80006,
    "status": 404,
    "type": "ProductNotFound",
    "messages": [
      "Product with id [481189] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/80006"
  }
}