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

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

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

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

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

HTTP‑статус

Текст ошибки

Пояснение

200

OK

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

400

Bad request

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

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

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

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

<errors>
  <error message="Bad request"/>
</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"/>
</errors>

403

Forbidden resource

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

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

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

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

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

Rate limit exceeded

Превышено одно или несколько ограничений для запросов.

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

"errors": 
[   
  {     
    "message": "Rate limit exceeded"
  }
]

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

<errors>
  <error message="Rate limit exceeded"/>
</errors>

404

{objectName} not found

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

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

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

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

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

405

 
Request method
  '{method}'
  not supported

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

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

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

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

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

422

 
Required parameter
  '{parameterName}'
  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 message="Required parameter
                 'geo_id' is missing"/>
</errors>

Parameter '{parameterName}'
  format is incorrect.
  Incorrect value '{value}'.
  Allowed values are:
  {allowedValues}

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

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

"errors":
[
  {
    "message":
      "Parameter 'fields' format
      is incorrect. Unknown value 'FOO'.
      Allowed values are: MODEL_CATEGORY,
      MODEL_DEFAULT_OFFER, MODEL_MEDIA,
      MODEL_OFFERS, MODEL_PHOTO,
      MODEL_PHOTOS, MODEL_PRICE,
      MODEL_RATING, OFFER_DELIVERY,
      OFFER_PHOTO"
  }
]

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

<errors>
  <error message="Parameter 'fields' format
                 is incorrect. Unknown
                 value 'FOO'. Allowed
                 values are: MODEL_CATEGORY,
                 MODEL_DEFAULT_OFFER,
                 MODEL_MEDIA, MODEL_OFFERS,
                 MODEL_PHOTO, MODEL_PHOTOS,
                 MODEL_PRICE, MODEL_RATING,
                 OFFER_DELIVERY,
                 OFFER_PHOTO"/>
</errors>

Parameter '{parameterName}'
  format is incorrect,
  expected {format}

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

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

"errors":
[
  {
    "message":
      "Parameter 'geo_id' format
      is incorrect, expected INTEGER
      NUMBER"
  }
]

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

<errors>
  <error message="Parameter 'geo_id' format
                 is incorrect, expected
                 INTEGER NUMBER"/>
</errors>

Value '{value}' of parameter
  '{parameterName}' 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 message="Value '1' of parameter
                 'substatus' is not
                 supported"/>
</errors>

499

Client closes the connection

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

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

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

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

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

500

Internal server error

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

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

"errors":
[
  {
    "message": "Internal server error"
  }
]

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

<errors>
  <error message="Internal server error"/>
</errors>
Предыдущая
Ограничения для запросов
Следующая
Изменения в документации