Запрос getOrdersLog
Для получения данных по изменению статусов заказов в приложении API использует структуру application/xml и HTTP-метод POST.
...
# | Наименование поля | Тип данных | Длина | Обязательность | Примеры | Описание |
1 | sessionID | Текст | Да | Идентификатор сессии, полученный от сервера после запроса авторизации. Срок жизни сессии – 5 минут.. Если в течении этого времени в рамках сессии были проведены запросы, то срок жизни сессии увеличивается еще на 5 минут | ||
2 | filter | |||||
2.1 | limit | Целое число | Нет | 1000 | Максимальное количество статусов, которое должна вернуть система. Количество запрашиваемых статусов не ограничено. Если лимит не указан, по умолчанию возвращается информация максимум о 30 статусах заказа. | |
2.2 | date | Данный блок может использоваться как вместе с блоком "ref", так и отдельно от него. | ||||
2.2.1 | begin | Нет | 2019-12-17T00:00:10.00Z | Начало временного интервала для выбора изменений. Формат – “ГГГГ-ММ-ДДTЧЧ:ММ:СС.00Z” | ||
2.2.2 | end | Нет | 2019-12-17T23:54:10.00Z | Окончания временного интервала для выбора изменений. Формат – “ГГГГ-ММ-ДДTЧЧ:ММ:СС.00Z” | ||
| 2.3 | refs | Блок содержит список заказов. Может использоваться как с блоком "date" (тогда будут выведены выбранные заказы в указанном промежутке), так и без него. | ||||
| 2.3.1 | reference | Текст | 64 | mID6890381 | Имя Номер заказа. |
Примеры запроса getOrdersLog
Заголовки:
Метод: POST
URL: [account-name].maxoptra.com/rest/2/distribution-api/orders/getOrdersLog
Метод: POST
Структура: application/xml
...
# | Наименование поля | Описание |
1 | Orders | |
1.1 | Order | |
| Атрибут “referenceNumber” | Название/Идентификатор заказа |
| Атрибут “status” | Статус заказа. Возможные значения представлены в Приложении 3. |
| Атрибут “type” | Тип заказа. DO – Доставка PU – Сбор |
| Атрибут “date” | Дата и время изменения статуса (по UTC) |
| Атрибут “author” | Имя пользователя, от имени которого совершено действие |
| Атрибут “shortNotes” | Название действия |
| Атрибут “fullNotes” | Расшифровка действия |
| Атрибут “fullNotes” | Причина недоставки если таковая имеется и комментарий введенный водителем. Возможные причины:
|
...