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

API
Главная / API - Оформление заявок из ЛК

Оформление заявок на перевозку из Личного Кабинета

Обновлено 21.10.2019
246 кб

Общая информация

Сервис предназначен для создания заявок на доставку грузов с использованием данных личного кабинета. Доступно использование метода без предварительного создания записей в адресной книге. Имеется возможность сохранять в адресную книгу данные, вводимые при создании заявки.

Имеется возможность использования метода для создании заявок без авторизации (из публичной части). См. описание в соответствующем разделе.

Оформление заявок

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

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

Адрес метода: 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",
         "payer":"sender"
      },
      "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":{  
            "street":"7800000000004380000000000",
            "house":"4",
            "building":"3",
            "structure":"лит. А",
            "flat":"214а",
            "save":true
         },
         "additionalAddress":{  
            "addressID":"",
            "address":{  
               "street":"7800000000004380000000000",
               "house":"4",
               "building":"3",
               "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",
         "city":"7700000000000000000000000",
         "address":{  
            "street":"7800000000004380000000000",
            "house":"4",
            "building":"3",
            "structure":"лит. А",
            "flat":"214а",
            "save":true
         },
         "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":{  
               "street":"7800000000004380000000000",
               "house":"4",
               "building":"2",
               "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":{  
               "street":"7800000000004380000000000",
               "house":"4",
               "building":"2",
               "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":{  
               "street":"7800000000004380000000000",
               "house":"4",
               "building":"2",
               "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":{  
      "cashOnDelivery":[  
         {  
            "orderNumber":"123456",
            "orderDate":"2018-04-09",
            "paymentType":"cash",
            "products":[  
               {  
                  "productName":"Кофеварка BRAUN",
                  "productCode":"K-2300",
                  "productAmount":"1",
                  "costWithVAT":"17800",
                  "VATRate":18
               }
            ]
         }
      ],
      "type":"cash",
      "primaryPayer":"sender",
      "paymentCity":"7800000000000000000000000"
   }
}

Адрес метода: 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>
         <payer>sender</payer>
      </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>
            <street>7800000000004380000000000</street>
            <house>4</house>
            <building>3</building>
            <structure>лит. А</structure>
            <flat>214а</flat>
            <save>true</save>
         </address>
         <additionalAddress>
            <addressID></addressID>
            <address>
               <street>7800000000004380000000000</street>
               <house>4</house>
               <building>3</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>
         <city>7700000000000000000000000</city>
         <address>
            <street>7800000000004380000000000</street>
            <house>4</house>
            <building>3</building>
            <structure>лит. А</structure>
            <flat>214а</flat>
            <save>true</save>
         </address>
         <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>
               <street>7800000000004380000000000</street>
               <house>4</house>
               <building>2</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>
               <street>7800000000004380000000000</street>
               <house>4</house>
               <building>2</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>
               <street>7800000000004380000000000</street>
               <house>4</house>
               <building>2</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>
      <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>
      <type>cash</type>
      <primaryPayer>sender</primaryPayer>
      <paymentCity>7800000000000000000000000</paymentCity>
   </payment>
</request>

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

Request
Request
ПараметрR*ТипОписание
Корневые параметры
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstring

ID сессии. Для получения сессии можно воспользоваться методом "Авторизация пользователя"

inOrderНетboolean

Если передано значение "false", то заявка сохраняется, но не передается в дальнейшую обработку.

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

deliveryДаobjectПараметры доставки
delivery.deliveryTypeДаDeliveryTypeТип доставки для межтерминальной перевозки
delivery.packagesНетarray of PackageСписок требуемых упаковок
delivery.accompanyingDocumentsНетarray of AcDocСопроводительные документы
delivery.derivalДаDerivalДоставка от адреса
delivery.arrivalДаArrivalДоставка до адреса
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Даobject
Параметры оплаты
payment.typeДаstring

Вид оплаты.

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

  • "cash" - оплата наличными
  • "noncash" - безналичная оплата
payment.primaryPayerДаstring

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

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

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

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

*Параметр является обязательным, если один из плательщиков - третье лицо

payment.cashOnDeliveryНетarray of CashOnDelivery

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

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

DeliveryType
DeliveryType
ПараметрR*ТипОписание
typeДаstring

Вид доставки.

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

  • "auto" - автодоставка
  • "express" - экспресс-доставка
  • "small" - доставка малогабаритного груза
  • "letter" - письмо
  • "avia" - авиадоставка
payerНетstring

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

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

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

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

Package
Package
ПараметрR*ТипОписание
uidДаstringUID упаковки из "Справочника доп. услуг для заявки"
payerНетstring

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

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

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

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

countНет*integer

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

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

AcDoc
AcDoc
ПараметрR*ТипОписание
actionДаstring

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

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

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

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

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

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

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

Derival
Derival
ПараметрR*ТипОписание
produceDateДаstring

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

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

pickupParamsНетPickupParams

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

variantДаstring

Способ отправки груза.

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

  • "terminal" - доставка груза от терминала
  • "address" - доставка груза от адреса
payerНетstring

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

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

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

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

terminalIDДа*integer

ID терминала из "Справочника терминалов".

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

addressIDДа*integer

ID адреса из "Адресной книги".

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

addressДа*Address

Адрес в форме набора параметров.

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

additionalAddressНетobject
Заезд на второй адрес
additionalAddress.addressIDНет*integer

ID адреса из "Адресной книги".

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

additionalAddress.addressНет*Address

Адрес в форме набора параметров.

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

additionalAddress.payerНетstring

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

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

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

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

timeДа*object

Время передачи груза для перевозки (на адресе).

*Только если выбран способ отправки груза "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 string

Дополнительные требования к транспорту. Указываются UID'ы из "Справочника специальных требований к транспорту".

Дополнительные требования включают в себя вид загрузки машины (боковая, задняя и пр.), а также другие требования: манипулятор, растентовка и пр.

PickupParams
PickupParams
ПараметрR*ТипОписание
derivalDriverPassНетinteger

Время заказа пропуска для въезда на территорию отправителя.

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

  • "1" - заказать за час
  • "24" - заказать за сутки
shipmentRegisterНетboolean

Запись на отгрузку.

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

paidEntryНетobjectИнформация о платном въезде на территорию отправителя
paidEntry.CostНетfloatСумма оплаты
paidEntry.TypeНетinteger

Вариант возмещения произведённой оплаты.

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

  • "1" - по чеку на адресе
  • "2" - включить в счет
shipmentDerivalНетstring

Номер отгрузки для получения груза.

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

priorCallНетboolean

Предварительный звонок.

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

noNeedAgreementНетboolean

Не требуется согласование с отправителем.

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

documentsForReceiveНетarray of stringДокументы для получения груза. Указываются UID'ы документов из справочника "Документы для получения груза"

Address
Address
ПараметрR*ТипОписание
streetДаstring

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

houseДаstring

Номер дома.

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

buildingНетstring

Строение.

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

structureНетstring

Корпус.

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

flatНетstring

Квартира.

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

saveНетboolean

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

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

Параметр не используется в блоках "juridicalAddress" класса "Counteragent"

Arrival
Arrival
ПараметрR*ТипОписание
variantДаstring

Способ отправки груза.

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

  • "terminal" - доставка груза до терминала
  • "address" - доставка груза до адреса
payerНетstring

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

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

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

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

terminalIDДа*integer

ID терминала из "Справочника терминалов".

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

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

addressIDДа*integer

ID адреса из "Адресной книги".

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

addressДа*Address

Адрес в форме набора параметров.

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

cityДа*string

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

*Допускается передача только одного из параметров: "terminalID", "addressID", "address", "city".

*Допускается передача этого параметра, только если в параметре "variant" передано значение "terminal".

При передаче этого параметра терминал получения груза определяется автоматически

timeДа*object

Время передачи груза получателю (на адресе).

*Только если выбран способ отправки груза "address"

time.worktimeStartДаstring

Начало периода передачи груза.

Формат: ЧЧ:ММ

time.worktimeEndДаstring

Окончание периода передачи груза.

Формат: ЧЧ:ММ

time.breakStartНетstring

Начало перерыва.

Формат: ЧЧ:ММ

time.breakEndНетstring

Окончание перерыва.

Формат: ЧЧ:ММ

time.exactTimeНетboolean

Передача груза в точное время.

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

handlingНетobject

Погрузо-разгрузочные работы на адресе.

ПРР могут быть заказаны только при отправке груза до адреса (в параметре "variant" передано значение "address")

handling.freightLiftНетboolean

Есть грузовой лифт.

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

handling.toFloorНетinteger

Номер этажа, на который требуется подъем.

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

handling.carryНетinteger

Пронос в метрах.

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

handling.payerНетstring

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

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

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

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

requirementsНетarray of string

Дополнительные требования к транспорту. Указываются UID'ы из "Справочника специальных требований к транспорту".

Дополнительные требования включают в себя вид загрузки машины (боковая, задняя и пр.), а также другие требования: манипулятор, растентовка и пр.

Requester
Requester
ПараметрR*ТипОписание
roleДаstring

Роль в перевозке.

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

  • "sender" - отправитель
  • "receiver" - получатель
  • "payer" - плательщик
  • "third" - третье лицо
uidДа*string

UID контрагента из "Списка контрагентов".

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

emailНетstring

E-mail заказчика перевозки.

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

Member
Member
ПараметрR*ТипОписание
counteragentIDДа*integer

ID контрагента из "Адресной книги".

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

counteragentДа*Counteragent

Контрагент в форме набора параметров.

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

contactIDsДа*array of integer

Список ID контактных лиц из "Адресной книги".

Максимальное количество элементов в массиве: 3.

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

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

contactPersonsДа*array of ContactPerson

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

Максимальное количество элементов в массиве: 3.

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

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

phoneIDsДа*array of integer

Список ID телефонных номеров из "Адресной книги".

Максимальное количество элементов в массиве: 3.

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

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

phoneNumbersДа*array of PhoneNumber

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

Максимальное количество элементов в массиве: 3.

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

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

emailНетstring

E-mail заказчика перевозки.

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

dataForReceiptДа*DataForReceipt

Контактные данные для отправки электронного чека плательщику-физическому лицу

*Параметр обязателен для контрагента-физического лица, являющегося плательщиком и не являющегося анонимным получателем. Для контрагента-анонимного получателя и для контрагента-юридического лица параметр не является обязательным и игнорируется

Counteragent
Counteragent
ПараметрR*ТипОписание
formДа*integer

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

*Допускается передача только одного из параметров: "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", оформляется упрощенная отправка.

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

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

phoneДа*string

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

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

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

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

ИНН.

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

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

juridicalAddressДа*Address

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

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

saveНетboolean

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

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

ContactPerson
ContactPerson
ПараметрR*ТипОписание
nameДаstring

Имя контактного лица

saveНетboolean

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

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

Параметр игнорируется для третьего лица

PhoneNumber
PhoneNumber
ПараметрR*ТипОписание
numberДаstring

Номер телефона.

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

extНетstring

Добавочный номер.

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

saveНетboolean

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

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

Параметр игнорируется для третьего лица

DataForReceipt
DataForReceipt
ПараметрR*ТипОписание
sendДаboolean

Согласие на получение электронного чека об оплате. Доступные значения:

  • "true" - пользователь ввел "phone" и/или "email" для отправки чека
  • "false" - пользователь отказался предоставлять контактные данные для отправки чека
phoneДа*string

Номер телефона для отправки чека.

Формат номера: "+79XXXXXXXXX" (12 символов: начинается с "+79", и далее 9 цифр)

*Если "send" = "true", то обязательна передача хотя бы одного из параметров: "phone" или "email"

*Если "send" = "false", то параметр игнорируется

emailДа*string

E-mail адрес для отправки чека

*Если "send" = "true", то обязательна передача хотя бы одного из параметров: "phone" или "email"

*Если "send" = "false", то параметр игнорируется

Cargo
Cargo
ПараметрR*ТипОписание
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"

oversizedVolumeНет*float

Объём негабаритной части груза, куб. м.

*Если вид доставки - "письмо" ("Request.Delivery.DeliveryType.type" = "letter"), то параметр игнорируется.

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

oversizedWeightНет*float

Вес негабаритной части груза, кг.

*Если вид доставки - "письмо" ("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"

freightNameДа*string

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

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

freightUIDДа*string

UID характера груза из справочника "Характер груза". Для поиска UID по наименованию груза следует воспользоваться методом "Характер груза по введенной строке"

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

CashOnDelivery
CashOnDelivery
ПараметрR*ТипОписание
orderNumberНетstring

Номер заказа интернет-магазина

orderDateНетdate

Дата заказа.

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

paymentTypeНетstring

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

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

  • "cash" - оплата наличными
  • "card" - оплата картой
productsНетarray of Product

Описание номенклатурного состава груза

Product
Product
ПараметрR*ТипОписание
productNameДаstring

Наименование товара

productCodeНетstring

Номенклатурный номер (артикул)

productAmountДаinteger

Количество

costWithVATДаfloat

Цена за ед. с НДС, руб.

VATRateНетinteger

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

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

  • "0"
  • "10"
  • "20"

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

Ответ метода

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

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

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

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusstring

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

metadata.generated_atstring

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

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

dataDataИнформация по итогу формирования заявки

Data
Data
ПараметрТипОписание
statestringСтатус обработки запроса
requestIDstring

Номер созданного предзаказа или заявки

barcodestring

Barcode для формирования штрихкода по алгоритму Code 128, если оформлен предзаказ

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

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

Отправитель

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

Member
Member
ПараметрТипОписание
counteragentobjectДанные контрагента
counteragent.idintegerID контрагента
counteragent.statestring

Статус контрагента.

Возможные значения:

  • "existed" - существующий
  • "new" - новый
addressobject

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

address.idintegerID адреса
address.statestring

Статус адреса.

Возможные значения:

  • "existed" - существующий
  • "new" - новый
contactPersonsarray of ContactPerson

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

phoneNumbersarray of PhoneNumber

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

ContactPerson
ContactPerson
ПараметрТипОписание
idintegerID контактного лица
statestring

Статус контактного лица.

Возможные значения:

  • "existed" - существующее
  • "new" - новое
valuestringФИО контактного лица

PhoneNumber
PhoneNumber
ПараметрТипОписание
idintegerID телефонного номера
statestring

Статус телефонного номера.

Возможные значения:

  • "existed" - существующий
  • "new" - новый
valuestringТелефонный номер

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

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

609001

400Указан некорректный документ, удостоверяющий личностьПроверьте правильность переданных значений

609002

400Указан некорректный адресУказан некорректный адрес

609003

400Выбран недопустимый терминалВыбран недопустимый терминал

609004

400Услуга недоступнаВыбранная услуга недоступна для указанных параметров перевозки

609005

400Значение превышает допустимоеГабариты превышают допустимые размеры

609006

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

609007

400Недопустимое значение параметраДетальное описание ошибки см. в поле "detail" ответа

609008

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

609009

400Ошибка оформления услуги Доставка в день заказаДетальное описание ошибки см. в поле "detail" ответа

609010

400Ошибка оформления услуги Доставка в точное времяДетальное описание ошибки см. в поле "detail" ответа

609011

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

609012

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

609013

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

609014

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

609015

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

609016

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