Поиск по сайту

API
Главная / API - Errors of API methods

Errors of API methods

Обновлено 18.11.2019
123 кб

General information

The document describes the error format of the API methods. It also contains the list of general errors that may occur when accessing API methods.

The given format of errors is currently used only for the next methods: "/v2/request", "/v1/payments/link".

Format of errors

Format of response of API methods in case of errors

Response example

{  
   "metadata":{
      "status":400,
      "detail":"abc",
      "generated_at":"2015-06-18 12:37:28"
   },
   "errors":[
      {
         "code":281016,
         "title":"ошибка упрощённой отправки",
         "detail":"контрагент с минимальным набором данных не может быть отправителем по заказу",
         "link":"https://dev.dellin.ru/api/ordering/request/#error_281016",
         "fields":["receiver"]
      },
      {
         "code":281017,
         "title":"Недопустимое значение параметра",
         "detail":"Данный параметр может содержать только значения из списка доступных значений",
         "link":"https://dev.dellin.ru/api/ordering/request/#error_281017",
         "fields":["requester"],
         "validValues":[1, 2, 3]
      },
      {
         "code":117004,
         "title":"значение не найдено в справочнике",
         "detail":"необходимо выбрать значение из соответствующего справочника",
         "link":"https://dev.dellin.ru/calculation/pickup/#error_117004",
         "fields":["requester"],
         "badValues":["0xa77fcf6a449164ed490133777a68bd00"]
      }
   ]
}
<response>
   <metadata>
      <status>400</status>
      <detail>abc</detail>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <errors>
      <code>281016</code>
      <title>ошибка упрощённой отправки</title>
      <detail>контрагент с минимальным набором данных не может быть отправителем по заказу</detail>
      <link>https://dev.dellin.ru/api/ordering/request/#error_281016</link>
      <fields>receiver</fields>
   </errors>
   <errors>
      <code>281017</code>
      <title>Недопустимое значение параметра</title>
      <detail>Данный параметр может содержать только значения из списка доступных значений</detail>
      <link>https://dev.dellin.ru/api/ordering/request/#error_281017</link>
      <fields>requester</fields>
      <validValues>1</validValues>
      <validValues>2</validValues>
      <validValues>3</validValues>
   </errors>
   <errors>
      <code>117004</code>
      <title>значение не найдено в справочнике</title>
      <detail>необходимо выбрать значение из соответствующего справочника</detail>
      <link>https://dev.dellin.ru/calculation/pickup/#error_117004</link>
      <fields>requester</fields>
      <badValues>0xa77fcf6a449164ed490133777a68bd00</badValues>
   </errors>
</response>

Description of parameters

Response
ParameterTypeDescription
metadataobjectOrder information
metadata.statusinteger

Emulated http-code of status

metadata.detailstring

Description of the server response

metadata.generated_atstring

Date and time of the server respone generation

errorsarray of Response.ErrorsList of errors

Response.Errors
ParameterTypeDescription
codeintegerError number
titlestring

Error title

detailstringError description
linkstringLink to the document
fieldsarray of string

List of parameters in method request that caused the error

validValuesarray of stringList of available parameter values
badValuesarray of string

List of wrong parameter values that were passed

List of general errors of API methods

Error numberhttp-codeError titleError description
TitleTranslationDescriptionTranslation
100001415Некорректный content-typeIncorrect content-typeДопустимые значения content-type: application/json (стандарт RFC4627) и text/xml (стандарт RFC3023)Valid content-type values: application/json (standard RFC4627) and text/xml (standard RFC3023)
100002404Метод не найденMethod not foundПроверьте правильность адреса методаCheck if the method address is correct
100003410Метод отключенMethod disabledЗапрошенный метод более не доступенThe requested method is no longer available
100004403Отсутствует доступ к методуNo access to methodДоступ к методу предоставляется по требованию. Для получения доступа обратитесь к персональному менеджеру или в техническую поддержкуAccess to the method is available on request. For access please contact your personal manager or technical support
100005429Количество запросов превышеноNumber of requests exceeded the limitsПревышена допустимая частота запросов. Для увеличения лимита обратитесь к персональному менеджеру или в техническую поддержкуThe allowed request rate has been exceeded. To increase the limit, contact your personal manager or technical support
100006500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
101001401Требуется авторизация

Authorization required

Не передан API-ключAPI key is not passed
101002401Требуется авторизацияAuthorization required
Передан недействительный API-ключThe passed API key is invalid
101003401Требуется авторизацияAuthorization required
Требуется передать параметр sessionIDThe "sessionID" parameter is required
101004401Требуется авторизацияAuthorization required
Время жизни сессии истеклоSession expired
101005401Требуется авторизацияAuthorization required
Сессия не найдена или создана с другим API-ключомSession not found or created with another API key
101006401Требуется авторизацияAuthorization required
Неверный логин или парольIncorrect login or password
101007401Требуется авторизацияAuthorization required
API-ключ заблокирован. Обратитесь в техническую поддержкуAPI key is blocked. Contact technical support
101008401Ошибка парсингаParsing errorЗапрос не соответствует формату jsonRequest does not match the json format
101009401Ошибка парсингаParsing errorЗапрос не соответствует формату xmlRequest does not match the xml format
110001400Неверный формат параметраInvalid parameter formatЗначение, переданное в параметре, не соответствует требуемому форматуParameter value does not match the required format
110002400Ошибка типизацииInvalid typeЗначение, переданное в параметре, имеет некорректный типParameter value has incorrect type
110003400Отсутствует обязательный параметрRequired parameter is missingОтсутствует обязательный параметрRequired parameter is missing
110004400Не передан ни один из обязательных параметровAll required parameter are missingВ запросе должен присутствовать хотя бы один параметр из совокупности, однако не указано ни одногоRequest must contain at least one of the required parameters, but contains none of them
110005400Допустима передача только одного из параметровOnly one of the parameters is allowedУказаны взаимоисключающие параметры, только один из которых может присутствовать в запросеMutually exclusive parameters are passed. Request must contain just one of them
110006400Превышено ограничение на длину спискаExceeded list length limitКоличество элементов в списке превышает максимально допустимоеNumber of items in the list exceeds the maximum allowed
110007400Объект не существуетObject does not existНе найден объект с указанным ID. Проверьте правильность переданного значенияThe object with the indicated ID is not found. Check if the passed value is correct
120001500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
120002500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
120201400Ошибка в параметрах запросаInvalid request parametersПереданы неправильные параметры в запросRequest contains invalid parameters
121001500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
121002500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
130001500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
130002400Ошибка выполнения запросаRequest completed with an errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
130003400Указан некорректный документ, удостоверяющий личностьInvalid ID valueПроверьте правильность переданных значенийVerify that the passed values are correct
130004400Не передан ни один из обязательных параметровAll required parameter are missingВ запросе должен присутствовать хотя бы один параметр из совокупности, однако не указано ни одногоRequest must contain at least one of the required parameters, but contains none of them
130005400Отсутствует обязательный параметрRequired parameter is missingОтсутствует обязательный параметрRequired parameter is missing
130006400Значение превышает допустимоеValue exceeds the allowed maximumГабариты превышают допустимые размерыThe dimensions exceed the maximum allowed sizes
130007400Неверный формат параметраInvalid parameter formatЗначение, переданное в параметре, не соответствует требуемому форматуParameter value does not match the required format
130008400Недопустимое значение параметраInvalid parameter valueПроверьте правильность переданных значенийVerify that the passed values are correct
130009400Превышено ограничение на длину значенияThe value exceeds the maximum allowed lengthПревышена максимально допустимая длина значения поляThe value exceeds the maximum allowed field length
130010400Отсутствует согласие с тарифами и правилами перевозкиThe pricing policy and the shipping rules were not acceptedДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметраThe error description contains the additional information. The text varies depending on the parameter verified
150001500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
150002500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
180001400Указан некорректный документ, удостоверяющий личностьInvalid ID valueПроверьте правильность переданных значенийVerify that the passed values are correct
180002400Указан некорректный адресInvalid addressУказан некорректный адресInvalid address
180003400Выбран недопустимый терминалWrong terminal selectedВыбран недопустимый терминалWrong terminal selected
180004400Услуга недоступнаThe service is not availableВыбранная услуга недоступна для указанных параметров перевозкиThe selected service is not available for the passed shipping parameters
180005400Значение превышает допустимоеValue exceeds the allowed maximumГабариты превышают допустимые размерыThe dimensions exceed the maximum allowed sizes
180006400Ошибка в параметрах запросаInvalid request parametersДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметраThe error description contains the additional information. The text varies depending on the parameter verified
180007400Недопустимое значение параметраInvalid parameter valueДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметраThe error description contains the additional information. The text varies depending on the parameter verified
180008400Ошибка упрощенной отправкиSimplified dispatch errorДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметраThe error description contains the additional information. The text varies depending on the parameter verified
180009400Ошибка оформления услуги Доставка в день заказаSame day delivery errorДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметраThe error description contains the additional information. The text varies depending on the parameter verified
180010400Ошибка оформления услуги Доставка в точное времяExact time delivery errorДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметраThe error description contains the additional information. The text varies depending on the parameter verified
180011400Указан некорректный период работыInvalid work hours indicatedДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметраThe error description contains the additional information. The text varies depending on the parameter verified
180012400Выбранная дата недоступнаThe selected date is not availableДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметраThe error description contains the additional information. The text varies depending on the parameter verified
180013400Ошибка параметров оплатыPayment parameters errorДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметраThe error description contains the additional information. The text varies depending on the parameter verified
180014400Ошибка наложенного платежаCash on delivery errorДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметраThe error description contains the additional information. The text varies depending on the parameter verified
180015400Ошибка оформления услугиService ordering errorДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметраThe error description contains the additional information. The text varies depending on the parameter verified
190001400Необходимо получить согласиеConfirmation requiredНеобходимо получить согласие на отправку данных о платежеPayment data transfer confirmation is required