Запрос getOrderStatuses
Для получения статусов заказов API использует структуру application/x-www-form-urlencoded и HTTP-метод POST.
Входные данные запроса getOrderStatuses
Входные данные отправляются в качестве атрибутов и должны быть включены в тело запроса. Список всех поддерживаемых атрибутов представлен ниже.
# | Название аттрибута | Тип | Стиль | Обязательность | Описание |
1 | sessionID | Текст | Да | Идентификатор сессии, полученный от сервера после запроса авторизации. Срок жизни сессии – 5 минут.. Если в течении этого времени в рамках сессии были проведены запросы, то срок жизни сессии увеличивается еще на 5 минут | |
2 | orders | Текст | Query | Да | Список названий/идентификаторов заказов, разделенных «*» |
Пример запроса getOrderStatuses
Заголовки:
URL: [account-name].maxoptra.com/rest/2/distribution-api/orders/getOrderStatuses
Метод: POST
Структура: application/x-www-form-urlencoded
Для этого запроса все атрибуты должны находиться в параметрах запроса.
Параметры запроса: sessionID=eca3b9f1afa24988834ceb5c6aafdcbf&orders=1071088*1070773*1070807*gsdfg
Ответ getOrderStatuses
Для получения статуса заказов API использует структуру application/xml в качестве структуры ответа
Выходные данные ответа getOrderStatuses
# | Название поля | Описание |
1 | orderStatusResponse | |
1.1 | orders | |
1.1.1 | order | |
| Атрибут “referenceNumber” | Название/Идентификатор заказа |
| Атрибут “status” | Статус заказа. Возможные значения представлены в разделе Статусы заказов. |
| Атрибут “fullNotes” | Причина недоставки, если таковая имеется, и комментарий, введенный водителем. Возможные причины:
| |
| Атрибут “<dynamic_attribute_name>” | Данный метод позволяет получить значения дополнительных полей для заказов. Данные поля добавляются отдельно для каждого конкретного аккаунта. <dynamic_attribute_name> - название дополнительно сконфигурированного для аккаунта поля заказа. | |
| Атрибут "deliveryRate" | Оценка доставки, проставленная клиентом. | |
| Атрибут "feedback" | Комментарий клиента о доставке. | |
| 1.1.1.1 | Атрибут "orderItem name" | Наименование товара (позиции) в заказе |
| Атрибут "name" | Название товара | |
| Атрибут "barcode" | Штрих-код товара в заказе | |
| Атрибут "status" | Статус товара в заказе | |
| Атрибут "externalId" | Внешний идентификатор товара | |
| Атрибут "costPerUnit" | Цена за единицу товара | |
| Атрибут "totalCost" | Общая стоимость товара | |
| Атрибут "quantity" | Количество единиц товара | |
| Атрибут "actualQuantity" | Фактическое количество единиц товара | |
| Атрибут "description" | Дополнительные сведения о товаре | |
| Атрибут "failReason" | Причина отказа от товара | |
| Атрибут "comment" | Комментаний водителя | |
| 1.1.1.2 | signature | Подпись клиента (подтверждение доставки заказа). По умолчанию опция экспорта подписи клиента (электронного подтверждения доставки заказа) выключена. Для подключения данной опции обращайтесь в службу технической поддержки Максоптры. |
| Атрибут "Content-Type" | Подтверждение подписи представлено в формате картинки .png ("image/png") с закодированным названием картинки. Название картинки представляет собой код base64, который можно конвертировать в вид, пригодный для сохранения и скачивания. | |
| 1.1.1.3 | attachments | Если в заказе есть вложение, система возвращает информацию о вложении: дату и время, комментарии, ссылку на фотографиии. |
| 1.1.1.3.1 | attachment | |
| Атрибут "date" | Дата и время, когда было сделано вложение (если есть). Система также прикладывает ссылку на фотографии. | |
| Атрибут "comment" | Комментарий к вложению (если есть). | |
1.2 | unknownReferences | |
1.2.1 | reference | Название/Идентификатор ненайденных заказов |
Пример ответа getOrderStatuses
<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="2.0">
<orderStatusResponse>
<orders>
<order referenceNumber="1070773" status="FAILED" fullNotes="Погодные условия: Комментарий водителя " />
<order referenceNumber="1070807" status="CLOSED">
<orderItem name="Шкаф-купе с зеркалом" barcode="CEARKF0000003001" status="NOT_CHECKED" costPerUnit="1" totalCost="10" quantity="10" actualQuantity="0"/>
<orderItem name="Шкаф-угловой с зеркалом" barcode="CEARKF0000003002" status="NOT_CHECKED" costPerUnit="2" totalCost="20" quantity="10" actualQuantity="20"/>
<signature Content-Type="image/png">iVBORw0KGgoAAAdtGMLQ+xpZB8D+rJDQewBZv0bYIi9WNlff/ySL8RerIyvWvkfYQKlYMwQEiYAAAAASUVORK5CYII=</signature>
<attachments>
<attachment comment="Test" date="03/11/2017 14:23">https://s3-eu-west-2.amazonaws.com/s-angelica-magenta-a-demo/angelica_magenta__demo_2d992131125c4bb581291249e0e898ad_full_1710623804.jpg</attachment>
</attachments>
</order>
<order referenceNumber="1071088" status="COMMITTING" />
<order referenceNumber="1071099_1534452_1" status="ALLOCATED" dynamic_attributes="test here" />
</orders>
<unknownReferences>
<reference>gsdfg</reference>
</unknownReferences>
</orderStatusResponse>
</apiResponse>
См. также
Статусы операций создания, редактирования и удаления заказов