Запрос getScheduleByAOCOnDate
Для получения расписания распределительного центра (области контроля) на определенную дату API использует структуру application/x-www-form-urlencoded и HTTP-метод POST.
...
# | Название поля | Описание |
1 | scheduleResponse | |
1.1 | units | |
| Атрибут “timeZone” | Часовой пояс аккаунта |
| Атрибут “timeZoneOffset” | Смещение часового пояса аккаунта | |
| Атрибут “currency” | Валюта аккаунта |
| Атрибут “speedUnits” | Единицы измерения скорости аккаунта | |
| Атрибут “distanceUnits” | Единицы измерения расстояния аккаунта |
| Атрибут “durationUnits” | Единицы измерения времени аккаунта |
| Атрибут “weightUnits” | Единицы измерения веса аккаунта |
Атрибут "volumeUnits" | Единицы измерения объема аккаунта | |
1.2 | vehicles | |
1.2.1 | vehicle | |
| Атрибут “id” | Идентификатор машины в аккаунте, который может быть использован в дальнейших запросах |
| Атрибут “name” | Имя машины |
Атрибут "externalID" | Внешний идентификатор машины | |
| Атрибут “driverName” | Имя водителя |
Атрибут "driverExternalID" | Внешний идентификатор водителя | |
| Атрибут “driverPhone” | Контактный телефон водителя |
| Атрибут “costByDistance” | Стоимость за милю/километр, значение зависит от единиц выбранных в «currency» |
| Атрибут "vehicleActivationCost" | Фиксированная стоимость использования определенной машины. Эта стоимость используется, чтобы отразить стоимость выхода машины в работу или зарплату водителя за день. | |
| Атрибут "costPerOrder" | Данный параметр отражает стоимость выполнения одного заказа определенной машиной. | |
| Атрибут “maxWeight” | Грузоподъемность транспортного средства, значение зависит от единиц, выбранных в “weightUnits” |
Атрибут "maxVolume" | Максимальная вместимость (объем) транспортного средства, значение зависит от единиц, выбранных в "volumeUnits" | |
| Атрибут “aocId” | Идентификатор распределительного центра, которому принадлежит машина |
1.2.1.1 | run | |
| Атрибут “runDay” | Дата поездки |
| Атрибут “runNumber” | Номер поездки |
| Атрибут “planDistance” | Планируемое расстояние |
| Атрибут “factDistance” | Фактическое расстояние |
| Атрибут “planDuration” | Планируемая общая продолжительность поездки (Рассчитывается как Планируемое время вождения + Планируемое время работы) |
| Атрибут “factDuration” | Фактическая общая продолжительность поездки (Рассчитывается как Плановое время погрузки на складе + Фактическое время вождения + Фактическое время работы на заказах) |
| Атрибут “runStartTime” | Планируемое время начала поездки / Означает время начала погрузки на складе - runLoadingStartTime. |
| Атрибут “runEndTime” | Планируемое время окончания поездки |
| Атрибут "runLoadingEndTime" | Время окончания погрузки на складе. Формат данных: "ДД.ММ.ГГГГ ЧЧ:ММ" | |
| Атрибут “availabilityStartTime” | Время начала доступности водителя |
| Атрибут “availabilityEndTime” | Время окончания доступности водителя |
| Атрибут “planWeight” | Общий вес заказов в поездке |
Атрибут "planVolume" | Общий объем заказов в поездке | |
Атрибут "weightUtilization" | Загрузка по первой единице вместимости (весу). Рассчитывается как planWeight * 100 / maxWeight. Число без знака %. | |
Атрибут "volumeUtilization" | Загрузка по второй единице вместимости (объему). Рассчитывается как planVolume * 100 / maxVolume. Число без знака %. | |
| Атрибут “cost” | Стоимость поездки. Стоимость = ((стоимость за час) * (продолжительность в часах)) + ((стоимость за километр) * (дистанция поездки)) |
1.2.1.1.1 | location | |
| Аттрибут "referenceNumber" | Идентификационный номер расположения клиента. | |
| Атрибут “number” | Порядковый номер заказа (расположения клиента) в рейсе. Возможен только для locationType=DROP |
| Атрибут “locationType” | Тип расположения клиента. Возможные значения
|
| Атрибут “name” | Название расположения клиента |
| Атрибут “address” | Адрес расположения клиента |
| Атрибут “latitude” | Координаты широты расположения клиента |
| Атрибут “longitude” | Координаты долготы расположения клиента |
| Атрибут “planArrivalTime” | Планируемое время прибытия в расположение клиента |
| Атрибут “planDepartureTime” | Планируемое время отправления от клиента |
| Атрибут “factArrivalTime” | Фактическое время прибытия к клиенту |
| Атрибут “factDepartureTime” | Фактическое время отправления от клиента |
Атрибут "planMileage" | Плановое расстояние до заказа. Выводится в зависимости от настроек аккаунта - в милях или километрах. | |
Атрибут "factMileage" | Фактическое расстояние до заказа. Измеряется в милях или километрах в зависимости от настроек аккаунта. | |
| Атрибут "factDuration" | Фактическая длительность доставки. | |
Атрибут "planDrivingTime" | Планируемое время движения к данной локации в минутах | |
Атрибут "factDrivingTime" | Фактическое время движения к данной локации в минутах (Предоставляется GPS-устройством на конкретный момент времени) | |
Атрибут "planStopDuration" | Планируемая длительность остановки | |
Атрибут "factStopDuration" | Фактическая длительность остановки. Рассчитывается как разность между фактическим временем убытия из локации (factDepartureTime) и фактическим временем прибытия на локацию (factArrivalTime). | |
Атрибут "estimatedArrivalTime" | Расчетное время прибытия. Если отсутствует - пустое | |
Атрибут "estimatedDepartureTime" | Расчетное время убытия. Если отсутствует - пустое | |
| Атрибут "isVerified" | Данное поле отвечает за отметку поля "Местонахождение проверено" на форме "Расположение клиента". Оно показывает, проверено или нет местонахождение расположения клиента. Возможные значения: true/false. | |
| Атрибут "lastVerifiedByUser" | Данное поле содержит информацию о пользователе, который последним подтвердил местонахождение расположения клиента. | |
| Атрибут "lastVerifiedTime" | Данное поле содержит дату и время последней проверки местонахождения расположения клиента. | |
1.2.1.1.1.1 | order | |
| Атрибут “orderReference” | Название заказа/Идентификатор |
| Атрибут “status” | Статус заказа. Возможные значения описаны в разделе "Статусы заказов". |
| Атрибут "signature Content-Type="image/png" | Подпись клиента (подтверждение доставки заказа). | |
| Атрибут “task” | Признак вида заказа. Возможные значения:
|
| Атрибут “duration” | Продолжительность разгрузки / погрузки у клиента |
| Атрибут “weight” | Первая единица измерения заказа, конфигурируется для каждого аккаунта отдельно. По умолчанию - Вес заказа |
Атрибут "volume" | Вторая единица измерения заказа, конфигурируется для каждого аккаунта отдельно. По умолчанию - Объем заказа | |
| Атрибут "reportedArrivalTime" | Отчетное время прибытия (время прибытия на место доставки заказа, переданное водителем). | |
| Атрибут "reportedDepartureTime" | Отчетное время убытия (время убытия с места доставки, переданное водителем). | |
| Атрибут "reportedSignatureTime" | Отчетное время получения подписи клиента (время получения подписи клиента, переданное водителем). | |
| Атрибут “<dynamic_attribute_name>” | Данный метод позволяет получить значения дополнительных полей для заказов. Данные поля добавляются отдельно для каждого конкретного аккаунта. <dynamic_attribute_name> - название дополнительно сконфигурированного для аккаунта поля заказа. |
| Атрибут "attachments" | Если в заказе есть вложение, система возвращает информацию о вложении: дату и время, комментарии, ссылку на фотографиии. | |
| Аттрибут "additionalInstructions" | Дополнительные инструкции | |
| Аттрибут "contactNumber" | Номер телефона клиента или контактного лица | |
| Аттрибут "orderItem" | Товары в составе заказа. Данное поле состоит включает следующие параметры: name, barcode, externalId, costPerUnit, totalCost, quantity, actualQuantity, description, failReason, comment. Параметры failReason, status и comment могут изменяться только водителем с мобильного приложения. |
...