Delivery dates
General information
The service allows getting the list of dates when the driver can deliver the cargo to the receiver's address (the information can be used when placing an order for delivery from terminal to the receiver's address with the help of "Adding delivery to the receiver's address" method). The service is available to authorized users only .
Delivery dates
Method request
Request structure
Method address: https://api.dellin.ru/v2/request_delivery/address/dates.json
{
"appkey":"00000000-0000-0000-0000-000000000000",
"sessionID":"00000000-0000-0000-0000-000000000000",
"docID":"2000085063763",
"delivery":{
"arrival":{
"addressID":3357,
"address":{
"search":"Омск, Ленина, 5",
"street":"5500000100005970000000000",
"house":"5",
"building":"1",
"structure":"4",
"flat":"1
},
"city":"5500000100000000000000000",
"time":{
"exactTime":true
},
"handling":{
"freightLift":true,
"toFloor":10,
"carry":100
},
"requirements":[
"0xabb9c63c596b08f94c3664c930e77778",
"0x88f93a2c37f106d94ff9f7ada8efe886",
"0x818e8ff1eda1abc349318a478659af08",
"0xb83b7589658a3851440a853325d1bf69",
"0x92fce2284f000b0241dad7c2e88b1655",
"0x9951e0ff97188f6b4b1b153dfde3cfec"
]
}
}
}Method address: https://api.dellin.ru/v2/request_delivery/address/dates.xml
<request>
<appkey>00000000-0000-0000-0000-000000000000</appkey>
<sessionID>00000000-0000-0000-0000-000000000000</sessionID>
<docID>2000085063763</docID>
<delivery>
<arrival>
<addressID>3357</addressID>
<address>
<search>Омск, Ленина, 5</search>
<street>5500000100005970000000000</street>
<house>5</house>
<building>1</building>
<structure>4</structure>
<flat>1</flat>
</address>
<city>5500000100000000000000000</city>
<time>
<exactTime>true</exactTime>
</time>
<handling>
<freightLift>true</freightLift>
<toFloor>10</toFloor>
<carry>100</carry>
</handling>
<requirements>0xabb9c63c596b08f94c3664c930e77778</requirements>
<requirements>0x88f93a2c37f106d94ff9f7ada8efe886</requirements>
<requirements>0x818e8ff1eda1abc349318a478659af08</requirements>
<requirements>0xb83b7589658a3851440a853325d1bf69</requirements>
<requirements>0x92fce2284f000b0241dad7c2e88b1655</requirements>
<requirements>0x9951e0ff97188f6b4b1b153dfde3cfec</requirements>
</arrival>
</delivery>
</request>Description of parameters
Request
| Request | |||
|---|---|---|---|
| Parameter | Required | Type | Description |
| appkey | Yes | string | Application key. To get the key, register |
sessionID | Yes | string | To get the session ID, use the User Authorization method |
| docID | Yes | string | Number of the order for delivery to the terminal placed with the help of "Placing LTL orders" method (or the number of the relevant waybill/order for shipping) for which delivery from the terminal to the sender's address need to be ordered (see "Adding delivery to the receiver's address" method) |
| delivery | Yes | object | Information on delivery |
| delivery.arrival | Yes | Arrival | Information on delivery to the receiver's address. An empty object can be passed |
Arrival
| Arrival | |||
|---|---|---|---|
| Parameter | Required | Type | Description |
| addressID | No | integer | Address ID from "Address book" Allows getting the list of possible completion dates in case of delivery to the address different from the one indicated in the waybill. Only one of the following parameters can be passed: "addressID", "address" or "city" |
| address | No | Address | Address data Allows getting the list of possible completion dates in case of delivery to the address different from the one indicated in the waybill. Only one of the following parameters can be passed: "addressID", "address" or "city" |
| city | No | string | City CLADR code. To get CLADR code use the services listed on "CLADR search" page Allows getting the list of possible completion dates in case of delivery to the city different from the one indicated in the waybill. Only one of the following parameters can be passed: "addressID", "address" or "city" |
| time | No | object | Information on delivery time |
| time.exactTime | No | boolean | Flag indicating that delivery at precise time is required. Default value: false |
| handling | No | object | Information on loading and unloading works |
| 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 carried |
| handling.carry | No | integer | Distance to which the cargo is to be carried, m |
| requirements | No | array of strings | UIDs of loading types/additional requirements to the truck. Possible values:
|
Address
Address | |||
|---|---|---|---|
| Parameter | Required | Type | Description |
search | No (1) | 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 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". Minimum 2 symbols, maximum 1024 (2) |
| street | No (1) | string | CLADR* code of the street (see. "CLADR search") (2). *CLADR - Classifier of Addresses of Russian Federation |
| house | No (1) | string | House number, including the letter. For example, "13/A" (2). Maximum 7 characters |
| building | No | string | Building (2). Maximum 5 characters |
| structure | No | string | Structure (2). Maximum 7 characters |
| flat | No | string | Apartment/office, including the letter. For example, "222 A" (2). Maximum 5 characters |
Notes:
| |||
Method response
Response structure
{
"metadata":{
"status":200,
"generated_at":"2020-06-03 09:06:54"
},
"data":{
"dates":[
"2020-06-04",
"2020-06-05",
"2020-06-06",
"2020-06-07",
"2020-06-08",
"2020-06-09",
"2020-06-10",
"2020-06-11",
"2020-06-12",
"2020-06-13",
"2020-06-14",
"2020-06-15",
"2020-06-16",
"2020-06-17",
"2020-06-18",
"2020-06-19",
"2020-06-20",
"2020-06-21",
"2020-06-22",
"2020-06-23",
"2020-06-24",
"2020-06-25",
"2020-06-26",
"2020-06-27",
"2020-06-28",
"2020-06-29",
"2020-06-30",
"2020-07-01",
"2020-07-02",
"2020-07-03",
"2020-07-04",
"2020-07-05",
"2020-07-06",
"2020-07-07",
"2020-07-08",
"2020-07-09",
"2020-07-10",
"2020-07-11",
"2020-07-12",
"2020-07-13",
"2020-07-14",
"2020-07-15",
"2020-07-16",
"2020-07-17",
"2020-07-18",
"2020-07-19",
"2020-07-20",
"2020-07-21",
"2020-07-22",
"2020-07-23",
"2020-07-24",
"2020-07-25",
"2020-07-26",
"2020-07-27",
"2020-07-28",
"2020-07-29",
"2020-07-30",
"2020-07-31",
"2020-08-01",
"2020-08-02"
],
"foundAddresses": [
{
"field": "delivery.derival.address",
"source": "Омск, Ленина, 5",
"result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
}
]
}
}<response>
<metadata>
<status>200</status>
<generated_at>2020-06-03 09:06:54</generated_at>
</metadata>
<data>
<dates>2020-06-04</dates>
<dates>2020-06-05</dates>
<dates>2020-06-06</dates>
<dates>2020-06-07</dates>
<dates>2020-06-08</dates>
<dates>2020-06-09</dates>
<dates>2020-06-10</dates>
<dates>2020-06-11</dates>
<dates>2020-06-12</dates>
<dates>2020-06-13</dates>
<dates>2020-06-14</dates>
<dates>2020-06-15</dates>
<dates>2020-06-16</dates>
<dates>2020-06-17</dates>
<dates>2020-06-18</dates>
<dates>2020-06-19</dates>
<dates>2020-06-20</dates>
<dates>2020-06-21</dates>
<dates>2020-06-22</dates>
<dates>2020-06-23</dates>
<dates>2020-06-24</dates>
<dates>2020-06-25</dates>
<dates>2020-06-26</dates>
<dates>2020-06-27</dates>
<dates>2020-06-28</dates>
<dates>2020-06-29</dates>
<dates>2020-06-30</dates>
<dates>2020-07-01</dates>
<dates>2020-07-02</dates>
<dates>2020-07-03</dates>
<dates>2020-07-04</dates>
<dates>2020-07-05</dates>
<dates>2020-07-06</dates>
<dates>2020-07-07</dates>
<dates>2020-07-08</dates>
<dates>2020-07-09</dates>
<dates>2020-07-10</dates>
<dates>2020-07-11</dates>
<dates>2020-07-12</dates>
<dates>2020-07-13</dates>
<dates>2020-07-14</dates>
<dates>2020-07-15</dates>
<dates>2020-07-16</dates>
<dates>2020-07-17</dates>
<dates>2020-07-18</dates>
<dates>2020-07-19</dates>
<dates>2020-07-20</dates>
<dates>2020-07-21</dates>
<dates>2020-07-22</dates>
<dates>2020-07-23</dates>
<dates>2020-07-24</dates>
<dates>2020-07-25</dates>
<dates>2020-07-26</dates>
<dates>2020-07-27</dates>
<dates>2020-07-28</dates>
<dates>2020-07-29</dates>
<dates>2020-07-30</dates>
<dates>2020-07-31</dates>
<dates>2020-08-01</dates>
<dates>2020-08-02</dates>
<foundAddresses>
<field>delivery.derival.address</field>
<source>Омск, Ленина, 5</source>
<result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
</foundAddresses>
</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 possible delivery dates |
| data.dates | array of strings | A list of possible delivery dates Format: YYYY-MM-DD |
| data.foundAddresses | array of FoundAddresses | Data on found addresses. The parameter is present in the response if "search" parameter of the "Address" class was passed in the request |
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 found |
Error handling
The common API errors are used with the method, for errors format description and errors list see Errors of API methods.
