Руководство разработчика
Ресурсы API

Сообщения об ошибках

В случае возникновения ошибки обработка запроса прекращается, сервер возвращает HTTP-статус ответа, отражающий суть произошедшей ошибки. Кроме статуса в ответе передается краткое описание ошибки.

Сообщение об ошибке возвращается в формате JSON, если в URL запроса не указан параметр format.

Описание ошибок передается в параметре errors.

Описание ошибок

HTTP-статус

Текст ошибки

Пояснение

200

OK

Запрос выполнен успешно.

400

Bad request

Запрос невалидный.

Пример сообщения для формата JSON:

"errors":
[
  {
    "message": "Bad request"
  }
]

Пример сообщения для формата XML:

<errors>
  <error message="Bad request"</error>
</errors>

401

Authorization failed: request from unknown IP address {IP-адрес} or invalid key or key suspended or key missing

Ошибка авторизации.

Возможные ошибки:

  • в запросе не указаны авторизационные данные или они невалидны;

  • IP-адрес, с которого был отправлен запрос, отсутствует в списке IP-адресов, указанных при получении авторизационного ключа.

Пример сообщения для формата JSON:

"errors":
[
  {
    "message": "Authorization failed: request from unknown IP address 0:0:0:0:0:0:0:0 or invalid key or key suspended or key missing"
  }
]

Пример сообщения для формата XML:

<errors>
 <error message="Authorization failed: request from unknown IP address 0:0:0:0:0:0:0:0 or invalid key or key suspended or key missing"</error>
</errors>

403

Forbidden resource

У вас нет доступа к этому ресурсу.

Пример сообщения для формата JSON:

"errors":
[
  {
    "message": "Forbidden resource"
  }
]

Пример сообщения для формата XML:

<errors>
  <error message="Forbidden resource"</error>
</errors>

404

{название_объекта} not found

Указанный в запросе объект не найден.

Пример сообщения для формата JSON:

"errors":
[
  {
    "message": "Offer not found"
  }
]

Пример сообщения для формата XML:

<errors>
 <error message="Offer not found"</error>
</errors>

405

Request method '{название_метода}' not supported

Используемый метод не поддерживается.

Пример сообщения для формата JSON:

"errors":
[
  {
    "message": "Request method 'DELETE' not supported"
  }
]

Пример сообщения для формата XML:

<errors>
 <error message="Request method 'DELETE' not supported"</error>
</errors>

422

Parameter '{название_параметра}' format is incorrect, expected {название_формата}

В запросе отсутствует обязательный параметр.

Пример сообщения для формата JSON:

"errors":
[
  {
    "message": "Parameter 'orderId' format is incorrect, expected number"
  }
]

Пример сообщения для формата XML:

<errors>
 <error message="Parameter 'orderId' format is incorrect, expected number"</error>
</errors>

Required parameter '{название_параметра}' is missing

Значение параметра, указанного в запросе, не соответствует формату. В тексте ошибки указывается требуемый формат параметра.

Пример сообщения для формата JSON:

"errors":
[
  {
    "message": "Required parameter 'orderId' is missing"
  },
  {
    "message": "Required parameter 'geo_id' is missing"
  }
]

Пример сообщения для формата XML:

<errors>
 <error message="Required parameter 'orderId' is missing"</error>
 <error message="Required parameter 'geo_id' is missing"</error>
</errors>

Value '{переданное_значение}' of parameter '{название_параметра}' is not supported

Переданные данные невалидны или в структуре данных содержатся ошибки либо в заголовке Content-Type указан формат JSON, но передана корректная структура данных в формате XML (или наоборот).

Пример сообщения для формата JSON:

"errors":
[
  {
    "message": "Value 'ALL' of parameter 'orderId' is not supported"
  },
  {
    "message": "Value '1' of parameter 'substatus' is not supported"
  }
]

Пример сообщения для формата XML:

<errors>
 <error message="Value 'ALL' of parameter 'orderId' is not supported"</error>
 <error message="Value '1' of parameter 'substatus' is not supported"</error>
</errors>

499

Client closes the connection

Клиент закрыл соединение, не дождавшись ответа от сервера.

Пример сообщения для формата JSON:

"errors":
[
  {
    "message": "Client closes the connection"
  }
]

Пример сообщения для формата XML:

<errors>
 <error message="Client closes the connection"</error>
</errors>

500

Internal server error

На сервере произошла ошибка.

Пример сообщения для формата JSON:

"errors":
[
  {
    "message": "Internal Server Error"
  }
 
]

Пример сообщения для формата XML:

<errors>
 <error message="Internal Server Error"</error>
</errors>
Сообщения об ошибках Коды ошибок Описания ошибок