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

API
Главная / API - Справочники

Справочники

Обновлено 11.06.2021
Содержание:

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

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

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

Запросы всех методов имеют одинаковую структуру

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

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}
<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

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

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

Ответы методов

Запросы следующих методов имеют одинаковую структуру (в ответах методов содержатся ссылки для скачивания CSV файла):

  • Справочник видов доставки.
  • Справочник дополнительных услуг.
  • Характер груза.
  • Справочник услуг ПРР.
  • Справочник видов плательщиков.
  • Справочник видов платежа.
  • Документы для получения груза.
  • Справочник параметров для статистического отчета.

Описания ответов прочих методов приведено в соответствующих разделах

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

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

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

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

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

Вместо "[filename]" ссылка содержит наименование, совпадающее с ключевым словом в наименовании соответствующего метода. 

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

Описания содержимого файлов приведены в разделах соответствующих методов

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

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

Справочник видов доставки

Адрес метода:

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:

  • id - идентификатор вида доставки;
  • uid - UID вида доставки, используется в других методах для определения вида доставки;
  • description - наименование вида доставки.
    Возможные значения:
    • "автотранспортная перевозка";
    • "экспресс-перевозка";
    • "авиаперевозка";
    • "коммерческая почта";
    • "доставка малогабаритного груза".
Малогабаритный груз - это груз, параметры которого не превышают следующие значения:
  • масса меньше либо равна 30 кг;
  • Д*Ш*В меньше либо равны 0,54*0,39*0,39 м;
  • объём меньше либо равен 0,1 куб. м.
Заказ услуги "Доставка малогабаритного груза" возможен только в случае, если в городах отправки и получения есть подразделения компании "Деловые Линии", более подробную информацию см. на сайте компании

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

Используется при расчёте стоимости и оформлении заказа. См. методы:

Адрес метода:

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:

  • id - уникальный идентификатор услуги;
  • uid - уникальный идентификатор для связи с другими справочниками;
  • name - наименование услуги.

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

Адрес метода:

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:

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

Справочник услуг ПРР

Адрес метода:

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:

  • UID - уникальный идентификатор параметра погрузо-разгрузочных работ;
  • valueRequired - признак, определяющий необходимость указания значения для дополнительного параметра погрузо-разгрузочных работ. Возможные значения: "1" - требуется указание значения; "0" - не требуется указание значения;
  • name - Наименование дополнительного параметра погрузо-разгрузочных работ.

Справочник видов плательщиков

Адрес метода:

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:

  • id - уникальный идентификатор;
  • name - наименование типа плательщика.

Справочник видов платежа

Адрес метода:

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:

  • id - уникальный идентификатор;
  • name - наименование типа оплаты.

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

Адрес метода:

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:

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

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

Адрес метода:

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:

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

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

Адрес метода: 

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "uid":"0xb83b7589658a3851440a853325d1bf69",
         "name":"боковая погрузка",
         "title":"Боковая загрузка",
         "incompatible":[
            "0xabb9c63c596b08f94c3664c930e77778"
         ]
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <uid>0xb83b7589658a3851440a853325d1bf69</uid>
      <name>боковая погрузка</name>
      <title>Боковая загрузка</title>
      <incompatible>0xabb9c63c596b08f94c3664c930e77778</incompatible>
   </data>
</response>

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

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusinteger

Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200"

metadata.generated_atstring

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

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

dataarray of DataСведения о видах загрузки
data.uidstring

UID вида загрузки

data.namestring

Полное наименование вида загрузки.

Возможные значения:

  • "верхняя погрузка";
  • "боковая погрузка"
data.titlestring

Краткое наименование вида загрузки.

Возможные значения:

  • "Верхняя загрузка";
  • "Боковая загрузка"
data.incompatiblearray of stringsUID видов загрузки, несовместимых с видом, UID которого передан в параметре "data.uid"

Справочник специальных требований к транспорту

Адрес метода: 

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "uid":"0x92fce2284f000b0241dad7c2e88b1655",
         "name":"для погрузки необходим гидроборт",
         "title":"Гидроборт",
         "incompatible":[
            "0x88f93a2c37f106d94ff9f7ada8efe886"
         ]
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <uid>0x92fce2284f000b0241dad7c2e88b1655</uid>
      <name>для погрузки необходим гидроборт</name>
      <title>Гидроборт</title>
      <incompatible>0x88f93a2c37f106d94ff9f7ada8efe886</incompatible>
   </data>
</response>

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

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

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

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

dataarray of DataИнформация о специальном требовании к транспорту
data.uidstring

UID услуги

data.namestring

Полное наименование услуги.

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

data.titlestring

Краткое наименование услуги.

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

data.incompatiblearray of stringsUID услуг, несовместимых с видом, UID которого передан в параметре "data.uid"

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

data.name

data.title

для погрузки необходим гидробортГидроборт
для погрузки необходим манипуляторМанипулятор
для погрузки необходима открытая машинаОткрытая машина
растентовкаРастентовка

Справочник упаковок

Адрес метода: 

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "uid":"0x838FC70BAEB49B564426B45B1D216C15",
         "title":"Деревянная обрешётка",
         "name":"crate",
         "countable":"false",
         "incompatible":[
            "0x8783b183e825d40d4eb5c21ef63fbbfb",
            "0xb9f594d27a2d31b440a647d19547543c"
         ]
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <uid>0x838FC70BAEB49B564426B45B1D216C15</uid>
      <title>Деревянная обрешётка</title>
      <name>crate</name>
      <countable>false</countable>
      <incompatible>0x8783b183e825d40d4eb5c21ef63fbbfb</incompatible>
      <incompatible>0xb9f594d27a2d31b440a647d19547543c</incompatible>
   </data>
</response>

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

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

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

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

dataarray of DataИнформация о виде упаковки
data.uidstring

UID

data.titlestring

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

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

data.namestring

Условное наименование типа упаковки на английском языке.

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

data.countablebooleanФлаг, обозначающий, что можно заказать несколько единиц упаковки
data.incompatiblearray of stringsUID видов упаковки, несовместимых с видом, UID которого передан в параметре "data.uid"

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

data.title

data.name

Деревянная обрешёткаcrate
Жёсткая коробcrate_plus
Картонные коробкиbox
Дополнительная упаковкаtype
Деревянная обрешётка + амортизацияcrate_with_bubble
Спец. упаковка для автостеколprotect_auto_glass
Спец. упаковка для автозапчастейprotect_auto_part
Палетный борт + амортизацияpallet_with_bubble
Воздушно-пузырьковая плёнкаbuble
Мешокbag
Палентный бортpallet

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

Адрес метода: 

Ответ метода

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

{
   "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
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Заказ завершен-