Page Comparison

Секция аутентификации

1

sessionID

Текст

Да

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

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

Секция заказов

1

orderReference

Текст

64

Нет

Внешняя ссылка (Поле "Идентификатор заказа" в приложении). Идентификатор заказа не должен содержать символ «*», если в дальнейшем планируется использование метода getOrderStatuses

Примечание Все идентификационные номера заказов, передаваемые в систему с помощью данного метода, должны быть уникальными!

2

areaOfControl

Текст

255

Да

Распределительный центр. Данное поле обязательно только, если в аккаунте создано несколько распределительных центров и не настроены территории.

Если настроены территории, при создании заказов достаточно указать только адрес расположения клиента, а Максоптра, используя территории, отнесёт тот или иной заказ к соответствующему распределительному центру.

3

date

Дата

Да

Дата временного окна доставки/сбора.
Формат - “DD.MM.YYYY”.

4

client

Нет

4.1

name

Текст

255

Нет

Наименование заказчика

4.2

contactPerson

Текст

255

Нет

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

4.3

contactNumber

Текст

255

Нет

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

Адрес электронной почты клиента.

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

5

location

Да

5.1

name

Текст

255

Да

Название местоположения клиента. Поле обязательно, если не указан globalId.

5.2

address

Текст

255

Да*

Москва, ул. Вятская 15

или

помощь.стебель.ставка

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

Примечание Максоптра поддерживает формат кодирования адреса по системе What3Words. Если вы хотите использовать эту интеграцию, свяжитесь с командой техподдержки Максоптры. После этого вы сможете указывать в качестве адреса расположения клиента код из трех слов.

5.3

latitude

Число

[-90;90]

Нет

Географическая широта адреса клиента, если в заказа передаются широта и долгота, то заказ будет расположен строго в соответствии с этими данными

5.4

longitude

Число

[-180;180]

Нет

Географическая долгота адреса клиента, если в заказа передаются широта и долгота, то заказ будет расположен строго в соответствии с этими данными

5.5

globalId

Текст

255

Нет

Уникальный идентификатор локации. Если в системе уже существует расположение клиента с точно таким же идентификатором, будет обновлено существующее расположение клиента и заказ будет ссылаться на обновленную запись.

См. также Идентификатор расположения клиента.

Да

(для заказов Pickup & Delivery)

Номер группового заказа. Предоставляется из CRM клиента.

Примечание Номер группового заказа должен быть уникальным на весь аккаунт. 

См. подробне в разделе Функциональность Pickup & Delivery.

Да

(для заказов Pickup & Delivery)

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

См. подробне в разделе Функциональность Pickup & Delivery.

7

vehicleRequirements

Нет

7.1.1

name

Текст

255

Нет

Наименование требования к транспортным средствам.

8

dropWindows

Да

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

Для многодневного планирования заказов следует указать временные окна с разными датами.

ПРИМЕЧАНИЕ!

В Максоптре доступна опция под названием Time window auto-replacement (Автозамена временных окон), которая позволяет использовать временные окна расположения клиента по умолчанию. Тогда (при включенной опции) поля dropWindows становятся необязательными. Если вам нужно подключить данную опцию, обратитесь в службу технической поддержки Максоптры.

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

8.1

dropWindow

Да

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

Для многодневного планирования заказов укажите временные окна с разными датами.

8.1.1

start

Дата и время

Да

Начало временного окна для работы в пункте назначения. Формат - “DD/MM/YYYY HH:MM”.

8.1.2

end

Дата и время

Да

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

9

priority

Число

1

Нет

10

durationDrop

Время

Нет

Продолжительность разгрузки/погрузки у клиента, формат: ЧЧ:ММ

11

price

Число

255

Нет

Стоимость заказа. Тут указывается стоимость для клиента, она не берется в рассчет при составлении расписания. Поле носит информативный характер

12

capacity

Число

Нет

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

13

volume

Число

Нет

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

14

collection

Логический

true/false

Нет

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

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

В случае отсутствия значения, автоматически будет проставлено значение false и создан заказ вида доставка.

15

additionalInstructions

Текст

255

Нет

Дополнительные инструкции

16

orderItems

16.1

orderItem

Товары - это отдельные позиции, входящие в один заказ (см.Параметр "Товары"). Раздел orderItems метода save состоит из нескольких полей: name, barcode, externalId, costPerUnit, quantity, description (см. ниже). Ни одно из этих полей не является обязательным. Если в заказе несколько товаров, каждый товар должен быть записан в отдельном тэге.

16.1.1

name

Текст

255

Нет

Наименование товара

16.1.2

barcode

Текст

255

Нет

Штрих-код товара (если есть).

17

dynamicAttributes

Нет

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

17.1

attribute

17.1.1

Атрибут “name”

255

Название дополнительного поля

17.1.2

Атрибут “value”

255

Значение для дополнительного поля

18

stopSequence

Текст

Нет

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

• first – заказ должен выполняться первым
• last – заказ должен выполняться последним
• any – заказ может находиться на любой позиции в рейсе. Данное значение указывается по умолчанию