Intercity transportation by dedicated truck

Обновлено 21.02.2023

221 кб

General information

This service allows ordering intercity transportation by dedicated truck. The transportation is carried out from the sender's address to the receiver's address (with loading/unloading in intermediate points if necessary). The service is available to authorized as well as unauthorized users. Authorized users can use address book data as well as update it when creating an order.

Intercity transportation by dedicated truck

Method request

Method address: https://api.dellin.ru/v1/ftl/request.json

{
   "appKey":"00000000-0000-0000-0000-000000000000",
   "sessionId":"00000000-0000-0000-0000-000000000000",
   "trailerType":"tent",
   "tentRequirements":[
      "removable_rack"
   ],
   "delivery":{
      "derival":{
         "addressID":3075,
         "address":{
            "search":"Омск, Ленина, 5",
            "street":"5500000100005970000000000",
            "house":"5",
            "building":"1",
            "structure":"2",
            "flat":"100",
            "save":false
         },
         "time":{
            "worktimeStart":"10:00",
            "worktimeEnd":"18:00",
            "breakStart":"12:00",
            "breakEnd":"13:00"
         },
         "documentsForReceive":[
            "0x90bc42c2d8cf7c1c47a40fc1ccfb54d5"
         ],
         "services":{
            "tentingRemoval":"side",
            "placesRecount":false
         }
      },
      "arrival":{
         "addressID":3076,
         "address":{
            "search":"Омск, Ленина, 5",
            "street":"5500000100005970000000000",
            "house":"5",
            "building":"1",
            "structure":"2",
            "flat":"100",
            "save":false
         },
         "time": {
            "worktimeStart":"10:00",
            "worktimeEnd":"18:00",
            "breakStart":"12:00",
            "breakEnd":"13:00"
         },
         "services":{
            "tentingRemoval":"side",
            "placesRecount":false,
            "unloadingRamp":false,
            "fridgeThermalReport":false
         }
      },
      "transit":[
         {
            "addressID":3077,
            "address":{
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"2",
               "flat":"100",
               "save":false
            },
            "time":{
               "worktimeStart":"10:00",
               "worktimeEnd":"18:00",
               "breakStart":"12:00",
               "breakEnd":"13:00"
            },
            "services":{
               "tentingRemoval":"side ",
               "loadingPlacesRecount":false,
               "unloadingPlacesRecount":false,
               "unloadingRamp":false
            }
         }
      ],
      "smsback":"79503334444",
      "emailback":"examble@gmail.com",
      "comment":"Текст комментария"
   },
   "members":{
      "requester":{
         "role":"third",
         "uid":"aa00a000-a600-0000-a000-00aa0aaa0a00"
      },
      "sender":{
         "counteragentID":2010,
         "counteragent":{
            "form":"0xaa9042fea4fa169d4d021c6941f2090f",
            "name":"ИП Иванов И. И",
            "inn":"550797658844",
            "document": {
               "type":"passport ",
               "serial":"0000",
               "number":"000000"
            },
            "juridicalAddress":{
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"2",
               "flat":"100",
               "save":false
            },
            "save":false
         },
         "contactID":[
            12345
         ],
         "contactPersons":[
            {
               "name":"Иванов Иван",
               "save":true
            }
         ],
         "phoneID":[
            12345
         ],             
         "phoneNumbers":[
            {
               "number":"79136333344",
               "save":true
            }
         ]
      },
      "transit":[
         {
            "counteragentID":2011,
            "counteragent":{
               "form":"0xaa9042fea4fa169d4d021c6941f2090f",
               "name":"ИП Сидоров",
               "inn":"550797658833",
               "document":{
                  "type":"passport ",
                  "serial":"0000",
                  "number":"000000"
               },
               "juridicalAddress":{
                  "search":"Омск, Ленина, 5",
                  "street":"5500000100005970000000000",
                  "house":"5",
                  "building":"1",
                  "structure":"2",
                  "flat":"100",
                  "save":false
               },
               "save":false
         },
         "contactID":[
            78945
         ],
         "contactPersons":[
            {
               "name":"Петр",
               "save":true
            }
         ],
         "phoneID":[
            78945
         ], 
         "phoneNumbers":[
            {
               "number":"79131133344",
               "save":true
            }
         ]
      }],
      "receiver":{
         "counteragentID":2012,
         "counteragent":{
            "form":"0xaa9042fea4fa169d4d021c6941f2090f",
            "name":"ИП Петров",
            "inn":"550797658822",
            "document":{
               "type":"passport",
               "serial":"0000",
               "number":"000000"
            },
            "juridicalAddress":{
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"2",
               "flat":"100",
               "save":false
            },
            "save":false
         },
         "contactID":[
            45612
         ],
         "contactPersons":[
            {
               "name":"Иван",
               "save":true
            }
         ],
         "phoneID":[
            45612
         ], 
         "phoneNumbers":[
            {
               "number":"79132233344",
               "save":true
            }
         ]
      },
      "third":{
         "counteragentID":2013,
         "counteragent":{
            "form":"0xAB91FEEA04F6D4AD48DF42161B6C2E7A",
            "name":"Шариков П. П.",
            "inn":"550797658844",
            "document":{
               "type":"passport",
               "serial":"0000",
               "number":"000000"
            },
            "juridicalAddress":{
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"2",
               "flat":"100",
               "save":false
            },
            "save":false
         },
         "contactID":[
            65421
         ],
         "contactPersons":[
            {
               "name":"Фёдор",
               "save":true
            }
         ],
         "phoneID":[
            65421
         ], 
         "phoneNumbers":[
            {
               "number":"79131133355",
               "save":true
            }
         ]
      }
   },
   "produceDate":"2020-04-15",
   "cargo": {
      "freightUID":"eddb67e3-bdb3-11e0-ad24-001a64963cbd"
   },
   "gpsReport":false,
   "payment":{
      "primaryPayer":"sender",
      "smsForBill":"79507878787",
      "emailForBill":"example@gmail.com"
   }
}

Method address: https://api.dellin.ru/v1/ftl/request.xml

<request>
   <appKey>00000000-0000-0000-0000-000000000000</appKey>
   <sessionId>00000000-0000-0000-0000-000000000000</sessionId>
   <trailerType>tent</trailerType>
   <tentRequirements>removable_rack</tentRequirements>
   <delivery>
      <derival>
         <addressID>3075</addressID>
         <address>
            <search>Омск, Ленина, 5</search>
            <street>5500000100005970000000000</street>
            <house>5</house>
            <building>1</building>
            <structure>2</structure>
            <flat>100</flat>
            <save>false</save>
         </address>
         <time>
            <worktimeStart>10:00</worktimeStart>
            <worktimeEnd>18:00</worktimeEnd>
            <breakStart>12:00</breakStart>
            <breakEnd>13:00</breakEnd>
         </time>
         <documentsForReceive>0x90bc42c2d8cf7c1c47a40fc1ccfb54d5</documentsForReceive>
         <services>
            <tentingRemoval>side</tentingRemoval>
            <placesRecount>false</placesRecount>
         </services>
      </derival>
      <arrival>
         <addressID>3076</addressID>
         <address>
            <search>Омск, Ленина, 5</search>
            <street>5500000100005970000000000</street>
            <house>5</house>
            <building>1</building>
            <structure>2</structure>
            <flat>100</flat>
            <save>false</save>
         </address>
         <time>
            <worktimeStart>10:00</worktimeStart>
            <worktimeEnd>18:00</worktimeEnd>
            <breakStart>12:00</breakStart>
            <breakEnd>13:00</breakEnd>
         </time>
         <services>
            <tentingRemoval>side</tentingRemoval>
            <placesRecount>false</placesRecount>
            <unloadingRamp>false</unloadingRamp>
            <fridgeThermalReport>false</fridgeThermalReport>
         </services>
      </arrival>
      <transit>
         <addressID>3077</addressID>
         <address>
            <search>Омск, Ленина, 5</search>
            <street>5500000100005970000000000</street>
            <house>5</house>
            <building>1</building>
            <structure>2</structure>
            <flat>100</flat>
            <save>false</save>
         </address>
         <time>
            <worktimeStart>10:00</worktimeStart>
            <worktimeEnd>18:00</worktimeEnd>
            <breakStart>12:00</breakStart>
            <breakEnd>13:00</breakEnd>
         </time>
         <services>
            <tentingRemoval>side </tentingRemoval>
            <loadingPlacesRecount>false</loadingPlacesRecount>
            <unloadingPlacesRecount>false</unloadingPlacesRecount>
            <unloadingRamp>false</unloadingRamp>
         </services>
      </transit>
      <smsback>79503334444</smsback>
      <emailback>examble@gmail.com</emailback>
      <comment>Текст комментария</comment>
   </delivery>
   <members>
      <requester>
         <role>third</role>
         <uid>aa00a000-a600-0000-a000-00aa0aaa0a00</uid>
      </requester>
      <sender>
         <counteragentID>2010</counteragentID>
         <counteragent>
            <form>0xaa9042fea4fa169d4d021c6941f2090f</form>
            <name>ИП Иванов И. И</name>
            <inn>550797658844</inn>
            <document>
               <type>passport </type>
               <serial>0000</serial>
               <number>000000</number>
            </document>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <building>5</building>
               <flat>1</flat>
               <house>2</house>
               <structure>1</structure>
               <save>false</save>
            </juridicalAddress>
            <save>false</save>
         </counteragent>
         <contactID>12345</contactID>
         <contactPersons>
            <name>Иванов Иван</name>
            <save>true</save>
         </contactPersons>
         <phoneID>12345</phoneID>
         <phoneNumbers>
            <number>79136333344</number>
            <save>true</save>
         </phoneNumbers>
      </sender>
      <transit>
         <counteragentID>2011</counteragentID>
         <counteragent>
            <form>0xaa9042fea4fa169d4d021c6941f2090f</form>
            <name>ИП Сидоров</name>
            <inn>550797658833</inn>
            <document>
               <type>passport </type>
               <serial>0000</serial>
               <number>000000</number>
            </document>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <building>5</building>
               <flat>1</flat>
               <house>2</house>
               <structure>100</structure>
               <save>false</save>
            </juridicalAddress>
            <save>false</save>
         </counteragent>
         <contactID>78945</contactID>
         <contactPersons>
            <name>Петр</name>
            <save>true</save>
         </contactPersons>
         <phoneID>78945</phoneID>
         <phoneNumbers>
            <number>79131133344</number>
            <save>true</save>
         </phoneNumbers>
      </transit>
      <receiver>
         <counteragentID>2012</counteragentID>
         <counteragent>
            <form>0xaa9042fea4fa169d4d021c6941f2090f</form>
            <name>ИП Петров</name>
            <inn>550797658822</inn>
            <document>
               <type>passport</type>
               <serial>0000</serial>
               <number>000000</number>
            </document>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <building>5</building>
               <flat>1</flat>
               <house>2</house>
               <structure>100</structure>
               <save>false</save>
            </juridicalAddress>
            <save>false</save>
         </counteragent>
         <contactID>45612</contactID>
         <contactPersons>
            <name>Иван</name>
            <save>true</save>
         </contactPersons>
         <phoneID>45612</phoneID>
         <phoneNumbers>
            <number>79132233344</number>
            <save>true</save>
         </phoneNumbers>
      </receiver>
      <third>
         <counteragentID>2013</counteragentID>
         <counteragent>
            <form>0xAB91FEEA04F6D4AD48DF42161B6C2E7A</form>
            <name>Шариков П. П.</name>
            <inn>550797658844</inn>
            <document>
               <type>passport</type>
               <serial>0000</serial>
               <number>000000</number>
            </document>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <building>5</building>
               <flat>1</flat>
               <house>2</house>
               <structure>100</structure>
               <save>false</save>
            </juridicalAddress>
            <save>false</save>
         </counteragent>
         <contactID>65421</contactID>
         <contactPersons>
            <name>Фёдор</name>
            <save>true</save>
         </contactPersons>
         <phoneID>65421</phoneID>
         <phoneNumbers>
            <number>79131133355</number>
            <save>true</save>
         </phoneNumbers>
      </third>
   </members>
   <produceDate>2020-04-15</produceDate>
   <cargo>
      <freightUID>eddb67e3-bdb3-11e0-ad24-001a64963cbd</freightUID>
   </cargo>
   <gpsReport>false</gpsReport>
   <payment>
      <primaryPayer>sender</primaryPayer>
      <smsForBill>79507878787</smsForBill>
      <emailForBill>example@gmail.com</emailForBill>
   </payment>
</request>

Description of parameters

Request

Request
Parameter	Required	Type	Description
appkey	Yes	string	Application key. To get the key, register
sessionID	No	string	To get the session ID, use the "User Authorization" method
trailerType	Yes	string	Truck type. Possible values: "isoterm" - insulated; "tent" - curtainside; "fridge" - refrigerator
tentRequirements	No	array of strings	Additional requirements to the curtainside truck ("trailerType" parameter value is "tent") . Possible values: "hard_board" - rigid; "removable_beam" - removable top beam; "removable_rack" - removable side rails. Several values can be passed. The parameter is ignored for insulated/refrigerator trucks ("trailerType" prameter value is "isoterm"/"fridge")
delivery	Yes	object	Information on way points
delivery.derival	Yes	Waypoint	Information on point of departure
delivery.arrival	Yes	Waypoint	Information on point of arrival
delivery.transit	No	array of Waypoint	Information on intermediate points - 4 points maximum It is not possible to indicate an intermediate point in case a refrigerator tuck is ordered (the request "trailerType" parameter value is "fridge")
delivery.smsback	Yes	string	Contact phone number for SMS-notifications. Format: "7XXXXXXXXXX" (11 digits starting with 7)
delivery.emailback	Yes	string	Contact email. 128 characters maximum
delivery.comment	No	string	Additional information on the order. 500 characters maximum
members	Yes	object	Shipping parties
members.requester	Yes	Requester	Client data
members.sender	Yes	Member	Sender data
members.transit	No*	array of Member	Data of intermediate point counterparty *If the request contains at least one "delivery.transit" parameter, then the parameter is required. The number of "members.transit" elements should equal to the number of "delivery.transit" elements
members.receiver	Yes	Member	Receiver data
members.third	No	Member	Third party data
produceDate	Yes	string	The date of arrival of the truck to the point of departure/to the sender. Format: YYYY-MM-DD
cargo	Yes	object	Information on the cargo
cargo.freightUID	Yes	string	Cargo UID (see "Nature of cargo: search by string (dedicated truck transportation)" directory)
gpsReport	No	boolean	Flag indicating that GPS report on transportation is required
payment	Yes	object	Payer data
payment.primaryPayer	Yes	string	Payer role Possible values: "sender"; "receiver"; "third" - third party
payment.smsForBill	No	string	Phone number for sending the payment receipt. Format: "7XXXXXXXXXX" (11 digits starting with 7) The parameter is used only for individuals
payment.emailForBill	No	string	Email address for sending the payment receipt. 128 characters maximum The parameter is used only for individuals

Waypoint

Waypoint
Parameter	Required	Type	Description
addressID	No*	integer	Address ID from "Address book" *If the user is unauthorized ("sessionID" parameter is not passed in the request), then the parameter is ignored. If the user is authorized ("sessionID" parameter is passed in the request), then one of the excluding parameters is required: "addressID" or "address"
address	No*	Address	Address data *If the user is unauthorized ("sessionID" parameter is not passed in the request), then the parameter is required. If the user is authorized ("sessionID" parameter is passed in the request), then one of the excluding parameters is required: "addressID" or "address"
time	Yes	object	Loading/unloading period
time.worktimeStart	Yes	string	Period start. Format: HH:MM
time.worktimeEnd	Yes	string	Period end. Format: HH:MM
time.breakStart	No	string	Break start. Format: HH:MM
time.breakEnd	No	string	Break end. Format: HH:MM
documentsForReceive	Yes	array of strings	Document UID from "Documents for receipt of cargo" For "delivery.derival" object only
services	Yes	object	Additional services
services.tentingRemoval	No	string	Curtains removal. Possible values: "back"; "top"; "side"; "full". Default value is "back" Curtains removal is available only if a curtainside truck is ordered (that is when "tent" value is passed for "trailerType" parameter), but it is not available if a rigid body truck is ordered ("tentRequirements" parameter with "hard_board" value is passed in the request)
services.placesRecount	No	boolean	Flag indicating that it is necessary to count cargo places at the point of departure/arrival Only for "delivery.derival" and "delivery.arrival" objects
services.loadingPlacesRecount	No	boolean	Flag indicating that it is necessary to count cargo places at intermediate point while loading the truck The service is unavailable if a refrigerator truck is ordered ("fridge" value is passed for "trailerType" parameter).For "delivery.transit" object only
services.unloadingPlacesRecount	No	boolean	Flag indicating that it is necessary to count cargo places at intermediate point while unloading the truck The service is unavailable if a refrigerator truck is ordered ("fridge" value is passed for "trailerType" parameter).For "delivery.transit" object only
services.unloadingRamp	No	boolean	Flag indicating that ramp unloading is necessary The service is available for curtainside/insulated trucks in case top curtain removal is not ordered ("tent"/"isoterm" value is passed for "trailerType" parameter, "top" value is not passed for "tentRequirements" parameter). Only for "delivery.transit" and "delivery.arrival" objects
services.fridgeThermalReport	No	boolean	Flag indicating that temperature conditions report is necessary The service is available only for refrigerator trucks ("fridge" value is passed for "trailerType" parameter). For "delivery.arrival" object only

Requester

Parameter

Required

Type

Description

role

Yes

string

Client role.

Possible values:

sender;
receiver;
payer;
third - third party

uid

No*

string

Counterparty UID, see "List of available counterparties".

*If the user is authorized ("sessionID" parameter is passed in the request), then parameter is required. The current account should have full access to the counterparty (see "Available counterparties" method, response parameter "info.accessLevel")

Member

Member
Parameter	Required	Type	Description
counteragentID	No*	integer	Counterparty ID from "Address book" *If the user is unauthorized, then parameter is ignored. For authorized users one of the excluding parameters is required: "counteragentID" or "counteragent"
counteragent	No*	object	Counterparty info *The parameter is required for unauthorized users. For authorized users one of the excluding parameters is required: "counteragentID" or "counteragent"
counteragent.form	Yes	string	UID of legal form of organization from the "Search of forms of organization"
counteragent.name	Yes	string	Individual or company name
counteragent.inn	No*	string	TIN (taxpayer identification number). Allowed number of characters may vary depending on country and legal form of organization. The parameter is used for legal entities only (that is when legal entity UID is passed in the "counteragent.form" parameter) *If the counterparty is a legal entity, the parameter is required
counteragent.document	No*	Document	Personal ID data. The parameter is used only for individuals (that is when an individual UID is passed in the "counteragent.form" parameter) *If the counterparty is an individual, the parameter is required
counteragent.juridicalAddress	No	Address	Legal address. The parameter is used for legal entities only (that is when legal entity UID is passed in the "counteragent.form" parameter)
counteragent.save	No	boolean	Flag indicating that the counterparty data should be saved to the address book (see counterparties-related methods of the address book) Only authorized users can save the objects to the address book
contactID	No*	array of integers	Contact persons IDs from "Address book". Maximum 3 elements in the array *If the user is unauthorized, then parameter is ignored. For authorized users one of the excluding parameters is required: "contactID" or "contactPersons"
contactPersons	No*	array of contactPersons	Contact persons data. Maximum 3 elements in the array for authorized users, 1 - for unauthorized *The parameter is required for unauthorized users. For authorized users one of the excluding parameters is required: "contactID" or "contactPersons"
contactPersons.name	Yes	string	Contact person name
contactPersons.save	No	boolean	Flag indicating that the contact person data should be saved to the address book (see contact details-related methods of the address book). Default value is "false" Only authorized users can save the objects to the address book. In case of "members.third" object the parameter is ignored
phoneID	No*	array of integers	Phone number IDs from "Address book". Maximum 3 elements in the array *If the user is unauthorized, then parameter is ignored. For authorized users one of the excluding parameters is required: "phoneID" or "phoneNumbers"
phoneNumbers	No*	array of phoneNumbers	Phone numbers list. Maximum 3 elements in the array for authorized users, 1 - for unauthorized *The parameter is required for unauthorized users. For authorized users one of the excluding parameters is required: "phoneID" or "phoneNumbers"
phoneNumbers.number	Yes	string	Phone number. Only digits and plus sign are allowed (plus can only be passed at the beginning of the string that starts with 7 or 375)
phoneNumbers.save	No	boolean	Flag indicating that the phone number should be saved to the address book (see contact details-related methods of the address book) Only authorized users can save the objects to the address book. In case of "members.third" object the parameter is ignored

Document

Document
Parameter	Required	Type	Description
type	Yes	string	Document type. Possible values: "passport"; "drivingLicence"; "foreignPassport" - international passport. For some countries "foreignPassport" value is not available
serial	Yes*	string	Document series *For some countries the parameter is not required and therefore ignored
number	Yes	string	Document number. Number format may vary depending on the country

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. The coordinates should not be used to pass the information about the juridical address, that is in blocks "juridicalAddress" of class "Counteragent". 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". Maximum 1024 symbols (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
save	No	boolean	Flag indicating that the address should be saved to the address book (see addresses-related methods of the address book) Only authorized users can save the objects to the address book. In case of "counteragent.juridicalAddress" object the parameter is ignored (to update the legal address pass "true" value for "counteragent.save" parameter)
Notes: Address information must be passed in the request therefore either "search" parameter is required or "street" and "house" parameters are required. If "search" parameter is passed in the request, then "street", "house", "building" and "structure" parameters must not be passed, but "flat" parameter may be passed (in this case the value of the "flat" parameter will be used as an apartment/office number)

Method response

Response structure

JSON
XML

{
   "metadata":{
      "status":201,
      "generated_at":"2020-06-17 15:15:58"
   },
   "data":{
      "orderNumber":"ДЛТ000001322783",
      "addressBook":{
         "sender":{
            "counteragent":{
               "id":2009,
               "state":"existing"
            },
            "address":{
               "id":3074,
               "state":"existing"
            },
            "phoneNumbers":[
               {
                  "id":15016,
                  "state":"existing",
                  "value":"79136444444"
               }
            ],
            "contactPersons":[
               {
                  "id":14978,
                  "state":"existing",
                  "value":"Иванов Иван"
               }
            ]
         },
         "transit":{
            "counteragent":{
               "id":2020,
               "state":"existing"
            },
            "address":{
               "id":3090,
               "state":"existing"
            },
            "phoneNumbers":[
               {
                  "id":15918,
                  "state":"existing",
                  "value":"+79135333333"
               }
            ],
            "contactPersons":[
               {
                  "id":14990,
                  "state":"existing",
                  "value":"Соколова В. В."
               }
            ]
         },
         "receiver":{
            "counteragent":{
               "id":2010,
               "state":"existing"
            },
            "address":{
               "id":3075,
               "state":"existing"
            },
            "phoneNumbers":[
               {
                  "id":15018,
                  "state":"existing",
                  "value":"+79136333333"
               }
            ],
            "contactPersons":[
               {
                  "id":14979,
                  "state":"existing",
                  "value":"Петрова Н. В."
               }
            ]
         },
         "third":{
            "counteragent":{
               "id":2011,
               "state":"existing"
            }
         }
      },
      "foundAddresses": [
         {
            "field": "delivery.derival.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "delivery.arrival.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "delivery.transit.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.sender.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.transit.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.receiver.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.third.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         }
      ]
   }
}

<response>
   <metadata>
      <status>201</status>
      <generated_at>2020-06-17 15:15:58</generated_at>
   </metadata>
   <data>
      <orderNumber>ДЛТ000001322783</orderNumber>
      <addressBook>
         <sender>
            <counteragent>
               <id>2009</id>
               <state>existing</state>
            </counteragent>
            <address>
               <id>3074</id>
               <state>existing</state>
            </address>
            <phoneNumbers>
               <id>15016</id>
               <state>existing</state>
               <value>79136444444</value>
            </phoneNumbers>
            <contactPersons>
               <id>14978</id>
               <state>existing</state>
               <value>Иванов Иван</value>
            </contactPersons>
         </sender>
         <transit>
            <counteragent>
               <id>2020</id>
               <state>existing</state>
            </counteragent>
            <address>
               <id>3090</id>
               <state>existing</state>
            </address>
            <phoneNumbers>
               <id>15918</id>
               <state>existing</state>
               <value>+79135333333</value>
            </phoneNumbers>
            <contactPersons>
               <id>14990</id>
               <state>existing</state>
               <value>Соколова В. В.</value>
            </contactPersons>
         </transit>
         <receiver>
            <counteragent>
               <id>2010</id>
               <state>existing</state>
            </counteragent>
            <address>
               <id>3075</id>
               <state>existing</state>
            </address>
            <phoneNumbers>
               <id>15018</id>
               <state>existing</state>
               <value>+79136333333</value>
            </phoneNumbers>
            <contactPersons>
               <id>14979</id>
               <state>existing</state>
               <value>Петрова Н. В.</value>
            </contactPersons>
         </receiver>
         <third>
            <counteragent>
               <id>2011</id>
               <state>existing</state>
            </counteragent>
         </third>
      </addressBook>
      <foundAddresses>
         <field>delivery.derival.address</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>delivery.arrival.address</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>delivery.transit.address</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.sender.counteragent.juridicalAddress</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.transit.counteragent.juridicalAddress</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.receiver.counteragent.juridicalAddress</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.third.counteragent.juridicalAddress</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 201 (Created) is returned
metadata.generated_at	string	Server response date and time. Format: YYYY-MM-DD HH:MM:SS
data	Data	Information about the order

Data

Data
Параметр	Тип	Описание
orderNumber	string	Order number
addressBook	object	Information on new/edited objects from the address book
addressBook.sender	Member	Sender data
addressBook.transit	Member	Data of intermediate point counterparty
addressBook.receiver	Member	Receiver data
addressBook.third	Member	Third party 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

Member

Member
Параметр	Тип	Описание
counteragent	BookItem	Counterparty data (see counterparties-related methods of the address book)
address	BookItem	Address data (see addresses-related methods of the address book) (1)
phoneNumbers	array of BookItem	Phone number data (see contact details-related methods of the address book) (1)
contactPersons	array of BookItem	Contact person data (see contact details-related methods of the address book) (1)
Notes: The parameter is not used for "addressBook.third" object

BookItem

BookItem
Параметр	Тип	Описание
id	integer	ID of the new/updated object of address book
state	string	Object status. Possible Values: "existing" - the existing object has been edited; "new" - a new object has been created
value	string	Phone number (in case of "phoneNumbers" object)/contact person name (in case of "contactPersons" object) The parameter is not used for "counteragent" and "address" objects

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.

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

Intercity transportation by dedicated truck

General information

Intercity transportation by dedicated truck

Method request

Request structure

Description of parameters

Request

Waypoint

Requester

Member

Document

Address

Method response

Response structure

Description of parameters

Response

Data

Member

BookItem

FoundAddresses

Error handling