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

API
Главная / API - Dispatch dates

Dispatch dates

Обновлено 02.05.2024
Скачать в PDF
180 кб
Содержание:

General information

The service allows getting the list of dates when the driver can pickup the cargo from sender's address or when the sender can submit the cargo at the terminal (the information can be used when placing an order with the help of "Placing LTL orders" method). The service is available to authorized as well as unauthorized users.

Pickup dates

Method request

Request structure

Method address: https://api.dellin.ru/v2/request/address/dates.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "delivery":{
      "deliveryType":{
         "type":"auto"
      },
      "derival":{
         "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"
         ]
      }
   },
   "cargo":{
      "quantity":4,
      "weight":12,
      "height":1,
      "width":1,
      "length":1,
      "totalVolume":1,
      "totalWeight":12
   }
}

Method address: https://api.dellin.ru/v2/request/address/dates.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <delivery>
      <deliveryType>
         <type>auto</type>
      </deliveryType>
      <derival>
         <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>
      </derival>
   </delivery>
   <cargo>
      <quantity>4</quantity>
      <weight>12</weight>
      <height>1</height>
      <width>1</width>
      <length>1</length>
      <totalVolume>1</totalVolume>
      <totalWeight>12</totalWeight>
   </cargo>
</request>

Description of parameters

Request
Request
ParameterRequiredTypeDescription
appkeyYesstringApplication key. To get the key, register
sessionIDNostring

To get the session ID, use the "User Authorization" method

deliveryYesobjectInformation on delivery
delivery.deliveryTypeYesDeliveryTypeInformation on type of terminal-to-terminal shipping
delivery.derivalYesDerival

Information on shipping from sender's the address

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 parameter is not required, passed value is ignored, the parameter takes the value "1"
cargo.weightNo*float

Weight of the heaviest cargo place, kg

*If quantity of the cargo places ("cargo.quantity" parameter value) is more than 1, then the parameter is required. Otherwise, the parameter takes the value of "cargo.totalWeight" parameter.
If the shipping type is "letter"  ("request.delivery.deliveryType.type" = "letter"), then the parameter is not required, 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, passed value is ignored, the parameter takes the value "0.01"
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, passed value is ignored, the parameter takes the value "0.21"
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, passed value is ignored, the parameter takes the value "0.3"
cargo.totalVolumeYes*float

Total cargo volume, m3

If the shipping type is "letter" ("request.delivery.deliveryType.type" = "letter"), then the parameter is not required, 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, passed value is ignored, the parameter takes the value "0.5"

DeliveryType
DeliveryType
ParameterRequiredTypeDescription

type

Yesstring

Shipping type.

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 30 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

Derival
Derival
ParameterRequiredTypeDescription
addressIDNo*integer

Address ID from "Address book"

*One of the excluding parameters is required: "addressID", "address" or "city"
addressNo*Address

Address data

*One of the excluding parameters is required: "addressID", "address" or "city"
cityNo*string

City CLADR code. To get CLADR code use the services listed on "CLADR search" page

*One of the excluding parameters is required: "addressID", "address" or "city"
timeNoobjectInformation on pickup time
time.exactTimeNoboolean

Flag indicating that picked up at precise time is required.

Default value: false

handlingNoobjectInformation on loading and unloading works
handling.freightLiftNoboolean

Flag indicating that there is a service lift.

Default value: false

handling.toFloorNointeger

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

handling.carryNointegerDistance to which the cargo is to be carried, m
requirementsNoarray of strings

UIDs of loading types/additional requirements to the truck.

Possible values:

  • 0xb83b7589658a3851440a853325d1bf69 - side loading;
  • 0xabb9c63c596b08f94c3664c930e77778 - top loading;
  • 0x92fce2284f000b0241dad7c2e88b1655 - tail lift;
  • 0x88f93a2c37f106d94ff9f7ada8efe886 - crane;
  • 0x9951e0ff97188f6b4b1b153dfde3cfec - open vehicle;
  • 0x818e8ff1eda1abc349318a478659af08 - removable curtains

Address

Address

ParameterRequiredTypeDescription

search

No*string

Address as text or as coordinates.

When passing an address as text, the request should include:

  • name of the region and its type: "область", "край", etc. (for correct parsing of addresses of citys of the same name);
  • city name;
  • street name;
  • house number.

The address elements should be separated by comma, for example "Омская обл., Омск, Ленина, 5".

When passing an address as coordinates, they should be separated by comma as well, the first number - latitude, for example "59.924501, 30.241762".

Minimum 2 characters, maximum 1024 characters

*Passing the "search" parameter or a pair of "street" and "house" parameters is required.
The "search" parameter and the "street", "house", "building" and "structure" parameter set are mutually exclusive
If errors occur while parsing the address string, we recommend using address selection methods
streetNo*string

CLADR* code of the street (see. "CLADR search").

*CLADR - Classifier of Addresses of Russian Federation

*Passing the "search" parameter or a pair of "street" and "house" parameters is required.
The "search" parameter and the "street", "house", "building" and "structure" parameter set are mutually exclusive
houseNo*string

House number, including the letter. For example, "13/A".

Maximum 7 characters

*Passing the "search" parameter or a pair of "street" and "house" parameters is required.
The "search" parameter and the "street", "house", "building" and "structure" parameter set are mutually exclusive
buildingNostring

Building.

Maximum 5 characters

The "search" parameter and the "street", "house", "building" and "structure" parameter set are mutually exclusive
structureNostring

Structure.

Maximum 7 characters

The "search" parameter and the "street", "house", "building" and "structure" parameter set are mutually exclusive
flatNostring

Apartment/office, including the letter. For example, "222 A".

Maximum 5 characters

If “search” and “flat” parameters are both passed in the request, then the value of the “flat” parameter will be used as the apartment/office number

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
ParameterTypeDescription
metadataobjectSystem information
metadata.statusintegerEmulated 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 possible pickup dates
data.datesarray of strings

A list of possible pickup dates

Format: YYYY-MM-DD

data.foundAddressesarray of FoundAddressesData on found addresses. The parameter is present in the response if "search" parameter of the "Address" class was passed in the request

FoundAddresses
FoundAddresses
ParameterTypeDescription
fieldstringThe parent object that was used to pass the "search" parameter
sourcestring

Entered value

resultstring

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.

Dates of cargo handover at the terminal 

Method request

Request structure

Method address: https://api.dellin.ru/v2/request/terminal/dates.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "delivery":{
      "derival":{
         "terminalID":310
      }
   }
}

Method address: https://api.dellin.ru/v2/request/terminal/dates.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <delivery>
      <derival>
         <terminalID>310</terminalID>
      </derival>
   </delivery>
</request>

Description of parameters

Request
Request
ParameterRequiredTypeDescription
appkeyYesstringApplication key. To get the key, register
sessionIDNostring

To get the session ID, use the "User Authorization" method

deliveryYesobjectInformation on delivery
delivery.derivalYesDerival

Information on shipping from the terminal

Derival
Derival
ParameterRequiredTypeDescription
terminalIDYesinteger

Terminal ID from "Terminals" directory

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"
      ]
   }
}
<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>
   </data>
</response>

Description of parameters

Response
Response
ParameterTypeDescription
metadataobjectSystem information
metadata.statusintegerEmulated 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 possible dates of order completion
data.datesarray of strings

A list of possible dates of cargo handover at the terminal

Format: YYYY-MM-DD

Error handling

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