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

API
Главная / API - Доставка до адреса

Доставка до адреса

Обновлено 09.08.2017
122 кб

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

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

Заказ услуги Доставка до адреса

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

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

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

{
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "docSQLuid":"0xa8554c84937a86d54489b6015d345a42",
   "produceDate":"2013-12-17",
   "comment":"забрать можно и в обеденный перерыв",
   "paymentType":"cash",
   "payer":"third",
   "notifySMS":"+79601231221",
   "notifyMail":"mail@mail.ru",
   "contactPerson":{  
      "name":"Василий",
      "phoneNumbersExtended":[  
         {
            "phoneNumber": "+7(333)333-33-33",
            "addNumber": ""
         }, 
         {
            "phoneNumber": "+7(333)333-33-33",
            "addNumber": "9878"
         }
      ]  
   },
   "address":{  
      "cityCode":"7800000000000000000000000",
      "streetCode":"7800000000000070000000000",
      "street":"Васильковая",
      "house":"1а",
      "building":"2б",
      "structure":"3с",
      "flat":"4е"
   },
   "workTime":{  
      "start":"10:00",
      "end":"17:00"
   },
   "breakTime":{  
      "start":"14:00",
      "end":"14:30"
   },
   "third":{  
      "isIndividual":false,
      "name":"Иванова Мария Петровна",
      "countryUID":"0x8F51001438C4D49511DBD774581EDB7A",
      "phoneNumbersExtended":[  
         {
            "phoneNumber": "+7(333)333-33-33",
            "addNumber": ""
         }, 
         {
            "phoneNumber": "+7(333)333-33-33",
            "addNumber": "9878"
         }
      ],
      "person":"Маша",
      "opfType":"ООО",
      "opfUID":"0x8390B2048D37E0154B845FB22793E865",
      "inn":"123",
      "juridicalAddress":{  
         "cityCode":"7800000000000000000000000",
         "streetCode":"7800000000000070000000000",
         "street":"Васильковая",
         "house":"1а",
         "building":"2б",
         "structure":"3с",
         "flat":"4е"
      },
      "document":{  
         "dtype":"passport",
         "serial":"1234",
         "number":"123456",
         "date":"2013-08-01"
      },
      "address_obj":{
         "code": "7800000000000000000000000"
      }
   },
   "timeexact":true,
   "additionalOptions": [
      "0xb83b7589658a3851440a853325d1bf69",
      "0x92fce2284f000b0241dad7c2e88b1655"
   ],
   "loadUnload":[  
      {  
         "uid":"0xa77fcf6a449164ed490133777a68bd51"
      },
      {  
         "uid":"0xadf1fc002cb8a9954298677b22dbde12",
         "value":"4"
      },
      {  
         "uid":"0x9a0d647ddb11ebbd4ddaaf3b1d9f7b74",
         "value":"58"
      }
   ]
}

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <docsqluid>0xa8554c84937a86d54489b6015d345a42</docsqluid>
   <producedate>2013-12-17</producedate>
   <comment>забрать можно и в обеденный перерыв</comment>
   <paymenttype>cash</paymenttype>
   <payer>third</payer>
   <notifysms>+79601231221</notifysms>
   <notifymail>mail@mail.ru</notifymail>
   <contactperson>
      <name>Василий</name>
      <phonenumbersextended>
         <phonenumber>+7(333)333-33-33</phonenumber>
         <addnumber></addnumber>
      </phonenumbersextended>
      <phonenumbersextended>
         <phonenumber>+7(333)333-33-33</phonenumber>
         <addnumber>9878</addnumber>
      </phonenumbersextended>
   </contactperson>
   <address>
      <citycode>7800000000000000000000000</citycode>
      <streetcode>7800000000000070000000000</streetcode>
      <street>Васильковая</street>
      <house>1а</house>
      <building>2б</building>
      <structure>3с</structure>
      <flat>4е</flat>
   </address>
   <worktime>
      <start>10:00</start>
      <end>17:00</end>
   </worktime>
   <breaktime>
      <start>14:00</start>
      <end>14:30</end>
   </breaktime>
   <third>
      <isindividual>false</isindividual>
      <name>Маша</name>
      <countryuid>0x8F51001438C4D49511DBD774581EDB7A</countryuid>
      <phonenumbersextended>
         <phonenumber>+7(333)333-33-33</phonenumber>
         <addnumber></addnumber>
      </phonenumbersextended>
      <phonenumbersextended>
         <phonenumber>+7(333)333-33-33</phonenumber>
         <addnumber>9878</addnumber>
      </phonenumbersextended>
      <person>Маша</person>
      <opftype>ООО</opftype>
      <opfuid>0x8390B2048D37E0154B845FB22793E865</opfuid>
      <inn>123</inn>
      <juridicaladdress>
         <citycode>7800000000000000000000000</citycode>
         <streetcode>7800000000000070000000000</streetcode>
         <street>Васильковая</street>
         <house>1а</house>
         <building>2б</building>
         <structure>3с</structure>
         <flat>4е</flat>
      </juridicaladdress>
      <document>
         <dtype>passport</dtype>
         <serial>1234</serial>
         <number>123456</number>
         <date>2013-08-01</date>
      </document>
      <address_obj>
         <code>7800000000000000000000000</code>
      </address_obj>
   </third>
   <timeexact>true</timeexact>
   <additionaloptions>0xb83b7589658a3851440a853325d1bf69</additionaloptions>
   <additionaloptions>0x92fce2284f000b0241dad7c2e88b1655</additionaloptions>
   <loadunload>
      <uid>0xa77fcf6a449164ed490133777a68bd51</uid>
   </loadunload>
   <loadunload>
      <uid>0xadf1fc002cb8a9954298677b22dbde12</uid>
      <value>4</value>
   </loadunload>
   <loadunload>
      <uid>0x9a0d647ddb11ebbd4ddaaf3b1d9f7b74</uid>
      <value>58</value>
   </loadunload>
</request>

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

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

sessionID

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

docSQLuid

ДаstringUID накладной, полученный из сервиса "Список заказов"

produceDate

ДаstringЖелаемая дата выполнения заявки

comment

НетstringКомментарий

paymentType

Даstring

Вид платежа.

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

  • "cash" - наличный расчет
  • "no-cash" - безналичный расчет

payer

Даstring

Плательщик.

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

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

notifySMS

НетstringНомер телефона для SMS-уведомлений

notifyMail

НетstringE-mail адрес для уведомлений

contactPerson

НетRequest.ContactPersonКонтактное лицо (если не передать, то данные будут взяты из накладной)

address

ДаobjectАдрес доставки
address.cityCodeДаstringКод города
address.streetCodeНетstringКод улицы
address.streetДаstringУлица
address.houseДаstringДом
address.buildingНетstringКорпус
address.structureНетstringСтроение
address.flatНетstringКвартира
workTimeДаobjectВремя работы

workTime.start

ДаstringНачало рабочего времени

workTime.end

ДаstringОкончание рабочего времени
breakTimeДаobjectПерерыв на обед
breakTime.startДаstringНачало обеденного перерыва
breakTime.endДаstringОкончание обеденного перерыва
thirdДа*Request.Third.Juridical

Данные третьего лица (для юридического лица)

*Только если "payer" = "third"

Request.Third.Physical

Данные третьего лица (для физического лица)

*Только если "payer" = "third"

timeexactДаbooleanТочное время доставки

additionalOptions

Нетarray of string

Дополнительные параметры доставки до адреса из "Справочника специальных требований к транспорту"

loadUnloadНетarray of Request.LoadUnloadЗаказ разгрузки ТС. Содержит дополнительные параметры, необходимые для расчета погрузо-разгрузочных работ

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

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

*Только если заказ не является заказом с упрощенной отправкой. Для заказов с УО - необязательный параметр

phoneNumbersExtendedДа*array of Request.ContactPerson.PhoneNumbersExtended

Массив контактных телефонов контактного лица

*Только если заказ не является заказом с упрощенной отправкой. Для заказов с УО параметр должен отсутствовать

Request.ContactPerson.PhoneNumbersExtended
ПараметрR*ТипОписание
phoneNumberДаstringНомер телефона
addNumberНетstringДобавочный номер

Request.Third.Juridical
ПараметрR*ТипОписание
isIndividualДаbooleanПризнак частного лица
nameДаstringНазвание юр. лица
countryUIDДаstringUID страны из "Справочника стран"
phoneNumbersExtendedДаarray of Request.Third.PhoneNumbersExtendedМассив контактных телефонов третьего лица
personДаstringКонтактное лицо
opfTypeДаstringОПФ юр. лица
opfUIDДаstringUID ОПФ юр. лица из "Справочника ОПФ"
innДаstringИНН
juridicalAddressДаobjectЮридический адрес
juridicalAddress.cityCodeДаstringКод города
juridicalAddress.streetCodeНетstringКод улицы
juridicalAddress.streetДаstringУлица
juridicalAddress.houseДаstringДом
juridicalAddress.buildingНетstringКорпус
juridicalAddress.structureНетstringСтроение
juridicalAddress.flatНетstringКвартира
address_objДа*object

Адрес местонахождения третьего лица

*Только если "payer" = "third" и "PaymentType" = "cash" (наличный расчет)

address_obj.codeДа*string

Код КЛАДР населенного пункта, в котором находится плательщик-третье лицо (из которого будет совершаться оплата перевозки)

*Только если "payer" = "third" и "PaymentType" = "cash" (наличный расчет)

Request.Third.Physical
ПараметрR*ТипОписание
isIndividualДаbooleanПризнак частного лица
nameДаstringФИО
countryUIDДаstringUID страны из "Справочника стран"
phoneNumbersExtendedДаarray of Request.Third.PhoneNumbersExtendedМассив контактных телефонов третьего лица
documentДаobjectДанные документа
document.dtypeДаstring

Вид документа.

Доступные варианты:

  • "passport" - паспорт
  • "foreignPassport" - загран. паспорт
  • "drivingLicence" - водительское удостоверение
document.serialДаstringСерия документа
document.numberДаstringНомер документа
document.dateДаstringДата выдачи документа
address_objДа*object

Адрес местонахождения третьего лица

*Только если "payer" = "third" и "PaymentType" = "cash" (наличный расчет)

address_obj.codeДа*string

Код КЛАДР населенного пункта, в котором находится плательщик-третье лицо (из которого будет совершаться оплата перевозки)

*Только если "payer" = "third" и "PaymentType" = "cash" (наличный расчет)

Параметры объекта "Request.Third.PhoneNumbersExtended" аналогичны параметрам объекта "Request.ContactPerson.PhoneNumbersExtended".

Request.LoadUnload
ПараметрR*ТипОписание
uidНетstringУникальные идентификаторы дополнительных параметров, необходимых для расчета погрузо-разгрузочных работ. Список параметров заполняется на основании данных из "Справочника услуг ПРР". Если дополнительные параметры не будут переданы в запросе, погрузо-разгрузочные работы будут заказаны, но их стоимость будет рассчитана неточно
valueНетstringЗначение доп. параметра, если оно необходимо. К примеру, доп. параметр = "этаж", значение = "4"

Ответ метода

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

{
   "answer":{
      "status":"success",
      "id":123456
   }
}
<response>
   <answer>
      <status>success</status>
      <id>123456</id>
   </answer>
</response>

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

Response
ПараметрТипОписание
answerobjectИнформация об оформленной заявке
answer.statusstring

Статус оформления заявки

answer.idintegerID заявки

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

Если в запросе не заполнены обязательные поля, в ответ вернётся соответствующее сообщение об ошибке:

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

{   
   "errors":{   
      "docSQLuid":"Требуется",
      "produceDate":"Требуется",
      "workTime":"Требуется",
      "payer":"Требуется",
      "paymentType":"Требуется"
   }
}
<response><errors>
   <docsqluid>Требуется</docsqluid>
   <producedate>Требуется</producedate>
   <worktime>Требуется</worktime>
   <payer>Требуется</payer>
   <paymenttype>Требуется</paymenttype>
</errors></response>

При попытке создать более одной заявки на отвоз по одной и той же накладной, или если передан номер несуществующей накладной, ошибка будет выглядеть следующим образом:

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

{
   "errors": "Оформление заявки по этой накладной недоступно"
}
<response>
   <errors>Оформление заявки по этой накладной недоступно</errors>
</response>

Если в запросе указан вид платежа "Наличный расчет", но в населенном пункте плательщика наличный расчет недоступен, будет выведена следующая ошибка:

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

{
   "errors": {
      "paymentType": "В населенном пункте плательщика наличный расчет недоступен."
   }
}
<response>
   <errors>
      <paymentType>В населенном пункте плательщика наличный расчет недоступен.</paymentType>
   </errors>
</response>

Если в качестве плательщика в запросе указано третье лицо, но не передан код КЛАДР населенного пункта плательщика, вернётся следующее сообщение об ошибке:

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

{  
   "errors":{  
      "third":{  
         "address_obj":{  
            "code":"Поле обязательно для заполнения если плательщик третье лицо и формой оплаты выбран наличный расчет."
         }
      }
   }
}
<response>
   <errors>
      <third>
         <address_obj>
            <code>Поле обязательно для заполнения если плательщик третье лицо и формой оплаты выбран наличный расчет.</code>
         </address_obj>
      </third>
   </errors>
</response>