Перевозка сборных грузов

Обновлено 08.08.2023

332 кб

Общие сведения

Сервис предназначен для оформления заказа/предзаказа на доставку грузов.

Метод доступен как авторизованным, так и не авторизованным пользователям. Авторизованные пользователи могут использовать данные адресной книги, а также сохранять в адресную книгу данные, вводимые при создании заявки.

Ниже представлено описание всех параметров метода, в соответствующем разделе можно найти примеры запросов и ответов.

Перевозка сборных грузов

Запрос метода

Адрес метода: https://api.dellin.ru/v2/request.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "inOrder":true,
   "delivery":{  
      "deliveryType":{  
         "type":"avia"
      },
      "packages":[  
         {  
            "uid":"0xA0A820F33B2F93FE44C8058B65C77D0F",
            "payer":"sender"
         },
         {  
            "uid":"0x947845D9BDC69EFA49630D8C080C4FBE",
            "payer":"sender",
            "count":3
         }
      ],
      "accompanyingDocuments":[  
         {  
            "action":"send",
            "payer":"sender"
         },
         {  
            "action":"return",
            "payer":"sender"
         }
      ],
      "derival":{  
         "produceDate":"2018-02-15",
         "pickupParams":{  
            "derivalDriverPass":24,
            "shipmentRegister":true,
            "paidEntry":{  
               "cost":100,
               "type":1
            },
            "shipmentDerival":"АБ1000222",
            "priorCall":true,
            "noNeedAgreement":true,
            "documentsForReceive":[  
               "0x90bc42c2d8cf7c1c47a40fc1ccfb54d5",
               "0x9c65f346435836584a8345ade132df00"
            ]
         },
         "variant":"terminal",
         "payer":"sender",
         "terminalID":"23",
         "addressID":457824578,
         "address":{  
            "search":"Омск, Ленина, 5",
            "street":"5500000100005970000000000",
            "house":"5",
            "building":"1",
            "structure":"лит.А",
            "flat":"214а",
            "save":true
         },
         "additionalAddress":{  
            "addressID":457824578,
            "address":{  
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"лит.А",
               "flat":"214а",
               "save":true
            },
            "payer":"sender"
         },
         "time":{  
            "worktimeStart":"09:00",
            "worktimeEnd":"18:00",
            "breakStart":"12:30",
            "breakEnd":"13:30",
            "exactTime":true
         },
         "handling":{  
            "freightLift":true,
            "toFloor":10,
            "carry":50,
            "payer":"third"
         },
         "requirements":[  
            "0x9951e0ff97188f6b4b1b153dfde3cfec",
            "0xabb9c63c596b08f94c3664c930e77778"
         ]
      },
      "arrival":{  
         "variant":"terminal",
         "payer":"sender",
         "terminalID":"23",
         "addressID":457824578,
         "address":{  
            "search":"59.924501, 30.241762",
            "street":"7800000000005550000000000",
            "house":"40",
            "building":"1",
            "structure":"лит.А",
            "flat":"214а",
            "save":true
         },
         "city":"7800000000000000000000000",
         "time":{  
            "worktimeStart":"09:00",
            "worktimeEnd":"18:00",
            "breakStart":"12:30",
            "breakEnd":"13:30",
            "exactTime":true
         },
         "handling":{  
            "freightLift":true,
            "toFloor":10,
            "carry":50,
            "payer":"third"
         },
         "requirements":[  
            "0x9951e0ff97188f6b4b1b153dfde3cfec",
            "0xabb9c63c596b08f94c3664c930e77778"
         ]
      },
      "smsback":"79213332211",
      "comment":"комментарий к отправке"
   },
   "members":{  
      "requester":{  
         "role":"payer",
         "uid":"f969722a-cca3-49ed-85ff-b6be9e904b94",
         "email":"test@mail.ru"
      },
      "sender":{  
         "counteragentID":456783515,
         "counteragent":{  
            "form":"0x8F51001438C4D49511DBD774581EDB80",
            "customForm":{  
               "formName":"ОБРУГ",
               "countryUID":"0x00000000000000000000000000000000",
               "juridical":true
            },
            "document":{  
               "type":"passport",
               "serial":"0000",
               "number":"123456"
            },
            "name":"Ромашка",
            "inn":"1234567890",
            "juridicalAddress":{
               "search":"Омск, Ленина, 5",  
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"3А",
               "flat":"Б-234"
            },
            "save":true
         },
         "contactIDs":[  
            12345678,
            78456123
         ],
         "contactPersons":[  
            {  
               "name":"Иван Иванович",
               "save":true
            },
            {  
               "name":"Петр Петрович",
               "save":false
            }
         ],
         "phoneIDs":[  
            98765412,
            65478921
         ],
         "phoneNumbers":[  
            {  
               "number":"79213332211",
               "ext":"0123",
               "save":true
            }
         ],
         "email":"test@mail.ru",
         "dataForReceipt":{
            "send":true,
            "phone":"+79999999999",
            "email":"test@mail.ru"
         }
      },
      "receiver":{  
         "counteragentID":456783515,
         "counteragent":{  
            "form":"0x8F51001438C4D49511DBD774581EDB80",
            "customForm":{  
               "formName":"ОБРУГ",
               "countryUID":"0x00000000000000000000000000000000",
               "juridical":true
            },
            "document":{  
               "type":"passport",
               "serial":"0000",
               "number":"123456"
            },
            "isAnonym":false,
            "phone":"79998887766",
            "name":"Ромашка",
            "inn":"1234567890",
            "juridicalAddress":{  
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"3А",
               "flat":"Б-234"
            },
            "save":true
         },
         "contactIDs":[  
            12345678,
            78456123
         ],
         "contactPersons":[  
            {  
               "name":"Иван Иванович",
               "save":true
            },
            {  
               "name":"Петр Петрович",
               "save":false
            }
         ],
         "phoneIDs":[  
            98765412,
            65478921
         ],
         "phoneNumbers":[  
            {  
               "number":"79213332211",
               "ext":"0123",
               "save":true
            }
         ],
         "email":"test@mail.ru",
         "dataForReceipt":{
            "send":true,
            "phone":"+79999999999",
            "email":"test@mail.ru"
         }
      },
      "third":{  
         "counteragentID":456783515,
         "counteragent":{  
            "form":"0x8F51001438C4D49511DBD774581EDB80",
            "customForm":{  
               "formName":"ОБРУГ",
               "countryUID":"0x00000000000000000000000000000000",
               "juridical":true
            },
            "document":{  
               "type":"passport",
               "serial":"0000",
               "number":"123456"
            },
            "name":"Ромашка",
            "inn":"1234567890",
            "juridicalAddress":{  
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"3А",
               "flat":"Б-234"
            },
            "save":true
         },
         "contactIDs":[  
            12345678,
            78456123
         ],
         "contactPersons":[  
            {  
               "name":"Иван Иванович",
               "save":true
            },
            {  
               "name":"Петр Петрович",
               "save":false
            }
         ],
         "phoneIDs":[  
            98765412,
            65478921
         ],
         "phoneNumbers":[  
            {  
               "number":"79213332211",
               "ext":"0123",
               "save":true
            }
         ],
         "email":"test@mail.ru",
         "dataForReceipt":{
            "send":true,
            "phone":"+79999999999",
            "email":"test@mail.ru"
         }
      }
   },
   "cargo":{  
      "quantity":1,
      "length":0.42,
      "width":0.18,
      "height":0.3,
      "weight":25.0,
      "totalVolume":0.02,
      "totalWeight":0.02,
      "oversizedWeight":25.0,
      "oversizedVolume":0.02,
      "hazardClass":2.1,
      "insurance":{  
         "statedValue":11220.50,
         "payer":"sender",
         "term":true
      },
      "freightUID":"0x9c2acaea110d75ba48fdc7a83c976269"
   },
   "payment":{  
      "type":"cash",
      "promocode":"promo123",
      "primaryPayer":"sender",
      "paymentCity":"5500000100000000000000000",
      "paymentCitySearch":{
         "search":"Омск"
            },
      "cashOnDelivery":[  
         {  
            "orderNumber":"123456",
            "orderDate":"2018-04-09",
            "paymentType":"cash",
            "products":[  
               {  
                  "productName":"Кофеварка BRAUN",
                  "productCode":"K-2300",
                  "productAmount":"1",
                  "costWithVAT":"17800",
                  "VATRate":18
               }
            ]
         }
      ]
   },
   "cargoCode":"1234" 
}

Адрес метода: https://api.dellin.ru/v2/request.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <inOrder>true</inOrder>
   <delivery>
      <deliveryType>
         <type>avia</type>
      </deliveryType>
      <packages>
         <uid>0xA0A820F33B2F93FE44C8058B65C77D0F</uid>
         <payer>sender</payer>
      </packages>
      <packages>
         <uid>0x947845D9BDC69EFA49630D8C080C4FBE</uid>
         <payer>sender</payer>
         <count>3</count>
      </packages>
      <accompanyingDocuments>
         <action>send</action>
         <payer>sender</payer>
      </accompanyingDocuments>
      <accompanyingDocuments>
         <action>return</action>
         <payer>sender</payer>
      </accompanyingDocuments>
      <derival>
         <produceDate>2018-02-15</produceDate>
         <pickupParams>
            <derivalDriverPass>24</derivalDriverPass>
            <shipmentRegister>true</shipmentRegister>
            <paidEntry>
               <cost>100</cost>
               <type>1</type>
            </paidEntry>
            <shipmentDerival>АБ1000222</shipmentDerival>
            <priorCall>true</priorCall>
            <noNeedAgreement>true</noNeedAgreement>
            <documentsForReceive>0x90bc42c2d8cf7c1c47a40fc1ccfb54d5</documentsForReceive>
            <documentsForReceive>0x9c65f346435836584a8345ade132df00</documentsForReceive>
         </pickupParams>
         <variant>terminal</variant>
         <payer>sender</payer>
         <terminalID>23</terminalID>
         <addressID>457824578</addressID>
         <address>
            <search>Омск, Ленина, 5</search>
            <street>5500000100005970000000000</street>
            <house>5</house>
            <building>1</building>
            <structure>лит.А</structure>
            <flat>214а</flat>
            <save>true</save>
         </address>
         <additionalAddress>
            <addressID>457824578</addressID>
            <address>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <house>5</house>
               <building>1</building>
               <structure>лит.А</structure>
               <flat>214а</flat>
               <save>true</save>
            </address>
            <payer>sender</payer>
         </additionalAddress>
         <time>
            <worktimeStart>09:00</worktimeStart>
            <worktimeEnd>18:00</worktimeEnd>
            <breakStart>12:30</breakStart>
            <breakEnd>13:30</breakEnd>
            <exactTime>true</exactTime>
         </time>
         <handling>
            <freightLift>true</freightLift>
            <toFloor>10</toFloor>
            <carry>50</carry>
            <payer>third</payer>
         </handling>
         <requirements>0x9951e0ff97188f6b4b1b153dfde3cfec</requirements>
         <requirements>0xabb9c63c596b08f94c3664c930e77778</requirements>
      </derival>
      <arrival>
         <variant>terminal</variant>
         <payer>sender</payer>
         <terminalID>23</terminalID>
         <addressID>457824578</addressID>
         <address>
            <search>59.924501, 30.241762</search>
            <street>7800000000005550000000000</street>
            <house>40</house>
            <building>1</building>
            <structure>лит.А</structure>
            <flat>214а</flat>
            <save>true</save>
         </address>
         <city>7800000000000000000000000</city>
         <time>
            <worktimeStart>09:00</worktimeStart>
            <worktimeEnd>18:00</worktimeEnd>
            <breakStart>12:30</breakStart>
            <breakEnd>13:30</breakEnd>
            <exactTime>true</exactTime>
         </time>
         <handling>
            <freightLift>true</freightLift>
            <toFloor>10</toFloor>
            <carry>50</carry>
            <payer>third</payer>
         </handling>
         <requirements>0x9951e0ff97188f6b4b1b153dfde3cfec</requirements>
         <requirements>0xabb9c63c596b08f94c3664c930e77778</requirements>
      </arrival>
      <smsback>79213332211</smsback>
      <comment>комментарий к отправке</comment>
   </delivery>
   <members>
      <requester>
         <role>payer</role>
         <uid>f969722a-cca3-49ed-85ff-b6be9e904b94</uid>
         <email>test@mail.ru</email>
      </requester>
      <sender>
         <counteragentID>456783515</counteragentID>
         <counteragent>
            <form>0x8F51001438C4D49511DBD774581EDB80</form>
            <customForm>
               <formName>ОБРУГ</formName>
               <countryUID>0x00000000000000000000000000000000</countryUID>
               <juridical>true</juridical>
            </customForm>
            <document>
               <type>passport</type>
               <serial>0000</serial>
               <number>123456</number>
            </document>
            <name>Ромашка</name>
            <inn>1234567890</inn>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <house>5</house>
               <building>1</building>
               <structure>3А</structure>
               <flat>Б-234</flat>
            </juridicalAddress>
            <save>true</save>
         </counteragent>
         <contactIDs>12345678</contactIDs>
         <contactIDs>78456123</contactIDs>
         <contactPersons>
            <name>Иван Иванович</name>
            <save>true</save>
         </contactPersons>
         <contactPersons>
            <name>Петр Петрович</name>
            <save>false</save>
         </contactPersons>
         <phoneIDs>98765412</phoneIDs>
         <phoneIDs>65478921</phoneIDs>
         <phoneNumbers>
            <number>79213332211</number>
            <ext>0123</ext>
            <save>true</save>
         </phoneNumbers>
         <email>test@mail.ru</email>
         <dataForReceipt>
            <send>true</send>
            <phone>+79999999999</phone>
            <email>test@mail.ru</email>
         </dataForReceipt>
      </sender>
      <receiver>
         <counteragentID>456783515</counteragentID>
         <counteragent>
            <form>0x8F51001438C4D49511DBD774581EDB80</form>
            <customForm>
               <formName>ОБРУГ</formName>
               <countryUID>0x00000000000000000000000000000000</countryUID>
               <juridical>true</juridical>
            </customForm>
            <document>
               <type>passport</type>
               <serial>0000</serial>
               <number>123456</number>
            </document>
            <isAnonym>false</isAnonym>
            <phone>79998887766</phone>
            <name>Ромашка</name>
            <inn>1234567890</inn>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <house>5</house>
               <building>1</building>
               <structure>3А</structure>
               <flat>Б-234</flat>
            </juridicalAddress>
            <save>true</save>
         </counteragent>
         <contactIDs>12345678</contactIDs>
         <contactIDs>78456123</contactIDs>
         <contactPersons>
            <name>Иван Иванович</name>
            <save>true</save>
         </contactPersons>
         <contactPersons>
            <name>Петр Петрович</name>
            <save>false</save>
         </contactPersons>
         <phoneIDs>98765412</phoneIDs>
         <phoneIDs>65478921</phoneIDs>
         <phoneNumbers>
            <number>79213332211</number>
            <ext>0123</ext>
            <save>true</save>
         </phoneNumbers>
         <email>test@mail.ru</email>
         <dataForReceipt>
            <send>true</send>
            <phone>+79999999999</phone>
            <email>test@mail.ru</email>
         </dataForReceipt>
      </receiver>
      <third>
         <counteragentID>456783515</counteragentID>
         <counteragent>
            <form>0x8F51001438C4D49511DBD774581EDB80</form>
            <customForm>
               <formName>ОБРУГ</formName>
               <countryUID>0x00000000000000000000000000000000</countryUID>
               <juridical>true</juridical>
            </customForm>
            <document>
               <type>passport</type>
               <serial>0000</serial>
               <number>123456</number>
            </document>
            <name>Ромашка</name>
            <inn>1234567890</inn>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <house>5</house>
               <building>1</building>
               <structure>3А</structure>
               <flat>Б-234</flat>
            </juridicalAddress>
            <save>true</save>
         </counteragent>
         <contactIDs>12345678</contactIDs>
         <contactIDs>78456123</contactIDs>
         <contactPersons>
            <name>Иван Иванович</name>
            <save>true</save>
         </contactPersons>
         <contactPersons>
            <name>Петр Петрович</name>
            <save>false</save>
         </contactPersons>
         <phoneIDs>98765412</phoneIDs>
         <phoneIDs>65478921</phoneIDs>
         <phoneNumbers>
            <number>79213332211</number>
            <ext>0123</ext>
            <save>true</save>
         </phoneNumbers>
         <email>test@mail.ru</email>
         <dataForReceipt>
            <send>true</send>
            <phone>+79999999999</phone>
            <email>test@mail.ru</email>
         </dataForReceipt>
      </third>
   </members>
   <cargo>
      <quantity>1</quantity>
      <length>0.42</length>
      <width>0.18</width>
      <height>0.3</height>
      <weight>25</weight>
      <totalVolume>0.02</totalVolume>
      <totalWeight>0.02</totalWeight>
      <oversizedWeight>25</oversizedWeight>
      <oversizedVolume>0.02</oversizedVolume>
      <hazardClass>2.1</hazardClass>
      <insurance>
         <statedValue>11220.5</statedValue>
         <payer>sender</payer>
         <term>true</term>
      </insurance>
      <freightUID>0x9c2acaea110d75ba48fdc7a83c976269</freightUID>
   </cargo>
   <payment>
      <type>cash</type>
      <promocode>promo123</promocode>
      <primaryPayer>sender</primaryPayer>
      <paymentCity>5500000100000000000000000</paymentCity>
      <paymentCitySearch>
         <search>Омск</search>
      </paymentCitySearch>
      <cashOnDelivery>
         <orderNumber>123456</orderNumber>
         <orderDate>2018-04-09</orderDate>
         <paymentType>cash</paymentType>
         <products>
            <productName>Кофеварка BRAUN</productName>
            <productCode>K-2300</productCode>
            <productAmount>1</productAmount>
            <costWithVAT>17800</costWithVAT>
            <VATRate>18</VATRate>
         </products>
      </cashOnDelivery>
   </payment>
   <cargoCode>1234</cargoCode>
</request>

Описание параметров

Request

Request
Параметр	Обязательный	Тип	Описание
appkey	Да	string	Ключ приложения. Для получения ключа необходимо пройти регистрацию
sessionID	Нет	string	ID сессии. Для получения сессии можно воспользоваться методом "Авторизация пользователя"
inOrder	Нет	boolean	Если передано значение "false", то заявка сохраняется, но не передается в дальнейшую обработку (необходимо, например, в случае, если заявку будет включена в состав мультизаявки). Значение по умолчанию: "true". Если пользователь не авторизован, то параметр игнорируется
delivery	Да	object	Параметры доставки
delivery.deliveryType	Да	DeliveryType	Тип доставки для межтерминальной перевозки
delivery.packages	Нет	array of Packages	Список требуемых упаковок
delivery.accompanyingDocuments	Нет	array of AcDocs	Сопроводительные документы
delivery.derival	Да	DerivalArrival	Доставка от адреса
delivery.arrival	Да	DerivalArrival	Доставка до адреса
delivery.smsback	Нет	string	Телефон для SMS-уведомлений. Формат номера: "7ХХХХХХХХХХ" (11 цифр с ведущей семёркой)
delivery.comment	Нет	string	Комментарий к заказу. Максимальная длина поля: 500 символов В ходе обработки запроса некоторые спецсимволы из текста комментария заменяются на их html-аналоги (например, символ " заменяется на "&quot"). В результате возможно превышение ограничения в 500 символов и вывод ошибки 130009 (см. "Ошибки методов API")
members	Да	object	Участники перевозки
members.requester	Да	Requester	Заказчик перевозки
members.sender	Да	Member	Отправитель
members.receiver	Да	Member	Получатель
members.third	Нет	Member	Третье лицо
cargo	Да	Cargo	Характеристики груза
payment	Да	Payment	Параметры оплаты
cargoCode	Нет	string	Номер товарно-транспортной накладной клиента. Максимальная длина строки - 100 символов Номер товарно-транспортной накладной используется при формировании пакетных заказов

DeliveryType

DeliveryType
Параметр	Обязательный	Тип	Описание
type	Да	string	Вид доставки. Доступные значения: "auto" - автодоставка; "express" - экспресс-доставка; "letter" - письмо; "avia" - авиадоставка; "small" - доставка малогабаритного груза Малогабаритный груз - это груз, параметры которого не превышают следующие значения: масса меньше либо равна 30 кг; ДШВ меньше либо равны 0,540,390,39 м; объём меньше либо равен 0,1 куб. м. Заказ услуги "Доставка малогабаритного груза" возможен только в случае, если в городах отправки и получения есть подразделения компании "Деловые Линии", более подробную информацию см. на сайте компании

Packages

Packages
Параметр	Обязательный	Тип	Описание
uid	Да	string	UID упаковки из "Справочника дополнительных услуг"
payer	Нет	string	Плательщик по услуге. Доступные значения: "sender" - отправитель; "receiver" - получатель; "third" - третье лицо. Если параметр не передан, то он принимает значение параметра "request.payment.primaryPayer"
count	Нет*	integer	Количество мешков или коробок *Параметр является обязательным, если выбран один из следующих видов упаковки: "Упаковка мешок", "Картонная коробка", "Спец. упаковка для автостекол", "Спец. упаковка для автозапчастей"

AcDocs

Параметр

Обязательный

Тип

Описание

action

Да

string

Действие над сопроводительными документами.

Доступные значения:

"send" - отправка;
"return" - возврат

Возврат сопроводительных документов недоступен при отправке груза "анонимному" получателю, то есть, если значение "members.receiver.counteragent.isAnonym" - "true". "Анонимный" получатель - получатель, о котором предоставлен минимум информации (см. описание услуги "Упрощённая отправка груза" на сайте компании "Деловые Линии")

payer

Нет*

string

Плательщик по услуге.

Доступные значения:

"sender" - отправитель;
"receiver" - получатель;
"third" - третье лицо.

* Если параметр не передан, то он принимает значение параметра "request.payment.primaryPayer"

DerivalArrival

DerivalArrival
Параметр	Обязательный	Тип	Описание
produceDate	Да	string	Дата передачи груза на терминал отправления или дата приезда машины к отправителю. Формат: ГГГГ-ММ-ДД Получить список дат, на которые может быть назначен приезд водителя, можно при помощи сервиса "Подбор даты отправки". Передавая в качестве значения параметра текущую дату, следует учитывать, что доставка груза от адреса в день оформления заказа возможна, только если заявка оформлена в будний день до 16:00 по местному времени, в населённом пункте есть терминал компании "Деловые Линии", который работает в течение двух или более часов с момента подачи заявки, а габариты груза не превышают: вес - 4999 кг; объем - 21,99 м3; длина - 6 м; ширина - 2 м; высота - 2,2 м Параметр используется для только для объекта "request.delivery.derival"
pickupParams	Нет	PickupParams	Дополнительные параметры доставки груза от адреса Параметр используется для только для объекта "request.delivery.derival"
variant	Да	string	Способ отправки груза. Доступные значения: "terminal" - доставка груза от/до терминала. Примечание. При заказе перевозки малогабаритного груза (значение параметра запроса "delivery.deliverуType.type" - "small") доставка от/до терминала невозможна. "address" - доставка груза от/до адреса; "airport" - доставка груза до аэропорта, вариант используется, если в городе, в который необходимо доставить груз, нет терминала "Деловых Линий", в этом случае груз можно получить в грузовом терминале в аэропорту. Примечание. Вариант используется только для объекта "request.delivery.arrival" и только при заказе доставки авиатранспортом (значение параметра запроса "delivery.deliverуType.type" - "avia"). При заказе доставки груза до аэропорта следует передать параметр "city", передача параметров "terminalID", "addressID", "address" невозможна Для объекта "request.delivery.derival": при выборе доставки от адреса отправителя будет оформлен заказ, при выборе доставки от терминала отправителя - предзаказ
payer	Нет	string	Плательщик по услуге. Доступные значения: "sender" - отправитель; "receiver" - получатель; "third" - третье лицо. Если параметр не передан, то он принимает значение параметра "request.payment.primaryPayer"
terminalID	Нет*	string	ID терминала из "Справочника терминалов". При заказе экспресс-перевозки (значение параметра запроса "delivery.deliverуType.type" - "express") необходимо передать ID терминала, который оказывает услуги по приёму/выдаче экспресс-грузов (в "Справочнике терминалов" выбранный терминал должен иметь вложенный параметр "Worktables.Worktable.department" со значением "Приём груза к экспресс-перевозке" (в случае объекта "request.delivery.derival")/"Выдача грузов экспресс-перевозки" (в случае объекта "request.delivery.arrival"). *Обязательно должен быть передан один из взаимоисключающих параметров: "terminalID", "addressID", "address", "city"
addressID	Нет*	integer	ID адреса из "Адресной книги". Если пользователь не авторизован, то параметр игнорируется. *Обязательно должен быть передан один из взаимоисключающих параметров: "terminalID", "addressID", "address", "city"
address	Нет*	Address	Адрес. *Обязательно должен быть передан один из взаимоисключающих параметров: "terminalID", "addressID", "address, "city"
city	Нет*	string	Код КЛАДР населенного пункта. Может быть получен с помощью сервисов, представленных на странице "Поиск КЛАДР". При доставке до адреса (значение параметра "variant" - "address") передача параметра невозможна. При передаче параметра терминал получения груза определяется автоматически *Обязательно должен быть передан один из взаимоисключающих параметров: "terminalID", "addressID", "address, "city" Параметр используется для только для объекта "request.delivery.arrival"
additionalAddress	Нет	object	Заезд на второй адрес Параметр используется для только для объекта "request.delivery.derival"
additionalAddress.addressID	Нет	integer	ID адреса из "Адресной книги". Если пользователь не авторизован, то параметр игнорируется. Параметры "addressID" и "address" являются взаимоисключающими
additionalAddress.address	Нет	Address	Адрес в форме набора параметров. Параметры "addressID" и "address" являются взаимоисключающими
additionalAddress.payer	Нет	string	Плательщик по услуге. Доступные значения: "sender" - отправитель; "receiver" - получатель; "third" - третье лицо. Если параметр не передан, то он принимает значение параметра "request.payment.primaryPayer"
time	Нет*	object	Время передачи груза (на адресе). *Если значение параметра "variant" - "address", то параметр является обязательным
time.worktimeStart	Да	string	Начало периода передачи груза. Формат: ЧЧ:ММ
time.worktimeEnd	Да	string	Окончание периода передачи груза. Формат: ЧЧ:ММ
time.breakStart	Нет	string	Начало перерыва. Формат: ЧЧ:ММ
time.breakEnd	Нет	string	Окончание перерыва. Формат: ЧЧ:ММ
time.exactTime	Нет	boolean	Передача груза в точное время. Значение по умолчанию: "false"
handling	Нет	object	Погрузо-разгрузочные работы на адресе
handling.freightLift	Нет	boolean	Есть грузовой лифт. Значение по умолчанию: "false"
handling.toFloor	Нет	integer	Номер этажа, на который требуется подъём. Максимальная длина поля: 5 символов
handling.carry	Нет	integer	Пронос в метрах. Максимальная длина поля: 5 символов
handling.payer	Нет	string	Плательщик по услуге. Доступные значения: "sender" - отправитель; "receiver" - получатель; "third" - третье лицо. Если параметр не передан, то он принимает значение параметра "request.payment.primaryPayer"
requirements	Нет	array of strings	Дополнительные требования к транспорту. Указываются UID'ы из "Справочника специальных требований к транспорту" и "Справочника видов загрузки" Дополнительные требования включают в себя вид загрузки машины (боковая, задняя и пр.), а также другие требования: манипулятор, растентовка и пр.

PickupParams

PickupParams
Параметр	Обязательный	Тип	Описание
derivalDriverPass	Нет	integer	Время заказа пропуска для въезда на территорию отправителя. Доступные значения: "1" - заказать за час; "24" - заказать за сутки
shipmentRegister	Нет	boolean	Запись на отгрузку. Значение по умолчанию: "false"
paidEntry	Нет	object	Информация о платном въезде на территорию отправителя
paidEntry.сost	Нет	float	Сумма оплаты
paidEntry.type	Нет	integer	Вариант возмещения произведённой оплаты. Доступные значения: "1" - по чеку на адресе; "2" - включить в счет
shipmentDerival	Нет	string	Номер отгрузки для получения груза. Максимальная длина поля: 30 символов
priorCall	Нет	boolean	Предварительный звонок. Значение по умолчанию: "false"
noNeedAgreement	Нет	boolean	Не требуется согласование с отправителем. Значение по умолчанию: "false"
documentsForReceive	Нет	array of strings	Документы для получения груза. Указываются UID'ы документов из справочника "Документы для получения груза"

Address

Address
Параметр	Обязательный	Тип	Описание
search	Нет (1)	string	Адрес в виде текста или координат. Координаты не следует использовать для передачи информации о юридическом адресе, то есть в блоках "juridicalAddress" класса "Counteragent". При передаче адреса в виде текста, помимо собственно адреса, в запрос следует включать наименование населённого пункта, элементы необходимо указывать через запятую, например "Омск, Ленина, 5". Координаты также указываются через запятую, первое число - широта, например "59.924501, 30.241762". Минимум 2 символа, максимум - 1024 (2)
street	Нет (1)	string	Код КЛАДР улицы. Может быть получен с помощью сервисов, представленных на странице "Поиск КЛАДР" (2)
house	Нет (1)	string	Номер дома (2). Максимальная длина поля: 7 символов
building	Нет	string	Корпус (2). Максимальная длина поля: 5 символов
structure	Нет	string	Строение (2). Максимальная длина поля: 7 символов
flat	Нет	string	Квартира (2). Максимальная длина поля: 5 символов
save	Нет	boolean	Признак сохранения объекта в адресную книгу. Значение по умолчанию: "false". Параметр не используется в блоках "juridicalAddress" класса "Counteragent". Если пользователь не авторизован, то параметр игнорируется
Примечания: Обязательно должен быть передан адрес - в виде строки ("search") или набора параметров (в этом случае обязательными являются параметры "street" и "house"). Передача параметра "search" исключает передачу параметров "street", "house", "building" и "structure", но допускает передачу параметра "flat" (в этом случае в качестве номера квартиры/офиса будет использоваться значение параметра "flat")

Requester

Requester
Параметр	Обязательный	Тип	Описание
role	Да	string	Роль в перевозке. Доступные значения: "sender" - отправитель; "receiver" - получатель; "payer" - плательщик; "third" - третье лицо
uid	Нет*	string	UID контрагента из "Списка контрагентов". *Параметр игнорируется для неавторизованных пользователей и при отсутствии полного доступа к контрагентам. В остальных случаях параметр является обязательным
email	Нет	string	Email заказчика перевозки

Member

Member
Параметр	Обязательный	Тип	Описание
counteragentID	Нет*	integer	ID контрагента из "Адресной книги". *Если пользователь не авторизован, то параметр игнорируется. Если пользователь авторизован, то передача одного из взаимоисключающих параметров "counteragentID" или "counteragent" является обязательной
counteragent	Нет*	Counteragent	Контрагент в форме набора параметров. *Если пользователь не авторизован, то параметр является обязательным. Если пользователь авторизован, то обязательной является передача одного из взаимоисключающих параметров "counteragentID" или "counteragent"
contactIDs	Нет*	array of integers	Список ID контактных лиц из "Адресной книги". Максимальное количество элементов в массиве - 3. *Параметр игнорируется для контрагента-"анонимного" получателя (1). Также параметр игнорируется, если пользователь не авторизован. Если пользователь авторизован и контрагент не является анонимным получателем, то передача одного из взаимоисключающих параметров "contactID" или "contactPersons" является обязательной
contactPersons	Нет*	array of ContactPersons	Список контактных лиц. Для авторизованных пользователей максимальное количество элементов в массиве - 3, для неавторизованных - 1. *Параметр игнорируется для контрагента-"анонимного" получателя (1). Если пользователь не авторизован, то параметр является обязательным. Если пользователь авторизован и контрагент не является анонимным получателем, то обязательной является передача одного из взаимоисключающих параметров "counteragentID" или "counteragent"
contactPersons.name	Да	string	Имя контактного лица
contactPersons.save	Нет	boolean	Признак сохранения объекта в адресную книгу. Значение по умолчанию: "false". Параметр игнорируется для третьего лица. Параметр игнорирутся для неавторизованных пользователей
phoneIDs	Нет*	array of integers	Список ID телефонных номеров из "Адресной книги". Максимальное количество элементов в массиве - 3. *Параметр игнорируется для контрагента-"анонимного" получателя (1). Также параметр игнорируется, если пользователь не авторизован. Если пользователь авторизован и контрагент не является анонимным получателем, то передача одного из взаимоисключающих параметров "phoneIDs" или "phoneNumbers" является обязательной
phoneNumbers	Нет*	array of PhoneNumbers	Список телефонных номеров. Для авторизованных пользователей максимальное количество элементов в массиве - 3, для неавторизованных - 1. *Параметр игнорируется для контрагента-"анонимного" получателя (1). Если пользователь не авторизован, то параметр является обязательным. Если пользователь авторизован и контрагент не является анонимным получателем, то обязательной является передача одного из взаимоисключающих параметров "phoneIDs" или "phoneNumbers"
phoneNumbers.number	Да	string	Номер телефона. Максимальная длина поля: 15 цифр
phoneNumbers.ext	Нет	string	Добавочный номер. Максимальная длина поля: 5 цифр
phoneNumbers.save	Нет	boolean	Признак сохранения объекта в адресную книгу. Значение по умолчанию: "false". Параметр игнорируется для третьего лица. Параметр игнорируется для неавторизованных пользователей
email	Нет	string	Email для отправки уведомлений участнику перевозки
dataForReceipt	Нет*	object	Контактные данные для отправки электронного чека плательщику-физическому лицу *Параметр обязателен для контрагента-физического лица, являющегося плательщиком и не являющегося "анонимным" получателем. Для контрагента-"анонимного" получателя и для контрагента-юридического лица параметр не является обязательным и игнорируется (1)
dataForReceipt.send	Да	boolean	Согласие на получение электронного чека об оплате. Доступные значения: "true" - пользователь ввел "phone" и/или "email" для отправки чека; "false" - пользователь отказался предоставлять контактные данные для отправки чека
dataForReceipt.phone	Нет*	string	Номер телефона для отправки чека. Формат номера: "+79XXXXXXXXX" (12 символов: начинается с "+79", и далее 9 цифр) Если "send" = "true", то обязательна передача хотя бы одного из параметров: "phone" или "email" Если "send" = "false", то параметр игнорируется
dataForReceipt.email	Нет*	string	Email адрес для отправки чека Если "send" = "true", то обязательна передача хотя бы одного из параметров: "phone" или "email" Если "send" = "false", то параметр игнорируется
Примечания: "Анонимный" получатель - получатель, о котором предоставлен минимум информации (см. описание услуги "Упрощённая отправка груза" на сайте компании "Деловые Линии")

Counteragent

Counteragent
Параметр	Обязательный	Тип	Описание
form	Нет*	string	UID организационно-правовой формы (ОПФ). Найти ОПФ можно при помощи метода "Поиск ОПФ" или же метода "Поиск контрагентов" (метод доступен неавторизованным пользователям и позволяет осуществлять поиск по данным ЕГРЮЛ (1) и ЕГРИП (2)) При передаче данных об "анонимном" (3) получателе (значение параметра "isAnonym" - "true") в качестве значения параметра необходимо передать UID физического лица РФ ("0xAB91FEEA04F6D4AD48DF42161B6C2E7A"). *Передача одного из взаимоисключающих параметров "form" или "customForm" является обязательно. При этом параметр "customForm" следует использовать только в том случае, если не удалось найти нужную ОПФ в справочнике
customForm	Нет*	object	ОПФ в форме набора параметров. *Передача одного из взаимоисключающих параметров "form" или "customForm" является обязательно. При этом параметр "customForm" следует использовать только в том случае, если не удалось найти нужную ОПФ в справочнике
customForm.formName	Да	string	Название ОПФ в текстовом формате. Максимальная длина поля: 35 символов
customForm.countryUID	Да	string	UID страны, см. метод "Поиск стран"
customForm.juridical	Да	boolean	Признак юридического лица
document	Нет*	object	Документ, удостоверяющий личность *Параметр является обязательным, только если оба параметра "customForm.juridical" и "isAnonym" переданы со значением "false"
document.type	Да	string	Тип документа. Доступные значения: "passport" - паспорт; "drivingLicence" - водительское удостоверение; "foreignPassport" - заграничный паспорт. Для некоторых стран значение "foreignPassport" недоступно
document.serial	Да*	string	Серия документа. *Для некоторых стран параметр не является обязательным и игнорируется
document.number	Да	string	Номер документа. Формат номера зависит от страны
isAnonym	Нет	boolean	Признак контрагента - "анонимного" получателя. Если передано значение "true", оформляется упрощенная отправка (3). Передача параметра со значением "true" доступна только для участника перевозки с ролью "Получатель" (блок "Receiver"). Значение по умолчанию: "false"
phone	Нет*	string	Номер телефона контрагента-"анонимного" получателя (3). Формат номера: "7ХХХХХХХХХХ" (11 цифр с ведущей семёркой). *Параметр является обязательным только для контрагента-"анонимного" получателя
name	Да	string	Имя контрагента или название юр. лица
inn	Нет*	string	ИНН. Максимальная длина поля зависит от страны и ОПФ *Параметр является обязательным только для юр. лица (в параметре "form" передан UID ОПФ юр. лица или "customForm.juridical" = "true")
juridicalAddress	Нет	Address	Юридический адрес. Параметр используется только для юр. лица (в параметре "form" передан UID ОПФ юр. лица или "customForm.juridical" = "true")
save	Нет	boolean	Признак сохранения объекта в адресную книгу. Значение по умолчанию: "false". Если пользователь не авторизован, то параметр игнорируется
Примечания: ЕГРЮЛ - Единый государственный реестр юридических лиц. ЕГРИП - Единый государственный реестр индивидуальных предпринимателей "Анонимный" получатель - получатель, о котором предоставлен минимум информации (см. описание услуги "Упрощённая отправка груза" на сайте компании "Деловые Линии")

Cargo

Cargo
Параметр	Обязательный	Тип	Описание
quantity	Нет	integer	Количество грузовых мест, шт. Значение по умолчанию: "1". Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то переданное значение параметра игнорируется, и используется значение по умолчанию ("1").
length	Да*	float	Длина самого длинного грузового места, м. *Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, и используется значение "0.3"
width	Да*	float	Ширина самого широкого грузового места, м. *Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, и используется значение "0.21"
height	Да*	float	Высота самого высокого грузового места, м. *Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, и используется значение "0.01"
weight	Нет*	float	Вес самого тяжелого грузового места, кг. Если количество грузовых мест > 1 ("request.cargo.quantity" > 1), то параметр является обязательным. В противном случае значение параметра считается равным значению параметра "totalWeight" Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, и используется значение "0.5"
totalVolume	Да*	float	Общий объём груза, куб. м. *Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, и используется значение "0.001"
totalWeight	Да*	float	Общий вес груза, кг. *Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр не является обязательным, переданное значение параметра игнорируется, и используется значение "0.5"
oversizedWeight	Нет*	float	Вес негабаритных грузовых мест, кг (1). Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр игнорируется. Если по весо-габаритным характеристикам определено, что груз не является габаритным, то параметр является обязательным
oversizedVolume	Нет*	float	Объём негабаритных грузовых мест, куб. м (1). Если вид доставки - "письмо" ("request.delivery.deliveryType.type" = "letter"), то параметр игнорируется. Если по весо-габаритным характеристикам определено, что груз не является габаритным, то параметр является обязательным
hazardClass	Нет	float	Класс опасности груза. Значение по умолчанию: "0"
insurance	Нет	object	Информация о страховании груза
insurance.statedValue	Нет	float	Объявленная стоимость груза, руб. Максимальная длина поля: 12 символов
insurance.payer	Нет	string	Плательщик по услуге. Доступные значения: "sender" - отправитель; "receiver" - получатель; "third" - третье лицо. Если параметр не передан, то он принимает значение параметра "request.payment.primaryPayer"
insurance.term	Нет	boolean	Признак страхования срока доставки груза. Значение по умолчанию: "true"
freightUID	Да	string	UID характера груза из справочника "Характер груза". Для поиска UID по наименованию груза следует воспользоваться методом "Характер груза по введенной строке". Если значение параметра "request.delivery.deliveryType.type" - "letter", то переданное значение игнорируется, автоматически устанавливается UID груза "Документы"
Примечания: 1. Негабаритное грузовое место - это: для случаев, отличных от авиаперевозки: грузовое место, вес которого больше или равен 100 кг либо хотя бы одно из измерений (Д х Ш х В) которого больше или равно 3 м; при авиаперевозке: грузовое место, вес которого больше или равен 80 кг (больше 53 кг до упаковки, если заказана жесткая упаковка (2)) либо хотя бы одно из измерений (Д х Ш х В) которого больше или равно 1,3 х 1 х 0,8 м соответственно (больше 1,2 х 0,9 х 0,65 м соответственно (до упаковки), если заказана жесткая упаковка(2)). 2. Заказ жесткой упаковки определяется передачей в параметре "request.delivery.packages.uid" идентификатора одного из следующих видов упаковки (см. "Справочник дополнительных услуг"): "crate" - деревянная обрешётка, "crate_plus" - жёсткий короб, "crate_with_bubble" - деревянная обрешетка + амортизация, "protect_auto_glass" - спец. упаковка для автостекол, "protect_auto_part" - спец. упаковка для автозапчастей

Payment

Payment
Параметр	Обязательный	Тип	Описание
type	Да	string	Вид оплаты (1). Доступные значения: "cash" - оплата наличными или банковской картой; "noncash" - оплата посредством банковского перевода
promocode	Нет	string	Промокод
primaryPayer	Да	string	Плательщик по умолчанию. Указанный плательщик оплачивает основную услугу (межтерминальную перевозку) и все прочие услуги, если по ним не указаны иные плательщики. Доступные значения: "sender" - отправитель; "receiver" - получатель; "third" - третье лицо
paymentCity	Нет*	string	Код КЛАДР населенного пункта оплаты (1). Может быть получен с помощью сервисов, представленных на странице "Поиск КЛАДР". *Если один из плательщиков - третье лицо, то один из взаимоисключающих параметров "paymentCity" или "paymentCitySearch" является обязательным, в противном случае параметр игнорируется.
paymentCitySearch	Нет*	object	Данные по населённому пункту оплаты в виде произвольной строки (1). *Если один из плательщиков - третье лицо, то один из взаимоисключающих параметров "paymentCity" или "paymentCitySearch" является обязательным, в противном случае параметр игнорируется.
paymentCitySearch.search	Да	string	Населённый пункт в виде произвольной строки. Максимум 1024 символа. Помимо наименования населённого пункта, в строке может быть передано наименование страны, региона, района - это позволит уточнить поиск и исключить ошибки, которые могут возникнуть из-за одинаковых названий населённых пунктов
cashOnDelivery	Нет	array of CashOnDelivery	Наложенный платеж. Оформление услуги возможно только при соблюдении следующих условий: Заказчик является юридическим лицом, которому доступна услуга "Наложенный платёж"(для получения разрешения на использование услуги необходимо обратиться к менеджеру компании "Деловые Линии"). Заказчик выступает в роли отправителя (значение параметра "members.requester.role" - "sender". Получатель является физическим лицом. В запросе должен быть передан параметр "cashOnDelivery.products". Если параметр не передан, то услуга "Наложенный платёж" оформлена не будет, однако объект можно будет использовать для передачи внутреннего номера заказа клиента (см. описание параметра "cashOnDelivery.orderNumber"). При оформлении услуги невозможна доставка до аэропорта / до адреса получателя от аэропорта. В настоящий момент допускается передача только одного элемента в массив "CashOnDelivery", прочие переданные элементы игнорируются. Если пользователь не авторизован, то параметр игнорируется
cashOnDelivery.orderNumber	Нет	string	Внутренний номер заказа клиента (например, номер заказа интернет-магазина). Параметр может быть использован для передачи внутреннего номера заказа не только в случае оплаты наложенным платежом. При этом соблюдение прочих условий, необходимых для оформления услуги "наложенный платёж", не требуется, см. пример 2 в разделе "Оформление заказа"
cashOnDelivery.orderDate	Нет	string	Дата заказа. Формат: "ГГГГ-ММ-ДД"
cashOnDelivery.paymentType	Нет	string	Заявленный вид оплаты. Доступные значения: "cash" - оплата наличными; "card" - оплата картой
cashOnDelivery.products	Нет	array of Products	Описание номенклатурного состава груза
Примечания: В некоторых населённых пунктах оплата наличными/банковской картой (значение параметра "type" - "cash") невозможна, оплатить услугу в этих населённых пунктах можно только посредством банковского перевода (значение параметра "type" - "noncash"). Передав один из взаимоисключающих параметров - "paymentCity" или "paymentCitySearch", можно удостовериться, что в населённом пункте доступна выбранная форма оплаты. Кроме того, список населённых пунктов, в которых доступна только оплата посредством банковского перевода, можно найти в "Справочник населенных пунктов с ограничениями по оплате"

Products

Products
Параметр	Обязательный	Тип	Описание
productName	Да	string	Наименование товара
productCode	Нет	string	Номенклатурный номер (артикул)
productAmount	Да	integer	Количество (1)
costWithVAT	Да	float	Цена за ед. с НДС, руб. (1)
VATRate	Нет	integer	Ставка НДС, %. Доступные значения: "0"; "10"; "20". Если товар не облагается НДС, то следует передавать не нулевое значение, а просто не передавать параметр
Примечания: При оформлении наложенного платежа общая сумма по заказу (то есть сумма произведений значений параметров "costWithVAT" и "productAmount" каждого из элементов массива "CashOnDelivery.products") должна быть целым числом

Ответ метода

Структура ответа

JSON
XML

{  
   "metadata":{  
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{  
      "state":"success",
      "requestID":3954004,
      "information":[
         "Промокод нельзя применить в заказе"
      ],
      "barcode":"41508460D0905400400000014",
      "addressBook":{  
         "sender":{  
            "counteragent":{  
               "id":2132424,
               "state":"existed"
            },
            "address":{  
               "id":89985444,
               "state":"new"
            },
            "contactPersons":[  
               {  
                  "id":78436784,
                  "state":"existed",
                  "value":"Иван Иванович"
               },
               {  
                  "id":3778489,
                  "state":"new",
                  "value":"Петр Петрович"
               }
            ],
            "phoneNumbers":[  
               {  
                  "id":6543687564,
                  "state":"existed",
                  "value":"795545785587"
               },
               {  
                  "id":4574583767,
                  "state":"new",
                  "value":"0127588848887588"
               }
            ]
         }
      },
      "foundAddresses": [
         {
            "field": "delivery.derival.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "delivery.derival.additionalAddress.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "delivery.arrival.address",
            "source": "199106, Россия, Санкт-Петербург, Санкт-Петербург, Кожевенная линия, дом 40",
            "result": "199106, Россия, г Санкт-Петербург, линия Кожевенная, дом 40"
         },
         {
            "field": "members.sender.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.receiver.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.third.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "payment.paymentCitySearch",
            "source": "Омск",
            "result": "Россия, Омская обл, г Омск"
         }
      ]
   }
}

<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <state>success</state>
      <requestID>3954004</requestID>
      <information>Промокод нельзя применить в заказе</information>
      <barcode>41508460D0905400400000014</barcode>
      <addressBook>
         <sender>
            <counteragent>
               <id>2132424</id>
               <state>existed</state>
            </counteragent>
            <address>
               <id>89985444</id>
               <state>new</state>
            </address>
            <contactPersons>
               <id>78436784</id>
               <state>existed</state>
               <value>Иван Иванович</value>
            </contactPersons>
            <contactPersons>
               <id>3778489</id>
               <state>new</state>
               <value>Петр Петрович</value>
            </contactPersons>
            <phoneNumbers>
               <id>6543687564</id>
               <state>existed</state>
               <value>795545785587</value>
            </phoneNumbers>
            <phoneNumbers>
               <id>4574583767</id>
               <state>new</state>
               <value>0127588848887588</value>
            </phoneNumbers>
         </sender>
      </addressBook>
      <foundAddresses>
         <field>delivery.derival.address</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>delivery.derival.additionalAddress.address</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>delivery.arrival.address</field>
         <source>199106, Россия, Санкт-Петербург, Санкт-Петербург, Кожевенная линия, дом 40</source>
         <result>199106, Россия, г Санкт-Петербург, линия Кожевенная, дом 40</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.sender.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>
      <foundAddresses>
         <field>payment.paymentCitySearch</field>
         <source>Омск</source>
         <result>Россия, Омская обл, г Омск</result>
      </foundAddresses>
   </data>
</response>

Описание параметров

Response

Response
Параметр	Тип	Описание
metadata	object	Системная информация
metadata.status	integer	Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_at	string	Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"
data	object	Информация по итогу формирования заявки
data.state	string	Статус обработки запроса
data.requestID	integer	Номер созданного предзаказа или заявки
data.information	array of strings	Информационное сообщение. Отображается, например, если в запросе был передан промокод, но применить его по какой-то причине невозможно
data.barcode	string	Barcode для формирования штрихкода по алгоритму Code 128, если оформлен предзаказ (то есть, если значение параметра запроса "delivery.derival.variant" - "terminal")
data.addressBook	AddressBook	Информация о сохранении данных в адресную книгу. Если пользователь не авторизован, то параметр отсутствует в ответе
data.foundAddresses	array of FoundAddresses	Данные по найденным адресам / населённым пунктам. Параметр присутствует в ответе, только если в запросе был передан параметр "search" класса "Address" или параметр "payment.paymentCitySearch.search"

AddressBook

AddressBook
Параметр	Тип	Описание
sender	Member	Отправитель
receiver	Member	Получатель
third	Member	Третье лицо

Member

Member
Параметр	Тип	Описание
counteragent	BookItem	Данные контрагента
address	BookItem	Данные об адресе
contactPersons	array of BookItem	Список контактных лиц
phoneNumbers	array of BookItem	Список телефонных номеров

BookItem

BookItem
Параметр	Тип	Описание
id	integer	ID нового/отредактированного объекта адресной книги
state	string	Статус объекта. Возможные значения: "existing" - отредактированы данные существующего объекта; "new" - создан новый объект
value	string	Номер телефона (в случае объекта "phoneNumbers") / имя контактного лица (в случае объекта "contactPersons") Отсутствует у объектов "counteragent" и "address"

FoundAddresses

FoundAddresses
Параметр	Тип	Описание
field	string	Объект, в котором был передан параметр "search"
source	string	Введённое значение
result	string	Найденный адрес / населённый пункт

Обработка ошибок

Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:

Номер ошибки	http-код	Краткое описание	Детальное описание
609013	400	Ошибка параметров оплаты	Детальное описание ошибки см. в поле "detail" ответа
609014	400	Ошибка наложенного платежа	Детальное описание ошибки см. в поле "detail" ответа
609016	400	Ошибка при сохранении заявки	Невозможно сохранить заявку

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

Перевозка сборных грузов

Общие сведения

Перевозка сборных грузов

Запрос метода

Структура запроса

Описание параметров

Request

DeliveryType

Packages

AcDocs

DerivalArrival

PickupParams

Address

Requester

Member

Counteragent

Cargo

Payment

Products

Ответ метода

Структура ответа

Описание параметров

Response

AddressBook

Member

BookItem

FoundAddresses

Обработка ошибок