getOrdersWithZone

Owned by Former user (Deleted)
Last updated: Jun 16, 2022 by Admin Doc Maxoptra
3 min read


Запрос getOrdersWithZone

Для получения списка заказов с информацией о зонах планирования, к которым принадлежат эти заказы, API использует структуру application/x-www-form-urlencoded и HTTP-метод POST.


Входные данные запроса getOrdersWithZone

Входные данные отправляются в качестве атрибутов и должны быть включены в тело запроса. Список всех поддерживаемых атрибутов представлен ниже.

#

Название аттрибута

Тип

Стиль

Обязательность

Описание

1

sessionID

Текст


Да

Идентификатор сессии, полученный от сервера после запроса авторизации.

Срок жизни сессии – 5 минут.. Если в течении этого времени в рамках сессии были проведены запросы, то срок жизни сессии увеличивается еще на 5 минут

2

aoсID

Целое число

Query

Да

Идентификатор распределительного центра

3

date

Дата

Query

Да

Дата, для которой будет произведена выгрузка заказов. Формат зависит от локализации в конфигурации аккаунта. Например, для Англии формат – “DD/MM/YYYY”. Для России – “ДД.MM.ГГГГ”


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


Заголовки:

Метод: POST

URL: [account-name].maxoptra.com/rest/2/distribution-api/orders/getOrdersWithZone?sessionID=94bb1165ed40419dbecde6910fb1bff1&date=12.10.2014&aocID=337

Структура: application/x-www-form-urlencoded

Для этого запроса все атрибуты должны находиться в теле запроса.

Тело запроса: не должно содержать никакой информации

Ответ getOrdersWithZone

Для получения списка заказов с информацией о зонах планирования, к которым принадлежат эти заказы, API использует структуру application/xml в качестве структуры ответа.

Выходные данные ответа getOrdersWithZone

#

Название поля

Описание

1

OrdersWithZoneResponse


1.1

orders


1.1.1

order


 

Атрибут “id”

Системный идентификатор заказа

 

Атрибут “referenceNumber”

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

 

Атрибут “aocId”

Идентификатор распределительного центра

 

Атрибут  “locationGlobalId”

Глобальный идентификатор местоположения (локации) заказа

 

Атрибут “address”

Адрес клиента (точки, где должна быть произведена разгрузка для заказов вида доставка или погрузка для заказов вида сбор)

 

Атрибут “latitude”

Географическая широта адреса клиента

 

Атрибут “longitude”

Географическая долгота адреса клиента


Атрибут "isVerified"Данное поле отвечает за отметку поля "Местонахождение проверено" на форме "Расположение клиента". Оно показывает, проверено или нет местонахождение расположения клиента. Возможные значения: true/false.

Атрибут "lastVerifiedByUser"Данное поле содержит информацию о пользователе, который последним подтвердил местонахождение расположения клиента.

Атрибут "lastVerifiedTime"Данное поле содержит дату и время последней проверки местонахождения расположения клиента.

 

Атрибут “capacity”

Первая единица измерения заказа, конфигурируется для каждого аккаунта отдельно. По умолчанию - Вес заказа

 

Атрибут “volume”

Вторая единица измерения заказа, конфигурируется для каждого аккаунта отдельно. По умолчанию – Объем заказа

 

Атрибут “contactPerson”

Контактное лицо со стороны клиента (имя и фамилия)

 

Атрибут “contactNumber”

Телефонный номер заказчика или контактного лица

 

Атрибут “zoneId”

Идентификатор зоны планирования, к которой принадлежит заказ

 

Атрибут “zoneName”

Наименование зоны планирования, к которой принадлежит заказ

 

Атрибут “dropDuration”

Продолжительность операции заказа


Атрибут "cost"Стоимость заказа

Атрибут "factCost"Фактическая стоимость заказа

 

Атрибут “collection”

Признак, определяющий вид заказа. Возможные значения: true/false.

Если указан true – заказ вида сбор, Если указан false – заказ вида доставка.

 

Атрибут “priority”

Приоритет заказа. Возможные значения: 0, 1, 2. Значения определяют приоритет по следующей шкале:

0 – Низкий

1 – Средний

2 – Высокий

 

Атрибут “fullNotes”

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

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

Атрибут "<dynamic_attribute_name>"

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

<dynamic_attribute_name> - название дополнительно сконфигурированного для аккаунта поля заказа.


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

1.1.1.1

dropWindows

Конструкция, содержащая информация о допустимых окнах для разгрузки/погрузки товара на территории клиента. Каждая должна содержать в себе минимум одну конструкцию dropWindow, ее описание приведено ниже.

1.1.1.2

dropWindow

Конструкция, содержащая информация об одном окне для разгрузки/погрузки товара на территории клиента. Должна содержать в себе 2 параметра: start и end, описание параметров приведено ниже.

 

Атрибут “startTime”

Начало временного окна для работы в пункте назначения. Формат зависит от локализации в конфигурации аккаунта. Например, для Англии формат – “DD/MM/YYYY HH:MM”. Для России – “ДД.ММ.ГГГГ ЧЧ:ММ”

 

Атрибут “endTime”

Окончание временного окна для работы в пункте назначения. Формат зависит от локализации в конфигурации аккаунта. Например, для Англии формат – “DD/MM/YYYY HH:MM”. Для России – “ДД.ММ.ГГГГ ЧЧ:ММ”

Пример ответа getOrdersWithZone

<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">
   <OrdersWithZoneResponse>
      <orders>
         <order id="726796" referenceNumber="mID726796" aocId="337" address="Hathaway Gardens,Ealing,London,W13 0DH" latitude="57.99847" longitude="56.24283" isVerified="true" lastVerifiedByUser="System: Geocode Provider" lastVerifiedTime="23.10.2017 12:50" capacity="20" contactPerson="John Dean" contactNumber="635-85-89" zoneId="40" zoneName="London" collection="false" priority="0" fullNotes="Погодные условия: Комментарий водителя ">
            <attachments>
               <attachment comment="Test" date="23.10.2017 14:23">https://s3-eu-west-2.amazonaws.com/s-angelica-magenta-a-demo/angelica_magenta__demo_2d992131125c4bb581291249e0e898ad_full_1710623804.jpg</attachment>
            </attachments>
            <dropWindows>
               <dropWindow startTime="23.10.2017 10:00" endTime="23.10.2017 15:00" />
               <dropWindow startTime="23.10.2017 16:00" endTime="23.10.2017 19:00" />
            </dropWindows>
         </order>
      </orders>
   </OrdersWithZoneResponse>
</apiResponse>


См. также

Методы API. Заказы

save

Территории / Группы территорий