Импoрт заказов. Параметры и требования к файлу импорта.

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

Описание

Пример

Длина поля (симв.)

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

orderReference

Уникальный идентификатор или номер заказа в системе. Это может быть номер из 1С или любой другой. Если номер не задавать, то система назначит произвольный. При задании уже существующего идентификатора система будет пытаться обновить параметры такого заказа (если такой заказ не распределен на машину, иначе будет создан новый заказ с дубликатом номера заказа)

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

T0000129082

64

в общем случае - нет.

да -  когда требуется обнолвлять существующие незапланированные заказы в течение дня

date

Дата доставки или сбора заказа. Формат даты -  дд.мм.гггг, т.е. год обозначается четырьмя цифрами

01.01.2015

нет, но требуется в случаях, когда при выборе  файла не указывается дата

distributionCentreName

Область, контролируемая диспетчером. Здесь для конкретного заказа указывается название склада, находящегося в ведении диспетчера. Данное поле обязательно только, если в аккаунте создано несколько распределительных центров и не настроены территории.

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

Центральное депо

255

нет – для одного РЦ, да – для нескольких РЦ (если не настроены территории)

distributionCentreAddress

Адрес местонахождения РЦ (склада), откуда машина начинает и где заканчивает свой рейс.

(формат: «Город, улица, дом» либо «Улица, дом, город»)

Ново-Садовая улица 349, Самара, городской округ Самара, Россия

255

нет

clientName

Имя заказчика, отображаемое в системе. Обычно здесь пишется название фирмы, по которому можно легко выделить данного клиента среди других. По данному названию работает поиск в выпадающем списке адреса заказа. Это сделано для упрощения выбора существующего клиента по легко запоминающейся информации о клиенте

ООО Мясной Пир

255

нет

contactPerson

Контактное лицо у данного заказа. Здесь обычно указывается имя человека для контакта

Иванов И.И.

255

нет

contactNumber

Телефон контактного лица заказчика (рекомендуется использовать международный формат: +, код страны, код города, номер абонента – все пишется слитно)

+78482345678

255

нет

contactEmail

Email контактного лица. Ограничения: поле поддерживает только латиницу, цифры,  дефис, нижнее подчеркивание, @ и точку. Формат записи – почта@домен.зона . Зона до 4 знаков (ru, com, mobi и т.д.)

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

contact@company.ru

64

нет

customerLocationName

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

ООО Мясной Пир (Север)

255

нет, но обязательно для создания клиентской локации

customerLocationAddress

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

В данное поле не рекомендуется вносить такие сведения, как квартира, домофон, позвонить за час и т.д., так как такая информация приводит к искажениям при поиске адреса. Для дополнительной информации следует использовать поле additionalInstructions

Россия, Санкт-Петербург, Разъезжая улица, 17

255

да

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

См. Адрес в формате What3Words

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

customerLocationGlobalId

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

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

2807d00452364ba6a

64

нет

task

Разновидность заказа: сбор или доставка. Если поле не заполнено, то считается, что данный заказ требуется доставить. Простановка слова «доставка» означает то же самое. Если проставить «сбор», то такой заказ предполагается к вывозу

сбор

нет

dropDuration

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

10

нет

capacity

Один из двух возможных параметров заказа - масса заказа (в кг), либо любая другая величина (человек, коробок, поддонов, штук). Дробные значение следует вводить через запятую

24,7

нет

volume

Второй параметр заказа - объем заказа (м3). Дробные значение следует вводить через запятую

2,5

нет

cost

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

3200

255

нет

orderItems

Товарами называются позиции, входящие в один заказ. Для одинаковых товаров может принимать одинаковое значение.

Правила записи:

• Допустимы любые символы кроме апострофа и кавычек (‘ и ”)
• Имя товара заключается в квадратные скобки - […],
• Прочая информация о товаре разделяется вертикальными чертами - |,
• Каждый товар отделяется от другого точкой с запятой - ;.

Формат записи и порядок указания данных следующий:

[Название товара]штрих-код|идентификатор|цена за единицу|планируемое количество|описание;

Если вам нужно указать не все, а лишь определенные параметры, то в этом случае нужно оставить вертикальные черты без указания данных. Например, если нам нужно указать только имя и количество, формат записи будет такой: [Название товара]|||20|;

Можно не писать вертикальные черты, идущие после последней указанной величины, если дальше больше ничего не будет указано: [Название товара]|||20.

Также см. Параметр "Товары"

* При выгрузке файла из другой учетной системы список значений поля выделяется в двойные кавычки: "[Название товара 1]штрих-код|идентификатор|цена|количество|описание; [Название товара 2]штрих-код|идентификатор|цена|количество|описание"

[Hennesy OX 1958 Партия 1 коробка 2 из 2]1008105964500552|GD4561321|320|12|Не кантовать!;

или (при пропуске некоторых данных)

[Hennesy VSOP 1977 коробка 1 из 1]|||50|;

* "[Hennesy OX 1958 Партия 1 коробка 2 из 2]1008105964500552|GD4561321|320|12|Не кантовать!"

нет

additionalinstructions

Любые дополнительные сведения о заказе или клиенте (сведения об оплате картой, примечания по доставке прайс-листов, коды домофона, просьба позвонить за час и т.п.)

Офисное здание MOD Design. Можно не заходить внутрь, позвонить мне, я выйду на улицу и заберу заказ. Можно зайти внутрь, подняться на второй этаж, на стене большая надпись SuperJob, у стены желтая скамейка. Позвонить уже оттуда

255

нет

vehicleRequirements

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

Своя машина, Средняя

255

нет

Начальная дата, когда клиент доступен для приема машины. Формат даты: дд.мм.гггг. Начиная с этого дня можно выполнять работы у клиента. Данный параметр применяется совместно с orderDateTo

Предполагает использование поля OrderTimeFrom1 (планирование нескольких временных окон) или OrderTimeFrom (планирование на период от 2-5 дней, см. Многодневное планирование).

Примечание: при использовании данного поля поле date не используется.

Конечная дата, когда клиент еще доступен для приема машины. Означает крайний день, когда можно выполнять работу у клиента

Предполагает использование поля OrderTimeTo1 (планирование нескольких временных окон) или OrderTimeTo (планирование на период от 2-5 дней см. Многодневное планирование).

Примечание: при использовании данного поля поле date не используется.

Используется в следующих случаях:

1) При планировании на один день. В этом случае поле означает начало первого окна работы у клиента (если у клиента несколько временных окон). Окно определяет допустимые временные рамки для доставки или вывоза заказа. Подразумевает указание второго временного окна (orderTimeFrom2).

2) При многодневном планировании (2-5 дней). Может использоваться как отдельно, так и совместно с orderTimeFrom2, чтобы задавать одно или два временных окна для заказов при многодневном планировании.

Здесь и далее формат времени чч:мм

Примечание. 

Данный параметр определяет время, раньше которого заказ выполнить нельзя, а начиная с данного времени – можно.

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

Требует указывать дату (поле orderDateFrom)

Допускается не указывать ведущий ноль, например вместо 02:00 писать 2:00

02:00

нет

Используется в следующих случаях:

1) При планировании на один день. В этом случае поле означает конец первого окна работы у клиента (чч:мм). Параметр определяет крайний срок, до которого должна быть завершена работа по данному заказу. Подразумевает указание второго временного окна (orderTimeTo2).

2) При многодневном планировании (2-5 дней). Может использоваться как отдельно, так и совместно с orderTimeTo2, чтобы задавать одно или два временных окна для заказов при многодневном планировании.

Требует указывать дату (поле orderDateTo).

06:45

нет

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

Применяется как для плинирования на один день, так и при многодневном планировании (2-5 дней).

Требует указывать дату (поле orderDateFrom).

10:30

нет

Конец второго окна работы у клиента (чч:мм). Определяет крайний срок окончания работ в рамках дополнительного временного окна.

Применяется как для плинирования на один день, так и при многодневном планировании (2-5 дней).

Требует указывать дату (поле orderDateTo).

14:00

нет

Priority

1

нет

latitude

Координата «широта» в диапазоне от -90 до 90 в виде десятичного числа. Дробные значение следует вводить через точку. Применяется для уточнения месторасположения клиента в случаях, когда адрес определяет место лишь приблизительно

Не используйте 0 в качестве координаты

55.755831

20

нет

longitude

Координата «долгота» в диапазоне от -180 до 180 в виде десятичного числа. Дробные значение следует вводить через точку

Не используйте 0 в качестве координаты

37.617673

20

нет

schedulingZoneName

Название территории планирования. В системе можно рисовать на карте регионы в виде многоугольников и накладывать их на заказы, равно как размещать заказы в рамках заранее созданных регионов. Регионы могут пересекаться, поэтому на этапе импорта заказ следует привязать к правильному региону. При рисовании границ территорий пользователь задает их название. В данном поле файла импорта следует указывать именно эти названия. Если название не указывать, а заказу будут соответствовать несколько территорий, то заказу будет присвоена территория, которая в системе была создана самой первой

Юго-запад

255

нет

is_return_packages

Возврат тары (true=да, false=нет). По умолчанию false, если не указывать, то false

false

нет

return_packages_comments

Комментарий к возврату тары, если is_return_packages=true

нет

stopSequence

порядок заказа в рейсе, значения:

• Первый - первый в рейсе

• Последний - последний в рейсе

• Любой (или пусто) - любой в рейсе

Если не указано, то равно Любой.

Если указать Первый /Последний нескольким заказам, то такие заказы перераспределятся между собой в голове или хвосте рейса соответственно.

Первый

нет

sequenceInRun

Порядковый номер заказа в рейсе для расписания, созданного заранее вне Максоптры. Каждый заказ должен иметь уникальный последовательный номер, начиная с 1

1

если задано, то для этого заказа обязательны к заполнению поля «allocationDate» и «vehicleName»

runNumber

Номер рейса для импорта готового расписания (3.9.4.14)

1

если задано, то для этого заказа обязательны к заполнению поля «allocationDate» и «vehicleName»

vehicleName

Название машины (регистрационный номер).

Примечание Если при импорте расписания указано не уникальное имя машины на день расписания, то появляется ошибка: "Машина с именем "ААА" уже существует. Пожалуйста, укажите уникальное имя, чтобы запланировать на него заказ. Также можно использовать внешний идентификатор из поля vehicleExternalID"

к610кн23

да

allocationDate

Дата планирования заказа.

Дата доставки или сбора заказа. Формат даты -  дд.мм.гггг, т.е. год обозначается четырьмя цифрами

20.04.2015

да

Номер группового заказа в паре заказов Pickup&Delivery (связанных заказов). Данный номер предоставляется из CRM заказчика.

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

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