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

API
Главная / API - Калькулятор стоимости и сроков

Калькулятор стоимости и сроков перевозки

Обновлено 27.04.2024
289 кб

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

Сервис позволяет получить подробную информацию о стоимости и сроках интересующего способа перевозки.

Ниже представлено описание всех параметров метода, в соответствующем разделе можно найти примеры запросов и ответов. 

Калькулятор стоимости и сроков перевозки

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

Структура запроса 

Адрес метода: https://api.dellin.ru/v2/calculator.json 

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "delivery":{
      "deliveryType":{
         "type":"express"
      },
      "arrival":{
         "variant":"terminal",
         "terminalID":"1",
         "addressID":238577,
         "address":{
            "search":"59.924501, 30.241762",
            "street":"7800000000008850000000000",
            "house":"5",
            "building":"1",
            "structure":"лит.А",
            "flat":"214а"
         },
         "city":"7800000000000000000000000",
         "time":{
            "worktimeStart":"9:30",
            "worktimeEnd":"19:00",
            "breakStart":"12:00",
            "breakEnd":"13:00",
            "exactTime":false
         },
         "handling":{
            "freightLift":true,
            "toFloor":2,
            "carry":50
         },
         "requirements":[
            "0x9951e0ff97188f6b4b1b153dfde3cfec",
            "0x88f93a2c37f106d94ff9f7ada8efe886"
         ]
      },
      "derival":{
         "produceDate":"2019-11-08",
         "variant":"address",
         "terminalID":"1",
         "addressID":238577,
         "address":{
            "search":"Москва, Юности, 5",
            "street":"7700000000004650000000000",
            "house":"5",
            "building":"2",
            "structure":"лит.Б",
            "flat":"21"
         },
         "time":{
            "worktimeEnd":"19:30",
            "worktimeStart":"9:00",
            "breakStart":"12:00",
            "breakEnd":"13:00",
            "exactTime":false
         },
         "handling":{
            "freightLift":true,
            "toFloor":40,
            "carry":243
         },
         "requirements":[
            "0x9951e0ff97188f6b4b1b153dfde3cfec",
            "0x88f93a2c37f106d94ff9f7ada8efe886"
         ]
      },
      "packages":[
         {
            "uid":"0xa6a7bd2bf950e67f4b2cf7cc3a97c111",
            "count":1
         }
      ],
      "accompanyingDocuments":[
         {
            "action":"send"
         },
         {
            "action":"return"
         }
      ]
   },
   "members":{
      "requester":{
         "role":"sender",
         "uid":"ae62f076-d602-4341-b691-45bf8dfe4a10"
      }
   },
   "cargo":{
      "quantity":4,
      "length":1,
      "width":1,
      "height":1,
      "weight":12,
      "totalVolume":1,
      "totalWeight":12,
      "oversizedWeight":0,
      "oversizedVolume":0,
      "freightUID":"0x82e6000423b423b711da7d15445d42cb",
      "hazardClass":7.2,
      "insurance":{
         "statedValue":15477.34,
         "term":false
      }
   },
   "payment":{
      "type":"cash",
      "promocode":"promo123",
      "paymentCity":"7700000000000000000000000",
      "paymentCitySearch":{
         "search":"Москва"
      }
   } 
}

Адрес метода: https://api.dellin.ru/v2/calculator.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <delivery>
      <deliveryType>
         <type>express</type>
      </deliveryType>
      <arrival>
         <variant>terminal</variant>
         <terminalID>1</terminalID>
         <addressID>238577</addressID>
         <address>
            <search>59.924501, 30.241762</search>
            <street>7800000000008850000000000</street>
            <house>5</house>
            <building>1</building>
            <structure>лит.А</structure>
            <flat>214а</flat>
         </address>
         <city>7800000000000000000000000</city>
         <time>
            <worktimeStart>9:30</worktimeStart>
            <worktimeEnd>19:00</worktimeEnd>
            <breakStart>12:00</breakStart>
            <breakEnd>13:00</breakEnd>
            <exactTime>false</exactTime>
         </time>
         <handling>
            <freightLift>true</freightLift>
            <toFloor>2</toFloor>
            <carry>50</carry>
         </handling>
         <requirements>0x9951e0ff97188f6b4b1b153dfde3cfec</requirements>
         <requirements>0x88f93a2c37f106d94ff9f7ada8efe886</requirements>
      </arrival>
      <derival>
         <produceDate>2019-11-08</produceDate>
         <variant>address</variant>
         <terminalID>1</terminalID>
         <addressID>238577</addressID>
         <address>
            <search>Москва, Юности, 5</search>
            <street>7700000000004650000000000</street>
            <house>5</house>
            <building>2</building>
            <structure>лит.Б</structure>
            <flat>21</flat>
         </address>
         <time>
            <worktimeEnd>19:30</worktimeEnd>
            <worktimeStart>9:00</worktimeStart>
            <breakStart>12:00</breakStart>
            <breakEnd>13:00</breakEnd>
            <exactTime>false</exactTime>
         </time>
         <handling>
            <freightLift>true</freightLift>
            <toFloor>40</toFloor>
            <carry>243</carry>
         </handling>
         <requirements>0x9951e0ff97188f6b4b1b153dfde3cfec</requirements>
         <requirements>0x88f93a2c37f106d94ff9f7ada8efe886</requirements>
      </derival>
      <packages>
         <uid>0xa6a7bd2bf950e67f4b2cf7cc3a97c111</uid>
         <count>1</count>
      </packages>
      <accompanyingDocuments>
         <action>send</action>
      </accompanyingDocuments>
      <accompanyingDocuments>
         <action>return</action>
      </accompanyingDocuments>
   </delivery>
   <members>
      <requester>
         <role>sender</role>
         <uid>ae62f076-d602-4341-b691-45bf8dfe4a10</uid>
      </requester>
   </members>
   <cargo>
      <quantity>4</quantity>
      <length>1</length>
      <width>1</width>
      <height>1</height>
      <weight>12</weight>
      <totalVolume>1</totalVolume>
      <totalWeight>12</totalWeight>
      <oversizedWeight>0</oversizedWeight>
      <oversizedVolume>0</oversizedVolume>
      <freightUID>0x82e6000423b423b711da7d15445d42cb</freightUID>
      <hazardClass>7.2</hazardClass>
      <insurance>
         <statedValue>15477.34</statedValue>
         <term>false</term>
      </insurance>
   </cargo>
   <payment>
      <type>cash</type>
      <promocode>promo123</promocode>
      <paymentCity>7700000000000000000000000</paymentCity>
      <paymentCitySearch>
         <search>Москва</search>
      </paymentCitySearch>
   </payment>
</request>

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

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDНетstringID сессии, требуется для учета индивидуальных скидок. Для получения сессии необходимо воспользоваться сервисом "Авторизация пользователя"
deliveryДаobject

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

delivery.deliveryTypeДаDeliveryTypeВид межтерминальной перевозки груза для которого будет рассчитана стоимость
delivery.arrivalДаDerivalArrivalДанные по доставке груза до получателя
delivery.derivalДаDerivalArrivalДанные по доставке груза от отправителя
delivery.packagesНетarray of PackagesДанные по упаковке. При отсутствии параметра расчёт производится без учёта услуги
delivery.accompanyingDocumentsНетarray of AcDocИнформация по сопроводительным документам
membersНетobjectУчастники перевозки
members.requesterНетRequesterЗаказчик перевозки
cargoДаCargoИнформация о грузе
paymentНетPaymentОплата перевозки

DeliveryType
DeliveryType
ПараметрОбязательныйТипОписание

type

Даstring

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

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

  • "auto"- автодоставка;
  • "express" - экспресс-доставка;
  • "letter" - письмо;
  • "avia" - авиадоставка;
  • "small" - доставка малогабаритного груза.

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

DerivalArrival
DerivalArrival
ПараметрОбязательныйТипОписание
produceDateДаstring

Дата выполнения заказа.

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

Используется только для параметра "request.delivery.derival"
variantДаstring

Способ доставки груза.

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

  • "address" - доставка груза непосредственно от адреса отправителя / до адреса получателя.
    Примечание. При заказе перевозки малогабаритного груза (значение параметра запроса "delivery.deliverуType.type" - "small") доставка от/до терминала невозможна;
  • "terminal" - доставка груза от/до терминала;
  • "airport" - доставка груза до аэропорта, вариант используется, если в городе, в который необходимо доставить груз, нет терминала "Деловых Линий", в этом случае груз можно получить в грузовом терминале в аэропорту.
    Примечание
    . Вариант используется только для объекта "request.delivery.arrival" и только при заказе авиаперевозки (значение параметра запроса "delivery.deliverуType.type" - "avia"). При заказе доставки груза до аэропорта следует передать параметр "city", передача параметров "terminalID", "addressID", "address" невозможна
terminalIDНетstring

ID терминала отправки/доставки груза из "Справочника терминалов".

Заполняется при расчете стоимости предзаказа

Допускается передача только одного из следующих параметров: "terminalID", "addressID", "address", "city"
addressIDНетinteger

ID адреса отправителя/получателя из адресной книги Личного кабинета (подробнее см. сервис "Адреса").

Заполняется в случае, если клиенту необходим расчёт для адреса, сохранённого в Личном Кабинете

Допускается передача только одного из следующих параметров: "terminalID", "addressID", "address", "city"
addressНетobject

Адрес

Допускается передача только одного из следующих параметров: "terminalID", "addressID", "address", "city"

address.search

Нет*string

Адрес в виде текста или координат.

При передаче адреса в виде текста в запрос следует включать:

  • наименование региона с указанием его типа: область, край и т. п. (для корректного разбора адресов одноименных населенных пунктов),
  • наименование населённого пункта,
  • наименование улицы;
  • номер дома.

Элементы необходимо указывать через запятую, например "Омская обл., Омск, Ленина, 5".

При передаче адреса в виде координат они также указываются через запятую, первое число - широта, например "59.924501, 30.241762".

Минимальная длина поля - 2 символа, максимальная - 1024 символа.

*Передача одного из взаимоисключающих параметров "address.search" или "address.street"является обязательной
В случае возникновения ошибок разбора строки адреса рекомендуем воспользоваться методами подбора адресов
address.streetНет*string

Код КЛАДР улицы. Может быть получен с помощью сервисов, представленных на странице "Поиск КЛАДР"

*Передача одного из взаимоисключающих параметров "address.search" или "address.street"является обязательной
address.houseНетstring

Номер дома.

Максимальная длина поля - 7 символов

Параметр учитывается в случае передачи параметра "address.street"
address.buildingНетstring

Корпус.

Максимальная длина поля - 5 символов

Параметр учитывается в случае передачи параметра "address.street"
address.structureНетstring

Строение.

Максимальная длина поля - 7 символов

Параметр учитывается в случае передачи параметра "address.street"
address.flatНетstring

Квартира

Параметр не влияет на расчет стоимости перевозки
cityНетstring

Код КЛАДР города. Может быть получен с помощью сервисов, представленных на странице "Поиск КЛАДР"

Используется только для параметра "request.delivery.arrival".Передача параметра невозможна, если заказана доставка до адреса (значение параметра "variant" - "address").Допускается передача только одного из следующих параметров: "terminalID", "addressID", "address", "city"
timeНет*object

Время передачи груза отправителем/получателю на адресе.

*Параметр является обязательным, если выбрана доставка от адреса / до адреса (значение параметра "variant" - "address")

time.worktimeStartДаstring

Начало периода передачи груза.

Формат: "ЧЧ:ММ"

time.worktimeEndДаstring

Окончание периода передачи груза.

Формат: "ЧЧ:ММ"

time.breakStartНетstring

Начало перерыва.

Формат: "ЧЧ:ММ"

time.breakEndНетstring

Окончание перерыва.

Формат: "ЧЧ:ММ"

time.exactTimeНетboolean

Передача груза в точное время.

Значение по умолчанию: "false"

handlingНетobject

Погрузо-разгрузочные работы на адресе.

Необязательный параметр, при его отсутствии расчёт производится без учёта стоимости услуги

handling.freightLiftНетboolean

Есть грузовой лифт.

Значение по умолчанию: "false"

handling.toFloorНетinteger

Номер этажа, на который необходимо поднять груз

handling.carryНетinteger

Расстояние, на которое необходимо перенести груз (в метрах)

requirementsНетarray of strings

Дополнительные требования к транспорту: доступные виды загрузки машины (боковая, задняя и пр.), а также другие требования - манипулятор, растентовка и пр.

Указываются UID'ы из "Справочника специальных требований к транспорту" и "Справочника видов загрузки". Возможна передача нескольких значений

Packages
Packages
ПараметрОбязательныйТипОписание
uidДаstringВид упаковки груза, UID упаковки из "Справочника дополнительных услуг"
countНет*integer

Количество упаковок

*Если выбрана упаковка "Упаковка мешок" или "Картонная коробка", то параметр является обязательным

AcDoc
AcDoc
ПараметрОбязательныйТипОписание
actionДаstring

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

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

  • "send" - отправка;
  • "return" - возврат
Возможна передача обоих значений с использованием отдельных параметров.Возврат сопроводительных документов недоступен при отправке груза "анонимному" получателю, то есть, если значение "members.receiver.counteragent.isAnonym" - "true".  "Анонимный" получатель - получатель, о котором предоставлен минимум информации (см. описание услуги "Упрощённая отправка груза" на сайте компании "Деловые Линии")

Requester
Requester
ПараметрОбязательныйТипОписание
roleНетstring

Роль в перевозке.

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

  • "sender" - отправитель;
  • "receiver" - получатель;
  • "payer" - плательщик;
  • "third" - третье лицо
uidНетstring

UID контрагента из "Списка контрагентов".

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

Cargo
Cargo
ПараметрОбязательныйТипОписание
quantityНетinteger

Количество грузовых мест, шт. Значение по умолчанию - "1".

Если вид перевозки груза - "письмо" ("request.delivery.deliveryType.type" = "letter"), то переданное значение параметра игнорируется, используется значение "1"

lengthДа*float

Длина самого длинного грузового места, м.

*Если вид перевозки груза - "письмо"("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, используется значение "0.3"

widthДа*float

Ширина самого широкого грузового места, м.

Если вид перевозки груза- "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, используется значение "0.21"

heightДа*float

Высота самого высокого грузового места, м.

*Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, используется значение "0.01"

weightНет*float

Вес самого тяжелого грузового места, кг.

*Параметр является обязательным, если количество грузовых мест больше одного ("request.cargo.quantity" > 1). В противном случае значение параметра принимается равным значению параметра "request.cargo.totalWeight".
*Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, используется значение "0.5"

totalVolumeДа*float

Общий объём груза, м3.

*Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, используется значение "0.001"

totalWeightДа*float

Общий вес груза, кг.

*Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, используется значение "0.5"

oversizedWeightНет*float

Вес негабаритных грузовых мест, кг (1).

Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр игнорируется.

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

oversizedVolumeНет*float

Объём негабаритных грузовых мест, м3 (1).

Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр игнорируется.

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

freightUIDНетstring

UID характера груза из справочника "Характер груза". Для поиска UID по наименованию груза следует использовать сервис "Характер груза: поиск по строке (перевозка сборных грузов)". 

Если значение параметра "request.delivery.deliveryType.type" - "letter", то переданное значение игнорируется, автоматически устанавливается UID груза "Документы"

hazardClassДаfloat

Класс опасности груза.

Значение по умолчанию - "0"

insuranceНетobjectИнформация о страховке груза
insurance.statedValueДаfloat

Объявленная стоимость груза, руб.

Максимальная длина поля - 12 символов

insurance.termДаboolean

Признак страхования срока доставки груза.

Значение по умолчанию - "true"

Примечания:

1. Негабаритное грузовое место - это:

  • при авиаперевозке, если заказана жесткая упаковка (2): грузовое место, вес которого до упаковки больше 53 кг либо хотя бы одно из измерений (Д х Ш х В) которого до упаковки больше 1,2 х 0,9 х 0,65 м соответственно;
  • в остальных случаях: грузовое место, хотя бы одна из весогабаритных характеристик которого (длина, ширина, высота или вес) превышает соответствующее значение из ответа метода "Параметры негабаритного груза" с учетом вида доставки ("request.delivery.deliveryType.type"), на дату, указанную в параметре "request.delivery.derival.produceDate".

2. Заказ жесткой упаковки определяется передачей в параметре "request.delivery.packages.uid" идентификатора одного из следующих видов упаковки (см. "Справочник дополнительных услуг"):

  • "crate" - деревянная обрешётка,
  • "crate_plus" - жёсткий короб,
  • "crate_with_bubble" - деревянная обрешетка + амортизация,
  • "protect_auto_glass" - спец. упаковка для автостекол,
  • "protect_auto_part" - спец. упаковка для автозапчастей

Payment
Payment
ПараметрОбязательныйТипОписание
typeДаstring

Вид оплаты (1).

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

  • "cash" - оплата наличными или банковской картой;
  • "noncash" - оплата посредством банковского перевода
promocodeНетstringПромокод
paymentCityНет*string

Код КЛАДР населённого пункта оплаты (1). Может быть получен с помощью сервисов, представленных на странице "Поиск КЛАДР"

*Передача одного из взаимоисключающих параметров "paymentCity" или "paymentCitySearch" является обязательной
paymentCitySearchНет*string

Данные по населённому пункту оплаты в виде произвольной строки (1)

*Передача одного из взаимоисключающих параметров "paymentCity" или "paymentCitySearch" является обязательной

paymentCitySearch.search

ДаstringНаселённый пункт в виде произвольной строки. Максимум - 1024 символа. Помимо наименования населённого пункта, в строке может быть передано наименование страны, региона, района - это позволит уточнить поиск и исключить ошибки, которые могут возникнуть из-за одинаковых названий населённых пунктов

Примечания:

  1. В некоторых населённых пунктах оплата наличными / банковской картой (значение параметра "type" - "cash") невозможна, оплатить услугу в этих населённых пунктах можно только посредством банковского перевода (значение параметра "type" - "noncash"). Передав один из взаимоисключающих параметров - "paymentCity" или "paymentCitySearch", можно удостовериться, что в населённом пункте доступна выбранная форма оплаты. Кроме того, список населённых пунктов, в которых доступна только оплата посредством банковского перевода, можно найти в "Справочнике населенных пунктов с ограничениями по оплате"

Ответ метода

Структура ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2019-11-25 08:16:47"
   },
   "data":{
      "derival":{
         "terminal":"Санкт-Петербург",
         "price":475,
         "contractPrice":false,
         "servicePrice":475,
         "premiumDetails":[
            
         ],
         "terminals":[
            
         ],
         "handling":{
            "price":0,
            "contractPrice":false,
            "premium":0,
            "discount":0,
            "premiumDetails":[
               
            ],
            "discountDetails":[
               
            ]
         },
         "contractPrice":false
      },
      "intercity":{
         "price":null,
         "contractPrice":true,
         "premium":0,
         "discount":0,
         "premiumDetails":[
            
         ],
         "discountDetails":[
            
         ]
      },
      "small":{
         "price":540,
         "contractPrice":false,
         "premium":0,
         "discount":0,
         "premiumDetails":[
            
         ],
         "discountDetails":[
            
         ]
      },
      "air":{
         "price":540,
         "contractPrice":false,
         "premium":0,
         "discount":0,
         "premiumDetails":[
            
         ],
         "discountDetails":[
            
         ]
      },
      "express":{
         "price":540,
         "contractPrice":false,
         "premium":0,
         "discount":0,
         "premiumDetails":[
            
         ],
         "discountDetails":[
            
         ]
      },
      "letter":{
         "price":540,
         "contractPrice":false,
         "premium":0,
         "discount":0,
         "premiumDetails":[
            
         ],
         "discountDetails":[
            
         ]
      },
      "arrival":{
         "terminal":"Чита",
         "price":0,
         "contractPrice":false,
         "premiumDetails":[
            {
               "name":"Экспедирование до клиента график доставки",
               "value":2000,
               "date":null,
               "announcement":false,
               "public":true
            }
         ],
         "terminals":[
            {
               "id":"104",
               "name":"Чита",
               "address":"Чита, Сухая Падь ул., 3",
               "streetCode":"7500000100008350000000000",
               "price":0,
               "contractPrice":false,
               "default":true,
               "express":false,
               "isPVZ":false
            }
         ],
         "contractPrice":false
      },
      "price":1680,
      "priceMinimal":"auto",
      "packages":{
         
      },
      "orderDates":{
         "pickup":"2019-11-26",
         "senderAddressTime":null,
         "senderTerminalTime":null,
         "arrivalToOspSender":null,
         "derrivalFromOspSender":"2019-11-26",
         "arrivalToOspReceiver":null,
         "arrivalToAirport":"2019-11-28",
         "arrivalToAirportMax":"2019-11-29",
         "giveoutFromOspReceiver":"2019-11-28 00:00:00",
         "giveoutFromOspReceiverMax":"2019-11-29 00:00:00",
         "derrivalFromOspReceiver":null,
         "createTo":null,
         "derrivalToAddress":null,
         "derivalToAddressMax":null
      },
      "deliveryTerm":0,
      "accompanyingDocuments":{
         "send":{
            "price":200,
            "contractPrice":false,
            "premium":0,
            "discount":0,
            "premiumDetails":[
               
            ],
            "discountDetails":[
               
            ]
         },
         "return":{
            "price":200,
            "contractPrice":false,
            "premium":0,
            "discount":0,
            "premiumDetails":[
               
            ],
            "discountDetails":[
               
            ]
         }
      },
      "insurance":250,
      "insuranceComponents":{
         "cargoInsurance":200,
         "termInsurance":50
      },
      "notify":{
         "price":15,
         "contractPrice":false,
         "premium":0,
         "discount":0,
         "premiumDetails":[
            
         ],
         "discountDetails":[
            
         ]
      },
      "simpleShippingAvailable":true,
      "availableDeliveryTypes":{
         "auto":480.0,
         "small":549.0,
         "avia":4230.0,
         "express":620.0,
         "letter":null
      },
      "foundAddresses":[
         {
            "field":"delivery.derival.address",
            "source":"199106, Россия, Санкт-Петербург, Санкт-Петербург, Кожевенная линия, дом 40",
            "result":"199106, Россия, г Санкт-Петербург, линия Кожевенная, дом 40"
         },
         {
            "field":"delivery.arrival.address",
            "source":"Москва, Юности, 5",
            "result":"Россия, Московская обл, г Москва, ул Юности, д 5"
         },
         {
            "field":"payment.paymentCitySearch",
            "source":"Москва",
            "result":"Россия, Московская обл, г Москва"
         }
      ],
      "information":[
         "После оформления заказа наш специалист свяжется с Вами для утверждения стоимости"
      ]
   }
} 
<response>
   <metadata>
      <status>200</status>
      <generated_at>2019-11-25 08:16:47</generated_at>
   </metadata>
   <data>
      <derival>
         <terminal>Санкт-Петербург</terminal>
         <price>475</price>
         <contractPrice>false</contractPrice>
         <servicePrice>475</servicePrice>
         <handling>
            <price>0</price>
            <contractPrice>false</contractPrice>
            <premium>0</premium>
            <discount>0</discount>
         </handling>
      </derival>
      <intercity>
         <price />
         <contractPrice>true</contractPrice>
         <premium>0</premium>
         <discount>0</discount>
      </intercity>
      <small>
         <price>540</price>
         <contractPrice>false</contractPrice>
         <premium>0</premium>
         <discount>0</discount>
      </small>
      <air>
         <price>540</price>
         <contractPrice>false</contractPrice>
         <premium>0</premium>
         <discount>0</discount>
      </air>
      <express>
         <price>540</price>
         <contractPrice>false</contractPrice>
         <premium>0</premium>
         <discount>0</discount>
      </express>
      <letter>
         <price>540</price>
         <contractPrice>false</contractPrice>
         <premium>0</premium>
         <discount>0</discount>
      </letter>
      <arrival>
         <terminal>Чита</terminal>
         <price>0</price>
         <contractPrice>false</contractPrice>
         <premiumDetails>
            <name>Экспедирование до клиента график доставки</name>
            <value>2000</value>
            <date />
            <announcement>false</announcement>
            <public>true</public>
         </premiumDetails>
         <terminals>
            <id>104</id>
            <name>Чита</name>
            <address>Чита, Сухая Падь ул., 3</address>
            <streetCode>7500000100008350000000000</streetCode>
            <price>0</price>
            <contractPrice>false</contractPrice>
            <default>true</default>
            <express>false</express>
            <isPVZ>false</isPVZ>
         </terminals>
      </arrival>
      <price>1680</price>
      <priceMinimal>auto</priceMinimal>
      <packages />
      <orderDates>
         <pickup>2019-11-26</pickup>
         <senderAddressTime />
         <senderTerminalTime />
         <arrivalToOspSender />
         <derrivalFromOspSender>2019-11-26</derrivalFromOspSender>
         <arrivalToOspReceiver />
         <arrivalToAirport>2019-11-28</arrivalToAirport>
         <arrivalToAirportMax>2019-11-29</arrivalToAirportMax>
         <giveoutFromOspReceiver>2019-11-28 00:00:00</giveoutFromOspReceiver>
         <giveoutFromOspReceiverMax>2019-11-29 00:00:00</giveoutFromOspReceiverMax>
         <derrivalFromOspReceiver />
         <createTo />
         <derrivalToAddress />
         <derivalToAddressMax />
      </orderDates>
      <deliveryTerm>0</deliveryTerm>
      <accompanyingDocuments>
         <send>
            <price>200</price>
            <contractPrice>false</contractPrice>
            <premium>0</premium>
            <discount>0</discount>
         </send>
         <return>
            <price>200</price>
            <contractPrice>false</contractPrice>
            <premium>0</premium>
            <discount>0</discount>
         </return>
      </accompanyingDocuments>
      <insurance>250</insurance>
      <insuranceComponents>
         <cargoInsurance>200</cargoInsurance>
         <termInsurance>50</termInsurance>
      </insuranceComponents>
      <notify>
         <price>15</price>
         <contractPrice>false</contractPrice>
         <premium>0</premium>
         <discount>0</discount>
      </notify>
      <simpleShippingAvailable>true</simpleShippingAvailable>
      <availableDeliveryTypes>
         <auto>480</auto>
         <small>549</small>
         <avia>4230</avia>
         <express>620</express>
         <letter />
      </availableDeliveryTypes>
      <foundAddresses>
         <field>delivery.derival.address</field>
         <source>199106, Россия, Санкт-Петербург, Санкт-Петербург, Кожевенная линия, дом 40</source>
         <result>199106, Россия, г Санкт-Петербург, линия Кожевенная, дом 40</result>
      </foundAddresses>
      <foundAddresses>
         <field>delivery.arrival.address</field>
         <source>Москва, Юности, 5</source>
         <result>Россия, Московская обл, г Москва, ул Юности, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>payment.paymentCitySearch</field>
         <source>Москва</source>
         <result>Россия, Московская обл, г Москва</result>
      </foundAddresses>
      <information>После оформления заказа наш специалист свяжется с Вами для утверждения стоимости</information>
   </data>
</response>

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

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

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

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

dataobjectИнформация по стоимости и срокам перевозки груза
data.derivalDerivalArrivalДанные по доставке груза от отправителя
data.intercityCostsCalculation

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

data.smallCostsCalculation

Информация о стоимости доставки малогабаритного груза

data.airCostsCalculationИнформация о стоимости авиаперевозки
data.expressCostsCalculationИнформация о стоимости экспресс-перевозки
data.letterCostsCalculationИнформация о стоимости услуги "Письмо"
data.arrivalDerivalArrivalДанные по доставке груза до получателя
data.pricestring

Итоговая стоимость для выбранного вида перевозки

Итоговая стоимость складывается из значений следующих параметров:
  1. Cтоимость выбранного вида межтерминальной перевозки ("data.intercity.price"/"data.small.price"/"data.air.price"/"data.express.price"/"data.letter.price").
  2. "data.derival.price" - стоимость доставки от отправителя.
  3. "data.arrival.price" - стоимость доставки до получателя.
  4. "data.insurance" - стоимость страхования груза.
  5. "data.packages.price" - стоимость упаковки, в ответе может присутствовать несколько таких параметров.
  6. "data.insurance.accompanyingDocuments.send.price" - стоимость отправки сопроводительных документов.
  7. "data.insurance.accompanyingDocuments.receive.price" - стоимость возврата сопроводительных документов.
  8. "data.notify.price" - стоимость услуги "Информация о статусе заказа"
Примечание. Если стоимость одной из услуг является договорной (значение параметра - "null", а значение соответствующего параметра "contractPrice" - "true"), то итоговая стоимость рассчитывается без учёта стоимости данной услуги
data.priceMinimalstring

Способ перевозки с минимальной стоимостью. Возможные значения:

  • "auto"- автоперевозка;
  • "express" - экспресс-доставка;
  • "small" - доставка малогабаритного груза;
  • "letter" - письмо;
  • "avia" - авиадоставка
data.packagesarray of CostsCalculation
Информация о стоимости упаковки
data.orderDatesOrderDatesГрафик движения груза
data.deliveryTermintegerСрок доставки груза от терминала получения до адреса (в днях)
data.accompanyingDocumentsAcDocИнформация о стоимости отправки/возврата сопроводительных документов
data.insurancestringОбщая стоимость страхования груза
data.insuranceComponentsInsuranceComponentsОбщий список услуг по страхованию груза и их стоимость
data.notifyCostsCalculationИнформация о стоимости услуги "информация о статусе заказа"
data.simpleShippingAvailableboolean

Информация о доступности услуги "упрощённая отправка"

data.availableDeliveryTypes

AvailableDeliveryTypesСписок доступных видов перевозки и их стоимость

data.foundAddresses

array of FoundAddressesДанные по найденным адресам / населённым пунктам. Параметр присутствует в ответе, только если в запросе был передан параметр "address.search" класса "DerivalArrival" или параметр "paymetn.paymentCitySearch.search"
data.informationarray of stringsИнформационное сообщение. Отображается, например, если стоимость какой-то из услуг является договорной (в ответе есть параметр "contractPrice" со значением "true") или если в запросе был передан промокод, но применить его по какой-то причине невозможно

DerivalArrival
DerivalArrival
ПараметрТипОписание
terminalstringГород подразделения-отправителя / подразделения-получателя
pricestring

Итоговая стоимость доставки от отправителя / до получателя

Если заказана доставка от терминала / до терминала, то есть в запросе для параметра "request.delivery.derival.variant"/"request.delivery.arrival.variant" было передано значение "terminal", то итоговая стоимость отправки/получения равна стоимости въезда на терминал (см. параметры "response.derival.teminals.pirce"/response.arrival.teminals.pirce").Если заказана доставка от адреса отправителя / до адреса получателя, то есть в запросе для параметра "request.delivery.derival.variant"/"request.delivery.arrival.variant" было передано значение "address", то итоговая стоимость складывается из значений следующих параметров:
  1. "response.derival.servicePrice"/"response.arrival.servicePrice"- стоимость услуги без учёта скидок и наценок.
  2. "response.derival.handling.price"/"response.arrival.handling.price"- стоимость погрузо-разгрузочных работ.
  3. Если заказана доставка от/до адреса, то также учитывается значение параметра "response.derival.premiumDetails.value"/"response.arrival.premiumDetails.value" - размер наценки (в ответе может присутствовать несколько таких параметров)
contractPricebooleanФлаг, обозначающий, что стоимость доставки является договорной. Если стоимость договорная (значение параметра - "true"), то значение параметров "price" и "servicePrice" - "null", информация о наценках и скидках отсутствует (массивы "premiumDetails" и "discountDetails" - пустые) 
servicePricestring

Стоимость услуги доставки груза от адреса отправителя / до адреса получателя (без учёта скидок и наценок)

Параметр выводится только в том случае, если производится расчёт стоимости доставки непосредственно от/до адреса, то есть в запросе для параметра"request.delivery.derival.variant"/"request.delivery.arrival.variant" было передано значение "address"(в случае, если рассчитывается стоимость доставки от/до терминала, то есть было передано значение "terminal", параметр не выводится)
premiumDetailsarray of PricingDetailsПодробная информация о наценках по услуге
discountDetailsarray of PricingDetailsПодробная информация о скидках по услуге
terminalsarray of TerminalsИнформация о терминалах, где может быть выдан/сдан груз
handlingCostsCalculationИнформация о стоимости погрузо-разгрузочных работ

CostsCalculation
CostsCalculation
ПараметрТипОписание
pricestringСтоимость услуги
contractPricebooleanПризнак договорной цены. Если стоимость договорная (значение параметра - "true"), то значение параметра "price" - "null", информация о наценках и скидках отсутствует (значения параметров "premium" и "discount" - "0", массивы "premiumDetails" и "discountDetails" - пустые) 
premiumstringРазмер наценки по услуге
discountstring

Размер скидки по услуге

premiumDetailsarray of PricingDetailsПодробная информация о наценках по услуге
discountDetailsarray of PricingDetailsПодробная информация о скидках по услуге

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

auto

float

Стоимость автодоставки

small

float

Стоимость доставки малогабаритного груза 

avia

float

Стоимость авиадоставки 

express

float

Стоимость экспресс-доставки

letter

float

Стоимость доставки письма

Информация о стоимости услуги доступна, только если значение параметра запроса "delivery.deliveryType.type" - "letter". В остальных случаях информация недоступна, значение параметра - "null"

OrderDates
OrderDates
ПараметрТипОписание
pickupstringДата передачи груза на адресе отправителя
senderAddressTimestringВремя, до которого необходимо забрать груз на адресе отправителя
senderTerminalTimestringВремя, до которого необходимо передать груз на терминал отправителя
arrivalToOspSenderstringДата прибытия на терминал-отправитель
derivalFromOspSenderstringДата отправки с терминала-отправителя
arrivalToOspReceiverstringДата прибытия на терминал-получатель
arrivalToAirportstringДата прибытия на терминал получателя / в аэропорт
arrivalToAirportMaxstringМаксимальная дата прибытия на терминал получателя / в аэропорт (в случае, если возможно увеличение срока прибытия)
giveoutFromOspReceiverstringДата и время, с которого груз готов к выдаче на терминале
giveoutFromOspReceiverMaxstringМаксимальная дата и время, с которого груз готов к выдаче на терминале (в случае, если возможно увеличение срока готовности)
derivalFromOspReceiverstringДата отправки с терминала-получателя
createTostringВремя, до которого необходимо подать заявку на доставку от адреса
derrivalToAddressstring

Дата и время, с которого возможна доставка до клиента

Параметр присутствует в ответе только при расчёте стоимости авиа или экспресс-перевозки (значение параметра запроса "delivery.deliveryType.type"- "avia" или "express")
derivalToAddressMaxstring

Максимальная дата и время, до которого возможна доставка до клиента

Параметр присутствует в ответе только при расчёте стоимости авиа или экспресс-перевозки (значение параметра запроса "delivery.deliveryType.type"- "avia" или "express")

AcDoc
AcDoc
ПараметрТипОписание
sendCostsCalculationИнформация о стоимости отправки сопроводительных документов
returnCostsCalculationИнформация о стоимости возврата сопроводительных документов

InsuranceComponents
InsuranceComponents
ПараметрТипОписание
cargoInsurancestringОбщая стоимость услуги "Страхование груза"
termInsurancestringОбщая стоимость услуги "Страхование срока доставки груза". Если стоимость не указана, значит, услуга недоступна для этого направления или груза
contractPricebooleanПризнак договорной цены. Если стоимость договорная (значение параметра - "true"), то информация о стоимости отсутствует (значения параметров "cargoInsurance" и "termInsurance" - "0") 

PricingDetails

PricingDetails

ПараметрТипОписание
namestringНаименование типа скидки/наценки. Например, "Наценка на негабарит" или "Открытая акция"
valuestring

Размер скидки/наценки в рублях

datestring

Срок действия.

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

announcementboolean

Признак отношения к акциям.

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

  • "true" - скидка/наценка в рамках акции;
  • "false" (или отсутствие параметра в пакете) - скидка/наценка вне акции
publicboolean

Признак публичной скидки/наценки. Для авторизованного пользователя наценки могут быть как публичными, так и индивидуальными. Для неавторизованного - только публичными.

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

  • "true" - публичная скидка/наценка;
  • "false" (или отсутствие параметра в пакете) - индивидуальная скидка/наценка (доступно только для авторизованных пользователей)
triggersarray of Triggers

Массив характеристик заказа, которые инициировали применение скидки.

Параметр выводится в блоке "discountDetails", если такие характеристики есть и скидка была применена

Triggers

Triggers

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

Характеристика заказа, которая инициировала применение скидки.

Например, если скидка была применена по промокоду, то параметр содержит значение "promocode"

Terminals

Terminals

ПараметрТипОписание
idstringID терминала из "Справочника терминалов"
namestringНаименование подразделения
addressstringАдрес терминала
streetCodestringКод КЛАДР улицы, см. метод "Поиск улиц"
pricestringСтоимость въезда на территорию терминала
contractPricebooleanПризнак договорной цены. Если стоимость договорная (значение параметра - "true"), то значение параметра "price" - "null"
defaultbooleanПризнак того, что терминал является терминалом по умолчанию для выбранного города
expressbooleanПризнак того, что на терминале может быть оказана услуга "Экспресс-перевозка"
isPVZboolean

В настоящий момент параметр присутствует в ответе, но не используется

FoundAddresses
FoundAddresses
ПараметрТипОписание
fieldstringОбъект, в котором был передан параметр "search"
sourcestring

Введённое значение

resultstring

Найденный адрес / населённый пункт

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

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