Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Запрос getOrderStatuses

Для получения статусов заказов API использует структуру application/x-www-form-urlencoded и HTTP-метод POST.

...

Пример запроса getOrderStatuses

Заголовки:

Метод: 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”

Причина недоставки, если таковая имеется, и комментарий, введенный водителем. Возможные причины:

  • Адресат выбыл
  • Адресат отсутствует
  • Доставка перенесена по просьбе адресата
  • Отказ от получения
  • По техническим причинам
  • Неточный/неверный адрес
  • Не найден адрес
  • Погодные условия
  • Иная

Атрибут “<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.2signature

Подпись клиента (подтверждение доставки заказа).

По умолчанию опция экспорта подписи клиента (электронного подтверждения доставки заказа) выключена. Для подключения данной опции обращайтесь в службу технической поддержки Максоптры.


Атрибут "Content-Type"

Подтверждение подписи представлено в виде формате картинки формата .png ("image/png") с закодированным названием картинки. Название картинки представляет собой код base64, который можно конвертировать в вид, пригодный для сохранения и скачивания.

1.1.1.3attachmentsЕсли в заказе есть вложение, система возвращает информацию о вложении: дату и время, комментарии, ссылку на фотографиии.
1.1.1.3.1attachment

Атрибут "date"Дата и время, когда было сделано вложение (если есть). Система также прикладывает ссылку на фотографии.

Атрибут "comment"Комментарий к вложению (если есть).

1.2

unknownReferences


1.2.1

reference

Название/Идентификатор ненайденных заказов

...