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

API
Главная / API - Shipping Cost and Time Calculator

Shipping Cost and Time Calculator

Обновлено 24.08.2020
214 кб

General information 

The service allows receiving the detailed information on the cost and the timeframes of the selected shipping type. To find out estimated shipping cost and timeframes, use "Estimated shipping cost and time calculator".

Below is the description of all method parameters, for the requests and the responses examples see the relevant section

Shipping cost and time calculator 

Method request

Request example

Method address: 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":{
            "street":"7800000000008850000000000"
         },
         "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":{
            "street":"7700000000003690000000000",
         },
         "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,
      "weight":12,
      "height":1,
      "totalVolume":1,
      "totalWeight":12,
      "oversizedWeight":0,
      "oversizedVolume":0,
      "freightUID":"0x82e6000423b423b711da7d15445d42cb",
      "freightName":"Автомобильные диски",
      "hazardClass":7.2,
      "insurance":{
         "statedValue":15477.34,
         "term":false
      }
   },
   "payment":{
      "paymentCity":"7700000000000000000000000",
      "type":"cash"
   }
}

Method address: 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>
            <street>7800000000008850000000000</street>
         </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>
            <street>7700000000003690000000000</street>
         </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>
      <weight>12</weight>
      <height>1</height>
      <totalVolume>1</totalVolume>
      <totalWeight>12</totalWeight>
      <oversizedWeight>0</oversizedWeight>
      <oversizedVolume>0</oversizedVolume>
      <freightUID>0x82e6000423b423b711da7d15445d42cb</freightUID>
      <freightName>Автомобильные диски</freightName>
      <hazardClass>7.2</hazardClass>
      <insurance>
         <statedValue>15477.34</statedValue>
         <term>false</term>
      </insurance>
   </cargo>
   <payment>
      <paymentCity>7700000000000000000000000</paymentCity>
      <type>cash</type>
   </payment>
</request>

Description of parameters

Request
Request
ParameterRequiredTypeDescription
appkeyYesstringApplication key. To get the key, register
sessionIDNostringSession ID is required to take personal discounts into account. To get the ID, use User authorization service
deliveryYesobject

Shipping details

delivery.deliveryTypeYesDeliveryTypeType of terminal-to-terminal shipping for which price is calculated
delivery.arrivalYesDerivalArrivalCargo arrival details
delivery.derivalYesDerivalArrivalCargo departure details
delivery.packagesNoarray of PackagesPackage details. If the parameter is not passed, the packaging price is not calculated
delivery.accompanyingDocumentsNoarray of AcDocShipping documents details
membersYesobjectShipping parties
members.requesterYesRequesterClient details
cargoYesobjectCargo details
cargo.quantityNointeger

Quantity of cargo places, pcs. Default value: 1.

If the shipping type is letter (request.delivery.deliveryType.type = letter), then the passed value is ignored, the parameter takes the value 1

cargo.lengthYes*float

Length of the longest cargo place, m.

*If the shipping type is letter (request.delivery.deliveryType.type = letter), then the parameter is not required, the passed value is ignored, the parameter takes the value 0.3

cargo.widthYes*
float

Width of the widest cargo place, m.

*If the shipping type is letter (request.delivery.deliveryType.type = letter), then the parameter is not required, the passed value is ignored, the parameter takes the value 0.21

cargo.weightNo*float

Weight of the heaviest cargo place, kg.

*If quantity of the cargo places > 1 (Request.Cargo.quantity > 1), then the parameter is required. Otherwise, the parameter takes the value of totalWeight parameter.

*If the shipping type is letter (request.delivery.deliveryType.type = letter), then the parameter is not required, the passed value is ignored, the parameter takes the value 0.5

cargo.heightYes*float

Height of the highest cargo place, m.

*If the shipping type is letter (request.delivery.deliveryType.type = letter), then the parameter is not required, the passed value is ignored, the parameter takes the value 0.01

cargo.totalVolumeYes*float

Total cargo volume, m3.

*If the shipping type is letter (request.delivery.deliveryType.type = letter), then the parameter is not required, the passed value is ignored, the parameter takes the value 0.001

cargo.totalWeightYes*float

Total cargo weight, kg.

*If the shipping type is letter (request.delivery.deliveryType.type = letter), then the parameter is not required, the passed value is ignored, the parameter takes the value 0.5

cargo.oversizedWeightNo*float

Weight of the oversized cargo places, kg (1).

If the shipping type is letter (request.delivery.deliveryType.type = letter), then parameter is ignored.

*If it is determined by the weight/the size that the cargo is oversized, then the parameter is required

cargo.oversizedVolumeNo*float

Volume of the oversized cargo places, m3 (1).

If the shipping type is letter (request.delivery.deliveryType.type = letter), then parameter is ignored.

*If it is determined by the weight/the size that the cargo is oversized, then the parameter is required

cargo.freightUIDNostring

UID of the nature of the cargo, see Nature of cargo directory. Using the cargo name to find the UID see Cargo type by an input string service

Only one of the following parameters can be passed: request.cargo.freightName or request.cargo.freightUID
cargo.freightNameNostring

Nature of cargo

Only one of the following parameters can be passed: request.cargo.freightName or request.cargo.freightUID
cargo.hazardClassYesfloat

Cargo hazard class.

Default value - 0

cargo.insuranceNoInsuaranceCargo insurance details
paymentYesobjectPayment details
payment.paymentCityYesstringCity CLADR code (CLADR - Classifier of Addresses of the Russian Federation). To get CLADR code use the services listed on Using CLADR codes page
payment.typeYesstring

Payment type.

Possible values:

  • cash;
  • noncash.

Used to check whether the cashless payment is available

Notes:

  1. An oversized cargo place is a cargo place with weight greater than or equal to 100 kg (80 kg in case of air transportation) or with at least one of the dimensions (LWH) greater than or equal to 3 m (80 сm in case of air transportation)

DeliveryType
DeliveryType
ParameterRequiredTypeDescription

type

Yesstring

Shipping type for which price is calculated.

Possible values:

  • auto- by truck;
  • express;
  • letter;
  • avia;
  • small - shipping of small-size cargo.

Small size cargo is the cargo with parameters that do not exceed the following values:
  • weight is less than or equal to 10 kg;
  • LWH is less than or equal to 0.54*0.39*0.39 m;
  • volume is less than or equal to 0.1 cubic meters.
It is only possible to order Small Cargo Delivery service if there are Delovye Linii company terminals in the city of departure and city of arrival. For more information see company website

DerivalArrival
DerivalArrival
ParameterRequiredTypeDescription
produceDateYesstring

Order completion date.

Format: YYYY-MM-DD

Only for request.derival object
variantYesstring

Shipping option.

Possible values:

  • address - shipping from the sender's address/delivery to the receiver's address;
  • terminal - shipping from the terminal/delivery to the terminal.

If small-size cargo delivery is ordered ("delivery.deliverуType.type" request parameter value is "small"), then shipping from the terminal/delivery to the terminal is not available

terminalIDNostring

Departure/arrival terminal ID, see Terminals directory.

The parameter is used for the pre-order (see below) price calculation

Only one of the following parameters can be passed: terminalID, addressID, address, city
Pre-orderIf a client wants to bring the cargo to the company terminal, they may place an order online, print the paper and bring it to the terminal. Thus they will be able to save time since the clients who placed a pre-order are served out of turn. For more information see Delovye Linii company website.
addressIDNointeger

Sender/receiver address ID from the user account address book, see Addresses service

The parameter is used to calculate the price for the addresses saved in the user account

Only one of the following parameters can be passed: terminalID, addressID, address, city
addressNoobject

Address

Only one of the following parameters can be passed: terminalID, addressID, address, city
address.streetYesstring

Street CLADR code (CLADR - Classifier of Addresses of the Russian Federation). To get CLADR code use services listed on Using CLADR codes page

cityNostring

City CLADR code. To get CLADR code use the services listed on Using CLADR codes page

Only for request.arrival object.The parameter can be used only if delivery to the terminal is ordered (that is "variant" parameter value is "terminal").Only one of the following parameters can be passed: terminalID, addressID, address, city
timeNo*object

Period during which the cargo can be picked up from the sender/handed over to the receiver at the address.

*The parameter is required if shipping from the sender's address/delivery to the receiver's address is ordered (that is "variant" parameter value is "address")

time.worktimeStartYesstring

Handover/pickup period start.

Format: HH:MM

time.worktimeEndYesstring

Handover/pickup period end.

Format: HH:MM

time.breakStartNostring

Break start.

Format: HH:MM

time.breakEndNostring

Break end.

Format: HH:MM

time.exactTimeNoboolean

Flag indicating that delivery/pickup at precise time is required.

Default value: false

handlingNoobject

Loading and unloading works at the address.

The parameter is not required. If the parameter is not passed in a request, the loading/unloading price is not calculated

handling.freightLiftNoboolean

Flag indicating that there is a service lift.

Default value: false

handling.toFloorNointeger

Number of the floor to which the cargo is to be lifted/from which the cargo is to be carried downstairs

handling.carryNointeger

Distance to which the cargo is to be carried, m

requirementsNoarray of strings

Additional requirements for the vehicle: available types of loading (side, rear, etc.), as well as the other requirements - manipulator, removable curtains, etc.

UIDs from the Directory of special requirements for transport. Several values can be passed.

Packages
Packages
ParameterRequiredTypeDescription
uidYesstringPackage UID, see Directory of additional services
countNo*integer

Number of bags/boxes

*The parameter is required if the package "bag" ("Упаковка мешок") or "carton box" ("Картонная коробка") is selected

AcDoc
AcDoc
ParameterRequiredTypeDescription
actionYesstring

Action with accompanying documents.

Possible values:

  • send;
  • return
It is possible to pass both values using separate parameters

Requester
Requester
ParameterRequiredTypeDescription
roleNostring

Client role.

Possible values:

  • sender;
  • receiver;
  • payer;
  • thirdthird party
uidNostring

Counterparty UID, see List of available counterparties.

The parameter is ignored in case the full access to counterparties is not available

Insuarance
Insuarance
ParameterRequiredTypeDescription
statedValueYesfloat

Cargo declared value, rubles.

Maximum 12 characters

termYesboolean

Flag indicating that cargo delivery time is insured.

Default value - true

Method response

Response example

{
   "metadata":{
      "status":200,
      "generated_at":"2019-11-25 08:16:47"
   },
   "data":{
      "derival":{
         "terminal":"Санкт-Петербург",
         "price":475,
         "servicePrice":475,
         "premiumDetails":[

         ],
         "terminals":[

         ],
         "handling":{
            "price":0,
            "premium":0,
            "discount":0,
            "premiumDetails":[

            ],
            "discountDetails":[

            ]
         }
      },
      "intercity":{
         "price":540,
         "premium":0,
         "discount":0,
         "premiumDetails":[

         ],
         "discountDetails":[

         ]
      },
      "small":{
         "price":540,
         "premium":0,
         "discount":0,
         "premiumDetails":[

         ],
         "discountDetails":[

         ]
      },
      "air":{
         "price":540,
         "premium":0,
         "discount":0,
         "premiumDetails":[

         ],
         "discountDetails":[

         ]
      },
      "express":{
         "price":540,
         "premium":0,
         "discount":0,
         "premiumDetails":[

         ],
         "discountDetails":[

         ]
      },
      "letter":{
         "price":540,
         "premium":0,
         "discount":0,
         "premiumDetails":[

         ],
         "discountDetails":[

         ]
      },
      "arrival":{
         "terminal":"Чита",
         "price":0,
         "premiumDetails":[
            {
               "name":"Экспедирование до клиента график доставки",
               "value":2000,
               "date":null,
               "announcement":false,
               "public":true
            }
         ],
         "terminals":[
            {
               "id":"104",
               "name":"Чита",
               "address":"Чита, Сухая Падь ул., 3",
               "streetCode":"7500000100008350000000000",
               "price":0,
               "default":true,
               "express":false,
               "isPVZ":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-28T00:00:00+03:00",
         "giveoutFromOspReceiverMax":"2019-11-29T00:00:00+03:00",
         "derrivalFromOspReceiver":null,
         "createTo":null,
         "derrivalToAddress":null,
         "derivalToAddressMax":null
      },
      "deliveryTerm":0,
      "accompanyingDocuments":{
         "send":{
            "price":200,
            "premium":0,
            "discount":0,
            "premiumDetails":[

            ],
            "discountDetails":[

            ]
         },
         "return":{
            "price":200,
            "premium":0,
            "discount":0,
            "premiumDetails":[

            ],
            "discountDetails":[

            ]
         }
      },
      "insurance":250,
      "insuranceComponents":{
         "cargoInsurance":200,
         "termInsurance":50
      },
      "notify":{
         "price":15,
         "premium":0,
         "discount":0,
         "premiumDetails":[

         ],
         "discountDetails":[

         ]
      },
      "simpleShippingAvailable":true,
      "availableDeliveryTypes": {
         "auto": 480.0,
         "small": 549.0,
         "avia": 4230.0,
         "express": 620.0,
         "letter": null
      }
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2019-11-25 08:16:47</generated_at>
   </metadata>
   <data>
      <derival>
         <terminal>Санкт-Петербург</terminal>
         <price>475</price>
         <servicePrice>475</servicePrice>
         <handling>
            <price>0</price>
            <premium>0</premium>
            <discount>0</discount>
         </handling>
      </derival>
      <intercity>
         <price>540</price>
         <premium>0</premium>
         <discount>0</discount>
      </intercity>
      <small>
         <price>540</price>
         <premium>0</premium>
         <discount>0</discount>
      </small>
      <air>
         <price>540</price>
         <premium>0</premium>
         <discount>0</discount>
      </air>
      <express>
         <price>540</price>
         <premium>0</premium>
         <discount>0</discount>
      </express>
      <letter>
         <price>540</price>
         <premium>0</premium>
         <discount>0</discount>
      </letter>
      <arrival>
         <terminal>Чита</terminal>
         <price>0</price>
         <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>
            <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-28T00:00:00+03:00</giveoutFromOspReceiver>
         <giveoutFromOspReceiverMax>2019-11-29T00:00:00+03:00</giveoutFromOspReceiverMax>
         <derrivalFromOspReceiver />
         <createTo />
         <derrivalToAddress />
         <derivalToAddressMax />
      </orderDates>
      <deliveryTerm>0</deliveryTerm>
      <accompanyingDocuments>
         <send>
            <price>200</price>
            <premium>0</premium>
            <discount>0</discount>
         </send>
         <return>
            <price>200</price>
            <premium>0</premium>
            <discount>0</discount>
         </return>
      </accompanyingDocuments>
      <insurance>250</insurance>
      <insuranceComponents>
         <cargoInsurance>200</cargoInsurance>
         <termInsurance>50</termInsurance>
      </insuranceComponents>
      <notify>
         <price>15</price>
         <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>
   </data>
</response>

Description of parameters

Response
Response
ParameterTypeDescription
metadataobjectSystem information
metadata.statusinteger

Emulated status http-code. If successful, code 200 is returned

metadata.generated_atstring

Server response date and time.

Format: YYYY-MM-DD HH:MM:SS

dataobjectInformation on shipping cost and time
data.derivalDerivalArrivalInformation on shipping from the sender
data.intercityCostsCalculation

Truck shipping details

data.smallCostsCalculationInformation on small-size cargo shipping
data.airCostsCalculationAir freight details
data.expressCostsCalculationExpress shipping details
data.letterCostsCalculationLetter service details
data.arrivalDerivalArrivalInformation on delivery to the receiver
data.pricestring

Total amount for the selected shipping type

The total amount is the sum of the values of the following parameters:
  1. The cost of the selected type of terminal-to-terminal transportation (data.intercity.price/data.small.price/data.air.price/data.express.price/data.letter.price).
  2. data.derival.price - cost of shipping from the sender.
  3. data.arrival.price - cost of delivery to the receiver.
  4. data.insurance - cargo insurance cost.
  5. data.packages.price - packaging cost, there may be several parameters in a response.
  6. data.insurance.accompanyingDocuments.send.price - cost of sending the shipping documents.
  7. data.insurance.accompanyingDocuments.receive.price - shipping documents return cost.
  8. data.notify.price - cost of Status Notification service
data.priceMininalstring

The cheapest shipping type. Possible values:

  • auto - truck shipping;
  • express - express shipping;
  • small - small-size cargo shipping;
  • letter;
  • avia - air freight
data.packagesarray of CostsCalculationPackaging cost details
data.orderDatesOrderDatesCargo transportation schedule
data.deliveryTermintegerDelivery time from the terminal of arrival to the receiver's address (in days)
data.accompanyingDocumentsAcDoc

Information on cost of shipping documents sending/returning

data.insurancestringCargo insurance cost
data.insuranceComponentsInsuranceComponentsList of cargo insurance services and their cost
data.notifyCostsCalculationStatus Notification service details
data.simpleShippingAvailableboolean

Flag indicating that Simplified Shipping service (see below) is available

Delovye Linii company allows providing minimum information on the receiver - only name and phone number. In this case SMS with a code is sent to the phone number. The code is used to receive the goods. For more information see the description of Simplified Shipping service on Delovye Linii company website
data.availableDeliveryTypesAvailableDeliveryTypesList of available shipping types and their price

DerivalArrival
DerivalArrival
ParameterTypeDescription
terminalstringCity where the terminal of departure/arrival is located
pricestring

Cost of shipping from the sender/delivery to the receiver

If a client orders the shipping from terminal/to terminal, that is the value of the request parameter request.delivery.derival.variant/request.delivery.arrival.variant is terminal, then the cost of shipping from the sender/delivery to the receiver equals to the cost of entering the terminal (see parameters response.derival.teminals.pirce/response.arrival.teminals.pirce).If shipping from the sender's address/delivery to the receiver's address is ordered, that is the value of the request parameter request.delivery.derival.variant/request.delivery.arrival.variant is address, then the cost equals to the sum of the values of the following parameters:
  1. response.derival.servicePrice/response.arrival.servicePrice - cost of delivery from thesender's address to the terminal/from the terminal to thereceiver's address (the discounts and the extra charges not considered).
  2. response.derival.handling.price/response.arrival.handling.price - handling pricing details.
  3. If shipping from the sender's address/delivery to thereceiver's address is ordered then, also response.derival.premiumDetails.value/response.arrival.premiumDetails.value - extra charges (a response may contain several parameters).

servicePricestring

The cost of delivery from thesender's address to the terminal/from the terminal to thereceiver's address (discounts and extra charges not considered)

The parameter is present in the response if shipping from the sender's address/delivery to thereceiver's address is ordered, that is the request parameter request.delivery.derival.variant/request.delivery.arrival.variant value is address (The parameter isn't present in the response if the price of the shipping from terminal/to terminal is calculated, that is the request parameter request.delivery.derival.variant/request.delivery.arrival.variant value is terminal)
premiumDetailsarray of PricingDetailsExtra charges details
terminalsarray of Terminals

Information on terminals (warehouses) where cargo can be handed over/picked up

handlingCostsCalculationHandling pricing details

CostsCalculation
CostsCalculation
ParameterTypeDescription
pricestringService price
premiumstringExtra charges amount
discountstring

Discount amount

premiumDetailsarray of PricingDetailsExtra charges details
discountDetailsarray of PricingDetailsDiscounts details

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

auto

float

Truck shipping price

small

float

Price of small-size cargo shipping

avia

float

Air freight price

express

float

Express shipping price

letter

float

Letter shipping price

Information on letter shipping is available only if request "delivery.deliveryType.type" parameter value is "letter", otherwise the information is not available and the parameter value is "null"

OrderDates
OrderDates
ParameterTypeDescription
pickupstringDate of cargo pickup from the sender's address
senderAddressTimestringThe latest possible time of cargo pickup at the sender's address
senderTerminalTimestringThe latest possible time of cargo delivery to the terminal of departure
arrivalToOspSenderstringDate of cargo arrival at the terminal of departure
derivalFromOspSenderstringDate of cargo departure from the terminal of departure
arrivalToOspReceiverstringDate of cargo arrival at the terminal of arrival
arrivalToAirportstringThe date of cargo delivery to the airport/terminal of arrival
arrivalToAirportMaxstringThe latest possible date of cargo delivery to the airport/terminal of arrival (if the date can be delayed)
giveoutFromOspReceiverstringDate when cargo is ready to be handed out at the terminal of arrival
giveoutFromOspReceiverMaxstringThe latest possible date when cargo is ready to be handed out at the terminal of arrival (if the date can be delayed)
derivalFromOspReceiverstringDate of cargo departure from the terminal of arrival
createTostring

The latest possible time to order delivery from the sender's address

derrivalToAddressstring

The earliest possible time when cargo can be handed over at the receiver's address

The parameter is present in the response only if avia or express transportation price is calculated ("delivery.deliveryType" request parameter value is "avia" or "express")
derivalToAddressMaxstring

The latest possible time when cargo can be handed over at the receiver's address

The parameter is present in the response only if avia or express transportation price is calculated ("delivery.deliveryType" request parameter value is "avia" or "express")

AcDoc
AcDoc
ParameterTypeDescription
sendCostsCalculationCost details of sending shipping documents
returnCostsCalculationCost details of returning shipping documents

InsuranceComponents
InsuranceComponents
ParameterTypeDescription
cargoInsurancestringCargo Insurance service cost
termInsurancestringCargo Delivery Time Insurance service cost. If the price is not indicated, then the service is not available for the selected destination

PricingDetails

PricingDetails

ParameterTypeDescription
namestringDiscount/surcharge name. For example, Oversize Surcharge or Current Promo
valuestring

Discount/surcharge amount, rubles

datestring

Discount/surcharge period.

Format: YYYY-MM-DD

announcementboolean

Flag indicating that the discount/surcharge is promotional.

Possible values:

  • true - promotional discount/surcharge;
  • false (the parameter is not present in the response) - regular discount/surcharge
publicboolean

Flag indicating that the discount/surcharge is public. Discount can be either public or personal for authorized users, and public only - for unauthorized users.

Possible values:

  • true - public discount/surcharge;
  • false (or the parameter is not present in the response) - personal discount/surcharge (for the authorized users only)

Terminals

Terminals

ParameterTypeDescription
idstringTerminal ID from Terminals directory
namestringName of the terminal
addressstringTerminal address
streetCodestring

Street CLADR code, see Streets directory (CLADR - Classifier of Addresses of the Russian Federation)

pricestringCost of entering the terminal's territory
defaultbooleanFlag indicating that the terminal is a default terminal for the selected city
expressbooleanFlag indicating that Express Shipping service can be provided at the terminal
isPVZboolean

Flag indicating that the terminal is a pick-up point.

Possible values:

  • true - the terminal is a pick-up point (the shipping from the terminal is not available, only pickup; maximum weight of cargo that can be received at the terminal - 10 kg, maximum LWH: 50x50x30 cm);
  • false - the terminal is not a pick-up point

Error handling

The common API errors are used with the method, for errors format description and errors list see Errors of API methods.