The ShopOnTarget API provides detailed information in case of an error. Hereby, the HTTP status code provides a general error classification while the body provides an error code in addition to an error description. The possible error codes and descriptions are listed below.

 

HTTP ResponseError CodeDescriptionSince Version
404 (NOT FOUND)0The API requires a valid core.1.0
404 (NOT FOUND)1The API requires a valid user name.1.0
403 (FORBIDDEN)2No valid API hash for the core given.1.0
400 (BAD REQUEST)3No product number for product identification provided.1.0
404 (NOT FOUND)4No valid product number for product identification provided.1.0
409 (CONFLICT)5Provided product number is already in use. Provide a unique one.1.0
400 (BAD REQUEST)6Product meta information (ID, version) is stored automatically. Remove it from the request.1.0
500 (INTERNAL SERVER ERROR)7The product was not storable. Please contact the administrator.1.0
400 (BAD REQUEST)8You have entered an invalid query offset.1.0
400 (BAD REQUEST)9You have entered an invalid query length.1.0
400 (BAD REQUEST)10You have deselected term and product suggestions.1.0
400 (BAD REQUEST)11The product is not in an expected format. Please verify the provided data.1.0
400 (BAD REQUEST)12The query you have provided is not accepted. Please provide a valid query.1.0
402 (PAYMENT REQUIRED)13The number of monthly requests exceeded the payed amount of requests. Please contact the system administrator.1.0
400 (BAD REQUEST)14No Synset ID was provided.1.1
400 (BAD REQUEST)15The provided SYNSET ID is not valid.1.1
400 (BAD REQUEST)16The provided SYNSET data is not valid.1.1
500 (INTERNAL SERVER ERROR)17The provided SYNSET cannot be stored.1.1
500 (INTERNAL SERVER ERROR)18The provided SYNSET cannot be deleted.1.1
400 (BAD REQUEST)19The provided facet definition is invalid.1.1
400 (BAD REQUEST)20The provided filter definition is invalid.1.1
404 (NOT FOUND)21The provided schema ID is no valid schema ID or it is not accessible for the user.2.0
400 (BAD REQUEST)22The provided schema data is not in the expected format. Please verify the provided data.2.0
400 (BAD REQUEST)23No schema name was provided. Please provide a representing name.2.0
400 (BAD REQUEST)24No schema description was provided. Please provide a describing description.2.0
500 (INTERNAL SERVER ERROR)25The schema was not storable. Please contact the administrator.2.0
400 (BAD REQUEST)26The provided schema is a public schema. It can only be changed by the creator.2.0
400 (BAD REQUEST)27The provided schema is a public schema. It can only be deleted by the creator.2.0
400 (BAD REQUEST)28The schema cannot be deleted. It is still in use.2.0
404 (NOT FOUND)29No valid document URI provided.2.0
409 (CONFLICT)30Provided document URI is already in use. Provide a unique one.2.0
500 (INTERNAL SERVER ERROR)31The document was not storable. Please contact the administrator.2.0
400 (BAD REQUEST)32The document is not in an expected format. Please verify the provided data.2.0
400 (BAD REQUEST)33The provided field name is invalid.2.0
400 (BAD REQUEST)34The provided core user data is invalid.2.0
500 (INTERNAL SERVER ERROR)35The provided core user was not storable. Please contact the administrator.2.0
500 (INTERNAL SERVER ERROR)36The provided CoreUser(s) cannot be deleted.2.0
400 (BAD REQUEST)37The provided core data is invalid.2.0
500 (INTERNAL SERVER ERROR)38The provided core was not storable. Please contact the administrator.2.0
500 (INTERNAL SERVER ERROR)39The provided core(s) cannot be deleted.2.0
400 (BAD REQUEST)40The provided username is already in use.2.0
500 (INTERNAL SERVER ERROR)41The search failed due to an internal error. Please contact the administrator.2.0
400 (BAD REQUEST)42The provided core name is already in use by the given user.2.0
400 (BAD REQUEST)43The provided sorting definition is invalid.2.1
500 (INTERNAL SERVER ERROR)44The provided statistics data cannot be stored.2.1
400 (BAD REQUEST)45The provided statistics data is not valid.2.1
400 (BAD REQUEST)46

The provided schema field type is invalid.

2.1
400 (BAD REQUEST)47The provided group field is invalid2.1
200-The operation was successful, the body response depends on the request itself. 

Response

Example response body in JSON format:

{
  "code": 1,
  "description": "The API requires a valid user name."
}

In case there is an additional information about the error (e.g. a missing field name), there is an additional information provided:

{
  "code": 1,
  "description": "The provided product is not in the expected format",
  "additionalInformation": "'productAvailability' has to be not null"
}