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

API
Главная / API - Заявка на прямую машину

Заявка на прямую машину

Обновлено 08.09.2017
90 кб

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

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

Заявка на прямую машину

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

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

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

{  
   "appkey":"00000000-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
      ],
      "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
      ],
      "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
      ]
   },
   "statedValue":100.90,
   "loading":true,
   "unloading":false,
   "adSend":false,
   "adReturn":true,
   "payer":"third",
   "paymentType":"cash",
   "mailback":"test@mail.ru",
   "smsback":"79211231234",
   "comment":"test test"
}

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

<request>
   <appkey>00000000-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>
      <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>
      <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>
   </third>
   <statedvalue>100.9</statedvalue>
   <loading>true</loading>
   <unloading>false</unloading>
   <adsend>false</adsend>
   <adreturn>true</adreturn>
   <payer>third</payer>
   <paymenttype>cash</paymenttype>
   <mailback>test@mail.ru</mailback>
   <smsback>79211231234</smsback>
   <comment>test test</comment>
</request>

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

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

Грузоподъемность.

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

  • "1" - 1.5т-15м3
  • "2" - 4т-27м3
  • "3" - 10т-35м3
requesterНетstringЗаказчик. UID одного из доступных контрагентов учетной записи ЛК. Может быть получен с помощью метода "Получение списка контрагентов"
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" = безналичная оплата
Контактные данные
mailbackНетstringE-mail для связи и уведомлений
smsbackНетstringТелефон для связи и уведомлений по SMS в формате "79999999999"
commentНетstringКомментарий к заказу

Request.Sender
ПараметрR*ТипОписание
counteragentIDДаintegerID контрагента. Указывается на основании "Адресной книги"
addressIDДаintegerID адреса. Указывается на основании "Адресной книги"
phoneДаinteger

ID контактного телефона или Массив ID контактных телефонов. Указывается на основании "Адресной книги".

В запросе должен присутствовать только 1 из параметров

phoneNumbersДаarray of integer
contactДаinteger

ID контактного лица или массив ID контактных лиц. Указывается на основании "Адресной книги".

в запросе должен присутствовать только 1 из параметров

contactListДаarray of integer
worktimeStartДаstring

Время начала работы.

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

worktimeEndДаstring

Время окончания работы.

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

breakStartНетstring

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

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

breakEndНетstringОкончание перерыва в работе.

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

untentTypeНетinteger

Тип растентовки.

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

  • "1" - задняя
  • "2" - верхняя
  • "3" - боковая

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

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

Ответ метода

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

{
   "order_id": 1111111,
   "success": true
}
<response>
   <order_id>1111111</order_id>
   <success>true</success>
</response>

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

Response
ПараметрТипОписание
order_idintegerНомер заказа
successbooleanПризнак успешности операции

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

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

{  
   "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 несуществующего контрагента
  • В аккаунте отсутствуют контрагенты