Skip to main content

API Responses

Maintenance Mode​

If the API is undergoing maintenance, the API will respond with the following:

{
  "statusCode": 503,
  "message": "The API is currently under maintenance, we apologize, but check back shortly.",
  "error": "Service Unavailable"
}

Request Timeout​

If an call exceeds 60 seconds, the API will terminate the request and respond with the following response:

{
  "statusCode": 408,
  "message": "Your request is taking over 60000ms, please try again"
}

Inventory Failure​

If a call to /inventory, is unable to fetch inventory data, the following error will be given:

{
  "statusCode": 500,
  "message": "Unable to fetch inventory data. Sorry for the inconvenience, please try again."
}

Invalid Date​

If a call to any endpoint provides an invalid ISO8601 date, the API will respond with the following error:

{
  "statusCode": 400,
  "message": "Invalid ISO8601 date provided for snapshot date. Format: 'YYYY-MM-DD'. Example: '2022-04-20'"
}

The only valid date format the API accepts is yyyy-mm-dd. See Dates and Times

Invalid Query Parameters​

If you provide invalid input, the API will response with the following error:

{
  "statusCode": 400,
  "message": "Bad request exception"
}