Изменение контактной информации по заказу
Общие сведения
Сервис позволяет изменять контактную информацию грузоотправителя и грузополучателя по заказу (функция недоступна для грузополучателя, являющегося "анонимным" получателем, то есть для получателя, о котором предоставлен минимум информации, см. описание услуги "Упрощённая отправка груза" на сайте компании "Деловые Линии"). Доступно изменение контактной информации только по заказам, к которым есть доступ у учетной записи текущего пользователя. Для проверки возможности внесения изменений следует использовать метод "Доступные изменения заказа". Изменения вступают в силу не сразу. Проверить статус заявки можно при помощи метода "История изменений заказа".
Изменение контактной информации по заказу
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v3/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/v3/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 | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
orderID | Да | string | Номер заказа, в который необходимо внести изменения |
members | Да | object | Изменяемая контактная информация участников перевозки. Могут быть переданы новые контактные данные или изменена информация, уже сохраненная в адресной книге учетной записи личного кабинета |
| members.sender | Нет | Member | Изменяемая контактная информация отправителя |
| members.receiver | Нет | Member | Изменяемая контактная информация получателя |
Member
| Member | |||
|---|---|---|---|
| Параметр | Обязательный | Тип | Описание |
| contactIDs | Нет* | array of integers | Список ID контактных лиц из "Адресной книги". Максимальное количество элементов в массиве: 3. *Параметр не является обязательным и игнорируется при публичном оформлении заявки. *Допускается передача только одного из параметров: "contactIDs", "contactPersons" |
| phoneIDs | Нет* | array of integers | Список ID телефонных номеров из "Адресной книги". Максимальное количество элементов в массиве: 3. *Параметр не является обязательным и игнорируется при публичном оформлении заявки. *Допускается передача только одного из параметров: "phoneIDs", "phoneNumbers" |
| contactPersons | Нет* | array of ContactPersons | Список контактных лиц. Максимальное количество элементов в массиве: 3. *Допускается передача только одного из параметров: "contactIDs", "contactPersons" |
| contactPersons.name | Нет | string | Имя контактного лица |
| phoneNumbers | Нет* | array of PhoneNumbers | Список телефонных номеров. Максимальное количество элементов в массиве: 3. *Допускается передача только одного из параметров: "phoneIDs", "phoneNumbers" |
| phoneNumbers.number | Нет | string | Номер телефона контактного лица. Допускаются цифры и знак "+" в начале строк, начинающихся с 7 или 375 |
| 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 | ||
|---|---|---|
| Параметр | Тип | Описание |
| metadata | object | Системная информация |
| metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200". В случае ошибки - "400" |
| metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
| data | object | Подтверждение успешности операции |
| data.status | string | Статус операции на английском языке. Возможное значение - "success" Статус "success" означает, что заявка на внесение изменений была принята. Проверить статус заявки можно при помощи метода "История изменений заказа" |
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".
