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

API
Главная / API - Orders for FTL

Orders for intercity transportation by dedicated truck

Обновлено 13.07.2020
207 кб

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.

Order for shipping by dedicated truck

Method request

Request example

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": {
                "street": "7800000000004380000000000",
                "building": "3",
                "flat": "100",
                "house": "15",
                "structure": "2",
                "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": {
                "street": "7800000000004380000000000",
                "building": "1",
                "flat": "100",
                "house": "1",
                "structure": "1",
                "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": {
                "street": "7800000000004380000000000",
                "building": "8",
                "flat": "2",
                "house": "5",
                "structure": "5",
                "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": {
                    "street": "7800000000004380000000000",
                    "building": "1",
                    "flat": "1",
                    "house": "1",
                    "structure": "1",
                    "save": false
                },
                "save": false
            },
            "contactID": [
                12345
            ],
            "contactPersons": [
                {
                    "name": "Иванов Иван",
                    "save": true
                }
            ],
            "phoneID": [
                12345
            ],             
            "phoneNumbers": [
                {
                    "ext": "12346",
                    "number": "79136333344",
                    "save": true
                }
            ]
        },
        "transit": [{
            "counteragentID": 2011,
            "counteragent": {
                "form": "0xaa9042fea4fa169d4d021c6941f2090f",
                "name": "ИП Сидоров",
                "inn": "550797658833",
                "document": {
                    "type": "passport ",
                    "serial": "0000",
                    "number": "000000"
                },
                "juridicalAddress": {
                    "street": "7800000000004380000000000",
                    "building": "2",
                    "flat": "2",
                    "house": "2",
                    "structure": "2",
                    "save": false
                },
                "save": false
            },
            "contactID": [
                78945
            ],
            "contactPersons": [
                {
                    "name": "Петр",
                    "save": true
                }
            ],
            "phoneID": [
                78945
            ], 
            "phoneNumbers": [
                {
                    "ext": "12346",
                    "number": "79131133344",
                    "save": true
                }
            ]
        }],
        "receiver": {
            "counteragentID": 2012,
            "counteragent": {
                "form": "0xaa9042fea4fa169d4d021c6941f2090f",
                "name": "ИП Петров",
                "inn": "550797658822",
                "document": {
                    "type": "passport",
                    "serial": "0000",
                    "number": "000000"
                },
                "juridicalAddress": {
                    "street": "7800000000004380000000000",
                    "building": "3",
                    "flat": "3",
                    "house": "3",
                    "structure": "3",
                    "save": false
                },
                "save": false
            },
            "contactID": [
                45612
            ],
            "contactPersons": [
                {
                    "name": "Иван",
                    "save": true
                }
            ],
            "phoneID": [
                45612
            ], 
            "phoneNumbers": [
                {
                    "ext": "12346",
                    "number": "79132233344",
                    "save": true
                }
            ]
        },
        "third": {
            "counteragentID": 2013,
            "counteragent": {
                "form": "0xAB91FEEA04F6D4AD48DF42161B6C2E7A",
                "name": "Шариков П. П.",
                "inn": "550797658844",
                "document": {
                    "type": "passport",
                    "serial": "0000",
                    "number": "000000"
                },
                "juridicalAddress": {
                    "street": "7800000000004380000000000",
                    "building": "4",
                    "flat": "4",
                    "house": "4",
                    "structure": "4",
                    "save": false
                },
                "save": false
            },
            "contactID": [
                65421
            ],
            "contactPersons": [
                {
                    "name": "Фёдр",
                    "save": true
                }
            ],
            "phoneID": [
                65421
            ], 
            "phoneNumbers": [
                {
                    "ext": "12346",
                    "number": "79131133355",
                    "save": true
                }
            ]
        }
    },
    "produceDate": "2020-04-15",
    "cargo": {
        "freightUID": "eddb67e3-bdb3-11e0-ad24-001a64963cbd",
        "freightName": "Мебель"
    },
    "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>
            <street>7800000000004380000000000</street>
            <building>3</building>
            <flat>100</flat>
            <house>15</house>
            <structure>2</structure>
            <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>
            <street>7800000000004380000000000</street>
            <building>1</building>
            <flat>100</flat>
            <house>1</house>
            <structure>1</structure>
            <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>
            <street>7800000000004380000000000</street>
            <building>8</building>
            <flat>2</flat>
            <house>5</house>
            <structure>5</structure>
            <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>
               <street>7800000000004380000000000</street>
               <building>1</building>
               <flat>1</flat>
               <house>1</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>
            <ext>12346</ext>
            <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>
               <street>7800000000004380000000000</street>
               <building>2</building>
               <flat>2</flat>
               <house>2</house>
               <structure>2</structure>
               <save>false</save>
            </juridicalAddress>
            <save>false</save>
         </counteragent>
         <contactID>78945</contactID>
         <contactPersons>
            <name>Петр</name>
            <save>true</save>
         </contactPersons>
         <phoneID>78945</phoneID>
         <phoneNumbers>
            <ext>12346</ext>
            <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>
               <street>7800000000004380000000000</street>
               <building>3</building>
               <flat>3</flat>
               <house>3</house>
               <structure>3</structure>
               <save>false</save>
            </juridicalAddress>
            <save>false</save>
         </counteragent>
         <contactID>45612</contactID>
         <contactPersons>
            <name>Иван</name>
            <save>true</save>
         </contactPersons>
         <phoneID>45612</phoneID>
         <phoneNumbers>
            <ext>12346</ext>
            <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>
               <street>7800000000004380000000000</street>
               <building>4</building>
               <flat>4</flat>
               <house>4</house>
               <structure>4</structure>
               <save>false</save>
            </juridicalAddress>
            <save>false</save>
         </counteragent>
         <contactID>65421</contactID>
         <contactPersons>
            <name>Фёдр</name>
            <save>true</save>
         </contactPersons>
         <phoneID>65421</phoneID>
         <phoneNumbers>
            <ext>12346</ext>
            <number>79131133355</number>
            <save>true</save>
         </phoneNumbers>
      </third>
   </members>
   <produceDate>2020-04-15</produceDate>
   <cargo>
      <freightUID>eddb67e3-bdb3-11e0-ad24-001a64963cbd</freightUID>
      <freightName>Мебель</freightName>
   </cargo>
   <gpsReport>false</gpsReport>
   <payment>
      <primaryPayer>sender</primaryPayer>
      <smsForBill>79507878787</smsForBill>
      <emailForBill>example@gmail.com</emailForBill>
   </payment>
</root>

Description of parameters

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

sessionID

Nostring

To get the session ID, use the User Authorization method

trailerType

Yesstring

Truck type.

Possible values:

  • "isoterm" - insulated;
  • "tent" - curtainside;
  • "fridge" - refrigerator

tentRequirements

Noarray 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")

deliveryYesobjectInformation on way points

delivery.derival

YesWaypointInformation on point of departure

delivery.arrival

YesWaypointInformation on point of arrival

delivery.transit

Noarray 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.smsbackYesstring

Contact phone number for SMS-notifications.

Format: "7XXXXXXXXXX" (11 digits starting with 7)

delivery.emailbackYesstringContact email. 128 characters maximum
delivery.commentNostringAdditional information on the order. 500 characters maximum
membersYesobjectShipping parties
members.requesterYesRequesterClient data
members.senderYesMemberSender data
members.transitNo*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.receiverYesMemberReceiver data

members.third

NoMemberThird party data
produceDateYesstring

The date of arrival of the truck to the point of departure/to the sender.

Format: YYYY-MM-DD

cargoYesobjectInformation on the cargo
cargo.freightUIDNo*string

Cargo UID (see "Nature of cargo: search by string (dedicated truck transportation)" directory)

*One of the excluding parameters is required: "cargo.freightName" or "cargo.freightUID"
cargo.freightNameNo*string

Cargo name

*One of the excluding parameters is required: "cargo.freightName" or "cargo.freightUID""
gpsReportNobooleanFlag indicating that GPS report on transportation is required
paymentYesobjectPayer data
payment.primaryPayerYesstring

Payer role

Possible values:

  • "sender";
  • "receiver";
  • "third" - third party
payment.smsForBillNostring

Phone number for sending the payment receipt.

Format: "7XXXXXXXXXX" (11 digits starting with 7)

The parameter is used only for individuals
payment.emailForBillNostring

Email address for sending the payment receipt. 128 characters maximum

The parameter is used only for individuals

Waypoint
Waypoint
ParameterRequiredTypeDescription

addressID

No*integer

Address ID from "Address book"

*If the user is unauthorized ("request.sessionID" parameter is not passed in the request), then the parameter is ignored. If the user is authorized ("request.sessionID" parameter is passed in the request), then one of the excluding parameters is required: "addressID" or "address"
addressNo*Address

Address data

*If the user is unauthorized ("request.sessionID" parameter is not passed in the request), then the parameter is required. If the user is authorized ("request.sessionID" parameter is passed in the request), then one of the excluding parameters is required: "addressID" or "address"

time

YesobjectLoading/unloading period
time.worktimeStartYesstring

Period start.

Format: HH:MM

time.worktimeEndYesstring

Period end.

Format: HH:MM

time.breakStartNostring

Break start.

Format: HH:MM

time.breakEndNostring

Break start.

Format: HH:MM

documentsForReceive

Yesarray of strings

Document UID from "Documents for receipt of cargo"

For "derival" object only

services

YesobjectAdditional services
services.tentingRemovalNostring

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 "" parameter), but it is not available if a rigid body truck is ordered ("" parameter with "hard_board" value is passed in the request)
services.placesRecountNoboolean

Flag indicating that it is necessary to count cargo places at the point of departure/arrival

Only for "" and "" objects
services.loadingPlacesRecountNoboolean

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 "" parameter).For "" object only
services.unloadingPlacesRecountNoboolean

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 "" parameter).For "" object only

services.unloadingRamp

Noboolean

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 "" parameter, "top" value is not passed for "" parameter). Only for "" and "" objects

services.fridgeThermalReport

Noboolean

Flag indicating that temperature conditions report is necessary

The service is available only for refrigerator trucks ("fridge" value is passed for "" parameter). For "" object only

Requester

Requester

ParameterRequiredTypeDescription

role

Yesstring

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 ("" 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
ParameterRequiredTypeDescription

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 Directory of legal forms of organization

counteragent.nameYesstringIndividual or company name
counteragent.innNo*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 "" parameter)

*If the counterparty is a legal entity, the parameter is required
counteragent.documentNo*Document

Personal ID data. The parameter is used only for individuals (that is when an individual UID is passed in the "" parameter)

*If the counterparty is an individual, the parameter is required

counteragent.juridicalAddress

NoAddress

Legal address. The parameter is used for legal entities only (that is when legal entity UID is passed in the "" parameter)

counteragent.save

Noboolean

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 integer

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.nameYesstringContact person name
contactPersons.saveNoboolean

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 "" object the parameter is ignored

phoneID

No*array of integer

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.numberYesstringPhone number. 15 digits maximum
phoneNumbers.extNostringExtension phone number. 5 digits maximum
phoneNumbers.saveNoboolean

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 "" object the parameter is ignored

Document

Document

ParameterRequiredTypeDescription

type

Yesstring

Document type.

Possible values:

  • "passport";
  • "drivingLicence";
  • "foreignPassport" - international passport. For some countries "foreignPassport" value is not available
serialYes*string

Document series

*For some countries the parameter is not required and therefore ignored

numberYesstringDocument number. Number format may vary depending on the country

Address

Address

ParameterRequiredTypeDescription
streetYesstring

CLADR* code of the street (see. "Streets directory").

*CLADR - Classifier of Addresses of Russian Federation 

buildingNostring

Building.

Maximum 5 characters

flatNostring

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

Maximum 5 characters

houseYesstring

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

Maximum 5 characters

structureNostring

Structure.

Maximum 5 characters

saveNoboolean

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 "" object the parameter is ignored (to update the legal address pass "true" value for "counteragent.save" parameter)

Method response

Response example

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

Description of parameters

Response
Response
ParameterTypeDescription
metadataobjectSystem information
metadata.statusinteger

Emulated status http-code. If successful, code 201 (Created) is returned

metadata.generated_atstring

Server response date and time.

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

dataData

Information about the order

Data
Data
ПараметрТипОписание
orderNumberstringOrder number
addressBookobjectInformation on new/edited objects from the address book
addressBook.senderMemberSender data
addressBook.transitMemberData of intermediate point counterparty 
addressBook.receiverMemberReceiver data

addressBook.third

MemberThird party data

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

counteragent

BookItemCounterparty data (see counterparties-related methods of the address book)

address

BookItem

Address data (see addresses-related methods of the address book)

The parameter is not used for "addressBook.third" object

phoneNumbers

array of BookItem

Phone number data (see contact details-related methods of the address book)

The parameter is not used for "addressBook.third" object

contactPersons

array of BookItem

Contact person data (see contact details-related methods of the address book)

The parameter is not used for "addressBook.third" object

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

id

integerID 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 "" object)/contact person name (in case of "" object)

The parameter is not used for "" and "" objects

Error handling

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