Изменение адреса и времени отправки
Общие сведения
Сервис позволяет изменить
Изменение адреса или времени отправки
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v3/orders/change_pickup.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "orderID":"00000000", "variant":"address", "addressID":457824578, "address":{ "street":"7800000000004380000000000", "search":"Санкт-Петербург, ул. Ленина, 1", "house":"4", "building":"3", "structure":"лит. А", "flat":"214а" }, "produce_date":"2020-10-01", "time":{ "worktimeStart":"09:00", "worktimeEnd":"18:00", "breakStart":"12:30", "breakEnd":"13:30", "exactTime":true }, "contactIDs":[ 12345678, 78456123 ], "contactPersons":[ { "name":"Иван Иванович" }, { "name":"Петр Петрович" } ], "phoneIDs":[ 98765412, 65478921 ], "phoneNumbers":[ { "number":"79213332211", "ext":"0123" } ] }
Адрес метода: https://api.dellin.ru/v3/orders/change_pickup.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <orderID>00000000</orderID> <variant>address</variant> <addressID>457824578</addressID> <address> <street>7800000000004380000000000</street> <search>Санкт-Петербург, ул. Ленина, 1</search> <house>4</house> <building>3</building> <structure>лит. А</structure> <flat>214а</flat> </address> <produce_date>2020-10-01</produce_date> <time> <worktimeStart>09:00</worktimeStart> <worktimeEnd>18:00</worktimeEnd> <breakStart>12:30</breakStart> <breakEnd>13:30</breakEnd> <exactTime>true</exactTime> </time> <contactIDs>12345678</contactIDs> <contactIDs>78456123</contactIDs> <contactPersons> <name>Иван Иванович</name> </contactPersons> <contactPersons> <name>Петр Петрович</name> </contactPersons> <phoneIDs>98765412</phoneIDs> <phoneIDs>65478921</phoneIDs> <phoneNumbers> <number>79213332211</number> <ext>0123</ext> </phoneNumbers> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться сервисом "Авторизация пользователя" |
orderID | Да | string | Номер заказа, в который необходимо внести изменения |
variant | Да | string | Способ отправки груза. Настоящий метод позволяет изменить лишь адрес отправки груза, но не способ, поэтому единственное возможное значение параметра - "address" (доставка груза от адреса) |
addressID | Нет* | integer | ID адреса из "Адресной книги" *В запросе обязательно должен быть передан один из взаимоисключающих параметров: "addressID" или "address" |
address | Нет* | object | Адрес. Новый адрес должен находиться в том же регионе, что и указанный изначально *В запросе обязательно должен быть передан один из взаимоисключающих параметров: "addressID" или "address" |
address.search | Нет* | string | Адрес в виде текста или координат. При передаче адреса в виде текста, помимо собственно адреса, в запрос следует включать наименование населённого пункта, элементы необходимо указывать через запятую, например "Омск, Ленина, 5". Координаты также указываются через запятую, первое число - широта, например "59.924501, 30.241762". Максимум - 1024 символа *В запросе обязательно должен быть передан адрес - в виде строки ("search") или набора параметров (в этом случае обязательными являются параметры "street" и "house") |
address.street | Нет* | string | Код КЛАДР улицы (см. "Поиск КЛАДР") *В запросе обязательно должен быть передан адрес - в виде строки ("search") или набора параметров (в этом случае обязательными являются параметры "street" и "house") |
address.house | Нет* | string | Номер дома, включая литеру. Например, "13/А". Максимум 7 символов *В запросе обязательно должен быть передан адрес - в виде строки ("search") или набора параметров (в этом случае обязательными являются параметры "street" и "house") |
address.building | Нет | string | Корпус. Максимум 5 символов Передача параметра "search" исключает передачу параметров "building" и "structure" |
address.structure | Нет | string | Строение. Максимум 7 символов Передача параметра "search" исключает передачу параметров "building" и "structure" |
address.flat | Нет | string | Номер квартиры/офиса. Допускается написание с буквой, например "222 А". Максимум 5 символов В случае одновременной передачи параметров "search" и "flat" в качестве номера квартиры/офиса будет использоваться значение параметра "flat" |
produce_date | Нет* | string | Дата передачи груза на терминал или дата приезда водителя-экспедитора к отправителю. Формат: ГГГГ-ММ-ДД Передавая в качестве значения параметра текущую дату, следует учитывать, что доставка груза от адреса в день оформления заказа возможна, только если заявка оформлена в будний день до 16:00 по местному времени, в населённом пункте есть терминал компании "Деловые Линии", который работает в течение двух или более часов с момента подачи заявки, а габариты груза не превышают:
*Если значение параметра "variant" - "address", то параметр является обязательным |
time | Нет* | object | Время передачи груза (на адресе). Информацию о доступных интервалах можно получить при помощи метода "Интервалы передачи груза на адресе отправителя" *Если значение параметра "variant" - "address", то параметр является обязательным |
time.worktimeStart | Да | string | Начало периода. Формат: ЧЧ:ММ |
time.worktimeEnd | Да | string | Конец периода. Формат: ЧЧ:ММ |
time.breakStart | Нет | string | Начало перерыва. Формат: ЧЧ:ММ |
time.breakEnd | Нет | string | Окончание перерыва. Формат: ЧЧ:ММ |
time.exactTime | Нет | boolean | Передача груза в точное время. Значение по умолчанию: "false" |
contactIDs | Нет* | array of integers | Список ID контактных лиц из "Адресной книги". Максимальное количество элементов в массиве - 3 *В запросе обязательно должен быть передан один из взаимоисключающих параметров: "contactIDs" или "contactPersons" |
contactPersons | Нет* | array of contactPersons | Данные контактных лиц. Максимальное количество элементов в массиве - 3 *В запросе обязательно должен быть передан один из взаимоисключающих параметров: "contactIDs" или "contactPersons" |
contactPersons.name | Да | string | Имя контактного лица |
phoneIDs | Нет* | array of integers | Список ID телефонных номеров из "Адресной книги". Максимальное количество элементов в массиве - 3 *В запросе обязательно должен быть передан один из взаимоисключающих параметров: "phoneIDs" или "phoneNumbers" |
phoneNumbers | Нет* | array of phoneNumbers | Список телефонных номеров. Максимальное количество элементов в массиве - 3 *В запросе обязательно должен быть передан один из взаимоисключающих параметров:: "phoneIDs" или "phoneNumbers" |
phoneNumbers.number | Да | string | Номер телефона. Максимум 15 символов (допускаются цифры и знак "+" в начале строки) |
phoneNumbers.ext | Нет | string | Добавочный номер. Максимум 5 цифр |
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2019-11-18 12:52:26" }, "data":{ "state":"success", "information": "Смена адреса и времени отправки груза будет бесплатной при подаче запроса до 17:00 (по местному времени) дня, предшествующего дню отправки.", "foundAddresses": [ { "source": "Санкт-Петербург, ул. Ленина, 1", "result": "Россия, г Санкт-Петербург, г Санкт-Петербург, ул Ленина, д 1", "field": "address" } ] } }
<response> <metadata> <status>200</status> <generated_at>2019-11-18 12:52:26</generated_at> </metadata> <data> <state>success</state> <information>Смена адреса и времени отправки груза будет бесплатной при подаче запроса до 17:00 (по местному времени) дня, предшествующего дню отправки.</information> <foundAddresses> <source>Санкт-Петербург, ул. Ленина, 1</source> <result>Россия, г Санкт-Петербург, г Санкт-Петербург, ул Ленина, д 1</result> <field>address</field> </foundAddresses> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200". В случае ошибки - "400" |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | object | Подтверждение успешности операции |
data.state | string | Статус операции на английском языке. Возможное значение - "success" Статус "success" означает, что заявка на внесение изменений была принята. После дополнительной проверки заявка может быть одобрена или отклонена. Проверить статус заявки можно при помощи метода "История изменений заказа" |
data.information | string | Информация об условиях бесплатного изменения адреса и времени отправки |
data.foundAddresses | array of FoundAddresses | Данные по найденным адресам. Параметр присутствует в ответе, только если в запросе был передан параметр "address.search" |
FoundAddresses
FoundAddresses | ||
---|---|---|
Параметр | Тип | Описание |
field | string | Объект, в котором был передан параметр "search" |
source | string | Введённое значение |
result | string | Найденный адрес |
Обработка ошибок
Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:
Номер ошибки | http-код | Краткое описание ошибки | Детальное описание ошибки |
---|---|---|---|
621001 | 400 | По данному заказу изменение адреса и времени недоступно | - |
621002 | 400 | По данному заказу изменение адреса и времени недоступно | Изменение по данному заказу недоступно в связи с отсутствием доступа |