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

API
Главная / API - Прочие справочники

Прочие справочники

Обновлено 06.07.2020
233 кб
Содержание:

Общие сведения

Сервис позволяет получить данные прочих справочников, не упомянутых в других разделах.

Справочник ОПФ

Данный справочник содержит перечень видов организационно-правовых форм (ОПФ).

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/references/opf_list.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "title":"Отк",
   "name":"ОАО",
   "countryUID":"0x8f51001438c4d49511dbd774581edb7a"
}

Адрес метода: https://api.dellin.ru/v1/references/opf_list.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <title>Отк</title>
   <name>ОАО</name>
   <countryUID>0x8f51001438c4d49511dbd774581edb7a</countryUID>
</request>

Описание параметров

Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
titleНет*string

Полное название ОПФ или его часть. Минимальная длина строки - 3 символа.

Поиск осуществляется как по началу, так и по середине строки.

*Запрос может содержать только один из параметров: "title" или "name"

nameНет*string

Краткое наименование ОПФ (ООО, ОАО и т. п.).

Поиск осуществляется с начала строки, точное совпадение обязательно

*Запрос может содержать только один из параметров: "title" или "name"

countryUIDНетstringUID страны из "Справочника стран"

Ответ метода

Пример ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "uid":"0x8390b2048d37e0154b845fb22793e865",
         "name":"ОАО",
         "juridical":"true",
         "title":"Открытое Акционерное Общество",
         "innLength":10,
         "countryUID":"0x8f51001438c4d49511dbd774581edb7a"
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <uid>0x8390b2048d37e0154b845fb22793e865</uid>
      <name>ОАО</name>
      <juridical>true</juridical>
      <title>Открытое Акционерное Общество</title>
      <innLength>10</innLength>
      <countryUID>0x8f51001438c4d49511dbd774581edb7a</countryUID>
   </data>
</response>

Описание параметров

Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200"
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataarray of DataИнформация об ОПФ
data.uidstringUID ОПФ
data.namestringКраткое наименование ОПФ (ООО, ОАО и т. п.)
data.juridicalboolean

Флаг обозначающий, что ОПФ является юридическим лицом

data.titlestringПолное наименование ОПФ
data.innLengthintegerНеобходимое количество цифр в ИНН
data.countryUIDstringUID страны из "Справочника стран"

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".


Справочник статусов заказа груза

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/references/statuses.json

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v1/references/statuses.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Описание параметров

Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

Ответ метода

Пример ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "status":"processing",
         "title":"В обработке"
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <status>processing</status>
      <title>В обработке</title>
   </data>
</response>

Описание параметров

Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200"
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataarray of DataИнформация о статусе заказа
data.statusstring

Статус заказа.

Возможные значения параметра см. в таблице ниже

data.titlestring

Наименование статуса заказа на русском языке

Возможные значения параметра см. в таблице ниже

Значения параметров "response.data.status" и "response.data.title"
В нижеследующей таблице приведены значения параметра "response.data.status" и соответствующие значения параметра "response.data.title"

data.status

data.title

Примечание
draftЧерновик-
processingВ обработке-
pickupЗабор груза от адресаПередача груза на адресе отправителя
waitingОжидает сдачи на терминал-
declinedОтклонен-
receivedГруз принят к перевозке-
received_warehousingГруз принят к перевозке. Платное хранение-
inwayГруз в пути-
arrivedГруз прибыл на терминал-
warehousingГруз прибыл на терминал. Платное хранение-
arrived_to_airportГруз прибыл в аэропорт-
airport_warehousingГруз прибыл в аэропорт. Платное хранение-
deliveryДоставка груза до адресаДоставка груза до адреса получателя
accompanying_documents_returnГруз выдан. Возврат СД-
finishedЗаказ завершен-

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".


Справочник параметров для статистического отчета

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/public/report_params.json

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v1/public/report_params.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Описание параметров

Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

Ответ метода

Пример ответа

{  
   "hash":"0dd17e7c6e8e69455360f392577356ace95385b0a94f5a062ef07aeee46be4a0",
   "url":"http://api.dellin.stage/catalog/report_params.csv?sk=5iq56DseyHlaqmYO7atEpw&e=1506409060"
}
<response>
   <hash>0dd17e7c6e8e69455360f392577356ace95385b0a94f5a062ef07aeee46be4a0</hash>
   <url>http://api.dellin.stage/catalog/report_params.csv?sk=5iq56DseyHlaqmYO7atEpw&e=1506409060</url>
</response>

Описание параметров

Response
ПараметрТипОписание
hashstringХеш-код файла (MD5). Путём сравнения хеш-кодов двух файлов, полученных в разное время, можно понять, изменились данные в справочнике или нет
urlstring

Ссылка на файл с данными справочника в формате csv в кодировке utf-8 (срок действия ссылки – 10 минут).

Разделителем строк в файле является символ "\n", разделителем столбцов – символ ",", а разделителем текста – символ " " ".

Файл содержит следующие колонки:

  • name — наименование параметра (ключ; на латинице);
  • caption — название параметра (на кириллице).

Рекомендуемая частота обновления скачанного файла - раз в месяц

Прайс-лист

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/public/pricelist.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "city_from_uid":"0x834f00112fdd658311da4c6326ef0e13",
   "city_to_uid":"0x834f00112fdd658311da4c6326ef0e13"
}

Адрес метода: https://api.dellin.ru/v1/public/pricelist.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <city_from_uid>0x834f00112fdd658311da4c6326ef0e13</city_from_uid>
   <city_to_uid>0x834f00112fdd658311da4c6326ef0e13</city_to_uid>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

city_from_uid

Нет*string

UID города отправления, см "Справочник городов из прайс-листа"

Обязательно должен быть передан один из параметров: "city_to_uid" или "city_from_uid"

city_to_uid

Нет*string

UID города назначения, см. "Справочник городов из прайс-листа"

Обязательно должен быть передан один из параметров: "city_to_uid" или "city_from_uid"

Ответ метода

Пример ответа

{  
   "data":{  
      "header":"Межтерминальная доставка",
      "table":{  
         "caption":"Отправка из г. Москва (7 (495) 775-55-30)",
         "header":[  
            {  
               "name":"city_to",
               "text":"направление"
            },
            {  
               "name":"min_cost",
               "text":"мин. ст-ть"
            },
            {  
               "name":"weight_cost",
               "text":"стоимость за 1 кг. (руб)",
               "value":[  
                  "5000 - 10000",
                  "3000 - 5000",
                  "2000 - 3000",
                  "1500 - 2000",
                  "800 - 1500",
                  "300 - 800",
                  "150 - 300",
                  "0 - 150"
               ]
            },
            {  
               "name":"volume_cost",
               "text":"стоимость за 1 куб.м. (руб)",
               "value":[  
                  "25 - 45",
                  "15 - 25",
                  "10 - 15",
                  "7 - 10",
                  "4 - 7",
                  "1.3 - 4",
                  "0.6 - 1.3",
                  "0 - 0.6"
               ]
            }
         ],
         "body":[  
            {  
               "city_to":"Абакан",
               "min_cost":570,
               "weight_cost":[  
                  17.9,
                  18.7,
                  19.4,
                  20,
                  20.4,
                  22.3,
                  23,
                  23.7
               ],
               "volume_cost":[  
                  4650,
                  4860,
                  5040,
                  5200,
                  5300,
                  5800,
                  5980,
                  6160
               ]
            },
            {  
               "city_to":"Адлер",
               "min_cost":450,
               "weight_cost":[  
                  11.5,
                  12.2,
                  12.6,
                  12.8,
                  13.2,
                  14.4,
                  14.8,
                  15.3
               ],
               "volume_cost":[  
                  2990,
                  3170,
                  3280,
                  3330,
                  3430,
                  3740,
                  3850,
                  3980
               ]
            }
         ]
      }
   }
}
<response>
   <data>
      <header>Межтерминальная доставка</header>
      <table>
         <caption>Отправка из г. Москва (7 (495) 775-55-30)</caption>
         <thead>      
            <tr>
               <th rowspan="2">направление</th>
               <th rowspan="2" class="brighten">мин. ст-ть</th>
               <th colspan="8" class="brighten">стоимость за 1 кг. (руб)</th>
               <th colspan="8" class="brighten">стоимость за 1 куб.м. (руб)</th>
            </tr>
            <tr>
               <th class="nowrap">5000 - 10000</th>
               <th class="nowrap">3000 - 5000</th>
               <th class="nowrap">2000 - 3000</th>
               <th class="nowrap">1500 - 2000</th>
               <th class="nowrap">800 - 1500</th>
               <th class="nowrap">300 - 800</th>
               <th class="nowrap">150 - 300</th>
               <th class="nowrap">0 - 150</th>
               <th class="nowrap">25 - 45</th>
               <th class="nowrap">15 - 25</th>
               <th class="nowrap">10 - 15</th>
               <th class="nowrap">7 - 10</th>
               <th class="nowrap">4 - 7</th>
               <th class="nowrap">1.3 - 4</th>
               <th class="nowrap">0.6 - 1.3</th>
               <th class="nowrap">0 - 0.6</th>
            </tr>
         </thead> 
         <tbody>
            <tr class="odd">
               <td>Абакан</td>
               <td class="numeric">570</td>
               <td class="numeric">17.9</td>
               <td class="numeric">18.7</td>
               <td class="numeric">19.4</td>
               <td class="numeric">20</td>
               <td class="numeric">20.4</td>
               <td class="numeric">22.3</td>
               <td class="numeric">23</td>
               <td class="numeric">23.7</td>
               <td class="numeric">4650</td>
               <td class="numeric">4860</td>
               <td class="numeric">5040</td>
               <td class="numeric">5200</td>
               <td class="numeric">5300</td>
               <td class="numeric">5800</td>
               <td class="numeric">5980</td>
               <td class="numeric">6160</td>
            </tr>
            <tr class="odd">
               <td>Адлер</td>
               <td class="numeric">450</td>
               <td class="numeric">11.5</td>
               <td class="numeric">12.2</td>
               <td class="numeric">12.6</td>
               <td class="numeric">12.8</td>
               <td class="numeric">13.2</td>
               <td class="numeric">14.4</td>
               <td class="numeric">14.8</td>
               <td class="numeric">15.3</td>
               <td class="numeric">2990</td>
               <td class="numeric">3170</td>
               <td class="numeric">3280</td>
               <td class="numeric">3330</td>
               <td class="numeric">3430</td>
               <td class="numeric">3740</td>
               <td class="numeric">3850</td>
               <td class="numeric">3980</td>
            </tr>
         </tbody>
      </table>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание

data

objectДанные о тарифах
data.headerstringНазвание таблицы
data.tableTableТаблица с тарифами

Table
Структуры объектов в формате JSON и XML отличаются, ниже приведено описание для каждого из форматов
JSON
Table
ПараметрТипОписание

caption

string

Информация о направлении перевозки

header

array of HeaderЗаголовки столбцов таблицы

header.name

stringЗаголовок столбца (наименование параметра из блока "")
header.textstringЗаголовок столбца (текстовое представление на кириллице)

header.value

array of stringsДиапазоны значений (заголовки столбцов в рамках данного столбца)

body

array of BodyТело таблицы
city_fromstring

Город отправления

Параметр присутствует в ответе, если в запросе был переда параметр "city_to_uid", но не был передан параметр "city_from_uid"
city_tostring

Город назначения

Параметр присутствует в ответе, если в запросе был переда параметр "city_from_uid", но не был передан параметр "city_to_uid"
min_costintegerМинимальная стоимость, руб.
weight_costarray of floatСтоимость, руб./кг. Значения для соответствующих диапазонов веса из параметра "header.value" (имеющего заголовочный параметр "" со значением "weight_cost")
volume_costarray of integerСтоимость, руб./м3. Значения для соответствующих диапазонов объема из параметра "header.value" (имеющего заголовочный параметр "" со значением "volume_cost")
XML
Table
ПараметрТипОписание

caption

stringИнформация о направлении перевозки
theadarray of TableRowЗаголовки столбцов таблицы
tbodyarray of TableRowТело таблицы
TableRow
ПараметрТипОписание

tr

array of TrСодержимое строки таблицы
tr.tharray of strings

Содержимое ячейки заголовка таблицы

Параметр используется только для объекта "thead.tr"
tr.tdarray of strings

Содержимое ячейки таблицы

Параметр используется только для объекта "tbody.tr"

Обработка ошибок

Если в запросе переданы не все обязательные параметры, то будет выведено следующее сообщение об ошибке:

Пример ответа - Не переданы обязательные параметры

{  
   "errors":"Некорректный запрос"
}
<response>
   <errors>Некорректный запрос</errors>
</response>


Если в запросе обязательные параметры переданы с пустыми значениями, то будет выведено следующее сообщение об ошибке:

Пример ответа - Обязательные параметры переданы с пустым значением

{  
   "errors":{  
      "city_from_uid":"Это поле не может быть пустым."
   }
}
<response>
   <errors>
      <city_from_uid>Это поле не может быть пустым.</city_from_uid>
   </errors>
</response>

Если в запросе переданы некорректные значения параметров, то будет выведено следующее сообщение об ошибке:

Пример ответа - Переданы некорректные значения параметров

{
   "errors":{
      "city_from_uid": "Некорректный uid города",
      "city_to_uid": "Некорректный uid города"
   }
}
<response>
   <errors>
      <city_from_uid>Некорректный uid города</city_from_uid>
      <city_to_uid>Некорректный uid города</city_to_uid>
   </errors>
</response>

Документы для получения груза

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

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/public/documents_for_receive.json

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v1/public/documents_for_receive.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Описание параметров

Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

Ответ метода

Пример ответа

{
   "hash": "1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4",
   "url": "https://api.dellin.ru/catalog/documents_for_receive.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434"
}
<response>
   <hash>1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4</hash>
   <url>https://api.dellin.ru/catalog/documents_for_receive.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434</url>
</response>

Описание параметров

Response
ПараметрТипОписание
hashstringХеш-код файла (MD5). Путём сравнения хеш-кодов двух файлов, полученных в разное время, можно понять, изменились данные в справочнике или нет
urlstring

Ссылка на файл с данными справочника в формате csv в кодировке utf-8 (срок действия ссылки – 10 минут).

Разделителем строк в файле является символ "\n", разделителем столбцов – символ ",", а разделителем текста – символ " " ".

Файл содержит следующие колонки:

  • UID — уникальный идентификатор документа для получения груза;
  • name — наименование документа для получения груза;
  • day_to_day — признак, определяющий возможность получения груза день-в-день по данному документу.

Рекомендуемая частота обновления скачанного файла - раз в месяц

Характер груза

Данный справочник содержит перечень видов характера груза.

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/public/freight_types.json

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v1/public/freight_types.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Описание параметров

Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

Ответ метода

Пример ответа

{
   "hash": "1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4",
   "url": "https://api.dellin.ru/catalog/freight_types.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434"
}
<response>
   <hash>1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4</hash>
   <url>https://api.dellin.ru/catalog/freight_types.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434</url>
</response>

Описание параметров

Response
ПараметрТипОписание
hashstringХеш-код файла (MD5). Путём сравнения хеш-кодов двух файлов, полученных в разное время, можно понять, изменились данные в справочнике или нет
urlstring

Ссылка на файл с данными справочника в формате csv в кодировке utf-8 (срок действия ссылки – 10 минут).

Разделителем строк в файле является символ "\n", разделителем столбцов – символ ",", а разделителем текста – символ " " ".

Файл содержит следующие колонки:

  • UID — уникальный идентификатор характера груза;
  • description — наименование характера груза.

Рекомендуемая частота обновления скачанного файла - раз в месяц

Справочник ОПФ (устаревшая версия)

Настоящий метод устарел. Вместо него рекомендуется использовать метод "Справочник ОПФ"

Данный справочник содержит перечень видов организационно-правовых форм (ОПФ).

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/public/opf_list.json

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v1/public/opf_list.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Описание параметров

Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

Ответ метода

Пример ответа

{
   "hash": "1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4",
   "url": "https://api.dellin.ru/catalog/opf_list.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434"
}
<response>
   <hash>1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4</hash>
   <url>https://api.dellin.ru/catalog/opf_list.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434</url>
</response>

Описание параметров

Response
ПараметрТипОписание
hashstringХеш-код файла (MD5). Путём сравнения хеш-кодов двух файлов, полученных в разное время, можно понять, изменились данные в справочнике или нет
urlstring

Ссылка на файл с данными справочника в формате csv в кодировке utf-8 (срок действия ссылки – 10 минут.). Разделителем строк в файле является символ "\n", разделителем столбцов – символ ",", а разделителем текста – символ " " ".

Файл содержит следующие колонки:

  • UID — уникальный идентификатор;
  • name — краткое наименование ОПФ (ООО, ОАО и т. п.);
  • juridical — признак юридического лица ("1" - да, "0" - нет);
  • fullName — полное наименование ОПФ;
  • innLength — необходимое количество цифр в ИНН;
  • countryUID — уникальный идентификатор страны.

Справочник статусов заказа груза (устаревшая версия)

Настоящий метод устарел. Вместо него рекомендуется использовать метод "Справочник статусов заказа груза"

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/public/statuses.json

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v1/public/statuses.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Описание параметров

Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

Ответ метода

Пример ответа

{  
   "hash":"db090d4a0111cc5a7a2282716218840972a65251651a4fb2dc8f6ea34e5d2fa0",
   "url":"https://api.dellin.ru/catalog/statuses.json?sk=0k92VHh-Am_cUX6qsvdEjQ&e=1496046122"
}
<response>
   <hash>db090d4a0111cc5a7a2282716218840972a65251651a4fb2dc8f6ea34e5d2fa0</hash>
   <url>https://api.dellin.ru/catalog/statuses.json?sk=0k92VHh-Am_cUX6qsvdEjQ&e=1496046122</url>
</response>

Описание параметров

Response
ПараметрТипОписание
hashstringХеш-код файла (MD5). Путём сравнения хеш-кодов двух файлов, полученных в разное время, можно понять, изменились данные в справочнике или нет
urlstring

Ссылка на файл с данными справочника в формате json