Skip to main content

Error Codes

The Product Intelligence service returns one of three HTTP status codes whenever an error occurs:

Status CodeDescription
403Authentication Error
422Request Parameter Errors
400General Processing Error

In addition to these status codes, the response body will have a structure similar to the following:

{
    "success": false,
    "message": "<Explanation of the error>"
}

403 - Authentication Error​

This status code is returned when there are issues with the user account used for the request. Possible message values are:

  • "This request requires X-API-Key header."
  • "The user couldn't be authenticated."
  • "Your user account is not active. Please contact support."

422 - Request Parameter Errors​

This status code is returned when there are issues with the request parameters sent. Possible message values are:

  • "Invalid date format: <date>. Please use YYYY-MM-DD."
  • "Product data on index <index> is invalid - it needs to have at least one 'description', 'product_name' or 'product_number' value"
  • "Balance limit exceeded. Number of submitted descriptions: <product count>. Current balance: <current limit>."

400 - General Processing Error​

This status code is returned for requests with processing issues. If this error is raised, please contact the system administrator immediately.