Перевозка малотоннажным транспортом

Обновлено 01.03.2023

121 кб

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

Сервис предназначен для оформления заявок на перевозку выделенным малотоннажным транспортом (при этом перевозка осуществляется не по стандартному маршруту, как при перевозке сборного груза, а напрямую, поскольку в машине нет грузов прочих клиентов - только груз заказчика).

Перевозка малотоннажным транспортом

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

Адрес метода: https://api.dellin.ru/v1/customers/request_ts.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "produceDate":"2017-02-20",
   "truckCapacity":"2",
   "sender":{  
      "counteragentID":5775755,
      "addressID":4545885,
      "contact":3465688,
      "contactList":[  
         12312343,
         54364565
      ],
      "phone":4656889,
      "phoneNumbers":[  
         31234343,
         36456565
      ],
      "dataForReceipt":{
         "phone":"+79ХХХХХХХХХ",
         "email":"test@mail.ru"
      },
      "worktimeStart":"09:00",
      "worktimeEnd":"18:00",
      "breakStart":"12:00",
      "breakEnd":"13:00",
      "untentType":1
   },
   "receiver":{  
      "counteragentID":5775755,
      "addressID":4545885,
      "contact":3465688,
      "contactList":[  
         12312343,
         54364565
      ],
      "phone":4656889,
      "phoneNumbers":[  
         31234343,
         36456565
      ],
      "dataForReceipt":{
         "phone":"+79ХХХХХХХХХ",
         "email":"test@mail.ru"
      },
      "worktimeStart":"10:00",
      "worktimeEnd":"20:00",
      "breakStart":"14:00",
      "breakEnd":"14:30",
      "untentType":2
   },
   "transitPoints":[  
      {  
         "counteragentID":5775755,
         "addressID":4545885,
         "worktimeStart":"10:00",
         "worktimeEnd":"20:00",
         "breakStart":"14:00",
         "breakEnd":"14:30",
         "untentType":2
      },
      {  
         "counteragentID":5775755,
         "addressID":4545885,
         "worktimeStart":"10:00",
         "worktimeEnd":"20:00",
         "breakStart":"14:00",
         "breakEnd":"14:30",
         "untentType":3
      }
   ],
   "third":{  
      "counteragentID":5775755,
      "contact":3465688,
      "contactList":[  
         12312343,
         54364565
      ],
      "phone":4656889,
      "phoneNumbers":[  
         31234343,
         36456565
      ],
      "dataForReceipt":{
         "phone":"+79ХХХХХХХХХ",
         "email":"test@mail.ru"
      }
   },
   "statedValue":100.90,
   "loading":true,
   "unloading":false,
   "adSend":false,
   "adReturn":true,
   "payer":"third",
   "paymentType":"cash",
   "promocode":"promo123",
   "mailback":"test@mail.ru",
   "smsback":"79211231234",
   "comment":"test test"
}

Адрес метода: https://api.dellin.ru/v1/customers/request_ts.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <produceDate>2017-02-20</produceDate>
   <truckCapacity>2</truckCapacity>
   <sender>
      <counteragentID>5775755</counteragentID>
      <addressID>4545885</addressID>
      <contact>3465688</contact>
      <contactList>12312343</contactList>
      <contactList>54364565</contactList>
      <phone>4656889</phone>
      <phoneNumbers>31234343</phoneNumbers>
      <phoneNumbers>36456565</phoneNumbers>
      <dataForReceipt>
         <phone>+79ХХХХХХХХХ</phone>
         <email>test@mail.ru</email>
      </dataForReceipt>
      <worktimeStart>09:00</worktimeStart>
      <worktimeEnd>18:00</worktimeEnd>
      <breakStart>12:00</breakStart>
      <breakEnd>13:00</breakEnd>
      <untentType>1</untentType>
   </sender>
   <receiver>
      <counteragentID>5775755</counteragentID>
      <addressID>4545885</addressID>
      <contact>3465688</contact>
      <contactList>12312343</contactList>
      <contactList>54364565</contactList>
      <phone>4656889</phone>
      <phoneNumbers>31234343</phoneNumbers>
      <phoneNumbers>36456565</phoneNumbers>
      <dataForReceipt>
         <phone>+79ХХХХХХХХХ</phone>
         <email>test@mail.ru</email>
      </dataForReceipt>
      <worktimeStart>10:00</worktimeStart>
      <worktimeEnd>20:00</worktimeEnd>
      <breakStart>14:00</breakStart>
      <breakEnd>14:30</breakEnd>
      <untentType>2</untentType>
   </receiver>
   <transitPoints>
      <counteragentID>5775755</counteragentID>
      <addressID>4545885</addressID>
      <worktimeStart>10:00</worktimeStart>
      <worktimeEnd>20:00</worktimeEnd>
      <breakStart>14:00</breakStart>
      <breakEnd>14:30</breakEnd>
      <untentType>2</untentType>
   </transitPoints>
   <transitPoints>
      <counteragentID>5775755</counteragentID>
      <addressID>4545885</addressID>
      <worktimeStart>10:00</worktimeStart>
      <worktimeEnd>20:00</worktimeEnd>
      <breakStart>14:00</breakStart>
      <breakEnd>14:30</breakEnd>
      <untentType>3</untentType>
   </transitPoints>
   <third>
      <counteragentID>5775755</counteragentID>
      <contact>3465688</contact>
      <contactList>12312343</contactList>
      <contactList>54364565</contactList>
      <phone>4656889</phone>
      <phoneNumbers>31234343</phoneNumbers>
      <phoneNumbers>36456565</phoneNumbers>
      <dataForReceipt>
         <phone>+79ХХХХХХХХХ</phone>
         <email>test@mail.ru</email>
      </dataForReceipt>
   </third>
   <statedValue>100.9</statedValue>
   <loading>true</loading>
   <unloading>false</unloading>
   <adSend>false</adSend>
   <adReturn>true</adReturn>
   <payer>third</payer>
   <paymentType>cash</paymentType>
   <promocode>promo123</promocode>
   <mailback>test@mail.ru</mailback>
   <smsback>79211231234</smsback>
   <comment>test test</comment>
</request>

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

Request
Параметр	R*	Тип	Описание
Основные параметры
appkey	Да	string	Ключ приложения. Для получения ключа необходимо пройти регистрацию
sessionID	Да	string	ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
produceDate	Да	string	Дата выполнения
truckCapacity	Да	integer	Грузоподъемность. Доступные значения: "1" - 1.5т-15м3 "2" - 4т-27м3 "3" - 10т-35м3
requester	Нет	string	Заказчик. UID одного из доступных контрагентов учетной записи ЛК. Может быть получен с помощью метода "Cписок контрагентов"
role	Нет	string	Роль в перевозке. Доступные значения: "sender" - отправитель "receiver" - получатель "payer" - плательщик. Доступно, если в учетной записи ЛК есть не менее одного контрагента с полным доступом "third" - третье лицо. Доступно, если в учетной записи ЛК нет контрагентов с полным доступом
noFullAccess	Нет	boolean	Флаг отсутствия полного доступа к контрагентам. Параметр необходимо передать, если у оформителя заявки в учетной записи ЛК нет контрагентов с полным доступом
sender	Да	Request.Sender	Данные отправителя
receiver	Да	Request.Receiver	Данные получателя
transitPoints	Нет	array of Request.TransitPoints	Данные о дополнительных точках маршрута. Массив может содержать не более трех объектов
third	Да*	Request.Third	Данные третьего лица. *Только если "payer" = "third"
Дополнительные услуги
statedValue	Нет	float	Объявленная стоимость. Значение по умолчанию: "0"
loading	Нет	boolean	Погрузка в месте подачи. Значение по умолчанию: "false"
unloading	Нет	boolean	Разгрузка в месте назначения. Значение по умолчанию: "false"
Услуги по сопроводительным документам
adSend	Нет	boolean	Отправка сопроводительных документов. Значение по умолчанию: "false"
adReturn	Нет	boolean	Возврат сопроводительных документов. Значение по умолчанию: "false"
Данные по плательщику
payer	Да	string	Плательщик. Доступные значения: "sender" = отправитель "receiver" = получатель "third" = третье лицо
paymentType	Да	string	Тип оплаты. Доступные значения: "cash" = оплата наличными "non_cash" = безналичная оплата
promocode	Нет	string	Промокод (обрабатывается оператором при оформлении заказа)
Контактные данные
mailback	Нет	string	E-mail для связи и уведомлений
smsback	Нет	string	Телефон для связи и уведомлений по SMS в формате "79999999999"
comment	Нет	string	Комментарий к заказу

Request.Sender
Параметр	R*	Тип	Описание
counteragentID	Да	integer	ID контрагента. Указывается на основании "Адресной книги"
addressID	Да	integer	ID адреса. Указывается на основании "Адресной книги"
phone	Да	integer	ID контактного телефона или Массив ID контактных телефонов. Указывается на основании "Адресной книги". В запросе должен присутствовать только 1 из параметров
phoneNumbers	Да	array of integers
contact	Да	integer	ID контактного лица или массив ID контактных лиц. Указывается на основании "Адресной книги". В запросе должен присутствовать только 1 из параметров
contactList	Да	array of integers
dataForReceipt	Нет	object	Контактные данные для отправки электронного чека плательщику-физическому лицу
dataForReceipt.phone	Нет	string	Номер телефона для отправки чека. Формат номера: "+79XXXXXXXXX" (12 символов: начинается с "+79" и далее 9 цифр)
dataForReceipt.email	Нет	string	E-mail адрес для отправки чека
worktimeStart	Да	string	Время начала работы. Формат: ЧЧ:ММ
worktimeEnd	Да	string	Время окончания работы. Формат: ЧЧ:ММ
breakStart	Нет	string	Начало перерыва в работе. Формат: ЧЧ:ММ
breakEnd	Нет	string	Окончание перерыва в работе. Формат: ЧЧ:ММ
untentType	Нет	integer	Тип растентовки. Доступные значения: "1" - задняя "2" - верхняя "3" - боковая Значение по умолчанию: "1"

Параметры объектов "Request.Receiver", "Request.TransitPoints" и "Request.Third" аналогичны параметрам объекта "Request.Sender".

Ответ метода

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

JSON
XML

{
   "order_id": 1111111,
   "success": true
}

<response>
   <order_id>1111111</order_id>
   <success>true</success>
</response>

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

Response
Параметр	Тип	Описание
order_id	integer	Номер заказа
success	boolean	Признак успешности операции

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

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

JSON
XML

{  
   "answer":{  
      "state":"error",
      "errors":{  
         "smsback":"Значение параметра smsback не соответствует формату"
      }
   }
}

<response>
   <state>error</state>
   <errors>
      <smsback>Значение параметра smsback не соответствует формату</smsback>
   </errors>
</response>

Виды ошибок

Ошибка	Описание
Не указаны данные третьего лица	В параметре "payer" передано значение "third", но объект "third" отсутствует в запросе
Значение параметра "smsback" не соответствует формату	Формат параметра: 11 цифр с ведущей семеркой (79999999999)
Некорректное значение параметра "role"	В параметре "role" передано значение "payer" И (отсутствует полный доступ к контрагентам ИЛИ в параметре "noFullAccess" передано значение "true"); В параметре "role" передано значение "third" И (есть полный доступ к контрагентам ИЛИ в параметре "noFullAccess" передано значение "true")
Недопустимое значение параметра "requester"	В параметре "requester" передан UID несуществующего контрагента; В аккаунте отсутствуют контрагенты
Телефон содержит недопустимые символы; Неверный номер телефона	Значение параметра "dataForReceipt . phone" не соответствует формату: "+79XXXXXXXXX" (12 символов: начинается с "+79" и далее 9 цифр)

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

Перевозка малотоннажным транспортом

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

Перевозка малотоннажным транспортом

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

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

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

Ответ метода

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

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

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

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

Виды ошибок