История статусов заказа
Общие сведения
Сервис позволяет получать историю изменения статусов заказов. Сервис доступен как авторизованным, так и неавторизованным пользователям.
История статусов заказа
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v3/orders/statuses_history.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "docIds":[ "400267443", "400267444" ], "webOrderNumber":"935743976" }
Адрес метода: https://api.dellin.ru/v3/orders/statuses_history.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <docIds>400267443</docIds> <docIds>400267444</docIds> <webOrderNumber>935743976</webOrderNumber> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
docIds | Нет* | array of strings | Номер заказа, накладной или заявки. Возможна передача нескольких параметров. Максимум может быть передано 5 значений *В запросе обязательно должен быть передан один из взаимоисключающих параметров: "docIds" или "webOrderNumber" |
webOrderNumber | Нет* | string | Номер заказа интернет-магазина (внутренний номер заказа, ВНЗ) *В запросе обязательно должен быть передан один из взаимоисключающих параметров: "docIds" или "webOrderNumber" |
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2023-01-26 15:06:51" }, "data":{ "statusHistory":{ "400267443":[ { "number":"400267443", "state":"waiting", "stateName":"Ожидает сдачи на терминал", "stateDate":"2023-01-12T15:52:40.000+03:00", "detailedStatus":"waiting", "detailedStatusRus":null, "detailedStatusDate":"2023-01-12T15:52:40.000+03:00" }, { "number":"400267443", "state":"inway", "stateName":"Груз в пути", "stateDate":"2023-01-25T11:10:44.000+03:00", "detailedStatus":"inway", "detailedStatusRus":null, "detailedStatusDate":"2023-01-25T11:10:44.000+03:00" }, { "number":"400267443", "state":"arrived_to_airport", "stateName":"Груз прибыл в аэропорт", "stateDate":"2023-01-25T11:12:03.000+03:00", "detailedStatus":"arrived_to_airport", "detailedStatusRus":null, "detailedStatusDate":"2023-01-25T11:12:03.000+03:00" } ] }, "info":[ { "number":"400267444", "message":"Найдено более одного заказа" }, { "number":"935743976", "message":"Заказ не найден" } ] } }
<response> <metadata> <status>200</status> <generated_at>2023-01-26 15:06:51</generated_at> </metadata> <data> <statusHistory> <400267443> <number>400267443</number> <state>waiting</state> <stateName>Ожидает сдачи на терминал</stateName> <stateDate>2023-01-12T15:52:40.000+03:00</stateDate> <detailedStatus>waiting</detailedStatus> <detailedStatusRus /> <detailedStatusDate>2023-01-12T15:52:40.000+03:00</detailedStatusDate> </400267443> <400267443> <number>400267443</number> <state>inway</state> <stateName>Груз в пути</stateName> <stateDate>2023-01-25T11:10:44.000+03:00</stateDate> <detailedStatus>inway</detailedStatus> <detailedStatusRus /> <detailedStatusDate>2023-01-25T11:10:44.000+03:00</detailedStatusDate> </400267443> <400267443> <number>400267443</number> <state>arrived_to_airport</state> <stateName>Груз прибыл в аэропорт</stateName> <stateDate>2023-01-25T11:12:03.000+03:00</stateDate> <detailedStatus>arrived_to_airport</detailedStatus> <detailedStatusRus /> <detailedStatusDate>2023-01-25T11:12:03.000+03:00</detailedStatusDate> </400267443> </statusHistory> <info> <number>400267444</number> <message>Найдено более одного заказа</message> </info> <info> <number>935743976</number> <message>Заказ не найден</message> </info> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK) |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | object | История изменения статусов по каждому найденному заказу и информационные сообщения |
data.statusHistory | StatusHistory | Перечень найденных заказов и история изменения их статусов |
data.info | array of Info | Массив информационных сообщений. Выводится в ответе, если одновременно выполняются условия:
В этом случае по однозначно найденным заказам выводится история изменения их статусов в блоке "data.statusHistory", а по остальным номерам выводятся соответствующие информационные сообщения в блоке "data. info". Примечание: Если в запросе был передан только один номер документа и по нему было найдено более одного заказа или не было найдено ни одного, то вместо блока "data" в ответ будет выведена ошибка 130002 с соответствующим описанием (см. "Ошибки методов API") |
StatusHistory
StatusHistory | ||
---|---|---|
Параметр | Тип | Описание |
docId* | object | Массив с найденной историей заказа. *Вместо [docId] здесь и ниже в ответ выводится номер найденного документа |
docId.Number | integer | Переданный номер документа, по которому была найдена история изменения статусов |
docId.State | string | Статус заказа на английском языке (см. справочник "Справочник статусов заказа груза") |
docId.StateName | string | Статус заказа на русском языке (см. справочник "Справочник статусов заказа груза") |
docId.StateDate | string | Дата установки статуса. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС+ЧЧ:ММ" |
docId.DetailedStatus | string | Дополнительный статус заказа на английском языке. Возможные значения:
|
docId.DetailedStatusRus | string | Дополнительный статус заказа на русском языке. Возможные значения (порядок соответствует порядку возможных значений параметра "docId.detailedStatus"):
|
docId.DetailedStatusDate | string | Дата установки дополнительного статуса. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС+ЧЧ:ММ" |
Info
Info | ||
---|---|---|
Параметр | Тип | Описание |
number | string | Переданный номер документа |
message | string | Информационное сообщение |
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".