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

API
Главная / API - Изменение контактной информации

Изменение контактной информации по заказу

Обновлено 17.02.2020
87 кб

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

Сервис позволяет изменять контактную информацию грузоотправителя и грузополучателя по заказу (функция недоступна для грузополучателя, являющегося анонимным получателем, см. "Оформление заявок на перевозку из Личного Кабинета" или "Оформление заявок на перевозку из Публичного раздела"). Доступно изменение контактной информации только по заказам, к которым есть доступ у учетной записи текущего пользователя.

Изменение контактной информации по заказу

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

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

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

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "orderID":"1900395024773",
   "members":{
      "sender":{
         "contactIDs":[
            15637261,
            15638153,
            15638154
         ],
         "phoneIDs":[
            19501308,
            19501311,
            19501312
         ],
         "contactPersons":[
            {
               "name":"senderContact1"
            },
            {
               "name":"senderContact2"
            },
            {
               "name":"senderContact3"
            }
         ],
         "phoneNumbers":[
            {
               "number":"79620000000",
               "ext":"3567"
            },
            {
               "number":"79510000000"
            },
            {
               "number":"79500000000"
            }
         ]
      },
      "receiver":{
         "contactIDs":[
            15638146
         ],
         "phoneIDs":[
            19501297
         ],
         "contactPersons":[
            {
               "name":"receiverContact"
            }
         ],
         "phoneNumbers":[
            {
               "number":"79520000000"
            }
         ]
      }
   }
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <orderID>1900395024773</orderID>
   <members>
      <sender>
         <contactIDs>15637261</contactIDs>
         <contactIDs>15638153</contactIDs>
         <contactIDs>15638154</contactIDs>
         <phoneIDs>19501308</phoneIDs>
         <phoneIDs>19501311</phoneIDs>
         <phoneIDs>19501312</phoneIDs>
         <contactPersons>
            <name>senderContact1</name>
         </contactPersons>
         <contactPersons>
            <name>senderContact2</name>
         </contactPersons>
         <contactPersons>
            <name>senderContact3</name>
         </contactPersons>
         <phoneNumbers>
            <number>79620000000</number>
            <ext>3567</ext>
         </phoneNumbers>
         <phoneNumbers>
            <number>79510000000</number>
         </phoneNumbers>
         <phoneNumbers>
            <number>79500000000</number>
         </phoneNumbers>
      </sender>
      <receiver>
         <contactIDs>15638146</contactIDs>
         <phoneIDs>19501297</phoneIDs>
         <contactPersons>
            <name>receiverContact</name>
         </contactPersons>
         <phoneNumbers>
            <number>79520000000</number>
         </phoneNumbers>
      </receiver>
   </members>
</request>

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

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

orderID

Да
string

ID заказа, в который необходимо внести изменения

members

Да
object

Изменяемая контактная информация участников перевозки.

Могут быть переданы новые контактные данные или изменена информация, уже сохраненная в адресной книге учетной записи личного кабинета

members.senderНетMemberИзменяемая контактная информация отправителя
members.receiverНетMemberИзменяемая контактная информация получателя

Member
Member
ПараметрОбязательныйТипОписание
contactIDsНет*
array of integer

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

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

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

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

phoneIDsНет*
array of integer

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

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

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

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

contactPersons
Нет*
array of ContactPersons

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

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

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

contactPersons.nameНетstringИмя контактного лица
phoneNumbersНет*
array of PhoneNumbers

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

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

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

phoneNumbers.numberНетstring

Номер телефона контактного лица

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

phoneNumbers.extНетstringДобавочный номер. Максимальная длина - 4 символа

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2019-11-18 12:52:26"
   },
   "data":{
      "status":"success"
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2019-11-18 12:52:26</generated_at>
   </metadata>
   <data>
      <status>success</status>
   </data>
</response>

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

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

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

metadata.generated_atstring

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

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

dataobjectПодтверждение успешности операции
data.statusstring

Статус операции на английском языке. Возможное значение - "success"

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

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".