Shipping Cost and Time Calculator
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 structure
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":{ "search":"59.924501, 30.241762", "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":{ "search":"Москва, Юности, 5", "street":"7700000000004650000000000" }, "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":"Москва" } } }
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> <search>59.924501, 30.241762</search> <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> <search>Москва, Юности, 5</search> <street>7700000000004650000000000</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> <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>
Description of parameters
Request
Request | |||
---|---|---|---|
Parameter | Required | Type | Description |
appkey | Yes | string | Application key. To get the key, register |
sessionID | No | string | Session ID is required to take personal discounts into account. To get the ID, use "User authorization" service |
delivery | Yes | object | Shipping details |
delivery.deliveryType | Yes | DeliveryType | Type of terminal-to-terminal shipping for which price is calculated |
delivery.arrival | Yes | DerivalArrival | Cargo arrival details |
delivery.derival | Yes | DerivalArrival | Cargo departure details |
delivery.packages | No | array of Packages | Package details. If the parameter is not passed, the packaging price is not calculated |
delivery.accompanyingDocuments | No | array of AcDoc | Shipping documents details |
members | No | object | Shipping parties |
members.requester | No | Requester | Client details |
cargo | Yes | Cargo | Cargo details |
payment | No | Payment | Payment details |
DeliveryType
DeliveryType | |||
---|---|---|---|
Parameter | Required | Type | Description |
type | Yes | string | Shipping type for which price is calculated. Possible values:
Small size cargo is the cargo with parameters that do not exceed the following values:
|
DerivalArrival
DerivalArrival | |||
---|---|---|---|
Parameter | Required | Type | Description |
produceDate | Yes | string | Order completion date. Format: YYYY-MM-DD Only for request.delivery.derival object |
variant | Yes | string | Shipping option. Possible values:
|
terminalID | No | string | 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. |
addressID | No | integer | 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 |
address | No | object | Address Only one of the following parameters can be passed: terminalID, addressID, address, city |
address.search | No* | string | Address as a string. It is possible to pass address as text or as coordintaes. When passing address as a text along with the address (street and house number) it is necessary to pass the name of the city, the address elements should be separated by comma, for example "Омск, Ленина, 5". The coordinates should be separated by comma as well, the first number - latitude "59.924501, 30.241762". Maximum 1024 symbols *Only one of the excluding parameters: "address.search" or "address.street" is required |
address.street | No* | string | Street CLADR code (CLADR - Classifier of Addresses of the Russian Federation). To get CLADR code use services listed on "CLADR search" page *Only one of the excluding parameters: "address.search" or "address.street" is required |
city | No | string | City CLADR code. To get CLADR code use the services listed on "CLADR search" page Only for request.delivery.arrival object.The parameter can not be used if delivery to the address is ordered (that is "variant" parameter value is "address").Only one of the following parameters can be passed: terminalID, addressID, address, city |
time | No* | 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.worktimeStart | Yes | string | Handover/pickup period start. Format: HH:MM |
time.worktimeEnd | Yes | string | Handover/pickup period end. Format: HH:MM |
time.breakStart | No | string | Break start. Format: HH:MM |
time.breakEnd | No | string | Break end. Format: HH:MM |
time.exactTime | No | boolean | Flag indicating that delivery/pickup at precise time is required. Default value: false |
handling | No | object | 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.freightLift | No | boolean | Flag indicating that there is a service lift. Default value: false |
handling.toFloor | No | integer | Number of the floor to which the cargo is to be lifted/from which the cargo is to be carried downstairs |
handling.carry | No | integer | Distance to which the cargo is to be carried, m |
requirements | No | array 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" and from the "Directory of vehicle loading types". Several values can be passed. |
Packages
Packages | |||
---|---|---|---|
Parameter | Required | Type | Description |
uid | Yes | string | Package UID, see "Directory of additional services" |
count | No* | integer | Number of bags/boxes *The parameter is required if the package "bag" ("Упаковка мешок") or "carton box" ("Картонная коробка") is selected |
AcDoc
AcDoc | |||
---|---|---|---|
Parameter | Required | Type | Description |
action | Yes | string | Action with accompanying documents. Possible values:
It is possible to pass both values using separate parameters.The accompanying documents return is not available if the receiver is "anonymous" that is if "members.receiver.counteragent.isAnonym" parameter value is "true". "Anonymous" receiver is a receiver on whom minimum information is provided (only name and phone number is provided |
Requester
Requester | |||
---|---|---|---|
Parameter | Required | Type | Description |
role | No | string | Client role. Possible values:
|
uid | No | string | Counterparty UID, see "List of available counterparties". The parameter is ignored in case the full access to counterparties is not available |
Cargo
Cargo | |||
---|---|---|---|
Parameter | Required | Type | Description |
quantity | No | integer | 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 |
length | Yes* | 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 |
width | Yes* | 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 |
weight | No* | 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 |
height | Yes* | 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 |
totalVolume | Yes* | 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 |
totalWeight | Yes* | 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 |
oversizedWeight | No* | 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 |
oversizedVolume | No* | 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 |
freightUID | No | string | UID of the nature of the cargo, see "Nature of cargo" directory. Using the cargo name to find the UID see "Nature of cargo: search by the string (groupage cargo transportation)" service. If "request.delivery.deliveryType.type" parameter values is "letter", then the passed value is ignored, the nature of cargo is considered to be documents |
hazardClass | Yes | float | Cargo hazard class. Default value - 0 |
insurance | No | Insuarance | Cargo insurance details |
insurance.statedValue | Yes | float | Cargo declared value, rubles. Maximum 12 characters |
insurance.term | Yes | boolean | Flag indicating that cargo delivery time is insured. Default value - true |
Notes: 1. An oversized cargo place is:
2. A rigid packaging is ordered if the identifier of one of the following package types is passed in the request.delivery.packages.uid parameter (see "Directory of additional services"):
|
Payment
Payment | |||
---|---|---|---|
Parameter | Required | Type | Description |
type | Yes | string | Payment type (1). Possible values:
|
promocode | No | string | Promo code |
paymentCity | No* | string | City CLADR code (1) (CLADR - Classifier of Addresses of the Russian Federation). To get CLADR code use the services listed on "CLADR search" page *One of the excluding parameters - "paymentCity" or "paymentCitySearch" is required |
paymentCitySearch | No* | string | City of payment as a string (1) *One of the excluding parameters - "paymentCity" or "paymentCitySearch" is required |
paymentCitySearch.search | Yes | string | City as a string. Maximum 1024 symbols. Along with the name of the city it is possible to pass the name of the country, region or district - this will allow refining the search and eliminating errors that may occur since the cities can have the identical names |
Notes:
|
Method response
Response structure
{ "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>
Description of parameters
Response
Response | ||
---|---|---|
Parameter | Type | Description |
metadata | object | System information |
metadata.status | integer | Emulated status http-code. If successful, code 200 is returned |
metadata.generated_at | string | Server response date and time. Format: YYYY-MM-DD HH:MM:SS |
data | object | Information on shipping cost and time |
data.derival | DerivalArrival | Information on shipping from the sender |
data.intercity | CostsCalculation | Truck shipping details |
data.small | CostsCalculation | Information on small-size cargo shipping |
data.air | CostsCalculation | Air freight details |
data.express | CostsCalculation | Express shipping details |
data.letter | CostsCalculation | Letter service details |
data.arrival | DerivalArrival | Information on delivery to the receiver |
data.price | string | Total amount for the selected shipping type The total amount is the sum of the values of the following parameters:
|
data.priceMinimal | string | The cheapest shipping type. Possible values:
|
data.packages | array of CostsCalculation | Packaging cost details |
data.orderDates | OrderDates | Cargo transportation schedule |
data.deliveryTerm | integer | Delivery time from the terminal of arrival to the receiver's address (in days) |
data.accompanyingDocuments | AcDoc | Information on cost of shipping documents sending/returning |
data.insurance | string | Cargo insurance cost |
data.insuranceComponents | InsuranceComponents | List of cargo insurance services and their cost |
data.notify | CostsCalculation | Status Notification service details |
data.simpleShippingAvailable | boolean | 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.availableDeliveryTypes | AvailableDeliveryTypes | List of available shipping types and their price |
data.foundAddresses | array of FoundAddresses | Data on found addresses/cities. The parameter is present in the response if "address.search" parameter of the "DerivalArrival" class or "payment.paymentCitySearch.search" parameter were passed in the request |
data.information | array of strings | Info message stating that, for example, the company specialist will contact the client after they submit the order or that it is impossible to apply the passed promo code. The message is displayed if there is "contractPrice" parameter with the "true" value in the response or if it is impossible for some reason to apply the promo code that was passed in the request, respectively. Possible messages about the promo code:
|
DerivalArrival
DerivalArrival | ||
---|---|---|
Parameter | Type | Description |
terminal | string | City where the terminal of departure/arrival is located |
price | string | 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:
|
сontractPrice | boolean | Flag indicating that the price is negotiable. If the price is negotiable (the parameter value is "true"), then the "price" and "servicePrice" parameters values are "null", information on extra charges and discounts is not available ("premiumDetails" and "discountDetails" arrays are empty) |
servicePrice | string | 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) |
premiumDetails | array of PricingDetails | Extra charges details |
discountDetails | array of PricingDetails | Discounts details |
terminals | array of Terminals | Information on terminals (warehouses) where cargo can be handed over/picked up |
handling | CostsCalculation | Handling pricing details |
CostsCalculation
CostsCalculation | ||
---|---|---|
Parameter | Type | Description |
price | string | Service price |
contractPrice | boolean | Flag indicating that the price is negotiable. If the price is negotiable (the parameter value is "true"), then the "price" parameter values is "null", information on extra charges and discounts is not available ("premium" and "discount" parameters values are "0", "premiumDetails" and "discountDetails" arrays are empty) |
premium | string | Extra charges amount |
discount | string | Discount amount |
premiumDetails | array of PricingDetails | Extra charges details |
discountDetails | array of PricingDetails | Discounts 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 | ||
---|---|---|
Parameter | Type | Description |
pickup | string | Date of cargo pickup from the sender's address |
senderAddressTime | string | The latest possible time of cargo pickup at the sender's address |
senderTerminalTime | string | The latest possible time of cargo delivery to the terminal of departure |
arrivalToOspSender | string | Date of cargo arrival at the terminal of departure |
derivalFromOspSender | string | Date of cargo departure from the terminal of departure |
arrivalToOspReceiver | string | Date of cargo arrival at the terminal of arrival |
arrivalToAirport | string | The date of cargo delivery to the airport/terminal of arrival |
arrivalToAirportMax | string | The latest possible date of cargo delivery to the airport/terminal of arrival (if the date can be delayed) |
giveoutFromOspReceiver | string | Date when cargo is ready to be handed out at the terminal of arrival |
giveoutFromOspReceiverMax | string | The latest possible date when cargo is ready to be handed out at the terminal of arrival (if the date can be delayed) |
derivalFromOspReceiver | string | Date of cargo departure from the terminal of arrival |
createTo | string | The latest possible time to order delivery from the sender's address |
derrivalToAddress | string | 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.type" request parameter value is "avia" or "express") |
derivalToAddressMax | string | 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.type" request parameter value is "avia" or "express") |
AcDoc
AcDoc | ||
---|---|---|
Parameter | Type | Description |
send | CostsCalculation | Cost details of sending shipping documents |
return | CostsCalculation | Cost details of returning shipping documents |
InsuranceComponents
InsuranceComponents | ||
---|---|---|
Parameter | Type | Description |
cargoInsurance | string | Cargo Insurance service cost |
termInsurance | string | Cargo Delivery Time Insurance service cost. If the price is not indicated, then the service is not available for the selected destination |
contractPrice | boolean | Flag indicating that the price is negotiable. If the price is negotiable (the parameter value is "true"), then information on insurance price is not available ("cargoInsurance" and "termInsurance" values are "0") |
PricingDetails
PricingDetails | ||
---|---|---|
Parameter | Type | Description |
name | string | Discount/surcharge name. For example, Oversize Surcharge or Current Promo |
value | string | Discount/surcharge amount, rubles |
date | string | Discount/surcharge period. Format: YYYY-MM-DD |
announcement | boolean | Flag indicating that the discount/surcharge is promotional. Possible values:
|
public | boolean | 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:
|
triggers | array of Triggers | Array of order characteristics that triggered the discount. The parameter is present in the "discountDetails" block if there are such characteristics and the discount has been applied |
Triggers
Triggers | ||
---|---|---|
Параметр | Тип | Описание |
key | string | Order characteristic that triggered the discount. For example, if the discount was applied using a promo code, then the parameter contains the value "promocode" |
Terminals
Terminals | ||
---|---|---|
Parameter | Type | Description |
id | string | Terminal ID from Terminals directory |
name | string | Name of the terminal |
address | string | Terminal address |
streetCode | string | Street CLADR code, see "Streets search" (CLADR - Classifier of Addresses of the Russian Federation) |
price | string | Cost of entering the terminal's territory |
contractPrice | boolean | Flag indicating that the price is negotiable. If the price is negotiable (the parameter value is "true"), then the "price" parameter values is "null" |
default | boolean | Flag indicating that the terminal is a default terminal for the selected city |
express | boolean | Flag indicating that Express Shipping service can be provided at the terminal |
isPVZ | boolean | The parameter is present in the response, but is not currently used |
FoundAddresses
FoundAddresses | ||
---|---|---|
Parameter | Type | Description |
field | string | The parent object that was used to pass the "search" parameter |
source | string | Entered value |
result | string | Address/city found |
Error handling
The common API errors are used with the method, for errors format description and errors list see Errors of API methods.