Swagger API Личный кабинет Центр поддержки
  • Languages Русский

Расчет стоимости доставки #

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

POST /calculator

Параметры запроса #

РазделПараметрОписаниеТипОбязательныйПример
weightВес всего заказа (в граммах)числода1500
widthШирина заказа (в сантиметрах)числода25
heightВысота заказа (в сантиметрах)числода20
lengthВысота заказа (в сантиметрах)числода30
assessedCostОценочная стоимость (в рублях)числода100.6
pickupDateДата приёма груза (не обязательно, по умолчания берется текущая дата)строканет2021-01-27
pickupTypesТипы забора (см. /lists/pickupTypes), если не переданы берутся оба типамассив чиселнет1
deliveryTypesТипы доставки (см. /lists/deliveryTypes), если не переданы берутся оба типамассив чиселнет1
codCostCумма наложенного платежачислонет0
includeFeesСуммировать ли к итоговой стоимости все сборы СД (страховка и комиссия за НП)булев(логический)нетfalse
providerKeysМассив ключей служб доставки (не обязательно)массив строкнетdpd
timeoutВремя (миллисекунды) ожидания ответа от провайдера, результаты по провайдерам которые не успели в указанное время выдаваться не будут. Если не указывать будет ожидаться ответ от всех.числонет2000
extraParams
dpd.providerConnectIdID подключения провайдера, по которому нужно произвести рассчет.числонет1234
from
cityGuidID города в базе ФИАСстроканет0c5b2444-70a0-4932-980c-b4dc0d3f02b5
regionРегионстроканетМосква
cityНазвание городастроканетМосква
countryCodeКод страны в соответствии с ISO 3166-1 alpha-2строканетRU
addressStringПолный адрес отправителя для вычисления координат lat lngстроканетМосква, Хлебный пер. 19А
latШирота отправителячислонет55.755297
lngДолгота отправителячислонет37.593740
to
cityGuidID города в базе ФИАСстроканет0c5b2444-70a0-4932-980c-b4dc0d3f02b5
regionРегионстроканетМосква
cityНазвание городастроканетМосква
countryCodeКод страны в соответствии с ISO 3166-1 alpha-2строканетRU
addressStringПолный адрес получателя для вычисления координат lat lngстроканетМосква, ул. Машкова 21
latШирота получателячислонет55.764683
lngДолгота получателячислонет37.653810

Заполнение поля cityGuid обязательно, если не заполнено поле city и наоборот.

Заполнение поля addressString обязательно, если не заполнены другие обязательные поля адреса (countryCode,city,region,street).

В случае заполнения addressString - адрес будет разобран на составляющие и будут использоваться данные полученные в следствии разбора строки addressString.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

{
  "from": {
    "cityGuid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
    "region": "Москва",
    "city": "Москва",
    "countryCode": "RU",
    "addressString": "Москва, Хлебный пер. 19А",
    "lat": 55.755297,
    "lng": 37.593740
  },
  "to": {
    "cityGuid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
    "region": "Москва",
    "city": "Москва",
    "countryCode": "RU",
    "addressString": "Москва, ул. Машкова 21",
    "lat": 55.764683,
    "lng": 37.653810
  },
  "weight": 1500,
  "width": 25,
  "height": 20,
  "length": 30,
  "assessedCost": 100.6,
  "pickupDate": "2021-08-27",
  "pickupTypes": [
    1,
    2
  ],
  "deliveryTypes": [
    1,
    2
  ],
  "codCost": 0,
  "includeFees": false,
  "providerKeys": [
    "dpd",
    "cdek"
  ],
  "timeout": 2000,
  "extraParams": {
    "dpd.providerConnectId": 1234
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<request>
   <assessedCost>100.6</assessedCost>
   <codCost>0</codCost>
   <deliveryTypes>
      <element>1</element>
   </deliveryTypes>
   <extraParams>
      <dpd.providerConnectId>1234</dpd.providerConnectId>
   </extraParams>
   <from>
      <addressString>Москва, Хлебный пер. 19А</addressString>
      <city>Мосвква</city>
      <cityGuid>0c5b2444-70a0-4932-980c-b4dc0d3f02b5</cityGuid>
      <countryCode>RU</countryCode>
      <lat>55.755297</lat>
      <lng>37.593740</lng>
      <region>Москва</region>
   </from>
   <height>20</height>
   <includeFees>false</includeFees>
   <length>30</length>
   <pickupDate>2021-08-27</pickupDate>
   <pickupTypes>
      <element>2</element>
   </pickupTypes>
   <providerKeys>
      <element>[cdek]</element>
   </providerKeys>
   <timeout>2000</timeout>
   <to>
      <addressString>Москва, ул. Машкова 21</addressString>
      <city>Москва</city>
      <cityGuid>0c5b2444-70a0-4932-980c-b4dc0d3f02b5</cityGuid>
      <countryCode>RU</countryCode>
      <lat>55.764683</lat>
      <lng>37.653810</lng>
      <region>Москва</region>
   </to>
   <weight>1500</weight>
   <width>25</width>
</request>

Параметры ответа #

РазделПараметрОписаниеТипОбязательныйПример
deliveryToDoor
providerKeyНазвание СДстроканетcdek
tariffProviderIdID тарифастроканет11
tariffNameНазвание тарифастроканетЭкспресс лайт склад-дверь
pickupTypesТипы забора (см. /lists/pickupTypes), если не переданы берутся оба типа ,массив чиселнет2
deliveryTypesТипы доставки (см. /lists/deliveryTypes), если не переданы берутся оба типамассив чиселнет1
deliveryCostСтоимость доставкичислонет370
feesIncludedБыли ли включены сборы СД в общую стоимость(deliveryCost). NULL если невозможно определитьбулевнетfalse
insuranceFeeСумма страховых сборов. NULL если невозможно определитьчислонет0
cashServiceFeeСумма сборов за НП. NULL если невозможно определитьчислонет0
daysMaxМаксимальное количество дней на осуществление доставки.числонет3
daysMinМинимальное количество дней на осуществление доставки.числонет2
tariffIdID тарифачислонет19
deliveryToPoint
providerKeyНазвание СДстроканетcdek
tariffProviderIdID тарифастроканет11
tariffNameНазвание тарифастроканетЭкспресс лайт склад-склад
pickupTypesТипы забора (см. /lists/pickupTypes), если не переданы берутся оба типа ,массив чиселнет2
deliveryTypesТипы доставки (см. /lists/deliveryTypes), если не переданы берутся оба типамассив чиселнет1
deliveryCostСтоимость доставкичислонет370
feesIncludedБыли ли включены сборы СД в общую стоимость(deliveryCost). NULL если невозможно определитьбулевнетfalse
insuranceFeeСумма страховых сборов. NULL если невозможно определитьчислонет0
cashServiceFeeСумма сборов за наложенный платёж. NULL если невозможно определитьчислонет0
daysMaxМаксимальное количество дней на осуществление доставки.числонет3
daysMinМинимальное количество дней на осуществление доставки.числонет2
tariffIdID тарифачислонет19
pointIdsМассив идентификаторов доступных ПВЗ для каждого из тарифовмассив чиселнет234

Пример данных ответа #

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

{
   "deliveryToDoor": [
       {
           "providerKey": "cdek",
           "tariffs": [
               {
                   "tariffProviderId": 11,
                   "tariffId": 19,
                   "tariffName": "Экспресс лайт склад-дверь",
                   "from": "point",
                   "deliveryCost": 370,
                   "feesIncluded": false,
                   "insuranceFee": 0,
                   "cashServiceFee": 0,
                   "daysMin": 2,
                   "daysMax": 3,
                   "pickupTypes": [
                       2
                   ],
                   "deliveryTypes": [
                       1
                   ]
               },
               {
                   "tariffProviderId": 137,
                   "tariffId": 54,
                   "tariffName": "Посылка склад-дверь",
                   "from": "point",
                   "deliveryCost": 330,
                   "feesIncluded": false,
                   "insuranceFee": 0,
                   "cashServiceFee": 0,
                   "daysMin": 3,
                   "daysMax": 5,
                   "pickupTypes": [
                       2
                   ],
                   "deliveryTypes": [
                       1
                   ]
               }
           ]
       }
   ],
   "deliveryToPoint": []

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

<response>
  <deliveryToDoor>
    <providerKey>cdek</providerKey>
    <tariffs>
      <tariffProviderId>11</tariffProviderId>
      <tariffId>19</tariffId>
      <tariffName>Экспресс лайт склад-дверь</tariffName>
      <from>point</from>
      <deliveryCost>370</deliveryCost>
      <feesIncluded>false</feesIncluded>
      <insuranceFee>0</insuranceFee>
      <cashServiceFee>0</cashServiceFee>
      <daysMin>2</daysMin>
      <daysMax>3</daysMax>
      <pickupTypes>2</pickupTypes>
      <deliveryTypes>1</deliveryTypes>
    </tariffs>
    <tariffs>
      <tariffProviderId>137</tariffProviderId>
      <tariffId>54</tariffId>
      <tariffName>Посылка склад-дверь</tariffName>
      <from>point</from>
      <deliveryCost>330</deliveryCost>
      <feesIncluded>false</feesIncluded>
      <insuranceFee>0</insuranceFee>
      <cashServiceFee>0</cashServiceFee>
      <daysMin>3</daysMin>
      <daysMax>5</daysMax>
      <pickupTypes>2</pickupTypes>
      <deliveryTypes>1</deliveryTypes>
    </tariffs>
  </deliveryToDoor>
  <deliveryToPoint/>
</response>