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

API
Главная / API - Перевозка сборных грузов

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

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

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

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

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

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

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

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

Пример запроса

Адрес метода: 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":"Омск, Ленина, 5",
            "street":"5500000100005970000000000",
            "house":"5",
            "building":"1",
            "structure":"лит.А",
            "flat":"214а",
            "save":true
         },
         "city":"5500000100000000000000000",
         "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",
      "freightName":"Запчасти для трактора"
   },
   "payment":{  
      "type":"cash",
      "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>Омск, Ленина, 5</search>
            <street>5500000100005970000000000</street>
            <house>5</house>
            <building>1</building>
            <structure>лит.А</structure>
            <flat>214а</flat>
            <save>true</save>
         </address>
         <city>5500000100000000000000000</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>
      <freightName>Запчасти для трактора</freightName>
   </cargo>
   <payment>
      <type>cash</type>
      <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 символов

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" - доставка малогабаритного груза

Малогабаритный груз - это груз, параметры которого не превышают следующие значения:
  • масса меньше либо равна 10 кг;
  • Д*Ш*В меньше либо равны 0,54*0,39*0,39 м;
  • объём меньше либо равен 0,1 куб. м.
Заказ услуги "Доставка малогабаритного груза" возможен только в случае, если в городах отправки и получения есть подразделения компании "Деловые Линии", более подробную информацию см. на сайте компании

Packages
Packages
ПараметрОбязательныйТипОписание
uidДаstringUID упаковки из "Справочника дополнительных услуг"
payerНетstring

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

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

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

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

countНет*integer

Количество мешков или коробок

*Если выбрана упаковка "Упаковка мешок" или "Картонная коробка", то параметр является обязательным

AcDocs
AcDocs
ПараметрОбязательныйТипОписание
actionДаstring

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

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

  • "send" - отправка;
  • "return" - возврат
payerДаstring

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

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

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

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

DerivalArrival
DerivalArrival
ПараметрОбязательныйТипОписание
produceDateДаstring

Дата передачи груза на терминал отправления или дата приезда машины к отправителю.

Формат: ГГГГ-ММ-ДД

Параметр используется для  только для объекта "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").

Для объекта "request.delivery.arrival": может быть передан только ID пункта выдачи заказов (ПВЗ) или терминала по умолчанию (в "Справочнике терминалов" значение параметра "city.terminals.terminal.isPVZ" или параметра "city.terminals.terminal.default" - "true")

*Обязательно должен быть передан один из взаимоисключающих параметров: "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Адрес в виде произвольной строки. Минимум 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".

Если пользователь не авторизован, то параметр игнорируется

Примечания:

  1. Обязательно должен быть передан адрес - в виде произвольной строки ("search") или набора параметров (в этом случае обязательными являются параметры "street" и "house"). 
  2. Передача параметра "search" исключает передачу параметров "street", "house", "building", "structure" и "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", то параметр игнорируется

Примечания:

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

Counteragent
Counteragent
ПараметрОбязательныйТипОписание
formНет*string

UID организационно-правовой формы (ОПФ) из "Справочника ОПФ".

При передаче данных об "анонимном" (1) получателе (значение параметра "isAnonym" - "true") в качестве значения параметра необходимо передать UID физического лица РФ ("0xAB91FEEA04F6D4AD48DF42161B6C2E7A").

*Допускается передача только одного из параметров: "form", "customForm"

customFormНет*object

ОПФ в форме набора параметров.

*Допускается передача только одного из параметров: "form", "customForm"

customForm.formNameДаstring

Название ОПФ в текстовом формате.

Максимальная длина поля: 35 символов

customForm.countryUIDДаstringUID страны из "Справочника стран"
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", оформляется упрощенная отправка (1).

Передача параметра со значением "true" доступна только для участника перевозки с ролью "Получатель" (блок "Receiver").

Значение по умолчанию: "false"

phoneНет*string

Номер телефона контрагента-"анонимного" получателя (1).

Формат номера: "7ХХХХХХХХХХ" (11 цифр с ведущей семёркой).

*Параметр является обязательным только для контрагента-"анонимного" получателя

nameДаstringИмя контрагента или название юр. лица
innНет*string

ИНН.

Максимальная длина поля зависит от страны и ОПФ

*Параметр является обязательным только для юр. лица (в параметре "form" передан UID ОПФ юр. лица или "customForm.juridical" = "true")

juridicalAddressНетAddress

Юридический адрес.

Параметр используется только для юр. лица (в параметре "form" передан UID ОПФ юр. лица или "customForm.juridical" = "true")

saveНетboolean

Признак сохранения объекта в адресную книгу.

Значение по умолчанию: "false".

Если пользователь не авторизован, то параметр игнорируется

Примечания:

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

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 по наименованию груза следует воспользоваться методом "Характер груза по введенной строке" (2).

*Допускается передача только одного из параметров: "freightName", "freightUID"

freightName Нет*string

Характер груза в текстовом формате (2).

*Допускается передача только одного из параметров: "freightName", "freightUID"

Примечания:

  1. Негабаритное грузовое место - это грузовое место, вес которого больше либо равен 100 кг (80 кг в случае перевозки авиатранспортом) или одно из измерений (Д*Ш*В) которого больше либо равно 3 м (80 см в случае перевозки авиатранспортом).
  2. Если значение параметра "request.delivery.deliveryType.type" - "letter", то переданное значение игнорируется, автоматически устанавливается характер груза "Документы"

Payment
Payment
ПараметрОбязательныйТипОписание

type

Даstring

Вид оплаты.

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

  • "cash" - оплата наличными или банковской картой;
  • "noncash" - оплата посредством банковского перевода

primaryPayer

Даstring

Плательщик по умолчанию. Указанный плательщик оплачивает основную услугу (межтерминальную перевозку) и все прочие услуги, если по ним не указаны иные плательщики.

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

  • "sender" - отправитель;
  • "receiver" - получатель;
  • "third" - третье лицо
paymentCityНет*string

Код КЛАДР населенного пункта оплаты. Может быть получен с помощью сервисов, представленных на странице "Использование кодов КЛАДР". 

*Если один из плательщиков - третье лицо, а значение параметра "request.payment.type" - "cash", то один из взаимоисключающих параметров "paymentCity" или "paymentCitySearch" является обязательным, в противном случае параметр игнорируется

paymentCitySearchНет*object

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

*Если один из плательщиков - третье лицо, а значение параметра "request.payment.type" - "cash", то один из взаимоисключающих параметров "paymentCity" или "paymentCitySearch" является обязательным, в противном случае параметр игнорируется

paymentCitySearch.search

ДаstringНаселённый пункт в виде произвольной строки. Минимум 2 символа, максимум - 1024. Помимо наименования населённого пункта, в строке может быть передано наименование страны, региона, района - это позволит уточнить поиск и исключить ошибки, которые могут возникнуть из-за одинаковых названий населённых пунктов
cashOnDeliveryНетarray of CashOnDelivery

Наложенный платеж.

Оформление услуги возможно только при соблюдении следующих условий:

  1. Заказчик является юридическим лицом, которому доступна услуга "Наложенный платёж"(для получения разрешения на использование услуги необходимо обратиться к менеджеру компании "Деловые Линии").
  2. Заказчик выступает в роли отправителя (значение параметра "members.requester.role" - "sender".
  3. Получатель является физическим лицом.
  4. В запросе должен быть передан параметр "cashOnDelivery.products". Если параметр не передан, то услуга "Наложенный платёж" оформлен не будет, однако объект можно будет использовать для передачи внутреннего номера заказа клиента (см. описание параметра "cashOnDelivery.orderNumber").

При оформлении услуги невозможна доставка до адреса получателя/аэропорта (значение параметра "delivery.arrival.variant" должно быть "terminal").

В настоящий момент допускается передача только одного элемента в массив "CashOnDelivery", прочие переданные элементы игнорируются.

Если пользователь не авторизован, то параметр игнорируется

cashOnDelivery.orderNumberНетstring

Внутренний номер заказа клиента (например, номер заказа интернет-магазина).

Параметр может быть использован для передачи внутреннего номера заказа не только в случае оплаты наложенным платежом. При этом соблюдение прочих условий, необходимых для оформления услуги "наложенный платёж", не требуется, см. пример 2 в разделе "Оформление заказа"
cashOnDelivery.orderDateНетstring

Дата заказа.

Формат: "ГГГГ-ММ-ДД"

cashOnDelivery.paymentTypeНетstring

Заявленный вид оплаты.

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

  • "cash" - оплата наличными;
  • "card" - оплата картой
cashOnDelivery.productsНетarray of ProductsОписание номенклатурного состава груза

Products
Products
ПараметрОбязательныйТипОписание
productNameДаstringНаименование товара
productCodeНетstringНоменклатурный номер (артикул)
productAmountДаintegerКоличество (1)
costWithVATДаfloatЦена за ед. с НДС, руб. (1)
VATRateНетinteger

Ставка НДС, %.

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

  • "0";
  • "10";
  • "20".

Если товар не облагается НДС, то следует передавать не нулевое значение, а просто не передавать параметр

Примечания:

  1. При оформлении наложенного платежа общая сумма по заказу (то есть сумма произведений значений параметров "costWithVAT" и "productAmount" каждого из элементов массива "CashOnDelivery.products") должна быть целым числом

Ответ метода

Пример ответа

{  
   "metadata":{  
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{  
      "state":"success",
      "requestID":3954004,
      "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": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "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>
      <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>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</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
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusinteger

Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)

metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataobjectИнформация по итогу формирования заявки
data.statestringСтатус обработки запроса
data.requestIDintegerНомер созданного предзаказа или заявки
data.barcodestringBarcode для формирования штрихкода по алгоритму Code 128, если оформлен предзаказ (то есть, если значение параметра запроса "delivery.derival.variant" - "terminal")
data.addressBookAddressBook

Информация о сохранении данных в адресную книгу.

Если пользователь не авторизован, то параметр отсутствует в ответе

data.foundAddressesarray of FoundAddresses

Данные по найденным адресам/населённым пунктам. Параметр присутствует в ответе, только если в запросе был передан параметр "search" класса "Address" или параметр "payment.paymentCitySearch.search"

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

Отправитель

receiverMemberПолучатель
thirdMemberТретье лицо

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

counteragent

BookItemДанные контрагента

address

BookItem

Данные об адресе

contactPersons

array of BookItem

Список контактных лиц

phoneNumbers

array of BookItem

Список телефонных номеров

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

id

integerID нового/отредактированного объекта адресной книги

state

string

Статус объекта. Возможные значения:

  • "existing" - отредактированы данные существующего объекта;
  • "new" - создан новый объект

value

string

Номер телефона (в случае объекта "phoneNumbers")/имя контактного лица (в случае объекта "contactPersons")

Отсутствует у объектов "counteragent" и "address"

FoundAddresses
FoundAddresses
ПараметрТипОписание
fieldstringОбъект, в котором был передан параметр "search"
sourcestring

Введённое значение

resultstring

Найденный адрес/населённый пункт

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

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

Номер ошибкиhttp-кодКраткое описаниеДетальное описание

609013

400Ошибка параметров оплатыДетальное описание ошибки см. в поле "detail" ответа

609014

400Ошибка наложенного платежаДетальное описание ошибки см. в поле "detail" ответа

609016

400Ошибка при сохранении заявкиНевозможно сохранить заявку