...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Запрос getOrderStatuses
Для получения статусов заказов API использует структуру application/x-www-form-urlencoded и HTTP-метод POST.
...
Пример запроса getOrderStatuses
http://trial.maxoptra.com/rest/2/distribution-api/orders/getOrderStatuses?sessionID=eca3b9f1afa24988834ceb5c6aafdcbf&orders=1071088*1070773*1070807*gsdfg
Заголовки:
URL: Заголовки:
Метод: POST
URL: [account-name].maxoptra.com/rest/2/distribution-api/orders/getOrderStatusesМетод: POST
Структура: application/x-www-form-urlencoded
...
# | Название поля | Описание |
1 | orderStatusResponse | |
1.1 | orders | |
1.1.1 | order | |
| Атрибут “referenceNumber” | Название/Идентификатор заказа |
| Атрибут “status” | Статус заказа. Возможные значения представлены в разделе Статусы заказов. |
| Атрибут “fullNotes” | Причина недоставки, если таковая имеется, и комментарий, введенный водителем. Возможные причины:
| |
| Attribute Атрибут “<dynamic_attribute_name>” | This method allows receiving values for dynamic attributes (custom fields configured for an order in this particular account)Данный метод позволяет получить значения дополнительных полей для заказов. Данные поля добавляются отдельно для каждого конкретного аккаунта. <dynamic_attribute_name> - name of custom field name from account configurationназвание дополнительно сконфигурированного для аккаунта поля заказа. | |
| Атрибут "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"Формат | подтверждения подписи format of POD signature, e.g. Подтверждение подписи представлено в формате картинки .png ("image/png" with picture name) с закодированным названием картинки. Название картинки представляет собой код base64, который можно конвертировать в вид, пригодный для сохранения и скачивания. | |
| 1.1.1.3 | attachments | Если в заказе есть вложение, система возвращает информацию о вложении: дату и время, комментарии, ссылку на фотографиии. |
| 1.1.1.3.1 | attachment | |
| Атрибут "date" | Дата и время, когда было сделано вложение (если есть). Система также прикладывает ссылку на фотографии. | |
| Атрибут "comment" | Комментарий к вложению (если есть). | |
1.2 | unknownReferences | |
1.2.1 | reference | Название/Идентификатор ненайденных заказов |
...
| Code Block | ||
|---|---|---|
| ||
<?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> |
...
См. также
Статусы операций создания, редактирования и удаления заказов