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

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

Калькулятор услуги Доставка до адреса

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

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

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

Калькулятор услуги доставка до адреса

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

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

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

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "arrivalHouse":4,
   "arrivalPoint":"7700000000000000000000000",
   "docSQLUid":"0xb4960050569468bb11e7aa87cebf3d88",
   "calculateDate":"2017-10-15",
   "arrivalPeriodVisit":{  
      "start":"09:00",
      "end":"18:00"
   },
   "arrivalServices":[  
      "0xb83b7589658a3851440a853325d1bf69"
   ],
   "arrivalFixedTimeVisit":true,
   "arrivalUnLoading":[  
      {  
         "uid":"0xa77fcf6a449164ed490133777a68bd51"
      },
      {  
         "uid":"0xadf1fc002cb8a9954298677b22dbde12",
         "value":"4"
      },
      {  
         "uid":"0x9a0d647ddb11ebbd4ddaaf3b1d9f7b74",
         "value":"58"
      }
   ],
   "promocode":"promo123",
   "requester":1
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <arrivalHouse>4</arrivalHouse>
   <arrivalPoint>7700000000000000000000000</arrivalPoint>
   <docSQLUid>0xb4960050569468bb11e7aa87cebf3d88</docSQLUid>
   <calculateDate>2017-10-15</calculateDate>
   <arrivalPeriodVisit>
      <start>09:00</start>
      <end>18:00</end>
   </arrivalPeriodVisit>
   <arrivalServices>0xb83b7589658a3851440a853325d1bf69</arrivalServices>
   <arrivalFixedTimeVisit>true</arrivalFixedTimeVisit>
   <arrivalUnLoading>
      <uid>0xa77fcf6a449164ed490133777a68bd51</uid>
   </arrivalUnLoading>
   <arrivalUnLoading>
      <uid>0xadf1fc002cb8a9954298677b22dbde12</uid>
      <value>4</value>
   </arrivalUnLoading>
   <arrivalUnLoading>
      <uid>0x9a0d647ddb11ebbd4ddaaf3b1d9f7b74</uid>
      <value>58</value>
   </arrivalUnLoading>
   <promocode>promo123</promocode>
   <requester>1</requester>
</request>

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

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

arrivalHouse

Нет

integer

Номер дома

arrivalPointДаstring

Код КЛАДР пункта прибытия груза. Может быть указан код КЛАДР города или улицы.

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

docSQLUidДаstringUID накладной. Для получения идентификатора накладной необходимо воспользоваться методом "Журнал заказов"

calculateDate

Нет

string

Дата прибытия груза.

Если параметр не передан, то используется текущая дата

arrivalPeriodVisitНетobjectПериод времени доставки груза
arrivalPeriodVisit.startДаstringНачало периода доставки груза
arrivalPeriodVisit.endДаstringОкончание периода доставки груза
arrivalServicesНетarray of stringUID дополнительных услуг для доставки груза до адреса. Заполняется на основании "Справочника услуг ПРР". Пользователь может одновременно заказать несколько дополнительных услуг, но не все имеющиеся доп. услуги. Стоимость доп. услуг включается в стоимости доставки от/до адреса

arrivalFixedTimeVisit

Нетboolean

Фиксированное время доставки груза.

Если передано значение "true", то значение параметра "arrivalPeriodVisit.end" игнорируется, вместо него используется значение ("arrivalPeriodVisit.start" + 30 минут).

Значение по умолчанию: "false". Параметр требует передачи в запросе arrivalPeriodVisit, иначе возникает ошибка: "Требуется передать параметр 'arrivalperiodvisit'".

arrivalUnLoading

Нет

array of Request.ArrivalUnLoading

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

promocodeНетstringПромокод

Request.ArrivalUnLoading

Параметр

R*

Тип

Описание

uid

Нет

string

Уникальные идентификаторы дополнительных параметров, необходимых для расчета погрузо-разгрузочных работ. Список параметров заполняется на основании "Справочника услуг ПРР". Если дополнительные параметры не будут переданы в запросе, погрузо-разгрузочные работы будут заказаны, но их стоимость будет рассчитана неточно

value

Нет

string

Значение доп. параметра, если оно необходимо. К примеру, доп. параметр = "этаж", значение = "4"

Ответ метода

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

{  
   "redirect":false,
   "derival":{  
      "terminal":"Москва"
   },
   "arrival":{  
      "premium":"0.00",
      "premiumDetails":[  
         {  
            "date":null,
            "announcement":false,
            "name":"Боковая загрузка (получатель)",
            "value":"1650.00",
            "public":true
         },
         {  
            "date":null,
            "announcement":false,
            "name":"Экспедирование до клиента (фиксированное время)",
            "value":"490.00",
            "public":true
         }
      ],
      "discountDetails":[  
         {  
            "name":"Боковая загрузка (получатель)",
            "value":"50",
            "date":"2016-01-01",
            "announcement":"true",
            "public":"true",
            "triggers":[
               {
                  "key":"promocode"
               }
            ]
         },
         {  
            "name":"Экспедирование до клиента (фиксированное время)",
            "value":"100",
            "date":"2016-01-01",
            "announcement":"true",
            "public":"false"
         }
      ],
      "price":"2410.00",
      "terminal":"Москва",
      "discount":"150.00"
   },
   "loadunload":{
      "arrival":"1200.00",
      "discount":"0.00",
      "premium":"0.00",
      "premiumDetails":[],
      "discountDetails":[]
   },
   "information":[
      "Срок действия промокода истек"
   ]
}
<response>
   <redirect>false</redirect>
   <derival>
      <terminal>Москва</terminal>
   </derival>
   <arrival>
      <premium>0.00</premium>
      <premiumDetails>
         <date />
         <announcement>false</announcement>
         <name>Боковая загрузка (получатель)</name>
         <value>1650.00</value>
         <public>true</public>
      </premiumDetails>
      <premiumDetails>
         <date />
         <announcement>false</announcement>
         <name>Экспедирование до клиента (фиксированное время)</name>
         <value>490.00</value>
         <public>true</public>
      </premiumDetails>
      <discountDetails>
         <name>Скидка 1</name>
         <value>50</value>
         <date>2016-01-01</date>
         <announcement>true</announcement>
         <public>true</public>
         <triggers>
            <key>promocode</key>
         </triggers>
      </discountDetails>
      <discountDetails>
         <name>Скидка 2</name>
         <value>100</value>
         <date>2016-01-01</date>
         <announcement>true</announcement>
         <public>false</public>
      </discountDetails>
      <price>2410.00</price>
      <terminal>Москва</terminal>
      <discount>0.00</discount>
   </arrival>
   <loadunload>
      <arrival>1200.00</arrival>
      <discount>0.00</discount>
      <premium>0.00</premium>
   </loadunload>
   <information>Срок действия промокода истек</information>
</response>

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

Response
ПараметрТипОписание
redirectbooleanПризнак перенаправления груза
derivalobjectДанные о терминале отправления
derival.terminalstring

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

arrivalobjectИнформация о стоимости доставки груза до адреса получателя с учетом стоимости услуг, наценок и скидок на услуги, но без учета ПРР
arrival.premiumstringСуммарный размер наценок на услуги (при наличии)
arrival.premiumDetailsarray of PremiumDetailsДетализация стоимости услуг с учетом наценок и скидок
arrival.discountDetailsarray of DiscountDetailsДетализация скидок на услуги (при наличии)
arrival.pricestringИтоговая стоимость доставки до адреса без учета ПРР
arrival.terminalstringБлижайший населённый пункт к адресу получателя, в котором имеется терминал (может совпадать со значением параметра "derival.terminal", если нет другого терминала, расположенного ближе к получателю)
arrival.discountstringСуммарный размер скидок на услуги (при наличии)
loadunloadobjectИнформация о стоимости ПРР
loadunload.arrivalstring

Стоимость ПРР.

Если ПРР выполняются бесплатно, то параметр содержит значение "0"

loadunload.discountstringСуммарный размер скидок на ПРР (при наличии)
loadunload.premiumstringСуммарный размер наценок на ПРР (при наличии)
loadunload.premiumDetailsarray of PremiumDetailsДетализация стоимости услуг ПРР с учетом наценок и скидок
loadunload.discountDetailsarray of DiscountDetailsДетализация скидок на ПРР (при наличии)
informationarray of stringsИнформационное сообщение. Отображается, например, если в запросе был передан промокод, но применить его по какой-то причине невозможно

PremiumDetails
ПараметрТипОписание
namestringНаименование типа наценки
valuestringРазмер наценки (в рублях)
datedate

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

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

announcementboolean

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

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

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

Признак публичной наценки

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

DiscountDetails
ПараметрТипОписание
namestringНаименование типа скидки
valuestringРазмер скидки (в рублях)
datedate

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

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

announcementboolean

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

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

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

Признак публичной скидки

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

triggersarray of Triggers

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

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

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

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

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

Значение параметра announcement не зависит от параметра public. Так, скидка по акции может быть как публичной, так и индивидуальной.Если требуется определить полную стоимость доставки до адреса, необходимо сложить значения параметров "Response.Arrival.Price" и "Response.Loadunload.Arrival ".Если необходимо получить только стоимость услуги по доставке до адреса (без учета прочих услуг), нужно из значения параметра "Response.Arrival.Price" вычесть стоимости услуг, перечисленных в массиве "Response.Arrival.PremiumDetails".