Получить полные карточки заказов заказчика

Порядок работы для агента · Методы API и схема OpenAPI.

Назначение

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

Метод: POST /api/orders/v0/transferOrder/getFlatForCustomer

Если нужны только идентификаторы, используйте поиск заказов заказчика. Для списка с основными полями подходит getFlatForCustomerLite, для расширенного списка — getFlatForCustomerLiteDetailed.

Доступ
Аутентификация Требуется
Роли организаций exp
Права пользователя view_all_orders
Область доступа Организации с ролью заказчика, доступные текущему пользователю
Эффект Только чтение
Повтор вызова Безопасно повторять
Повтор после ошибки Только после временных ошибок
Автоматизация Требуется подтверждение
Чувствительность данных Содержит чувствительные данные

Нужны аутентификация, роль exp и право view_all_orders. Область доступа определяет контекст авторизации. forwarderIDs может только ограничить выдачу среди доступных организаций.

Входные данные

  • Передавайте условия либо в data.filter, либо в прежних полях верхнего уровня. Если filter передан, метод берёт isArchive с верхнего уровня только при отсутствии вложенного значения, а exactOrderIds — при пустом вложенном списке. Остальные прежние условия замещаются.

  • Пустые списки обычно не добавляют условия. Для архива укажите isArchive: true. Точный поиск по exactOrderIds также проверяет архив.

  • Для поиска по радиусу используйте loadPoint или unloadPoint с lat, long и radiusM.

  • Поля сортировки — CreatedAt, FirstLoadAt и need_driver_assign. Порядок без явно заданной сортировки не гарантируется.

  • Указывайте limit в корне data. Значение по умолчанию — 100. Метод запрашивает до limit + 1 идентификаторов и может вернуть дополнительную карточку. Длина ответа не показывает общее число заказов или наличие следующей страницы.

  • Передавайте withDeletedPlaces или withDeletedShipments, только если нужны удалённые места или грузы.

В data.filter доступны фильтры ЭДО и поиск по имени логиста из метода поиска заказов заказчика. edm.actionRequiredDocumentTypes ищет документы, ожидающие действия доступной организации. Флаги edm.hasEtrn, edm.hasEzz, edm.hasEpe и edm.hasExpr проверяют наличие (true) или отсутствие (false) документов у одного груза. Для поиска по имени используйте responsibleLogisticianNamedByForwarder и responsibleLogisticianNamedByExecutor.

Результат

data.orders содержит карточки в порядке применённой сортировки. Значения orders: [] и orders: null означают успешный пустой результат. Если необязательное поле отсутствует, сведений о нём в ответе нет.

У груза поля npShipment.sequenceOrder и npUnshipment.sequenceOrder показывают порядковые номера точек погрузки и выгрузки на маршруте. API опускает поле, если номер точки отсутствует или равен нулю.

В необязательном целочисленном поле distributionPriority приходит приоритет распределения груза, если он задан в оптимизаторе.

response.data.orders[].customer

customer показывает сведения о владельце груза в текущей карточке. Имя и телефон могут быть замаскированы, а адрес — скрыт. По такому ответу нельзя определить, есть ли исходное значение в системе. Для объекта целиком действует самое строгое ограничение его полей.

Повтор запроса

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

Работа с чувствительными данными

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

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

В фильтрах защищайте идентификаторы, ИНН, комментарии, названия грузов и мест, координаты и другие чувствительные условия поиска. filter может содержать несколько таких условий одновременно.

Карточка заказа объединяет персональные и коммерческие данные. В shipments и orderWay могут быть адреса, координаты, расписание, контакты точек и сведения о грузе. drivers, сведения о транспорте и рейсах, контакты сотрудников, реквизиты сторон, файлы и их названия тоже требуют защиты. В auction, matcher и volumeDemand могут быть ставки, участники и условия торгов. transferOrderAdditionalConfiguration может содержать произвольные данные.

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

Запрос

Поле Класс данных Субъект По умолчанию Ограничения
request.data.additionalConditions Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.carNumber[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.cargoComment[] Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.cargoID[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.customerComment[] Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.customerIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.distributionComment[] Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.driverIds[] Внутренний идентификатор Физическое лицо Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.exactCargoIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.exactOrderIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.executorIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.externalID[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.filter Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.flightExternalExecutor[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.flightIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.forwarderIDs[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.freeTags[] Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.loadNPIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.loadPoint Точное местоположение Коммерческие данные Показывать агрегированно Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.npShipmentIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.npUnshipmentIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.packageNames[] Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.partialCargoIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.partialOrderIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.responsibleLogisticianByExecutor[] Внутренний идентификатор Физическое лицо Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.responsibleLogisticianByForwarder[] Внутренний идентификатор Физическое лицо Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.responsibleLogisticianForFlightByExecutor[] Внутренний идентификатор Физическое лицо Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.shipmentNames[] Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.tin[] Налоговый идентификатор Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.trailerIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.truckIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.unloadNPIds[] Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
request.data.unloadPoint Точное местоположение Коммерческие данные Показывать агрегированно Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения

Ответ

Поле Класс данных Субъект По умолчанию Ограничения
response.data.orders[] Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].additionalConditions Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].alerts[].description Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].auction Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].basicConditionsTemplateId Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].bodyTypeComment Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].cancelComment[] Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].carHeadInfos[] Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].cargoCategory.categoryComment Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].cargoComment Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].cargoId Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].created.contact Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].customer.customerAddress Чувствительный адрес Смешанный или неизвестный Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].customer.customerCargoPrice Финансовые данные Коммерческие данные Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].customer.customerComment Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].customer.customerForwarderId Внутренний идентификатор Организация Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].customer.customerForwarderTin Налоговый идентификатор Организация Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].customer.customerName Название стороны Смешанный или неизвестный Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].customer.customerPhone Контактные данные человека Физическое лицо Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].customer.customerTin Налоговый идентификатор Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].customer.id Внутренний идентификатор Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].demandId Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].distribution Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].drivers[] Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].drivers[].masked_phone Контактные данные человека Физическое лицо Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].drivers[].name Имя человека Физическое лицо Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].execOrder Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].execOrderId Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].execResponsibleLogistician Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].executionPrice Финансовые данные Коммерческие данные Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].executor Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].executorConditionsTemplate.id Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].executorViews[] Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].files[] Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].files[].fileName Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].flightCreator Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].forwarder Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].freeTagsInfo[].id Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].freeTagsInfo[].name Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].fwdResponsibleLogistician Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].id Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].matcher Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].orderExternalID Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].orderWay Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].orderWay.visits[].wayPoint.address Чувствительный адрес Смешанный или неизвестный Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].orderWay.visits[].wayPoint.lat Точное местоположение Коммерческие данные Показывать агрегированно Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].orderWay.visits[].wayPoint.long Точное местоположение Коммерческие данные Показывать агрегированно Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].parentId Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].paymentDelayPeriod Финансовые данные Коммерческие данные Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].responsibleCustomer Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].rootId Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[] Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npShipment.npAdditionalContact[].npcEmail Контактные данные человека Физическое лицо Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npShipment.npAdditionalContact[].npcName Имя человека Физическое лицо Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npShipment.npAdditionalContact[].npcPhone Контактные данные человека Физическое лицо Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npShipment.npGeoAddress.address Чувствительный адрес Смешанный или неизвестный Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npShipment.npGeoAddress.lat Точное местоположение Коммерческие данные Показывать агрегированно Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npShipment.npGeoAddress.long Точное местоположение Коммерческие данные Показывать агрегированно Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npUnshipment.npAdditionalContact[].npcEmail Контактные данные человека Физическое лицо Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npUnshipment.npAdditionalContact[].npcName Имя человека Физическое лицо Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npUnshipment.npAdditionalContact[].npcPhone Контактные данные человека Физическое лицо Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npUnshipment.npGeoAddress.address Чувствительный адрес Смешанный или неизвестный Маскировать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npUnshipment.npGeoAddress.lat Точное местоположение Коммерческие данные Показывать агрегированно Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].shipments[].npUnshipment.npGeoAddress.long Точное местоположение Коммерческие данные Показывать агрегированно Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].systemConditionsTemplateId Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].tag.id Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].tag.name Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].trailerInfos[] Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].transIdentity Внутренний идентификатор Коммерческие данные Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].transferOrderAdditionalConditions Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].transferOrderAdditionalConfiguration Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].transferOrderCost Финансовые данные Коммерческие данные Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].transferOrderName Чувствительный свободный текст Смешанный или неизвестный Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].typePaymentAndTax Финансовые данные Коммерческие данные Скрывать полностью Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].updated.contact Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].utm Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
response.data.orders[].volumeDemand Запись с чувствительными данными Смешанный или неизвестный Не показывать Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения

Проверенные примеры

Используйте примеры для проверки формата без отправки запросов в рабочий сервис.

Успешный поиск синтетического заказа · синтетический пример

Сокращённый ответ показывает значимые поля найденной карточки; все значения созданы для примера, а чувствительные данные замаскированы.

Запрос

{
  "data": {
    "exactOrderIds": [
      "0-example-0000-00-00-001"
    ]
  }
}

Сокращённый ответ

{
  "data": {
    "orders": [
      {
        "currency": "RUB",
        "customer": {
          "customerAddress": "Example ********",
          "customerComment": "Example [redacted]",
          "customerCountry": "RU",
          "customerForwarderTin": "**********",
          "customerLegalForm": "ru_ooo",
          "customerName": "Example E*** C***",
          "customerPhone": "+7 *** ***-**-**",
          "customerTin": "**********"
        },
        "id": "0-example-0000-00-00-001",
        "shipments": [
          {
            "distributionPriority": 5,
            "npShipment": {
              "sequenceOrder": 1
            },
            "npUnshipment": {
              "sequenceOrder": 2
            }
          }
        ],
        "status": "draft",
        "transIdentity": "0-example-0000-00-00-001",
        "transferOrderType": "FTL"
      }
    ]
  }
}

Пустой результат · синтетический пример

Точный поиск по другому синтетическому ID демонстрирует успешный ответ без совпадений.

Запрос

{
  "data": {
    "exactOrderIds": [
      "0-example-0000-00-00-002"
    ]
  }
}

Сокращённый ответ

{
  "data": {
    "orders": null
  }
}

Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде example показывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.

Request

POST

https://partner-test-yamagistrali.ru/api/orders/v0/transferOrder/getFlatForCustomer

Тестовый стенд

Body

application/json
{
  "data": {
    "additionalConditions": {
      "additionalComment": "example",
      "currency": "example",
      "documentsDelay": {},
      "emails": [
        "example"
      ],
      "externalOrderID": "example",
      "fullName": "example",
      "isVatPayer": true,
      "phones": [
        "example"
      ],
      "price": 0.5,
      "priceComment": "example",
      "priceWithVat": 0.5,
      "specifyConditions": true,
      "vat": 0.5
    },
    "bodyTypes": [
      "example"
    ],
    "carBodyType": [
      "example"
    ],
    "carBrand": [
      "example"
    ],
    "carNumber": [
      "example"
    ],
    "carType": [
      "example"
    ],
    "cargoCategories": [
      "example"
    ],
    "cargoComment": [
      "example"
    ],
    "cargoID": [
      "example"
    ],
    "customerComment": [
      "example"
    ],
    "customerIds": [
      "example"
    ],
    "distributionComment": [
      "example"
    ],
    "driverIds": [
      "example"
    ],
    "exactCargoIds": [
      "example"
    ],
    "exactOrderIds": [
      "example"
    ],
    "executorIds": [
      "example"
    ],
    "externalID": [
      "example"
    ],
    "filter": {
      "additionalConditionsExternalOrderID": [
        "example"
      ],
      "bodyTypeComments": [
        "example"
      ],
      "bodyTypes": [
        "example"
      ],
      "carBodyType": [
        "example"
      ],
      "carBrand": [
        "example"
      ],
      "carNumber": [
        "example"
      ],
      "carType": [
        "example"
      ],
      "cargoCategories": [
        "example"
      ],
      "cargoComment": [
        "example"
      ],
      "cargoID": [
        "example"
      ],
      "customerComment": [
        "example"
      ],
      "customerIds": [
        "example"
      ],
      "distributionComment": [
        "example"
      ],
      "driverIds": [
        "example"
      ],
      "edm": {},
      "etrnState": [
        "example"
      ],
      "exactCargoIds": [
        "example"
      ],
      "exactDemandIds": [
        "example"
      ],
      "exactOrderIds": [
        "example"
      ],
      "excludeMatcherParticipants": [
        "example"
      ],
      "executorIds": [
        "example"
      ],
      "externalID": [
        "example"
      ],
      "flightExternalExecutor": [
        "example"
      ],
      "flightIds": [
        "example"
      ],
      "flightStatus": [
        "example"
      ],
      "flightSubStatus": [
        "example"
      ],
      "forwarderIDs": [
        "example"
      ],
      "fromChooseWinnerTS": {},
      "fromCreateTS": null,
      "fromFirstLoadDate": "example",
      "fromFirstLoadDateTs": null,
      "fromFirstLoadTS": null,
      "fromLoadingTS": null,
      "fromOrderWayFirstLoadingWayPointStartAtTS": null,
      "fromOrderWayLastUnloadingWayPointEndAtTS": null,
      "fromPalletCount": 0,
      "fromSimpleTaskDeadlineTS": null,
      "fromUnloadingTS": null,
      "fromUpdateTS": null,
      "fromVolume": 0.5,
      "fromWeight": 0.5,
      "hasAssignedDriverInAllFlights": true,
      "hasAssignedDriverInAnyFlight": true,
      "hubType": [
        "example"
      ],
      "isArchive": true,
      "isDeprecated": true,
      "isOptimized": true,
      "latestRevokeOnExecuteEvent": {},
      "latestSendToExecutEvent": null,
      "latestSendToMatchEvent": null,
      "latestWinnerAssignedEvent": null,
      "limit": 0,
      "loadNPIds": [
        "example"
      ],
      "loadPoint": {},
      "matchStatuses": [
        "example"
      ],
      "matcherParticipants": [
        "example"
      ],
      "npShipmentIds": [
        "example"
      ],
      "npUnshipmentIds": [
        "example"
      ],
      "orderWayFirstLoadingWayPoint": null,
      "orderWayFirstLoadingWayPointAddresses": [
        "example"
      ],
      "orderWayLastUnloadingWayPoint": null,
      "orderWayLastUnloadingWayPointAddresses": [
        "example"
      ],
      "packageNames": [
        "example"
      ],
      "partialCargoIds": [
        "example"
      ],
      "partialDemandIds": [
        "example"
      ],
      "partialOrderIds": [
        "example"
      ],
      "participantNames": [
        "example"
      ],
      "participantTINs": [
        "example"
      ],
      "responsibleLogisticianByExecutor": [
        "example"
      ],
      "responsibleLogisticianByForwarder": [
        "example"
      ],
      "responsibleLogisticianForFlightByExecutor": [
        "example"
      ],
      "responsibleLogisticianNamedByExecutor": [
        "example"
      ],
      "responsibleLogisticianNamedByForwarder": [
        "example"
      ],
      "shipmentFilterStatus": [
        "example"
      ],
      "shipmentNames": [
        "example"
      ],
      "simpleTaskDocumentNumbers": [
        "example"
      ],
      "simpleTaskParticipantRoles": [
        "example"
      ],
      "simpleTaskStatuses": [
        "example"
      ],
      "simpleTaskTypeIds": [
        "example"
      ],
      "simpleTaskTypeNames": [
        "example"
      ],
      "statuses": [
        "example"
      ],
      "temperatureRegime": [
        {}
      ],
      "tin": [
        "example"
      ],
      "toChooseWinnerTS": null,
      "toCreateTS": null,
      "toFirstLoadDate": "example",
      "toFirstLoadDateTs": null,
      "toFirstLoadTS": null,
      "toLoadingTS": null,
      "toOrderWayFirstLoadingWayPointStartAtTS": null,
      "toOrderWayLastUnloadingWayPointEndAtTS": null,
      "toPalletCount": 0,
      "toSimpleTaskDeadlineTS": null,
      "toUnloadingTS": null,
      "toUpdateTS": null,
      "toVolume": 0.5,
      "toWeight": 0.5,
      "trailerIds": [
        "example"
      ],
      "truckIds": [
        "example"
      ],
      "unloadNPIds": [
        "example"
      ],
      "unloadPoint": null,
      "withMyBets": true
    },
    "flightExternalExecutor": [
      "example"
    ],
    "flightIds": [
      "example"
    ],
    "flightStatus": [
      "example"
    ],
    "flightSubStatus": [
      "example"
    ],
    "forwarderIDs": [
      "example"
    ],
    "freeTags": [
      "example"
    ],
    "fromChooseWinnerTS": null,
    "fromCreateTS": null,
    "fromLoadingTS": null,
    "fromUnloadingTS": null,
    "fromUpdateTS": null,
    "hasAssignedDriverInAllFlights": true,
    "hasAssignedDriverInAnyFlight": true,
    "hubType": [
      "example"
    ],
    "isArchive": true,
    "limit": 0,
    "loadNPIds": [
      "example"
    ],
    "loadPoint": null,
    "matchStatuses": [
      "example"
    ],
    "npShipmentIds": [
      "example"
    ],
    "npUnshipmentIds": [
      "example"
    ],
    "packageNames": [
      "example"
    ],
    "partialCargoIds": [
      "example"
    ],
    "partialOrderIds": [
      "example"
    ],
    "responsibleLogisticianByExecutor": [
      "example"
    ],
    "responsibleLogisticianByForwarder": [
      "example"
    ],
    "responsibleLogisticianForFlightByExecutor": [
      "example"
    ],
    "shipmentFilterStatus": [
      "example"
    ],
    "shipmentNames": [
      "example"
    ],
    "sort": {
      "sortSettings": [
        {}
      ]
    },
    "statuses": [
      "example"
    ],
    "tin": [
      "example"
    ],
    "toChooseWinnerTS": null,
    "toCreateTS": null,
    "toLoadingTS": null,
    "toUnloadingTS": null,
    "toUpdateTS": null,
    "trailerIds": [
      "example"
    ],
    "truckIds": [
      "example"
    ],
    "unloadNPIds": [
      "example"
    ],
    "unloadPoint": null,
    "withDeletedPlaces": true,
    "withDeletedShipments": true
  }
}

Name

Description

data

Type: OrdersV0TransferOrderGetFlatForCustomerRequest

Example
{
  "additionalConditions": {
    "additionalComment": "example",
    "currency": "example",
    "documentsDelay": {
      "daysTypeAfterDocuments": "example",
      "daysTypeBeforeDocuments": "example",
      "delayAfterDocuments": 0,
      "delayBeforeDocuments": 0
    },
    "emails": [
      "example"
    ],
    "externalOrderID": "example",
    "fullName": "example",
    "isVatPayer": true,
    "phones": [
      "example"
    ],
    "price": 0.5,
    "priceComment": "example",
    "priceWithVat": 0.5,
    "specifyConditions": true,
    "vat": 0.5
  },
  "bodyTypes": [
    "example"
  ],
  "carBodyType": [
    "example"
  ],
  "carBrand": [
    "example"
  ],
  "carNumber": [
    "example"
  ],
  "carType": [
    "example"
  ],
  "cargoCategories": [
    "example"
  ],
  "cargoComment": [
    "example"
  ],
  "cargoID": [
    "example"
  ],
  "customerComment": [
    "example"
  ],
  "customerIds": [
    "example"
  ],
  "distributionComment": [
    "example"
  ],
  "driverIds": [
    "example"
  ],
  "exactCargoIds": [
    "example"
  ],
  "exactOrderIds": [
    "example"
  ],
  "executorIds": [
    "example"
  ],
  "externalID": [
    "example"
  ],
  "filter": {
    "additionalConditionsExternalOrderID": [
      "example"
    ],
    "bodyTypeComments": [
      "example"
    ],
    "bodyTypes": [
      "example"
    ],
    "carBodyType": [
      "example"
    ],
    "carBrand": [
      "example"
    ],
    "carNumber": [
      "example"
    ],
    "carType": [
      "example"
    ],
    "cargoCategories": [
      "example"
    ],
    "cargoComment": [
      "example"
    ],
    "cargoID": [
      "example"
    ],
    "customerComment": [
      "example"
    ],
    "customerIds": [
      "example"
    ],
    "distributionComment": [
      "example"
    ],
    "driverIds": [
      "example"
    ],
    "edm": {
      "actionRequiredDocumentTypes": [
        null
      ],
      "actionRequiredFromOrganizationIds": [
        null
      ],
      "documentIds": [
        null
      ],
      "epeStatuses": [
        null
      ],
      "etrnStatuses": [
        null
      ],
      "exprStatuses": [
        null
      ],
      "ezzStatuses": [
        null
      ],
      "hasEpe": true,
      "hasEtrn": true,
      "hasExpr": true,
      "hasEzz": true
    },
    "etrnState": [
      "example"
    ],
    "exactCargoIds": [
      "example"
    ],
    "exactDemandIds": [
      "example"
    ],
    "exactOrderIds": [
      "example"
    ],
    "excludeMatcherParticipants": [
      "example"
    ],
    "executorIds": [
      "example"
    ],
    "externalID": [
      "example"
    ],
    "flightExternalExecutor": [
      "example"
    ],
    "flightIds": [
      "example"
    ],
    "flightStatus": [
      "example"
    ],
    "flightSubStatus": [
      "example"
    ],
    "forwarderIDs": [
      "example"
    ],
    "fromChooseWinnerTS": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "fromCreateTS": null,
    "fromFirstLoadDate": "example",
    "fromFirstLoadDateTs": null,
    "fromFirstLoadTS": null,
    "fromLoadingTS": null,
    "fromOrderWayFirstLoadingWayPointStartAtTS": null,
    "fromOrderWayLastUnloadingWayPointEndAtTS": null,
    "fromPalletCount": 0,
    "fromSimpleTaskDeadlineTS": null,
    "fromUnloadingTS": null,
    "fromUpdateTS": null,
    "fromVolume": 0.5,
    "fromWeight": 0.5,
    "hasAssignedDriverInAllFlights": true,
    "hasAssignedDriverInAnyFlight": true,
    "hubType": [
      "example"
    ],
    "isArchive": true,
    "isDeprecated": true,
    "isOptimized": true,
    "latestRevokeOnExecuteEvent": {
      "fromTS": null,
      "toTS": null
    },
    "latestSendToExecutEvent": null,
    "latestSendToMatchEvent": null,
    "latestWinnerAssignedEvent": null,
    "limit": 0,
    "loadNPIds": [
      "example"
    ],
    "loadPoint": {
      "lat": 0.5,
      "long": 0.5,
      "radiusM": 0.5
    },
    "matchStatuses": [
      "example"
    ],
    "matcherParticipants": [
      "example"
    ],
    "npShipmentIds": [
      "example"
    ],
    "npUnshipmentIds": [
      "example"
    ],
    "orderWayFirstLoadingWayPoint": null,
    "orderWayFirstLoadingWayPointAddresses": [
      "example"
    ],
    "orderWayLastUnloadingWayPoint": null,
    "orderWayLastUnloadingWayPointAddresses": [
      "example"
    ],
    "packageNames": [
      "example"
    ],
    "partialCargoIds": [
      "example"
    ],
    "partialDemandIds": [
      "example"
    ],
    "partialOrderIds": [
      "example"
    ],
    "participantNames": [
      "example"
    ],
    "participantTINs": [
      "example"
    ],
    "responsibleLogisticianByExecutor": [
      "example"
    ],
    "responsibleLogisticianByForwarder": [
      "example"
    ],
    "responsibleLogisticianForFlightByExecutor": [
      "example"
    ],
    "responsibleLogisticianNamedByExecutor": [
      "example"
    ],
    "responsibleLogisticianNamedByForwarder": [
      "example"
    ],
    "shipmentFilterStatus": [
      "example"
    ],
    "shipmentNames": [
      "example"
    ],
    "simpleTaskDocumentNumbers": [
      "example"
    ],
    "simpleTaskParticipantRoles": [
      "example"
    ],
    "simpleTaskStatuses": [
      "example"
    ],
    "simpleTaskTypeIds": [
      "example"
    ],
    "simpleTaskTypeNames": [
      "example"
    ],
    "statuses": [
      "example"
    ],
    "temperatureRegime": [
      {
        "from": 0,
        "label": "example",
        "to": 0
      }
    ],
    "tin": [
      "example"
    ],
    "toChooseWinnerTS": null,
    "toCreateTS": null,
    "toFirstLoadDate": "example",
    "toFirstLoadDateTs": null,
    "toFirstLoadTS": null,
    "toLoadingTS": null,
    "toOrderWayFirstLoadingWayPointStartAtTS": null,
    "toOrderWayLastUnloadingWayPointEndAtTS": null,
    "toPalletCount": 0,
    "toSimpleTaskDeadlineTS": null,
    "toUnloadingTS": null,
    "toUpdateTS": null,
    "toVolume": 0.5,
    "toWeight": 0.5,
    "trailerIds": [
      "example"
    ],
    "truckIds": [
      "example"
    ],
    "unloadNPIds": [
      "example"
    ],
    "unloadPoint": null,
    "withMyBets": true
  },
  "flightExternalExecutor": [
    "example"
  ],
  "flightIds": [
    "example"
  ],
  "flightStatus": [
    "example"
  ],
  "flightSubStatus": [
    "example"
  ],
  "forwarderIDs": [
    "example"
  ],
  "freeTags": [
    "example"
  ],
  "fromChooseWinnerTS": null,
  "fromCreateTS": null,
  "fromLoadingTS": null,
  "fromUnloadingTS": null,
  "fromUpdateTS": null,
  "hasAssignedDriverInAllFlights": true,
  "hasAssignedDriverInAnyFlight": true,
  "hubType": [
    "example"
  ],
  "isArchive": true,
  "limit": 0,
  "loadNPIds": [
    "example"
  ],
  "loadPoint": null,
  "matchStatuses": [
    "example"
  ],
  "npShipmentIds": [
    "example"
  ],
  "npUnshipmentIds": [
    "example"
  ],
  "packageNames": [
    "example"
  ],
  "partialCargoIds": [
    "example"
  ],
  "partialOrderIds": [
    "example"
  ],
  "responsibleLogisticianByExecutor": [
    "example"
  ],
  "responsibleLogisticianByForwarder": [
    "example"
  ],
  "responsibleLogisticianForFlightByExecutor": [
    "example"
  ],
  "shipmentFilterStatus": [
    "example"
  ],
  "shipmentNames": [
    "example"
  ],
  "sort": {
    "sortSettings": [
      {
        "field": "example",
        "order": "example"
      }
    ]
  },
  "statuses": [
    "example"
  ],
  "tin": [
    "example"
  ],
  "toChooseWinnerTS": null,
  "toCreateTS": null,
  "toLoadingTS": null,
  "toUnloadingTS": null,
  "toUpdateTS": null,
  "trailerIds": [
    "example"
  ],
  "truckIds": [
    "example"
  ],
  "unloadNPIds": [
    "example"
  ],
  "unloadPoint": null,
  "withDeletedPlaces": true,
  "withDeletedShipments": true
}

OrdersV0TransferOrderGetFlatForCustomerDocumentsDelay

Name

Description

daysTypeAfterDocuments

Type: string | null

Дни (после предоставления документов) - рабочие/календарные

Example: example

daysTypeBeforeDocuments

Type: string | null

Дни (до предоставления документов) - рабочие/календарные

Example: example

delayAfterDocuments

Type: integer | null

Отсрочка, дней (после предоставления документов)

delayBeforeDocuments

Type: integer | null

Отсрочка, дней (до предоставления документов)
Example
{
  "daysTypeAfterDocuments": "example",
  "daysTypeBeforeDocuments": "example",
  "delayAfterDocuments": 0,
  "delayBeforeDocuments": 0
}

OrdersV0TransferOrderGetFlatForCustomerAdditionalConditions

Name

Description

additionalComment

Type: string | null

Комментарий

Example: example

currency

Type: string | null

Валюта (селектор)

Example: example

documentsDelay
Any of 2 types

Отсрочка документов

Example
{
  "daysTypeAfterDocuments": "example",
  "daysTypeBeforeDocuments": "example",
  "delayAfterDocuments": 0,
  "delayBeforeDocuments": 0
}

emails

Type: string[] | null

Электронная почта (массив для поддержки кнопок + и удалить)

Example
[
  "example"
]

externalOrderID

Type: string | null

Идентификатор заказа во внешней системе

Example: example

fullName

Type: string | null

ФИО

Example: example

isVatPayer

Type: boolean | null

Является ли плательщиком НДС

phones

Type: string[] | null

Телефон (массив для поддержки кнопок + и удалить)

Example
[
  "example"
]

price

Type: number | null

Стоимость без НДС

priceComment

Type: string | null

Комментарий к цене

Example: example

priceWithVat

Type: number | null

Стоимость с НДС

specifyConditions

Type: boolean | null

Указать условия (переключатель/тумблер)

vat

Type: number | null

НДС
Example
{
  "additionalComment": "example",
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "emails": [
    "example"
  ],
  "externalOrderID": "example",
  "fullName": "example",
  "isVatPayer": true,
  "phones": [
    "example"
  ],
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "specifyConditions": true,
  "vat": 0.5
}

OrderSearchEdmFilter

Name

Description

actionRequiredDocumentTypes

Type: string[] | null

ActionRequiredDocumentTypes ограничивает выдачу типами ЭПД с действием от организаций пользователя в текущей роли.

Example
[
  "example"
]

actionRequiredFromOrganizationIds

Type: string[] | null

ActionRequiredFromOrganizationIDs задаёт организации, от которых требуется действие.
При заданных ActionRequiredDocumentTypes ограничивает только эти типы, иначе — все фильтры статусов документов.

Example
[
  "example"
]

documentIds

Type: string[] | null

DocumentIDs ограничивает выдачу заказами с указанными идентификаторами документов ЭДО.

Example
[
  "example"
]

epeStatuses

Type: string[] | null

EpeStatuses ограничивает выдачу статусами документов EPE.

Example
[
  "example"
]

etrnStatuses

Type: string[] | null

EtrnStatuses ограничивает выдачу статусами документов ETRN.

Example
[
  "example"
]

exprStatuses

Type: string[] | null

ExprStatuses ограничивает выдачу статусами документов EXPR.

Example
[
  "example"
]

ezzStatuses

Type: string[] | null

EzzStatuses ограничивает выдачу статусами документов EZZ.

Example
[
  "example"
]

hasEpe

Type: boolean | null

hasEtrn

Type: boolean | null

hasExpr

Type: boolean | null

hasEzz

Type: boolean | null
Example
{
  "actionRequiredDocumentTypes": [
    "example"
  ],
  "actionRequiredFromOrganizationIds": [
    "example"
  ],
  "documentIds": [
    "example"
  ],
  "epeStatuses": [
    "example"
  ],
  "etrnStatuses": [
    "example"
  ],
  "exprStatuses": [
    "example"
  ],
  "ezzStatuses": [
    "example"
  ],
  "hasEpe": true,
  "hasEtrn": true,
  "hasExpr": true,
  "hasEzz": true
}

TimestampTZInput

Name

Description

displayTZ

Type: string

Example: +03:00

time

Type: string<date-time>

Example: 2020-01-01T11:47:38+03:00

useLocation

Type: string

Example: +05:00
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

OrderSearchMeddFilter

Name

Description

fromTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}
Example
{
  "fromTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "toTS": null
}

OrderSearchPointRequest

Name

Description

lat

Type: number

long

Type: number

radiusM

Type: number
Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

OrderSearchTemperatureRegime

Name

Description

from

Type: integer

to

Type: integer

label

Type: string | null

Example: example
Example
{
  "from": 0,
  "label": "example",
  "to": 0
}

OrderSearchFilter

Name

Description

additionalConditionsExternalOrderID

Type: string[] | null

Example
[
  "example"
]

bodyTypeComments

Type: string[] | null

Example
[
  "example"
]

bodyTypes

Type: string[] | null

BodyTypes типы груза. - Пусто == все

Example
[
  "example"
]

carBodyType

Type: string[] | null

CarBodyType - Пусто == все

Example
[
  "example"
]

carBrand

Type: string[] | null

CarBrand - Пусто == все

Example
[
  "example"
]

cargoCategories

Type: string[] | null

CargoCategories Категория груза. - Пусто == все

Example
[
  "example"
]

cargoComment

Type: string[] | null

Параметр "Комментарий для себя" в разделе "Перевозка" создания заказа

Example
[
  "example"
]

cargoID

Type: string[] | null

CargoID - Пусто == все

Example
[
  "example"
]

carNumber

Type: string[] | null

CarNumber - Пусто == все

Example
[
  "example"
]

carType

Type: string[] | null

CarType - Пусто == все

Example
[
  "example"
]

customerComment

Type: string[] | null

Параметр "Комментарий" в разделе "Владелец груза" создания заказа

Example
[
  "example"
]

customerIds

Type: string[] | null

Example
[
  "example"
]

distributionComment

Type: string[] | null

Параметр "Особые условия перевозки" в разделе "Исполнители" создания заказа

Example
[
  "example"
]

driverIds

Type: string[] | null

DriverIDs - Пусто == все

Example
[
  "example"
]

edm
Any of 2 types

  • Type: OrderSearchEdmFilter

    Example
    {
  "actionRequiredDocumentTypes": [
    "example"
  ],
  "actionRequiredFromOrganizationIds": [
    "example"
  ],
  "documentIds": [
    "example"
  ],
  "epeStatuses": [
    "example"
  ],
  "etrnStatuses": [
    "example"
  ],
  "exprStatuses": [
    "example"
  ],
  "ezzStatuses": [
    "example"
  ],
  "hasEpe": true,
  "hasEtrn": true,
  "hasExpr": true,
  "hasEzz": true
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "actionRequiredDocumentTypes": [
    "example"
  ],
  "actionRequiredFromOrganizationIds": [
    "example"
  ],
  "documentIds": [
    "example"
  ],
  "epeStatuses": [
    "example"
  ],
  "etrnStatuses": [
    "example"
  ],
  "exprStatuses": [
    "example"
  ],
  "ezzStatuses": [
    "example"
  ],
  "hasEpe": true,
  "hasEtrn": true,
  "hasExpr": true,
  "hasEzz": true
}

etrnState

Type: string[] | null

Example
[
  "example"
]

exactCargoIds

Type: string[] | null

Example
[
  "example"
]

exactDemandIds

Type: string[] | null

Example
[
  "example"
]

exactOrderIds

Type: string[] | null

Example
[
  "example"
]

excludeMatcherParticipants

Type: string[] | null

организации, не являющиеся участниками торгов. В выдачу попадут заказы, в которых нет ни одной ставки ни от одной организации из списка

Example
[
  "example"
]

executorIds

Type: string[] | null

WinnerExecuters - Пусто == все

Example
[
  "example"
]

externalID

Type: string[] | null

ExternalID - Пусто == все

Example
[
  "example"
]

flightExternalExecutor

Type: string[] | null

Example
[
  "example"
]

flightIds

Type: string[] | null

Example
[
  "example"
]

flightStatus

Type: string[] | null

Cтатусы рейсов

Example
[
  "example"
]

flightSubStatus

Type: string[] | null

Подстатусы рейсов без машины / без водителя / не начат рейс

Example
[
  "example"
]

forwarderIDs

Type: string[] | null

ForwarderIDs - Пусто == все

Example
[
  "example"
]

fromChooseWinnerTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время определения победителя.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromCreateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

FromCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromFirstLoadDate

Type: string | null

Только начальная дата диапазона первой погрузки в формате YYYY-MM-DD.

Example: example

fromFirstLoadDateTs
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Только начальная дата диапазона первой погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromFirstLoadTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время первой погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromLoadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromOrderWayFirstLoadingWayPointStartAtTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

дата, после которой которой начинается первая погрузка маршрута заказа

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromOrderWayLastUnloadingWayPointEndAtTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

дата, после которой которой начинается последняя разгрузка маршрута заказа

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromPalletCount

Type: integer | null

Количество паллет от

fromSimpleTaskDeadlineTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromUnloadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время разгрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromUpdateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromVolume

Type: number | null

Объем от (в кубических метрах)

fromWeight

Type: number | null

Вес от (принимаем в тоннах)

hasAssignedDriverInAllFlights

Type: boolean | null

Есть назначенный водитель во всех рейсах заказа.

hasAssignedDriverInAnyFlight

Type: boolean | null

Есть назначенный водитель хотя бы в одном рейсе заказа.

hubType

Type: string[] | null

HubType - Пусто == 1*1+закрытый

Example
[
  "example"
]

isArchive

Type: boolean | null

Включать ли в выдачу архивные заказы. Не влияет если явно заданы orderIds.

isDeprecated

Type: boolean | null

Показывать заказы с deprecatedAt.

isOptimized

Type: boolean | null

Показывать заказы, созданные по результатам оптимизации.

latestRevokeOnExecuteEvent
Any of 2 types

  • Type: OrderSearchMeddFilter

    Example
    {
  "fromTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "toTS": null
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "fromTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "toTS": null
}

latestSendToExecutEvent
Any of 2 types

  • Type: OrderSearchMeddFilter

    Example
    {
  "fromTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "toTS": null
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "fromTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "toTS": null
}

latestSendToMatchEvent
Any of 2 types

  • Type: OrderSearchMeddFilter

    Example
    {
  "fromTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "toTS": null
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "fromTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "toTS": null
}

latestWinnerAssignedEvent
Any of 2 types

  • Type: OrderSearchMeddFilter

    Example
    {
  "fromTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "toTS": null
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "fromTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "toTS": null
}

limit

Type: integer | null

Limit ограничение на количество заказов на выходе. - Пусто == 100

loadNPIds

Type: string[] | null

LoadNPIDs - Пусто == все

Example
[
  "example"
]

loadPoint
Any of 2 types

  • Type: OrderSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

LoadPoint - Пусто == все

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

matcherParticipants

Type: string[] | null

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

Example
[
  "example"
]

matchStatuses

Type: string[] | null

Statuses - Пусто == все

Example
[
  "example"
]

npShipmentIds

Type: string[] | null

Example
[
  "example"
]

npUnshipmentIds

Type: string[] | null

Example
[
  "example"
]

orderWayFirstLoadingWayPoint
Any of 2 types

  • Type: OrderSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

координаты и радиус первой погрузки маршрута заказа

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

orderWayFirstLoadingWayPointAddresses

Type: string[] | null

адреса первой погрузки маршрута заказа

Example
[
  "example"
]

orderWayLastUnloadingWayPoint
Any of 2 types

  • Type: OrderSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

координаты и радиус последней разгрузки маршрута заказа

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

orderWayLastUnloadingWayPointAddresses

Type: string[] | null

адреса последней разгрузки маршрута заказа

Example
[
  "example"
]

packageNames

Type: string[] | null

Example
[
  "example"
]

partialCargoIds

Type: string[] | null

Example
[
  "example"
]

partialDemandIds

Type: string[] | null

Example
[
  "example"
]

partialOrderIds

Type: string[] | null

Example
[
  "example"
]

participantNames

Type: string[] | null

Example
[
  "example"
]

participantTINs

Type: string[] | null

ИНН Участник перевозки - Пусто == все

Example
[
  "example"
]

responsibleLogisticianByExecutor

Type: string[] | null

ResponsibleLogisticianByExecutor id-сотрудников ответсвенных логистов. - Пусто == все

Example
[
  "example"
]

responsibleLogisticianByForwarder

Type: string[] | null

ResponsibleLogisticianByForwarder id-сотрудников ответсвенных логистов. - Пусто == все

Example
[
  "example"
]

responsibleLogisticianForFlightByExecutor

Type: string[] | null

Example
[
  "example"
]

responsibleLogisticianNamedByExecutor

Type: string[] | null

Example
[
  "example"
]

responsibleLogisticianNamedByForwarder

Type: string[] | null

Example
[
  "example"
]

shipmentFilterStatus

Type: string[] | null

Подстатусы грузов

Example
[
  "example"
]

shipmentNames

Type: string[] | null

Example
[
  "example"
]

simpleTaskDocumentNumbers

Type: string[] | null

Example
[
  "example"
]

simpleTaskParticipantRoles

Type: string[] | null

Example
[
  "example"
]

simpleTaskStatuses

Type: string[] | null

Example
[
  "example"
]

simpleTaskTypeIds

Type: string[] | null

Example
[
  "example"
]

simpleTaskTypeNames

Type: string[] | null

Example
[
  "example"
]

statuses

Type: string[] | null

Statuses - Пусто == все

Example
[
  "example"
]

temperatureRegime

Type: OrderSearchTemperatureRegime[] | null

TemperatureRegime температурные режимы груза. - Пусто == все

Example
[
  {
    "from": 0,
    "label": "example",
    "to": 0
  }
]

tin

Type: string[] | null

TIN ИНН. - Пусто == все

Example
[
  "example"
]

toChooseWinnerTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toCreateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toFirstLoadDate

Type: string | null

Только конечная дата диапазона первой погрузки в формате YYYY-MM-DD.

Example: example

toFirstLoadDateTs
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Только конечная дата диапазона первой погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toFirstLoadTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toLoadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toOrderWayFirstLoadingWayPointStartAtTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

дата, до которой которой заканчивается первая погрузка маршрута заказа

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toOrderWayLastUnloadingWayPointEndAtTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

дата, до которой которой заканчивается последняя разгрузка маршрута заказа

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toPalletCount

Type: integer | null

Количество паллет до

toSimpleTaskDeadlineTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toUnloadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время разгрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toUpdateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toVolume

Type: number | null

Объем до (в кубических метрах)

toWeight

Type: number | null

Вес до (принимаем в тоннах)

trailerIds

Type: string[] | null

TrailerIDs - Пусто == все

Example
[
  "example"
]

truckIds

Type: string[] | null

CarsIDs - Пусто == все

Example
[
  "example"
]

unloadNPIds

Type: string[] | null

UnloadNPIDs - Пусто == все

Example
[
  "example"
]

unloadPoint
Any of 2 types

  • Type: OrderSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

UnloadPoint - Пусто == все

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

withMyBets

Type: boolean | null

исключающий шорткат на предыдущие два фильтра. Заполняет соответствующий фильтр организациями текущего пользователя, очищает второй
Example
{
  "additionalConditionsExternalOrderID": [
    "example"
  ],
  "bodyTypeComments": [
    "example"
  ],
  "bodyTypes": [
    "example"
  ],
  "carBodyType": [
    "example"
  ],
  "carBrand": [
    "example"
  ],
  "carNumber": [
    "example"
  ],
  "carType": [
    "example"
  ],
  "cargoCategories": [
    "example"
  ],
  "cargoComment": [
    "example"
  ],
  "cargoID": [
    "example"
  ],
  "customerComment": [
    "example"
  ],
  "customerIds": [
    "example"
  ],
  "distributionComment": [
    "example"
  ],
  "driverIds": [
    "example"
  ],
  "edm": {
    "actionRequiredDocumentTypes": [
      "example"
    ],
    "actionRequiredFromOrganizationIds": [
      "example"
    ],
    "documentIds": [
      "example"
    ],
    "epeStatuses": [
      "example"
    ],
    "etrnStatuses": [
      "example"
    ],
    "exprStatuses": [
      "example"
    ],
    "ezzStatuses": [
      "example"
    ],
    "hasEpe": true,
    "hasEtrn": true,
    "hasExpr": true,
    "hasEzz": true
  },
  "etrnState": [
    "example"
  ],
  "exactCargoIds": [
    "example"
  ],
  "exactDemandIds": [
    "example"
  ],
  "exactOrderIds": [
    "example"
  ],
  "excludeMatcherParticipants": [
    "example"
  ],
  "executorIds": [
    "example"
  ],
  "externalID": [
    "example"
  ],
  "flightExternalExecutor": [
    "example"
  ],
  "flightIds": [
    "example"
  ],
  "flightStatus": [
    "example"
  ],
  "flightSubStatus": [
    "example"
  ],
  "forwarderIDs": [
    "example"
  ],
  "fromChooseWinnerTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "fromCreateTS": null,
  "fromFirstLoadDate": "example",
  "fromFirstLoadDateTs": null,
  "fromFirstLoadTS": null,
  "fromLoadingTS": null,
  "fromOrderWayFirstLoadingWayPointStartAtTS": null,
  "fromOrderWayLastUnloadingWayPointEndAtTS": null,
  "fromPalletCount": 0,
  "fromSimpleTaskDeadlineTS": null,
  "fromUnloadingTS": null,
  "fromUpdateTS": null,
  "fromVolume": 0.5,
  "fromWeight": 0.5,
  "hasAssignedDriverInAllFlights": true,
  "hasAssignedDriverInAnyFlight": true,
  "hubType": [
    "example"
  ],
  "isArchive": true,
  "isDeprecated": true,
  "isOptimized": true,
  "latestRevokeOnExecuteEvent": {
    "fromTS": null,
    "toTS": null
  },
  "latestSendToExecutEvent": null,
  "latestSendToMatchEvent": null,
  "latestWinnerAssignedEvent": null,
  "limit": 0,
  "loadNPIds": [
    "example"
  ],
  "loadPoint": {
    "lat": 0.5,
    "long": 0.5,
    "radiusM": 0.5
  },
  "matchStatuses": [
    "example"
  ],
  "matcherParticipants": [
    "example"
  ],
  "npShipmentIds": [
    "example"
  ],
  "npUnshipmentIds": [
    "example"
  ],
  "orderWayFirstLoadingWayPoint": null,
  "orderWayFirstLoadingWayPointAddresses": [
    "example"
  ],
  "orderWayLastUnloadingWayPoint": null,
  "orderWayLastUnloadingWayPointAddresses": [
    "example"
  ],
  "packageNames": [
    "example"
  ],
  "partialCargoIds": [
    "example"
  ],
  "partialDemandIds": [
    "example"
  ],
  "partialOrderIds": [
    "example"
  ],
  "participantNames": [
    "example"
  ],
  "participantTINs": [
    "example"
  ],
  "responsibleLogisticianByExecutor": [
    "example"
  ],
  "responsibleLogisticianByForwarder": [
    "example"
  ],
  "responsibleLogisticianForFlightByExecutor": [
    "example"
  ],
  "responsibleLogisticianNamedByExecutor": [
    "example"
  ],
  "responsibleLogisticianNamedByForwarder": [
    "example"
  ],
  "shipmentFilterStatus": [
    "example"
  ],
  "shipmentNames": [
    "example"
  ],
  "simpleTaskDocumentNumbers": [
    "example"
  ],
  "simpleTaskParticipantRoles": [
    "example"
  ],
  "simpleTaskStatuses": [
    "example"
  ],
  "simpleTaskTypeIds": [
    "example"
  ],
  "simpleTaskTypeNames": [
    "example"
  ],
  "statuses": [
    "example"
  ],
  "temperatureRegime": [
    {
      "from": 0,
      "label": "example",
      "to": 0
    }
  ],
  "tin": [
    "example"
  ],
  "toChooseWinnerTS": null,
  "toCreateTS": null,
  "toFirstLoadDate": "example",
  "toFirstLoadDateTs": null,
  "toFirstLoadTS": null,
  "toLoadingTS": null,
  "toOrderWayFirstLoadingWayPointStartAtTS": null,
  "toOrderWayLastUnloadingWayPointEndAtTS": null,
  "toPalletCount": 0,
  "toSimpleTaskDeadlineTS": null,
  "toUnloadingTS": null,
  "toUpdateTS": null,
  "toVolume": 0.5,
  "toWeight": 0.5,
  "trailerIds": [
    "example"
  ],
  "truckIds": [
    "example"
  ],
  "unloadNPIds": [
    "example"
  ],
  "unloadPoint": null,
  "withMyBets": true
}

OrderSearchSortSetting

Name

Description

field

Type: string

Example: example

order

Type: string | null

Example: example
Example
{
  "field": "example",
  "order": "example"
}

OrderSearchSort

Name

Description

sortSettings

Type: OrderSearchSortSetting[] | null

Example
[
  {
    "field": "example",
    "order": "example"
  }
]
Example
{
  "sortSettings": [
    {
      "field": "example",
      "order": "example"
    }
  ]
}

OrdersV0TransferOrderGetFlatForCustomerRequest

Name

Description

additionalConditions
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerAdditionalConditions

    Example
    {
  "additionalComment": "example",
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "emails": [
    "example"
  ],
  "externalOrderID": "example",
  "fullName": "example",
  "isVatPayer": true,
  "phones": [
    "example"
  ],
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "specifyConditions": true,
  "vat": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

Дополнительные условия заказа

Example
{
  "additionalComment": "example",
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "emails": [
    "example"
  ],
  "externalOrderID": "example",
  "fullName": "example",
  "isVatPayer": true,
  "phones": [
    "example"
  ],
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "specifyConditions": true,
  "vat": 0.5
}

bodyTypes

Type: string[] | null

BodyTypes типы груза. - Пусто == все

Example
[
  "example"
]

carBodyType

Type: string[] | null

CarBodyType - Пусто == все

Example
[
  "example"
]

carBrand

Type: string[] | null

CarBrand - Пусто == все

Example
[
  "example"
]

cargoCategories

Type: string[] | null

CargoCategories Категория груза. - Пусто == все

Example
[
  "example"
]

cargoComment

Type: string[] | null

Параметр "Комментарий для себя" в разделе "Перевозка" создания заказа

Example
[
  "example"
]

cargoID

Type: string[] | null

CargoID - Пусто == все

Example
[
  "example"
]

carNumber

Type: string[] | null

CarNumber - Пусто == все

Example
[
  "example"
]

carType

Type: string[] | null

CarType - Пусто == все

Example
[
  "example"
]

customerComment

Type: string[] | null

Параметр "Комментарий" в разделе "Владелец груза" создания заказа

Example
[
  "example"
]

customerIds

Type: string[] | null

Example
[
  "example"
]

distributionComment

Type: string[] | null

Параметр "Особые условия перевозки" в разделе "Исполнители" создания заказа

Example
[
  "example"
]

driverIds

Type: string[] | null

DriverIDs - Пусто == все

Example
[
  "example"
]

exactCargoIds

Type: string[] | null

Example
[
  "example"
]

exactOrderIds

Type: string[] | null

Example
[
  "example"
]

executorIds

Type: string[] | null

WinnerExecuters - Пусто == все

Example
[
  "example"
]

externalID

Type: string[] | null

ExternalID - Пусто == все

Example
[
  "example"
]

filter
Any of 2 types

  • Type: OrderSearchFilter

    Example
    {
  "additionalConditionsExternalOrderID": [
    "example"
  ],
  "bodyTypeComments": [
    "example"
  ],
  "bodyTypes": [
    "example"
  ],
  "carBodyType": [
    "example"
  ],
  "carBrand": [
    "example"
  ],
  "carNumber": [
    "example"
  ],
  "carType": [
    "example"
  ],
  "cargoCategories": [
    "example"
  ],
  "cargoComment": [
    "example"
  ],
  "cargoID": [
    "example"
  ],
  "customerComment": [
    "example"
  ],
  "customerIds": [
    "example"
  ],
  "distributionComment": [
    "example"
  ],
  "driverIds": [
    "example"
  ],
  "edm": {
    "actionRequiredDocumentTypes": [
      "example"
    ],
    "actionRequiredFromOrganizationIds": [
      "example"
    ],
    "documentIds": [
      "example"
    ],
    "epeStatuses": [
      "example"
    ],
    "etrnStatuses": [
      "example"
    ],
    "exprStatuses": [
      "example"
    ],
    "ezzStatuses": [
      "example"
    ],
    "hasEpe": true,
    "hasEtrn": true,
    "hasExpr": true,
    "hasEzz": true
  },
  "etrnState": [
    "example"
  ],
  "exactCargoIds": [
    "example"
  ],
  "exactDemandIds": [
    "example"
  ],
  "exactOrderIds": [
    "example"
  ],
  "excludeMatcherParticipants": [
    "example"
  ],
  "executorIds": [
    "example"
  ],
  "externalID": [
    "example"
  ],
  "flightExternalExecutor": [
    "example"
  ],
  "flightIds": [
    "example"
  ],
  "flightStatus": [
    "example"
  ],
  "flightSubStatus": [
    "example"
  ],
  "forwarderIDs": [
    "example"
  ],
  "fromChooseWinnerTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "fromCreateTS": null,
  "fromFirstLoadDate": "example",
  "fromFirstLoadDateTs": null,
  "fromFirstLoadTS": null,
  "fromLoadingTS": null,
  "fromOrderWayFirstLoadingWayPointStartAtTS": null,
  "fromOrderWayLastUnloadingWayPointEndAtTS": null,
  "fromPalletCount": 0,
  "fromSimpleTaskDeadlineTS": null,
  "fromUnloadingTS": null,
  "fromUpdateTS": null,
  "fromVolume": 0.5,
  "fromWeight": 0.5,
  "hasAssignedDriverInAllFlights": true,
  "hasAssignedDriverInAnyFlight": true,
  "hubType": [
    "example"
  ],
  "isArchive": true,
  "isDeprecated": true,
  "isOptimized": true,
  "latestRevokeOnExecuteEvent": {
    "fromTS": null,
    "toTS": null
  },
  "latestSendToExecutEvent": null,
  "latestSendToMatchEvent": null,
  "latestWinnerAssignedEvent": null,
  "limit": 0,
  "loadNPIds": [
    "example"
  ],
  "loadPoint": {
    "lat": 0.5,
    "long": 0.5,
    "radiusM": 0.5
  },
  "matchStatuses": [
    "example"
  ],
  "matcherParticipants": [
    "example"
  ],
  "npShipmentIds": [
    "example"
  ],
  "npUnshipmentIds": [
    "example"
  ],
  "orderWayFirstLoadingWayPoint": null,
  "orderWayFirstLoadingWayPointAddresses": [
    "example"
  ],
  "orderWayLastUnloadingWayPoint": null,
  "orderWayLastUnloadingWayPointAddresses": [
    "example"
  ],
  "packageNames": [
    "example"
  ],
  "partialCargoIds": [
    "example"
  ],
  "partialDemandIds": [
    "example"
  ],
  "partialOrderIds": [
    "example"
  ],
  "participantNames": [
    "example"
  ],
  "participantTINs": [
    "example"
  ],
  "responsibleLogisticianByExecutor": [
    "example"
  ],
  "responsibleLogisticianByForwarder": [
    "example"
  ],
  "responsibleLogisticianForFlightByExecutor": [
    "example"
  ],
  "responsibleLogisticianNamedByExecutor": [
    "example"
  ],
  "responsibleLogisticianNamedByForwarder": [
    "example"
  ],
  "shipmentFilterStatus": [
    "example"
  ],
  "shipmentNames": [
    "example"
  ],
  "simpleTaskDocumentNumbers": [
    "example"
  ],
  "simpleTaskParticipantRoles": [
    "example"
  ],
  "simpleTaskStatuses": [
    "example"
  ],
  "simpleTaskTypeIds": [
    "example"
  ],
  "simpleTaskTypeNames": [
    "example"
  ],
  "statuses": [
    "example"
  ],
  "temperatureRegime": [
    {
      "from": 0,
      "label": "example",
      "to": 0
    }
  ],
  "tin": [
    "example"
  ],
  "toChooseWinnerTS": null,
  "toCreateTS": null,
  "toFirstLoadDate": "example",
  "toFirstLoadDateTs": null,
  "toFirstLoadTS": null,
  "toLoadingTS": null,
  "toOrderWayFirstLoadingWayPointStartAtTS": null,
  "toOrderWayLastUnloadingWayPointEndAtTS": null,
  "toPalletCount": 0,
  "toSimpleTaskDeadlineTS": null,
  "toUnloadingTS": null,
  "toUpdateTS": null,
  "toVolume": 0.5,
  "toWeight": 0.5,
  "trailerIds": [
    "example"
  ],
  "truckIds": [
    "example"
  ],
  "unloadNPIds": [
    "example"
  ],
  "unloadPoint": null,
  "withMyBets": true
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "additionalConditionsExternalOrderID": [
    "example"
  ],
  "bodyTypeComments": [
    "example"
  ],
  "bodyTypes": [
    "example"
  ],
  "carBodyType": [
    "example"
  ],
  "carBrand": [
    "example"
  ],
  "carNumber": [
    "example"
  ],
  "carType": [
    "example"
  ],
  "cargoCategories": [
    "example"
  ],
  "cargoComment": [
    "example"
  ],
  "cargoID": [
    "example"
  ],
  "customerComment": [
    "example"
  ],
  "customerIds": [
    "example"
  ],
  "distributionComment": [
    "example"
  ],
  "driverIds": [
    "example"
  ],
  "edm": {
    "actionRequiredDocumentTypes": [
      "example"
    ],
    "actionRequiredFromOrganizationIds": [
      "example"
    ],
    "documentIds": [
      "example"
    ],
    "epeStatuses": [
      "example"
    ],
    "etrnStatuses": [
      "example"
    ],
    "exprStatuses": [
      "example"
    ],
    "ezzStatuses": [
      "example"
    ],
    "hasEpe": true,
    "hasEtrn": true,
    "hasExpr": true,
    "hasEzz": true
  },
  "etrnState": [
    "example"
  ],
  "exactCargoIds": [
    "example"
  ],
  "exactDemandIds": [
    "example"
  ],
  "exactOrderIds": [
    "example"
  ],
  "excludeMatcherParticipants": [
    "example"
  ],
  "executorIds": [
    "example"
  ],
  "externalID": [
    "example"
  ],
  "flightExternalExecutor": [
    "example"
  ],
  "flightIds": [
    "example"
  ],
  "flightStatus": [
    "example"
  ],
  "flightSubStatus": [
    "example"
  ],
  "forwarderIDs": [
    "example"
  ],
  "fromChooseWinnerTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "fromCreateTS": null,
  "fromFirstLoadDate": "example",
  "fromFirstLoadDateTs": null,
  "fromFirstLoadTS": null,
  "fromLoadingTS": null,
  "fromOrderWayFirstLoadingWayPointStartAtTS": null,
  "fromOrderWayLastUnloadingWayPointEndAtTS": null,
  "fromPalletCount": 0,
  "fromSimpleTaskDeadlineTS": null,
  "fromUnloadingTS": null,
  "fromUpdateTS": null,
  "fromVolume": 0.5,
  "fromWeight": 0.5,
  "hasAssignedDriverInAllFlights": true,
  "hasAssignedDriverInAnyFlight": true,
  "hubType": [
    "example"
  ],
  "isArchive": true,
  "isDeprecated": true,
  "isOptimized": true,
  "latestRevokeOnExecuteEvent": {
    "fromTS": null,
    "toTS": null
  },
  "latestSendToExecutEvent": null,
  "latestSendToMatchEvent": null,
  "latestWinnerAssignedEvent": null,
  "limit": 0,
  "loadNPIds": [
    "example"
  ],
  "loadPoint": {
    "lat": 0.5,
    "long": 0.5,
    "radiusM": 0.5
  },
  "matchStatuses": [
    "example"
  ],
  "matcherParticipants": [
    "example"
  ],
  "npShipmentIds": [
    "example"
  ],
  "npUnshipmentIds": [
    "example"
  ],
  "orderWayFirstLoadingWayPoint": null,
  "orderWayFirstLoadingWayPointAddresses": [
    "example"
  ],
  "orderWayLastUnloadingWayPoint": null,
  "orderWayLastUnloadingWayPointAddresses": [
    "example"
  ],
  "packageNames": [
    "example"
  ],
  "partialCargoIds": [
    "example"
  ],
  "partialDemandIds": [
    "example"
  ],
  "partialOrderIds": [
    "example"
  ],
  "participantNames": [
    "example"
  ],
  "participantTINs": [
    "example"
  ],
  "responsibleLogisticianByExecutor": [
    "example"
  ],
  "responsibleLogisticianByForwarder": [
    "example"
  ],
  "responsibleLogisticianForFlightByExecutor": [
    "example"
  ],
  "responsibleLogisticianNamedByExecutor": [
    "example"
  ],
  "responsibleLogisticianNamedByForwarder": [
    "example"
  ],
  "shipmentFilterStatus": [
    "example"
  ],
  "shipmentNames": [
    "example"
  ],
  "simpleTaskDocumentNumbers": [
    "example"
  ],
  "simpleTaskParticipantRoles": [
    "example"
  ],
  "simpleTaskStatuses": [
    "example"
  ],
  "simpleTaskTypeIds": [
    "example"
  ],
  "simpleTaskTypeNames": [
    "example"
  ],
  "statuses": [
    "example"
  ],
  "temperatureRegime": [
    {
      "from": 0,
      "label": "example",
      "to": 0
    }
  ],
  "tin": [
    "example"
  ],
  "toChooseWinnerTS": null,
  "toCreateTS": null,
  "toFirstLoadDate": "example",
  "toFirstLoadDateTs": null,
  "toFirstLoadTS": null,
  "toLoadingTS": null,
  "toOrderWayFirstLoadingWayPointStartAtTS": null,
  "toOrderWayLastUnloadingWayPointEndAtTS": null,
  "toPalletCount": 0,
  "toSimpleTaskDeadlineTS": null,
  "toUnloadingTS": null,
  "toUpdateTS": null,
  "toVolume": 0.5,
  "toWeight": 0.5,
  "trailerIds": [
    "example"
  ],
  "truckIds": [
    "example"
  ],
  "unloadNPIds": [
    "example"
  ],
  "unloadPoint": null,
  "withMyBets": true
}

flightExternalExecutor

Type: string[] | null

Example
[
  "example"
]

flightIds

Type: string[] | null

Example
[
  "example"
]

flightStatus

Type: string[] | null

Cтатусы рейсов

Example
[
  "example"
]

flightSubStatus

Type: string[] | null

Подстатусы рейсов без машины / без водителя / не начат рейс

Example
[
  "example"
]

forwarderIDs

Type: string[] | null

ForwarderIDs - Пусто == все

Example
[
  "example"
]

freeTags

Type: string[] | null

Example
[
  "example"
]

fromChooseWinnerTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время определения победителя.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromCreateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

FromCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromLoadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromUnloadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время разгрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromUpdateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

hasAssignedDriverInAllFlights

Type: boolean | null

Есть назначенный водитель во всех рейсах заказа.

hasAssignedDriverInAnyFlight

Type: boolean | null

Есть назначенный водитель хотя бы в одном рейсе заказа.

hubType

Type: string[] | null

HubType - Пусто == 1*1+закрытый

Example
[
  "example"
]

isArchive

Type: boolean | null

Включать ли в выдачу архивные заказы. Не влияет если явно заданы orderIds.

limit

Type: integer | null

Limit ограничение на количество заказов на выходе. - Пусто == 100

loadNPIds

Type: string[] | null

LoadNPIDs - Пусто == все

Example
[
  "example"
]

loadPoint
Any of 2 types

  • Type: OrderSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

LoadPoint - Пусто == все

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

matchStatuses

Type: string[] | null

Statuses - Пусто == все

Example
[
  "example"
]

npShipmentIds

Type: string[] | null

Example
[
  "example"
]

npUnshipmentIds

Type: string[] | null

Example
[
  "example"
]

packageNames

Type: string[] | null

Example
[
  "example"
]

partialCargoIds

Type: string[] | null

Example
[
  "example"
]

partialOrderIds

Type: string[] | null

Example
[
  "example"
]

responsibleLogisticianByExecutor

Type: string[] | null

ResponsibleLogisticianByExecutor id-сотрудников ответсвенных логистов. - Пусто == все

Example
[
  "example"
]

responsibleLogisticianByForwarder

Type: string[] | null

ResponsibleLogisticianByForwarder id-сотрудников ответсвенных логистов. - Пусто == все

Example
[
  "example"
]

responsibleLogisticianForFlightByExecutor

Type: string[] | null

Example
[
  "example"
]

shipmentFilterStatus

Type: string[] | null

Подстатусы грузов

Example
[
  "example"
]

shipmentNames

Type: string[] | null

Example
[
  "example"
]

sort
Any of 2 types

  • Type: OrderSearchSort

    Example
    {
  "sortSettings": [
    {
      "field": "example",
      "order": "example"
    }
  ]
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "sortSettings": [
    {
      "field": "example",
      "order": "example"
    }
  ]
}

statuses

Type: string[] | null

Statuses - Пусто == все

Example
[
  "example"
]

tin

Type: string[] | null

TIN ИНН. - Пусто == все

Example
[
  "example"
]

toChooseWinnerTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время определения победителя.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toCreateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toLoadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toUnloadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время разгрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toUpdateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

trailerIds

Type: string[] | null

TrailerIDs - Пусто == все

Example
[
  "example"
]

truckIds

Type: string[] | null

CarsIDs - Пусто == все

Example
[
  "example"
]

unloadNPIds

Type: string[] | null

UnloadNPIDs - Пусто == все

Example
[
  "example"
]

unloadPoint
Any of 2 types

  • Type: OrderSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

UnloadPoint - Пусто == все

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

withDeletedPlaces

Type: boolean

С удаленными местами

withDeletedShipments

Type: boolean

С удаленными грузами
Example
{
  "additionalConditions": {
    "additionalComment": "example",
    "currency": "example",
    "documentsDelay": {
      "daysTypeAfterDocuments": "example",
      "daysTypeBeforeDocuments": "example",
      "delayAfterDocuments": 0,
      "delayBeforeDocuments": 0
    },
    "emails": [
      "example"
    ],
    "externalOrderID": "example",
    "fullName": "example",
    "isVatPayer": true,
    "phones": [
      "example"
    ],
    "price": 0.5,
    "priceComment": "example",
    "priceWithVat": 0.5,
    "specifyConditions": true,
    "vat": 0.5
  },
  "bodyTypes": [
    "example"
  ],
  "carBodyType": [
    "example"
  ],
  "carBrand": [
    "example"
  ],
  "carNumber": [
    "example"
  ],
  "carType": [
    "example"
  ],
  "cargoCategories": [
    "example"
  ],
  "cargoComment": [
    "example"
  ],
  "cargoID": [
    "example"
  ],
  "customerComment": [
    "example"
  ],
  "customerIds": [
    "example"
  ],
  "distributionComment": [
    "example"
  ],
  "driverIds": [
    "example"
  ],
  "exactCargoIds": [
    "example"
  ],
  "exactOrderIds": [
    "example"
  ],
  "executorIds": [
    "example"
  ],
  "externalID": [
    "example"
  ],
  "filter": {
    "additionalConditionsExternalOrderID": [
      "example"
    ],
    "bodyTypeComments": [
      "example"
    ],
    "bodyTypes": [
      "example"
    ],
    "carBodyType": [
      "example"
    ],
    "carBrand": [
      "example"
    ],
    "carNumber": [
      "example"
    ],
    "carType": [
      "example"
    ],
    "cargoCategories": [
      "example"
    ],
    "cargoComment": [
      "example"
    ],
    "cargoID": [
      "example"
    ],
    "customerComment": [
      "example"
    ],
    "customerIds": [
      "example"
    ],
    "distributionComment": [
      "example"
    ],
    "driverIds": [
      "example"
    ],
    "edm": {
      "actionRequiredDocumentTypes": [
        null
      ],
      "actionRequiredFromOrganizationIds": [
        null
      ],
      "documentIds": [
        null
      ],
      "epeStatuses": [
        null
      ],
      "etrnStatuses": [
        null
      ],
      "exprStatuses": [
        null
      ],
      "ezzStatuses": [
        null
      ],
      "hasEpe": true,
      "hasEtrn": true,
      "hasExpr": true,
      "hasEzz": true
    },
    "etrnState": [
      "example"
    ],
    "exactCargoIds": [
      "example"
    ],
    "exactDemandIds": [
      "example"
    ],
    "exactOrderIds": [
      "example"
    ],
    "excludeMatcherParticipants": [
      "example"
    ],
    "executorIds": [
      "example"
    ],
    "externalID": [
      "example"
    ],
    "flightExternalExecutor": [
      "example"
    ],
    "flightIds": [
      "example"
    ],
    "flightStatus": [
      "example"
    ],
    "flightSubStatus": [
      "example"
    ],
    "forwarderIDs": [
      "example"
    ],
    "fromChooseWinnerTS": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "fromCreateTS": null,
    "fromFirstLoadDate": "example",
    "fromFirstLoadDateTs": null,
    "fromFirstLoadTS": null,
    "fromLoadingTS": null,
    "fromOrderWayFirstLoadingWayPointStartAtTS": null,
    "fromOrderWayLastUnloadingWayPointEndAtTS": null,
    "fromPalletCount": 0,
    "fromSimpleTaskDeadlineTS": null,
    "fromUnloadingTS": null,
    "fromUpdateTS": null,
    "fromVolume": 0.5,
    "fromWeight": 0.5,
    "hasAssignedDriverInAllFlights": true,
    "hasAssignedDriverInAnyFlight": true,
    "hubType": [
      "example"
    ],
    "isArchive": true,
    "isDeprecated": true,
    "isOptimized": true,
    "latestRevokeOnExecuteEvent": {
      "fromTS": null,
      "toTS": null
    },
    "latestSendToExecutEvent": null,
    "latestSendToMatchEvent": null,
    "latestWinnerAssignedEvent": null,
    "limit": 0,
    "loadNPIds": [
      "example"
    ],
    "loadPoint": {
      "lat": 0.5,
      "long": 0.5,
      "radiusM": 0.5
    },
    "matchStatuses": [
      "example"
    ],
    "matcherParticipants": [
      "example"
    ],
    "npShipmentIds": [
      "example"
    ],
    "npUnshipmentIds": [
      "example"
    ],
    "orderWayFirstLoadingWayPoint": null,
    "orderWayFirstLoadingWayPointAddresses": [
      "example"
    ],
    "orderWayLastUnloadingWayPoint": null,
    "orderWayLastUnloadingWayPointAddresses": [
      "example"
    ],
    "packageNames": [
      "example"
    ],
    "partialCargoIds": [
      "example"
    ],
    "partialDemandIds": [
      "example"
    ],
    "partialOrderIds": [
      "example"
    ],
    "participantNames": [
      "example"
    ],
    "participantTINs": [
      "example"
    ],
    "responsibleLogisticianByExecutor": [
      "example"
    ],
    "responsibleLogisticianByForwarder": [
      "example"
    ],
    "responsibleLogisticianForFlightByExecutor": [
      "example"
    ],
    "responsibleLogisticianNamedByExecutor": [
      "example"
    ],
    "responsibleLogisticianNamedByForwarder": [
      "example"
    ],
    "shipmentFilterStatus": [
      "example"
    ],
    "shipmentNames": [
      "example"
    ],
    "simpleTaskDocumentNumbers": [
      "example"
    ],
    "simpleTaskParticipantRoles": [
      "example"
    ],
    "simpleTaskStatuses": [
      "example"
    ],
    "simpleTaskTypeIds": [
      "example"
    ],
    "simpleTaskTypeNames": [
      "example"
    ],
    "statuses": [
      "example"
    ],
    "temperatureRegime": [
      {
        "from": 0,
        "label": "example",
        "to": 0
      }
    ],
    "tin": [
      "example"
    ],
    "toChooseWinnerTS": null,
    "toCreateTS": null,
    "toFirstLoadDate": "example",
    "toFirstLoadDateTs": null,
    "toFirstLoadTS": null,
    "toLoadingTS": null,
    "toOrderWayFirstLoadingWayPointStartAtTS": null,
    "toOrderWayLastUnloadingWayPointEndAtTS": null,
    "toPalletCount": 0,
    "toSimpleTaskDeadlineTS": null,
    "toUnloadingTS": null,
    "toUpdateTS": null,
    "toVolume": 0.5,
    "toWeight": 0.5,
    "trailerIds": [
      "example"
    ],
    "truckIds": [
      "example"
    ],
    "unloadNPIds": [
      "example"
    ],
    "unloadPoint": null,
    "withMyBets": true
  },
  "flightExternalExecutor": [
    "example"
  ],
  "flightIds": [
    "example"
  ],
  "flightStatus": [
    "example"
  ],
  "flightSubStatus": [
    "example"
  ],
  "forwarderIDs": [
    "example"
  ],
  "freeTags": [
    "example"
  ],
  "fromChooseWinnerTS": null,
  "fromCreateTS": null,
  "fromLoadingTS": null,
  "fromUnloadingTS": null,
  "fromUpdateTS": null,
  "hasAssignedDriverInAllFlights": true,
  "hasAssignedDriverInAnyFlight": true,
  "hubType": [
    "example"
  ],
  "isArchive": true,
  "limit": 0,
  "loadNPIds": [
    "example"
  ],
  "loadPoint": null,
  "matchStatuses": [
    "example"
  ],
  "npShipmentIds": [
    "example"
  ],
  "npUnshipmentIds": [
    "example"
  ],
  "packageNames": [
    "example"
  ],
  "partialCargoIds": [
    "example"
  ],
  "partialOrderIds": [
    "example"
  ],
  "responsibleLogisticianByExecutor": [
    "example"
  ],
  "responsibleLogisticianByForwarder": [
    "example"
  ],
  "responsibleLogisticianForFlightByExecutor": [
    "example"
  ],
  "shipmentFilterStatus": [
    "example"
  ],
  "shipmentNames": [
    "example"
  ],
  "sort": {
    "sortSettings": [
      {
        "field": "example",
        "order": "example"
      }
    ]
  },
  "statuses": [
    "example"
  ],
  "tin": [
    "example"
  ],
  "toChooseWinnerTS": null,
  "toCreateTS": null,
  "toLoadingTS": null,
  "toUnloadingTS": null,
  "toUpdateTS": null,
  "trailerIds": [
    "example"
  ],
  "truckIds": [
    "example"
  ],
  "unloadNPIds": [
    "example"
  ],
  "unloadPoint": null,
  "withDeletedPlaces": true,
  "withDeletedShipments": true
}

Responses

200 OK

OK

Body

application/json
{
  "data": {
    "orders": [
      {
        "additionalConditions": {},
        "agreementRules": {},
        "alerts": [
          {}
        ],
        "auction": {},
        "basicConditionsTemplateId": "example",
        "bodyType": [
          "example"
        ],
        "bodyTypeComment": "example",
        "cancelComment": [
          "example"
        ],
        "cancelReasonKey": "example",
        "carHeadInfos": [
          {}
        ],
        "cargoCategory": null,
        "cargoComment": "example",
        "cargoId": "example",
        "created": {
          "contact": null,
          "displayTZ": "+03:00",
          "time": "2020-01-01T00:00:00"
        },
        "currency": "example",
        "customer": null,
        "demandId": "example",
        "deprecatedAt": {},
        "dimensions": {},
        "distribution": {},
        "drivers": [
          {}
        ],
        "execOrder": {},
        "execOrderId": "example",
        "execResponsibleLogistician": {},
        "executionPrice": {},
        "executionSettings": {},
        "executor": {},
        "executorConditionsTemplate": {},
        "executorViews": [
          {}
        ],
        "files": [
          {}
        ],
        "flightCreator": {},
        "forwarder": null,
        "freeTagsInfo": [
          {}
        ],
        "fwdResponsibleLogistician": null,
        "id": "example",
        "isActual": true,
        "isArchived": true,
        "isReadonly": true,
        "isVolumeAuction": true,
        "latestRevokeOnExecute": null,
        "latestSendOnExecute": null,
        "latestSendOnMatcher": null,
        "latestWinnerAssigned": null,
        "matcher": {},
        "maxUpdatedDate": null,
        "orderExternalID": "example",
        "orderWay": {},
        "parentId": "example",
        "paymentDelayPeriod": {},
        "responsibleCustomer": null,
        "rootId": "example",
        "shipments": [
          {}
        ],
        "status": "example",
        "systemConditionsTemplateId": "example",
        "tag": null,
        "temperatureRegime": [
          {}
        ],
        "trailerInfos": [
          null
        ],
        "transIdentity": "example",
        "transferOrderAdditionalConditions": "example",
        "transferOrderAdditionalConfiguration": {},
        "transferOrderCost": {},
        "transferOrderName": "example",
        "transferOrderType": "example",
        "transshipmentTypes": [
          "example"
        ],
        "typePaymentAndTax": "example",
        "updated": null,
        "utm": {},
        "volumeDemand": {}
      }
    ]
  }
}

Name

Description

data

Type: OrdersV0TransferOrderGetFlatForCustomerResponse

Example
{
  "orders": [
    {
      "additionalConditions": {
        "additionalComment": "example",
        "currency": "example",
        "documentsDelay": null,
        "emails": [
          null
        ],
        "externalOrderID": "example",
        "fullName": "example",
        "isVatPayer": true,
        "phones": [
          null
        ],
        "price": 0.5,
        "priceComment": "example",
        "priceWithVat": 0.5,
        "specifyConditions": true,
        "vat": 0.5
      },
      "agreementRules": {
        "isDriverCanChangePackagesWithoutApproval": true,
        "isExecutorCanChangePackagesWithoutApproval": true,
        "isExecutorCanChangeShipmentsWithoutApproval": true,
        "isForwarderCanChangePackagesWithoutApproval": true,
        "isForwarderCanChangeShipmentsWithoutApproval": true,
        "isWarehouseCanChangePackagesWithoutApproval": true
      },
      "alerts": [
        {
          "alertType": "example",
          "description": "example"
        }
      ],
      "auction": {
        "allowMultimodal": true,
        "amount": 0.5,
        "auctionType": "example",
        "autoExtension": true,
        "autoExtensionActive": 0,
        "autoExtensionDuration": 0,
        "autoExtensionTime": 0,
        "autoSelection": true,
        "bargainingIsPossible": true,
        "bidStep": 0.5,
        "buyNowPrice": 0.5,
        "currency": "example",
        "decreaseOnly": true,
        "decreaseOnlyFromDeclaredPrice": true,
        "duration": 0,
        "endDate": null,
        "hideBidsFromCarrier": true,
        "isDirect": true,
        "isOpenAuction": true,
        "possibleMatcherExecutors": [
          null
        ],
        "startDate": null,
        "tariffMatrixParams": null,
        "useTariffMatrix": true,
        "vat": 0.5,
        "vatAmount": 0.5,
        "vatInPriceNotConsider": true
      },
      "basicConditionsTemplateId": "example",
      "bodyType": [
        "example"
      ],
      "bodyTypeComment": "example",
      "cancelComment": [
        "example"
      ],
      "cancelReasonKey": "example",
      "carHeadInfos": [
        {
          "bodyType": "example",
          "brand": "example",
          "height": 0.5,
          "hydroBort": true,
          "id": "example",
          "length": 0.5,
          "loadCapacity": 0.5,
          "model": "example",
          "number": "example",
          "palletCount": 0,
          "type": "example",
          "volume": 0.5,
          "width": 0.5
        }
      ],
      "cargoCategory": {
        "category": "example",
        "categoryComment": "example"
      },
      "cargoComment": "example",
      "cargoId": "example",
      "created": {
        "contact": {},
        "displayTZ": "+03:00",
        "time": "2020-01-01T00:00:00"
      },
      "currency": "example",
      "customer": {
        "customerAddress": "example",
        "customerCargoPrice": 0.5,
        "customerComment": "example",
        "customerCountry": "example",
        "customerForwarderId": "example",
        "customerForwarderTin": "example",
        "customerLegalForm": "example",
        "customerName": "example",
        "customerPhone": "example",
        "customerTin": "example",
        "id": "example"
      },
      "demandId": "example",
      "deprecatedAt": {
        "displayTZ": "+03:00",
        "time": "2020-01-01T00:00:00"
      },
      "dimensions": {
        "breadth": 0.5,
        "height": 0.5,
        "length": 0.5,
        "pallet_count": 0,
        "palletCount": 0,
        "volume": 0.5,
        "weight": 0.5
      },
      "distribution": {
        "amount": 0.5,
        "comment": "example",
        "currency": "example",
        "dayDocClose": 0,
        "dayDocDelay": 0,
        "docFormat": "example",
        "groupsId": [
          null
        ],
        "partners": [
          null
        ],
        "publicMatcher": true,
        "type": "example",
        "typeDocClose": "example",
        "typeDocDelay": "example"
      },
      "drivers": [
        {
          "id": "example",
          "isActual": true,
          "masked_phone": "example",
          "name": "example"
        }
      ],
      "execOrder": {
        "allowChangeWithoutConsentForExec": true,
        "allowChangeWithoutConsentForFwd": true,
        "createdAt": null,
        "currency": "example",
        "execFinalPrice": 0.5,
        "execPrice": 0.5,
        "execPriceSrc": "example",
        "execPriceVersion": "example",
        "execVat": 0.5,
        "id": "example",
        "isVatPayer": true,
        "settedAt": null,
        "updatedAt": null
      },
      "execOrderId": "example",
      "execResponsibleLogistician": null,
      "executionPrice": {
        "notVATPayer": true,
        "priceFinal": 0.5,
        "priceVAT": 0.5,
        "priceWOVAT": 0.5,
        "vat": 0.5
      },
      "executionSettings": {
        "driverAssignmentDeadline": null
      },
      "executor": {
        "id": "example",
        "isInBlackList": true,
        "isUnverified": true,
        "name": "example",
        "tin": "example"
      },
      "executorConditionsTemplate": {
        "id": "example",
        "type": "example"
      },
      "executorViews": [
        {
          "executorId": "example",
          "name": "example",
          "tin": "example"
        }
      ],
      "files": [
        {
          "createdAt": null,
          "fileId": "example",
          "fileName": "example"
        }
      ],
      "flightCreator": {
        "car": null,
        "comment": "example",
        "companyInfo": null,
        "currency": "example",
        "documentsDelay": null,
        "driver": null,
        "externalFlightId": "example",
        "flightName": "example",
        "isVatPayer": true,
        "price": 0.5,
        "priceComment": "example",
        "priceWithVat": 0.5,
        "trailer": null,
        "vat": 0.5,
        "willNotCarryMyself": true
      },
      "forwarder": {
        "forwarderComment": "example",
        "forwarderId": "example",
        "forwarderName": "example",
        "forwarderTin": "example",
        "isUnverified": true
      },
      "freeTagsInfo": [
        {
          "id": "example",
          "name": "example"
        }
      ],
      "fwdResponsibleLogistician": null,
      "id": "example",
      "isActual": true,
      "isArchived": true,
      "isReadonly": true,
      "isVolumeAuction": true,
      "latestRevokeOnExecute": null,
      "latestSendOnExecute": null,
      "latestSendOnMatcher": null,
      "latestWinnerAssigned": null,
      "matcher": {
        "bestBet": null,
        "bestBetOpenAuction": null,
        "bets": [
          null
        ],
        "canSelectWinner": true,
        "demandId": "example",
        "lastBet": null,
        "lastBetOpenAuction": null,
        "matcherAuction": {},
        "matcherStatus": "example",
        "refuseByExecuterAt": null,
        "refuseByExecuterReason": "example",
        "winBet": null,
        "winnerExecutor": null
      },
      "maxUpdatedDate": null,
      "orderExternalID": "example",
      "orderWay": {
        "archivedAt": null,
        "createdAt": null,
        "distanceKilometers": 0.5,
        "generationType": "example",
        "id": "example",
        "updatedAt": null,
        "visits": [
          null
        ]
      },
      "parentId": "example",
      "paymentDelayPeriod": {
        "daysDelayPeriod": 0,
        "paymentType": "example",
        "postPayCalendarType": "example"
      },
      "responsibleCustomer": null,
      "rootId": "example",
      "shipments": [
        {
          "comment": "example",
          "distributionPriority": 0,
          "executorRequirementId": "example",
          "executorRequirementShipmentId": "example",
          "flightInfo": null,
          "flightTaskId": "example",
          "isDeleted": true,
          "name": "example",
          "npShipment": {},
          "npShipmentId": "example",
          "npUnshipment": null,
          "packageType": "example",
          "packages": [
            null
          ],
          "quantizationMethod": "example",
          "requirementId": "example",
          "requirementShipmentId": "example",
          "shipmentExternalID": "example",
          "shipmentId": "example",
          "status": "example",
          "taskStatus": "example",
          "transferOrderTaskID": "example"
        }
      ],
      "status": "example",
      "systemConditionsTemplateId": "example",
      "tag": null,
      "temperatureRegime": [
        {
          "from": 0,
          "to": 0
        }
      ],
      "trailerInfos": [
        null
      ],
      "transIdentity": "example",
      "transferOrderAdditionalConditions": "example",
      "transferOrderAdditionalConfiguration": {},
      "transferOrderCost": {
        "currency": "example",
        "price": 0.5
      },
      "transferOrderName": "example",
      "transferOrderType": "example",
      "transshipmentTypes": [
        "example"
      ],
      "typePaymentAndTax": "example",
      "updated": null,
      "utm": {
        "utmCampaign": "example",
        "utmContent": "example",
        "utmMedium": "example",
        "utmSource": "example",
        "utmTerm": "example"
      },
      "volumeDemand": {
        "actualEndDate": null,
        "isOpenAuction": true,
        "offersCount": 0,
        "status": "example",
        "uniqueOrganizationsCount": 0,
        "volumeAuction": {},
        "volumeAuctionId": "example"
      }
    }
  ]
}

OrdersV0TransferOrderGetFlatForCustomerAgreementRules

Name

Description

isDriverCanChangePackagesWithoutApproval

Type: boolean

Может ли водитель менять места в заказе без согласования

isExecutorCanChangePackagesWithoutApproval

Type: boolean

Может ли исполнитель менять места в заказе без согласования

isExecutorCanChangeShipmentsWithoutApproval

Type: boolean

Может ли исполнитель менять грузы в заказе без согласования

isForwarderCanChangePackagesWithoutApproval

Type: boolean

Может ли заказчик менять места в заказе без согласования

isForwarderCanChangeShipmentsWithoutApproval

Type: boolean

Может ли заказчик менять грузы в заказе без согласования

isWarehouseCanChangePackagesWithoutApproval

Type: boolean

Может ли склад менять места в заказе без согласования
Example
{
  "isDriverCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangeShipmentsWithoutApproval": true,
  "isForwarderCanChangePackagesWithoutApproval": true,
  "isForwarderCanChangeShipmentsWithoutApproval": true,
  "isWarehouseCanChangePackagesWithoutApproval": true
}

OrdersV0TransferOrderGetFlatForCustomerAlertInfo

Name

Description

alertType

Type: string

Example: example

description

Type: string

Example: example
Example
{
  "alertType": "example",
  "description": "example"
}

TimestampTZOutput

Name

Description

displayTZ

Type: string

Example: +03:00

time

Type: string<date-time>

Example: 2020-01-01T00:00:00
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

OrdersV0TransferOrderGetFlatForCustomerOrgInfo

Name

Description

id

Type: string

Example: example

isInBlackList

Type: boolean

name

Type: string

Example: example

tin

Type: string

Example: example

isUnverified

Type: boolean | null
Example
{
  "id": "example",
  "isInBlackList": true,
  "isUnverified": true,
  "name": "example",
  "tin": "example"
}

OrdersV0TransferOrderGetFlatForCustomerTariffMatrixInfo

Name

Description

tariffMatrixId

Type: string

Идентификатор Тарифной матрицы

Example: example
Example
{
  "tariffMatrixId": "example"
}

OrdersV0TransferOrderGetFlatForCustomerTariffMatrixParams

Name

Description

isWhoFirst

Type: boolean

Торговля по принципу кто первый

tariffMatrixIds

Type: OrdersV0TransferOrderGetFlatForCustomerTariffMatrixInfo[] | null

Параметры тарифных матриц

Example
[
  {
    "tariffMatrixId": "example"
  }
]
Example
{
  "isWhoFirst": true,
  "tariffMatrixIds": [
    {
      "tariffMatrixId": "example"
    }
  ]
}

OrdersV0TransferOrderGetFlatForCustomerAuction

Name

Description

allowMultimodal

Type: boolean

Разрешить мультимодальные

auctionType

Type: string

тип торгов

Example: example

autoExtension

Type: boolean

Автопродление

autoExtensionActive

Type: integer

Время Активации автопродления в сеуундах

autoExtensionDuration

Type: integer

Максимальное длительность продления в секундах

autoExtensionTime

Type: integer

Время продления в секундах

autoSelection

Type: boolean

Автовыбор

bargainingIsPossible

Type: boolean

торг возможен

currency

Type: string

Валюта

Example: example

decreaseOnly

Type: boolean

Только на понижение

decreaseOnlyFromDeclaredPrice

Type: boolean

Только на понижение от заданной цены

duration

Type: integer

Длительность торгов в секундах

hideBidsFromCarrier

Type: boolean

Скрывать ставки от исполнителя

isDirect

Type: boolean

Прямые торги (1 участник)

isOpenAuction

Type: boolean

открытый аукцион

useTariffMatrix

Type: boolean

Торги Тарифная матрица

vatInPriceNotConsider

Type: boolean

без учёта НДС

amount

Type: number | null

Заявленная стоимость торгов - distribution.amount

bidStep

Type: number | null

Шаг торгов

buyNowPrice

Type: number | null

«Buy now» (input - число)

endDate
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Дата окончания

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

possibleMatcherExecutors

Type: OrdersV0TransferOrderGetFlatForCustomerOrgInfo[] | null

Example
[
  {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  }
]

startDate
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Дата начала (опциональное)

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

tariffMatrixParams
Any of 2 types

Параметры Тарифной матрицы

Example
{
  "isWhoFirst": true,
  "tariffMatrixIds": [
    {
      "tariffMatrixId": "example"
    }
  ]
}

vat

Type: number | null

НДС Distribution.amount (опциональное)

vatAmount

Type: number | null

НДС Distribution.amount (опциональное)
Example
{
  "allowMultimodal": true,
  "amount": 0.5,
  "auctionType": "example",
  "autoExtension": true,
  "autoExtensionActive": 0,
  "autoExtensionDuration": 0,
  "autoExtensionTime": 0,
  "autoSelection": true,
  "bargainingIsPossible": true,
  "bidStep": 0.5,
  "buyNowPrice": 0.5,
  "currency": "example",
  "decreaseOnly": true,
  "decreaseOnlyFromDeclaredPrice": true,
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "hideBidsFromCarrier": true,
  "isDirect": true,
  "isOpenAuction": true,
  "possibleMatcherExecutors": [
    {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example"
    }
  ],
  "startDate": null,
  "tariffMatrixParams": {
    "isWhoFirst": true,
    "tariffMatrixIds": [
      {
        "tariffMatrixId": "example"
      }
    ]
  },
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5,
  "vatInPriceNotConsider": true
}

OrdersV0TransferOrderGetFlatForCustomerCarInfo

Name

Description

bodyType

Type: string

Example: example

brand

Type: string

Example: example

height

Type: number

hydroBort

Type: boolean

id

Type: string

Example: example

length

Type: number

loadCapacity

Type: number

model

Type: string

Example: example

number

Type: string

Example: example

palletCount

Type: integer

type

Type: string

Example: example

volume

Type: number

width

Type: number
Example
{
  "bodyType": "example",
  "brand": "example",
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "palletCount": 0,
  "type": "example",
  "volume": 0.5,
  "width": 0.5
}

OrdersV0TransferOrderGetFlatForCustomerCargoCategory

Name

Description

category

Type: string

Тип груза.

Example: example

categoryComment

Type: string

Коментарий к типу груза.

Example: example
Example
{
  "category": "example",
  "categoryComment": "example"
}

TimestampTZOutputContact

Name

Description

name

Type: string

Example: example

orgId

Type: string | null

Example: example

orgName

Type: string | null

Example: example

orgTin

Type: string | null

Example: example

publicEmail

Type: string | null

Example: example

publicPhone

Type: string | null

Example: example

type

Type: string

Example: example

value

Type: string

Example: example
Example
{
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

TimestampTZWContactOutput

Name

Description

contact
Any of 2 types

  • Type: TimestampTZOutputContact

    Example
    {
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

displayTZ

Type: string | null

Example: +03:00

time

Type: string<date-time> | null

Example: 2020-01-01T00:00:00
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

OrdersV0TransferOrderGetFlatForCustomerCustomer

Name

Description

customerComment

Type: string

Комментарий заказчика

Example: example

customerName

Type: string

Имя контактного лица заказчика перевозки.

Example: example

customerPhone

Type: string

Телефон контактного лица заказчика перевозки.

Example: example

customerTin

Type: string

ИНН / БИН или другой уникальный налоговый номер
компании - заказчика перевозки.

Example: example

id

Type: string

Example: example

customerAddress

Type: string | null

адрес заказчика

Example: example

customerCargoPrice

Type: number | null

стоимость груза в блоке заказчика

customerCountry

Type: string | null

страна заказчика

Example: example

customerForwarderId

Type: string | null

Идентификатор организации владельца груза в роли заказчика

Example: example

customerForwarderTin

Type: string | null

Example: example

customerLegalForm

Type: string | null

юридическая форма организации (OOO,ИП др)

Example: example
Example
{
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerComment": "example",
  "customerCountry": "example",
  "customerForwarderId": "example",
  "customerForwarderTin": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example",
  "id": "example"
}

OrdersV0TransferOrderGetFlatForCustomerDimensions

Name

Description

breadth

Type: number | null

Ширина с точностью до 2х знактов.

height

Type: number | null

Высота с точностью до 2х знактов.

length

Type: number | null

Длина с точностью до 2х знактов.

pallet_count

Type: integer | null

Количество палет.

palletCount

Type: integer | null

volume

Type: number | null

Объём с точностью до 3х знактов.

weight

Type: number | null

Вес в КГ.
Example
{
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "pallet_count": 0,
  "palletCount": 0,
  "volume": 0.5,
  "weight": 0.5
}

OrdersV0TransferOrderGetFlatForCustomerPartner

Name

Description

id

Type: string

Example: example

isInBlackList

Type: boolean

name

Type: string

Example: example

tin

Type: string

Example: example

isUnverified

Type: boolean | null

uniqueTemplateId

Type: string | null

-- Содержит ID уникального шаблона, актуального на момент передачи заказа на торги

Example: example
Example
{
  "id": "example",
  "isInBlackList": true,
  "isUnverified": true,
  "name": "example",
  "tin": "example",
  "uniqueTemplateId": "example"
}

OrdersV0TransferOrderGetFlatForCustomerDistribution

Name

Description

comment

Type: string

Комментарий, например, "какие-то условия"

Example: example

currency

Type: string

Валюта, например, "rub"

Example: example

dayDocClose

Type: integer

Количество дней до закрытия документа, например, 2

dayDocDelay

Type: integer

Количество дней задержки документа, например, 3

docFormat

Type: string

формат предоставления

Example: example

publicMatcher

Type: boolean

открытый аукцион или нет

type

Type: string

Тип определения исполнителя, например, "Отправить в свои заказы"

Example: example

typeDocClose

Type: string

Тип документа для закрытия, например, "bankdays"

Example: example

typeDocDelay

Type: string

Тип документа для задержки, например, "bankdays"

Example: example

amount

Type: number | null

Заявленная стоимость торгов (Сумма, например, 123)

groupsId

Type: string[] | null

Группы, связанные с определением исполнителя (пока неизвестно, что конкретно будет в этом массиве)

Example
[
  "example"
]

partners

Type: OrdersV0TransferOrderGetFlatForCustomerPartner[] | null

Исполнители

Example
[
  {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example",
    "uniqueTemplateId": "example"
  }
]
Example
{
  "amount": 0.5,
  "comment": "example",
  "currency": "example",
  "dayDocClose": 0,
  "dayDocDelay": 0,
  "docFormat": "example",
  "groupsId": [
    "example"
  ],
  "partners": [
    {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example",
      "uniqueTemplateId": "example"
    }
  ],
  "publicMatcher": true,
  "type": "example",
  "typeDocClose": "example",
  "typeDocDelay": "example"
}

OrdersV0TransferOrderGetFlatForCustomerDriverInfo

Name

Description

id

Type: string

Example: example

isActual

Type: boolean

masked_phone

Type: string

Example: example

name

Type: string

Example: example
Example
{
  "id": "example",
  "isActual": true,
  "masked_phone": "example",
  "name": "example"
}

OrdersV0TransferOrderGetFlatForCustomerExecOrder

Name

Description

allowChangeWithoutConsentForExec

Type: boolean

allowChangeWithoutConsentForFwd

Type: boolean

createdAt

Type: TimestampTZOutput

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

id

Type: string

Example: example

updatedAt

Type: TimestampTZOutput

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

currency

Type: string | null

Example: example

execFinalPrice

Type: number | null

execPrice

Type: number | null

execPriceSrc

Type: string | null

Example: example

execPriceVersion

Type: string | null

Example: example

execVat

Type: number | null

isVatPayer

Type: boolean | null

settedAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}
Example
{
  "allowChangeWithoutConsentForExec": true,
  "allowChangeWithoutConsentForFwd": true,
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "currency": "example",
  "execFinalPrice": 0.5,
  "execPrice": 0.5,
  "execPriceSrc": "example",
  "execPriceVersion": "example",
  "execVat": 0.5,
  "id": "example",
  "isVatPayer": true,
  "settedAt": null,
  "updatedAt": null
}

OrdersV0TransferOrderGetFlatForCustomerExecutionPrice

Name

Description

notVATPayer

Type: boolean | null

priceFinal

Type: number | null

priceVAT

Type: number | null

priceWOVAT

Type: number | null

vat

Type: number | null
Example
{
  "notVATPayer": true,
  "priceFinal": 0.5,
  "priceVAT": 0.5,
  "priceWOVAT": 0.5,
  "vat": 0.5
}

OrdersV0TransferOrderGetFlatForCustomerDriverAssignmentDeadline

Name

Description

duration

Type: integer | null

endDate
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}
Example
{
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  }
}

OrdersV0TransferOrderGetFlatForCustomerExecutionSettings

Name

Description

driverAssignmentDeadline
Any of 2 types

Срок на назначение водителя и ТС в секундах или по дате

Example
{
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  }
}
Example
{
  "driverAssignmentDeadline": {
    "duration": 0,
    "endDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    }
  }
}

OrdersV0TransferOrderGetFlatForCustomerConditionsTemplate

Name

Description

id

Type: string

Example: example

type

Type: string

Example: example
Example
{
  "id": "example",
  "type": "example"
}

OrdersV0TransferOrderGetFlatForCustomerExecutorView

Name

Description

executorId

Type: string

ID исполнителя

Example: example

name

Type: string

Имя исполнителя

Example: example

tin

Type: string

ИНН исполнителя

Example: example
Example
{
  "executorId": "example",
  "name": "example",
  "tin": "example"
}

OrdersV0TransferOrderGetFlatForCustomerFileMeta

Name

Description

createdAt

Type: TimestampTZOutput

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

fileId

Type: string

Example: example

fileName

Type: string

Example: example
Example
{
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "fileId": "example",
  "fileName": "example"
}

OrdersV0TransferOrderGetFlatForCustomerCompanyInfo

Name

Description

companyName

Type: string | null

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

Example: example

companyType

Type: string | null

Тип компании

Example: example

country

Type: string | null

Страна

Example: example

email

Type: string | null

Почта

Example: example

fullName

Type: string | null

ФИО

Example: example

phone

Type: string | null

Телефон

Example: example

tin

Type: string | null

ИНН

Example: example
Example
{
  "companyName": "example",
  "companyType": "example",
  "country": "example",
  "email": "example",
  "fullName": "example",
  "phone": "example",
  "tin": "example"
}

OrdersV0TransferOrderGetFlatForCustomerFlightCreator

Name

Description

car
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerCarInfo

    Example
    {
  "bodyType": "example",
  "brand": "example",
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "palletCount": 0,
  "type": "example",
  "volume": 0.5,
  "width": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

Транспортное средство (с детальной информацией)

Example
{
  "bodyType": "example",
  "brand": "example",
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "palletCount": 0,
  "type": "example",
  "volume": 0.5,
  "width": 0.5
}

comment

Type: string | null

Комментарий

Example: example

companyInfo
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerCompanyInfo

    Example
    {
  "companyName": "example",
  "companyType": "example",
  "country": "example",
  "email": "example",
  "fullName": "example",
  "phone": "example",
  "tin": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Информация о компании

Example
{
  "companyName": "example",
  "companyType": "example",
  "country": "example",
  "email": "example",
  "fullName": "example",
  "phone": "example",
  "tin": "example"
}

currency

Type: string | null

Валюта

Example: example

documentsDelay
Any of 2 types

Отсрочка документов

Example
{
  "daysTypeAfterDocuments": "example",
  "daysTypeBeforeDocuments": "example",
  "delayAfterDocuments": 0,
  "delayBeforeDocuments": 0
}

driver
Any of 2 types

Водитель (с детальной информацией)

Example
{
  "id": "example",
  "isActual": true,
  "masked_phone": "example",
  "name": "example"
}

externalFlightId

Type: string | null

Внешний идентификатор рейса

Example: example

flightName

Type: string | null

Название рейса

Example: example

isVatPayer

Type: boolean | null

Является ли плательщиком НДС

price

Type: number | null

Стоимость без НДС

priceComment

Type: string | null

Комментарий к цене

Example: example

priceWithVat

Type: number | null

Стоимость с НДС

trailer
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerCarInfo

    Example
    {
  "bodyType": "example",
  "brand": "example",
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "palletCount": 0,
  "type": "example",
  "volume": 0.5,
  "width": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

Прицеп (с детальной информацией)

Example
{
  "bodyType": "example",
  "brand": "example",
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "palletCount": 0,
  "type": "example",
  "volume": 0.5,
  "width": 0.5
}

vat

Type: number | null

НДС

willNotCarryMyself

Type: boolean | null

Тумблер «Повезу не я»
Example
{
  "car": {
    "bodyType": "example",
    "brand": "example",
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "palletCount": 0,
    "type": "example",
    "volume": 0.5,
    "width": 0.5
  },
  "comment": "example",
  "companyInfo": {
    "companyName": "example",
    "companyType": "example",
    "country": "example",
    "email": "example",
    "fullName": "example",
    "phone": "example",
    "tin": "example"
  },
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "driver": {
    "id": "example",
    "isActual": true,
    "masked_phone": "example",
    "name": "example"
  },
  "externalFlightId": "example",
  "flightName": "example",
  "isVatPayer": true,
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "trailer": null,
  "vat": 0.5,
  "willNotCarryMyself": true
}

OrdersV0TransferOrderGetFlatForCustomerForwarder

Name

Description

forwarderId

Type: string

Идентификатор заказчика в сервисе Яндекс Магистрали

Example: example

forwarderName

Type: string

Название организации заказчика

Example: example

forwarderTin

Type: string

ИНН заказчика

Example: example

forwarderComment

Type: string | null

Комментарий заказчика

Example: example

isUnverified

Type: boolean | null
Example
{
  "forwarderComment": "example",
  "forwarderId": "example",
  "forwarderName": "example",
  "forwarderTin": "example",
  "isUnverified": true
}

OrdersV0TransferOrderGetFlatForCustomerTag

Name

Description

id

Type: string

Example: example

name

Type: string

Example: example
Example
{
  "id": "example",
  "name": "example"
}

TaxablePriceIO

Name

Description

base

Type: string | null

Цена исходная

Pattern: ^[1-9][0-9]*(\.[0-9]*[1-9])?$

Example: 100.18

currency

Type: string

ISO 4217 код валюты

Example: RUB

isVatPayer

Type: boolean

Признак плательщика НДС. Для плательщика укажите ставку vat или сумму vatAmount.

Default: false

subTotalPrice

Type: string | null

Итоговая цена с учётом НДС

Pattern: ^[1-9][0-9]*(\.[0-9]*[1-9])?$

Example: 122.21

vat

Type: string | null

Ставка НДС (в % от 0 до 100)

Pattern: ^[1-9][0-9]*(\.[0-9]*[1-9])?$

Example: 22

vatAmount

Type: string | null

Сумма НДС (ВАЖНО может быть без указания ставки НДС!!!)

Pattern: ^[1-9][0-9]*(\.[0-9]*[1-9])?$

Example: 22.03
Example
{
  "base": "100.18",
  "currency": "RUB",
  "isVatPayer": false,
  "subTotalPrice": "122.21",
  "vat": "22",
  "vatAmount": "22.03"
}

OrdersV0TransferOrderGetFlatForCustomerBetMultimodalRoteArc

Name

Description

addressFrom

Type: string

Example: example

addressTo

Type: string

Example: example

comment

Type: string

Example: example

currency

Type: string

Example: example

notVatPayer

Type: boolean

price

Type: number

priceWithVat

Type: number

taxablePrice

Type: TaxablePriceIO

Example
{
  "base": "100.18",
  "currency": "RUB",
  "isVatPayer": false,
  "subTotalPrice": "122.21",
  "vat": "22",
  "vatAmount": "22.03"
}

vat

Type: number
Example
{
  "addressFrom": "example",
  "addressTo": "example",
  "comment": "example",
  "currency": "example",
  "notVatPayer": true,
  "price": 0.5,
  "priceWithVat": 0.5,
  "taxablePrice": {
    "base": "100.18",
    "currency": "RUB",
    "isVatPayer": false,
    "subTotalPrice": "122.21",
    "vat": "22",
    "vatAmount": "22.03"
  },
  "vat": 0.5
}

OrdersV0TransferOrderGetFlatForCustomerBetMultimodal

Name

Description

isPriceByArc

Type: boolean

route

Type: OrdersV0TransferOrderGetFlatForCustomerBetMultimodalRoteArc[] | null

Example
[
  {
    "addressFrom": "example",
    "addressTo": "example",
    "comment": "example",
    "currency": "example",
    "notVatPayer": true,
    "price": 0.5,
    "priceWithVat": 0.5,
    "taxablePrice": {
      "base": "100.18",
      "currency": "RUB",
      "isVatPayer": false,
      "subTotalPrice": "122.21",
      "vat": "22",
      "vatAmount": "22.03"
    },
    "vat": 0.5
  }
]
Example
{
  "isPriceByArc": true,
  "route": [
    {
      "addressFrom": "example",
      "addressTo": "example",
      "comment": "example",
      "currency": "example",
      "notVatPayer": true,
      "price": 0.5,
      "priceWithVat": 0.5,
      "taxablePrice": {
        "base": "100.18",
        "currency": "RUB",
        "isVatPayer": false,
        "subTotalPrice": "122.21",
        "vat": "22",
        "vatAmount": "22.03"
      },
      "vat": 0.5
    }
  ]
}

OrdersV0TransferOrderGetFlatForCustomerTariffMatrix

Name

Description

tariffMatrixId

Type: string

Идентификатор матрицы тарифов

Example: example
Example
{
  "tariffMatrixId": "example"
}

OrdersV0TransferOrderGetFlatForCustomerBet

Name

Description

betComment

Type: string

Комментарий к ставке

Example: example

comment

Type: string

Example: example

condition

Type: string

Example: example

executor

Type: OrdersV0TransferOrderGetFlatForCustomerOrgInfo

Example
{
  "id": "example",
  "isInBlackList": true,
  "isUnverified": true,
  "name": "example",
  "tin": "example"
}

finalPrice

Type: number

id

Type: string

Example: example

isCanceled

Type: boolean

isCanceledByForwarder

Type: boolean

isOpenMarket

Type: boolean

isWinner

Type: boolean

notVatPayer

Type: boolean

price

Type: number

setDate

Type: TimestampTZWContactOutput

Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

taxablePrice

Type: TaxablePriceIO

Example
{
  "base": "100.18",
  "currency": "RUB",
  "isVatPayer": false,
  "subTotalPrice": "122.21",
  "vat": "22",
  "vatAmount": "22.03"
}

useMultimodal

Type: boolean

useTariffMatrix

Type: boolean

Использовали матрицу тарифов

vat

Type: number

vatAmount

Type: number

betMultimodal
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerBetMultimodal

    Example
    {
  "isPriceByArc": true,
  "route": [
    {
      "addressFrom": "example",
      "addressTo": "example",
      "comment": "example",
      "currency": "example",
      "notVatPayer": true,
      "price": 0.5,
      "priceWithVat": 0.5,
      "taxablePrice": {
        "base": "100.18",
        "currency": "RUB",
        "isVatPayer": false,
        "subTotalPrice": "122.21",
        "vat": "22",
        "vatAmount": "22.03"
      },
      "vat": 0.5
    }
  ]
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "isPriceByArc": true,
  "route": [
    {
      "addressFrom": "example",
      "addressTo": "example",
      "comment": "example",
      "currency": "example",
      "notVatPayer": true,
      "price": 0.5,
      "priceWithVat": 0.5,
      "taxablePrice": {
        "base": "100.18",
        "currency": "RUB",
        "isVatPayer": false,
        "subTotalPrice": "122.21",
        "vat": "22",
        "vatAmount": "22.03"
      },
      "vat": 0.5
    }
  ]
}

cancelDate
Any of 2 types

  • Type: TimestampTZWContactOutput

    Example
    {
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

cancelExecutorComment

Type: string | null

Комментарий отмены ставки исполнителем

Example: example

cancelForwarderComment

Type: string | null

Комментарий отмены ставки заказчиком

Example: example

tariffMatrix
Any of 2 types

Параметры матрицы тарифов

Example
{
  "tariffMatrixId": "example"
}
Example
{
  "betComment": "example",
  "betMultimodal": {
    "isPriceByArc": true,
    "route": [
      {
        "addressFrom": "example",
        "addressTo": "example",
        "comment": "example",
        "currency": "example",
        "notVatPayer": true,
        "price": 0.5,
        "priceWithVat": 0.5,
        "taxablePrice": {},
        "vat": 0.5
      }
    ]
  },
  "cancelDate": {
    "contact": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "cancelExecutorComment": "example",
  "cancelForwarderComment": "example",
  "comment": "example",
  "condition": "example",
  "executor": {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "finalPrice": 0.5,
  "id": "example",
  "isCanceled": true,
  "isCanceledByForwarder": true,
  "isOpenMarket": true,
  "isWinner": true,
  "notVatPayer": true,
  "price": 0.5,
  "setDate": null,
  "tariffMatrix": {
    "tariffMatrixId": "example"
  },
  "taxablePrice": null,
  "useMultimodal": true,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5
}

OrdersV0TransferOrderGetFlatForCustomerMatcherTariffMatrixInfo

Name

Description

orgId

Type: string

Идентификатор Тарифной матрицы

Example: example

tariffMatrixId

Type: string

Идентификатор Тарифной матрицы

Example: example
Example
{
  "orgId": "example",
  "tariffMatrixId": "example"
}

OrdersV0TransferOrderGetFlatForCustomerMatcherTariffMatrixParams

Name

Description

isWhoFirst

Type: boolean

Торговля по принципу кто первый

tariffMatrixInfos

Type: OrdersV0TransferOrderGetFlatForCustomerMatcherTariffMatrixInfo[] | null

Параметры тарифных матриц

Example
[
  {
    "orgId": "example",
    "tariffMatrixId": "example"
  }
]
Example
{
  "isWhoFirst": true,
  "tariffMatrixInfos": [
    {
      "orgId": "example",
      "tariffMatrixId": "example"
    }
  ]
}

OrdersV0TransferOrderGetFlatForCustomerMatcherAuction

Name

Description

allowMultimodal

Type: boolean

Разрешить мультимодальные

auctionType

Type: string

тип торгов

Example: example

autoExtension

Type: boolean

Автопродление

autoExtensionActive

Type: integer

Время Активации автопродления в сеуундах

autoExtensionDuration

Type: integer

Максимальное длительность продления в секундах

autoExtensionTime

Type: integer

Время продления в секундах

autoSelection

Type: boolean

Автовыбор

bargainingIsPossible

Type: boolean

торг возможен

currency

Type: string

Валюта - currency

Example: example

decreaseOnly

Type: boolean

Только на понижение

decreaseOnlyFromDeclaredPrice

Type: boolean

Только на понижение от заданной цены

duration

Type: integer

Длительность торгов в секундах

hideBidsFromCarrier

Type: boolean

Скрывать ставки от исполнителя

isDirect

Type: boolean

isOpenAuction

Type: boolean

timeLeftUntilEnd

Type: integer

Интервал времени в секундах до завершения торгов на момент формирования ответа

useTariffMatrix

Type: boolean

Торги Тарифная матрица

vatInPriceNotConsider

Type: boolean

без учёта НДС

actualEndDate
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время завершения аукциона с учётом продлений

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

amount

Type: number | null

Заявленная стоимость торгов - amount

autoExtensionCount

Type: integer | null

Количество срабатываний автопродления

bidStep

Type: number | null

Шаг торгов

buyNowPrice

Type: number | null

«Buy now» (input - число)

endDate
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Дата окончания

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

possibleMatcherExecutors

Type: OrdersV0TransferOrderGetFlatForCustomerOrgInfo[] | null

Example
[
  {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  }
]

prolongationDatetimeMax
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Дата когда пролонгация закончится

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

startDate
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Дата начала (опциональное)

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

tariffMatrixParams
Any of 2 types

Параметры Тарифной матрицы

Example
{
  "isWhoFirst": true,
  "tariffMatrixInfos": [
    {
      "orgId": "example",
      "tariffMatrixId": "example"
    }
  ]
}

vat

Type: number | null

НДС Distribution.amount (опциональное)

vatAmount

Type: number | null

НДС Distribution.amount (опциональное)
Example
{
  "actualEndDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "allowMultimodal": true,
  "amount": 0.5,
  "auctionType": "example",
  "autoExtension": true,
  "autoExtensionActive": 0,
  "autoExtensionCount": 0,
  "autoExtensionDuration": 0,
  "autoExtensionTime": 0,
  "autoSelection": true,
  "bargainingIsPossible": true,
  "bidStep": 0.5,
  "buyNowPrice": 0.5,
  "currency": "example",
  "decreaseOnly": true,
  "decreaseOnlyFromDeclaredPrice": true,
  "duration": 0,
  "endDate": null,
  "hideBidsFromCarrier": true,
  "isDirect": true,
  "isOpenAuction": true,
  "possibleMatcherExecutors": [
    {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example"
    }
  ],
  "prolongationDatetimeMax": null,
  "startDate": null,
  "tariffMatrixParams": {
    "isWhoFirst": true,
    "tariffMatrixInfos": [
      {
        "orgId": "example",
        "tariffMatrixId": "example"
      }
    ]
  },
  "timeLeftUntilEnd": 0,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5,
  "vatInPriceNotConsider": true
}

OrdersV0TransferOrderGetFlatForCustomerMatcher

Name

Description

canSelectWinner

Type: boolean

demandId

Type: string

Example: example

matcherAuction

Type: OrdersV0TransferOrderGetFlatForCustomerMatcherAuction

Example
{
  "actualEndDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "allowMultimodal": true,
  "amount": 0.5,
  "auctionType": "example",
  "autoExtension": true,
  "autoExtensionActive": 0,
  "autoExtensionCount": 0,
  "autoExtensionDuration": 0,
  "autoExtensionTime": 0,
  "autoSelection": true,
  "bargainingIsPossible": true,
  "bidStep": 0.5,
  "buyNowPrice": 0.5,
  "currency": "example",
  "decreaseOnly": true,
  "decreaseOnlyFromDeclaredPrice": true,
  "duration": 0,
  "endDate": null,
  "hideBidsFromCarrier": true,
  "isDirect": true,
  "isOpenAuction": true,
  "possibleMatcherExecutors": [
    {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example"
    }
  ],
  "prolongationDatetimeMax": null,
  "startDate": null,
  "tariffMatrixParams": {
    "isWhoFirst": true,
    "tariffMatrixInfos": [
      {
        "orgId": "example",
        "tariffMatrixId": "example"
      }
    ]
  },
  "timeLeftUntilEnd": 0,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5,
  "vatInPriceNotConsider": true
}

matcherStatus

Type: string

Example: example

bestBet
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerBet

    Example
    {
  "betComment": "example",
  "betMultimodal": {
    "isPriceByArc": true,
    "route": [
      {
        "addressFrom": "example",
        "addressTo": "example",
        "comment": "example",
        "currency": "example",
        "notVatPayer": true,
        "price": 0.5,
        "priceWithVat": 0.5,
        "taxablePrice": {},
        "vat": 0.5
      }
    ]
  },
  "cancelDate": {
    "contact": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "cancelExecutorComment": "example",
  "cancelForwarderComment": "example",
  "comment": "example",
  "condition": "example",
  "executor": {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "finalPrice": 0.5,
  "id": "example",
  "isCanceled": true,
  "isCanceledByForwarder": true,
  "isOpenMarket": true,
  "isWinner": true,
  "notVatPayer": true,
  "price": 0.5,
  "setDate": null,
  "tariffMatrix": {
    "tariffMatrixId": "example"
  },
  "taxablePrice": null,
  "useMultimodal": true,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "betComment": "example",
  "betMultimodal": {
    "isPriceByArc": true,
    "route": [
      {}
    ]
  },
  "cancelDate": {
    "contact": {},
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "cancelExecutorComment": "example",
  "cancelForwarderComment": "example",
  "comment": "example",
  "condition": "example",
  "executor": {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "finalPrice": 0.5,
  "id": "example",
  "isCanceled": true,
  "isCanceledByForwarder": true,
  "isOpenMarket": true,
  "isWinner": true,
  "notVatPayer": true,
  "price": 0.5,
  "setDate": null,
  "tariffMatrix": {
    "tariffMatrixId": "example"
  },
  "taxablePrice": {
    "base": "100.18",
    "currency": "RUB",
    "isVatPayer": false,
    "subTotalPrice": "122.21",
    "vat": "22",
    "vatAmount": "22.03"
  },
  "useMultimodal": true,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5
}

bestBetOpenAuction
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerBet

    Example
    {
  "betComment": "example",
  "betMultimodal": {
    "isPriceByArc": true,
    "route": [
      {
        "addressFrom": "example",
        "addressTo": "example",
        "comment": "example",
        "currency": "example",
        "notVatPayer": true,
        "price": 0.5,
        "priceWithVat": 0.5,
        "taxablePrice": {},
        "vat": 0.5
      }
    ]
  },
  "cancelDate": {
    "contact": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "cancelExecutorComment": "example",
  "cancelForwarderComment": "example",
  "comment": "example",
  "condition": "example",
  "executor": {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "finalPrice": 0.5,
  "id": "example",
  "isCanceled": true,
  "isCanceledByForwarder": true,
  "isOpenMarket": true,
  "isWinner": true,
  "notVatPayer": true,
  "price": 0.5,
  "setDate": null,
  "tariffMatrix": {
    "tariffMatrixId": "example"
  },
  "taxablePrice": null,
  "useMultimodal": true,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "betComment": "example",
  "betMultimodal": {
    "isPriceByArc": true,
    "route": [
      {}
    ]
  },
  "cancelDate": {
    "contact": {},
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "cancelExecutorComment": "example",
  "cancelForwarderComment": "example",
  "comment": "example",
  "condition": "example",
  "executor": {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "finalPrice": 0.5,
  "id": "example",
  "isCanceled": true,
  "isCanceledByForwarder": true,
  "isOpenMarket": true,
  "isWinner": true,
  "notVatPayer": true,
  "price": 0.5,
  "setDate": null,
  "tariffMatrix": {
    "tariffMatrixId": "example"
  },
  "taxablePrice": {
    "base": "100.18",
    "currency": "RUB",
    "isVatPayer": false,
    "subTotalPrice": "122.21",
    "vat": "22",
    "vatAmount": "22.03"
  },
  "useMultimodal": true,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5
}

bets

Type: OrdersV0TransferOrderGetFlatForCustomerBet[] | null

Example
[
  {
    "betComment": "example",
    "betMultimodal": {
      "isPriceByArc": true,
      "route": [
        {}
      ]
    },
    "cancelDate": {
      "contact": {},
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "cancelExecutorComment": "example",
    "cancelForwarderComment": "example",
    "comment": "example",
    "condition": "example",
    "executor": {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example"
    },
    "finalPrice": 0.5,
    "id": "example",
    "isCanceled": true,
    "isCanceledByForwarder": true,
    "isOpenMarket": true,
    "isWinner": true,
    "notVatPayer": true,
    "price": 0.5,
    "setDate": null,
    "tariffMatrix": {
      "tariffMatrixId": "example"
    },
    "taxablePrice": {
      "base": "100.18",
      "currency": "RUB",
      "isVatPayer": false,
      "subTotalPrice": "122.21",
      "vat": "22",
      "vatAmount": "22.03"
    },
    "useMultimodal": true,
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatAmount": 0.5
  }
]

lastBet
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerBet

    Example
    {
  "betComment": "example",
  "betMultimodal": {
    "isPriceByArc": true,
    "route": [
      {
        "addressFrom": "example",
        "addressTo": "example",
        "comment": "example",
        "currency": "example",
        "notVatPayer": true,
        "price": 0.5,
        "priceWithVat": 0.5,
        "taxablePrice": {},
        "vat": 0.5
      }
    ]
  },
  "cancelDate": {
    "contact": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "cancelExecutorComment": "example",
  "cancelForwarderComment": "example",
  "comment": "example",
  "condition": "example",
  "executor": {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "finalPrice": 0.5,
  "id": "example",
  "isCanceled": true,
  "isCanceledByForwarder": true,
  "isOpenMarket": true,
  "isWinner": true,
  "notVatPayer": true,
  "price": 0.5,
  "setDate": null,
  "tariffMatrix": {
    "tariffMatrixId": "example"
  },
  "taxablePrice": null,
  "useMultimodal": true,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "betComment": "example",
  "betMultimodal": {
    "isPriceByArc": true,
    "route": [
      {}
    ]
  },
  "cancelDate": {
    "contact": {},
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "cancelExecutorComment": "example",
  "cancelForwarderComment": "example",
  "comment": "example",
  "condition": "example",
  "executor": {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "finalPrice": 0.5,
  "id": "example",
  "isCanceled": true,
  "isCanceledByForwarder": true,
  "isOpenMarket": true,
  "isWinner": true,
  "notVatPayer": true,
  "price": 0.5,
  "setDate": null,
  "tariffMatrix": {
    "tariffMatrixId": "example"
  },
  "taxablePrice": {
    "base": "100.18",
    "currency": "RUB",
    "isVatPayer": false,
    "subTotalPrice": "122.21",
    "vat": "22",
    "vatAmount": "22.03"
  },
  "useMultimodal": true,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5
}

lastBetOpenAuction
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerBet

    Example
    {
  "betComment": "example",
  "betMultimodal": {
    "isPriceByArc": true,
    "route": [
      {
        "addressFrom": "example",
        "addressTo": "example",
        "comment": "example",
        "currency": "example",
        "notVatPayer": true,
        "price": 0.5,
        "priceWithVat": 0.5,
        "taxablePrice": {},
        "vat": 0.5
      }
    ]
  },
  "cancelDate": {
    "contact": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "cancelExecutorComment": "example",
  "cancelForwarderComment": "example",
  "comment": "example",
  "condition": "example",
  "executor": {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "finalPrice": 0.5,
  "id": "example",
  "isCanceled": true,
  "isCanceledByForwarder": true,
  "isOpenMarket": true,
  "isWinner": true,
  "notVatPayer": true,
  "price": 0.5,
  "setDate": null,
  "tariffMatrix": {
    "tariffMatrixId": "example"
  },
  "taxablePrice": null,
  "useMultimodal": true,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "betComment": "example",
  "betMultimodal": {
    "isPriceByArc": true,
    "route": [
      {}
    ]
  },
  "cancelDate": {
    "contact": {},
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "cancelExecutorComment": "example",
  "cancelForwarderComment": "example",
  "comment": "example",
  "condition": "example",
  "executor": {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "finalPrice": 0.5,
  "id": "example",
  "isCanceled": true,
  "isCanceledByForwarder": true,
  "isOpenMarket": true,
  "isWinner": true,
  "notVatPayer": true,
  "price": 0.5,
  "setDate": null,
  "tariffMatrix": {
    "tariffMatrixId": "example"
  },
  "taxablePrice": {
    "base": "100.18",
    "currency": "RUB",
    "isVatPayer": false,
    "subTotalPrice": "122.21",
    "vat": "22",
    "vatAmount": "22.03"
  },
  "useMultimodal": true,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5
}

refuseByExecuterAt
Any of 2 types

  • Type: TimestampTZWContactOutput

    Example
    {
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

refuseByExecuterReason

Type: string | null

Example: example

winBet
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerBet

    Example
    {
  "betComment": "example",
  "betMultimodal": {
    "isPriceByArc": true,
    "route": [
      {
        "addressFrom": "example",
        "addressTo": "example",
        "comment": "example",
        "currency": "example",
        "notVatPayer": true,
        "price": 0.5,
        "priceWithVat": 0.5,
        "taxablePrice": {},
        "vat": 0.5
      }
    ]
  },
  "cancelDate": {
    "contact": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "cancelExecutorComment": "example",
  "cancelForwarderComment": "example",
  "comment": "example",
  "condition": "example",
  "executor": {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "finalPrice": 0.5,
  "id": "example",
  "isCanceled": true,
  "isCanceledByForwarder": true,
  "isOpenMarket": true,
  "isWinner": true,
  "notVatPayer": true,
  "price": 0.5,
  "setDate": null,
  "tariffMatrix": {
    "tariffMatrixId": "example"
  },
  "taxablePrice": null,
  "useMultimodal": true,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "betComment": "example",
  "betMultimodal": {
    "isPriceByArc": true,
    "route": [
      {}
    ]
  },
  "cancelDate": {
    "contact": {},
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "cancelExecutorComment": "example",
  "cancelForwarderComment": "example",
  "comment": "example",
  "condition": "example",
  "executor": {
    "id": "example",
    "isInBlackList": true,
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "finalPrice": 0.5,
  "id": "example",
  "isCanceled": true,
  "isCanceledByForwarder": true,
  "isOpenMarket": true,
  "isWinner": true,
  "notVatPayer": true,
  "price": 0.5,
  "setDate": null,
  "tariffMatrix": {
    "tariffMatrixId": "example"
  },
  "taxablePrice": {
    "base": "100.18",
    "currency": "RUB",
    "isVatPayer": false,
    "subTotalPrice": "122.21",
    "vat": "22",
    "vatAmount": "22.03"
  },
  "useMultimodal": true,
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5
}

winnerExecutor
Any of 2 types
Example
{
  "id": "example",
  "isInBlackList": true,
  "isUnverified": true,
  "name": "example",
  "tin": "example"
}
Example
{
  "bestBet": {
    "betComment": "example",
    "betMultimodal": {
      "isPriceByArc": true,
      "route": [
        null
      ]
    },
    "cancelDate": {
      "contact": null,
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "cancelExecutorComment": "example",
    "cancelForwarderComment": "example",
    "comment": "example",
    "condition": "example",
    "executor": {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example"
    },
    "finalPrice": 0.5,
    "id": "example",
    "isCanceled": true,
    "isCanceledByForwarder": true,
    "isOpenMarket": true,
    "isWinner": true,
    "notVatPayer": true,
    "price": 0.5,
    "setDate": null,
    "tariffMatrix": {
      "tariffMatrixId": "example"
    },
    "taxablePrice": {
      "base": "100.18",
      "currency": "RUB",
      "isVatPayer": false,
      "subTotalPrice": "122.21",
      "vat": "22",
      "vatAmount": "22.03"
    },
    "useMultimodal": true,
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatAmount": 0.5
  },
  "bestBetOpenAuction": null,
  "bets": [
    null
  ],
  "canSelectWinner": true,
  "demandId": "example",
  "lastBet": null,
  "lastBetOpenAuction": null,
  "matcherAuction": {
    "actualEndDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "allowMultimodal": true,
    "amount": 0.5,
    "auctionType": "example",
    "autoExtension": true,
    "autoExtensionActive": 0,
    "autoExtensionCount": 0,
    "autoExtensionDuration": 0,
    "autoExtensionTime": 0,
    "autoSelection": true,
    "bargainingIsPossible": true,
    "bidStep": 0.5,
    "buyNowPrice": 0.5,
    "currency": "example",
    "decreaseOnly": true,
    "decreaseOnlyFromDeclaredPrice": true,
    "duration": 0,
    "endDate": null,
    "hideBidsFromCarrier": true,
    "isDirect": true,
    "isOpenAuction": true,
    "possibleMatcherExecutors": [
      null
    ],
    "prolongationDatetimeMax": null,
    "startDate": null,
    "tariffMatrixParams": {
      "isWhoFirst": true,
      "tariffMatrixInfos": [
        {}
      ]
    },
    "timeLeftUntilEnd": 0,
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatAmount": 0.5,
    "vatInPriceNotConsider": true
  },
  "matcherStatus": "example",
  "refuseByExecuterAt": null,
  "refuseByExecuterReason": "example",
  "winBet": null,
  "winnerExecutor": null
}

OrdersV0TransferOrderGetFlatForCustomerOrderWayActionRelation

Name

Description

shipmentId

Type: string

ID груза

Example: example

shipmentName

Type: string

Название груза

Example: example

transferTaskId

Type: string

ID задачи перевозки

Example: example

flightId

Type: string | null

ID рейса

Example: example

flightTaskId

Type: string | null

ID задачи перевозки

Example: example
Example
{
  "flightId": "example",
  "flightTaskId": "example",
  "shipmentId": "example",
  "shipmentName": "example",
  "transferTaskId": "example"
}

OrdersV0TransferOrderGetFlatForCustomerOrderWayAction

Name

Description

actionId

Type: string

ID действия

Example: example

actionType

Type: string

Что нужно сделать на маршруте (loading - погрузить груз, unloading - выгрузить груз, transit - не выгружать уже погруженный груз)

Example: example

orderInVisit

Type: integer

порядок выполнения задач в узле

relation
Any of 2 types

Связь с задачей перевозки (груз, заказ, рейс)

Example
{
  "flightId": "example",
  "flightTaskId": "example",
  "shipmentId": "example",
  "shipmentName": "example",
  "transferTaskId": "example"
}
Example
{
  "actionId": "example",
  "actionType": "example",
  "orderInVisit": 0,
  "relation": {
    "flightId": "example",
    "flightTaskId": "example",
    "shipmentId": "example",
    "shipmentName": "example",
    "transferTaskId": "example"
  }
}

OrdersV0TransferOrderGetFlatForCustomerOrderWayPoint

Name

Description

address

Type: string

Адрес точки

Example: example

id

Type: string

ID точки

Example: example

lat

Type: number

Широта точки

locality

Type: string

Город точки

Example: example

long

Type: number

Долгота точки

province

Type: string

Провинция точки

Example: example

addressComment

Type: string | null

Комментарий к адресу

Example: example

name

Type: string | null

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

Example: example

tin

Type: string | null

ИНН точки

Example: example
Example
{
  "address": "example",
  "addressComment": "example",
  "id": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "name": "example",
  "province": "example",
  "tin": "example"
}

OrdersV0TransferOrderGetFlatForCustomerOrderWayVisit

Name

Description

id

Type: string

ID посещения

Example: example

orderInWay

Type: integer

Порядок посещения точек в маршруте

startAt
All of 1 type

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

Дата начала посещения

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

actions

Type: OrdersV0TransferOrderGetFlatForCustomerOrderWayAction[] | null

Действия, которые нужно выполнить на маршруте

Example
[
  {
    "actionId": "example",
    "actionType": "example",
    "orderInVisit": 0,
    "relation": {
      "flightId": "example",
      "flightTaskId": "example",
      "shipmentId": "example",
      "shipmentName": "example",
      "transferTaskId": "example"
    }
  }
]

endAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Дата окончания посещения

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

wayPoint
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerOrderWayPoint

    Example
    {
  "address": "example",
  "addressComment": "example",
  "id": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "name": "example",
  "province": "example",
  "tin": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Точка на маршруте

Example
{
  "address": "example",
  "addressComment": "example",
  "id": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "name": "example",
  "province": "example",
  "tin": "example"
}
Example
{
  "actions": [
    {
      "actionId": "example",
      "actionType": "example",
      "orderInVisit": 0,
      "relation": {
        "flightId": "example",
        "flightTaskId": "example",
        "shipmentId": "example",
        "shipmentName": "example",
        "transferTaskId": "example"
      }
    }
  ],
  "endAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "id": "example",
  "orderInWay": 0,
  "startAt": null,
  "wayPoint": {
    "address": "example",
    "addressComment": "example",
    "id": "example",
    "lat": 0.5,
    "locality": "example",
    "long": 0.5,
    "name": "example",
    "province": "example",
    "tin": "example"
  }
}

OrdersV0TransferOrderGetFlatForCustomerOrderWay

Name

Description

createdAt
All of 1 type

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

Дата создания маршрута

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

generationType

Type: string

Тип генерации (auto / manual)

Example: example

id

Type: string

ID версии маршрута

Example: example

updatedAt
All of 1 type

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

Дата обновления маршрута

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

archivedAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Дата архивации маршрута

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

distanceKilometers

Type: number | null

Расстояние в километрах

visits

Type: OrdersV0TransferOrderGetFlatForCustomerOrderWayVisit[] | null

Посещения точек на маршруте следования

Example
[
  {
    "actions": [
      {
        "actionId": "example",
        "actionType": "example",
        "orderInVisit": 0,
        "relation": {}
      }
    ],
    "endAt": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "id": "example",
    "orderInWay": 0,
    "startAt": null,
    "wayPoint": {
      "address": "example",
      "addressComment": "example",
      "id": "example",
      "lat": 0.5,
      "locality": "example",
      "long": 0.5,
      "name": "example",
      "province": "example",
      "tin": "example"
    }
  }
]
Example
{
  "archivedAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "createdAt": null,
  "distanceKilometers": 0.5,
  "generationType": "example",
  "id": "example",
  "updatedAt": null,
  "visits": [
    {
      "actions": [
        {
          "actionId": "example",
          "actionType": "example",
          "orderInVisit": 0,
          "relation": null
        }
      ],
      "endAt": null,
      "id": "example",
      "orderInWay": 0,
      "startAt": null,
      "wayPoint": {
        "address": "example",
        "addressComment": "example",
        "id": "example",
        "lat": 0.5,
        "locality": "example",
        "long": 0.5,
        "name": "example",
        "province": "example",
        "tin": "example"
      }
    }
  ]
}

OrdersV0TransferOrderGetFlatForCustomerPaymentDelayPeriod

Name

Description

paymentType

Type: string

Тип оплаты.

Example: example

daysDelayPeriod

Type: integer | null

Количество дней отсрочки платяжа.

postPayCalendarType

Type: string | null

Тип постоплаты.

Example: example
Example
{
  "daysDelayPeriod": 0,
  "paymentType": "example",
  "postPayCalendarType": "example"
}

OrdersV0TransferOrderGetFlatForCustomerExternalExecutor

Name

Description

country

Type: string

Example: example

name

Type: string

Example: example

orgType

Type: string

Example: example

tin

Type: string

Example: example

contactEmail

Type: string | null

Example: example

contactName

Type: string | null

Example: example

contactPhone

Type: string | null

Example: example

vat

Type: number | null
Example
{
  "contactEmail": "example",
  "contactName": "example",
  "contactPhone": "example",
  "country": "example",
  "name": "example",
  "orgType": "example",
  "tin": "example",
  "vat": 0.5
}

OrdersV0TransferOrderGetFlatForCustomerFlightInfo

Name

Description

canSetCar

Type: boolean

canSetDriver

Type: boolean

canSetStatus

Type: boolean

flightId

Type: string

Example: example

flightStatus

Type: string

Example: example

flightTaskId

Type: string

Example: example

flightTaskStatus

Type: string

Example: example

subStatus

Type: string

Example: example

arrivalLoadingAt
Any of 2 types

  • Type: TimestampTZWContactOutput

    Example
    {
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

arrivalUnloadingAt
Any of 2 types

  • Type: TimestampTZWContactOutput

    Example
    {
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

carHeadInfo
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerCarInfo

    Example
    {
  "bodyType": "example",
  "brand": "example",
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "palletCount": 0,
  "type": "example",
  "volume": 0.5,
  "width": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "bodyType": "example",
  "brand": "example",
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "palletCount": 0,
  "type": "example",
  "volume": 0.5,
  "width": 0.5
}

departureLoadingAt
Any of 2 types

  • Type: TimestampTZWContactOutput

    Example
    {
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

departureUnloadingAt
Any of 2 types

  • Type: TimestampTZWContactOutput

    Example
    {
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

driverInfo
Any of 2 types
Example
{
  "id": "example",
  "isActual": true,
  "masked_phone": "example",
  "name": "example"
}

endLoadingAt
Any of 2 types

  • Type: TimestampTZWContactOutput

    Example
    {
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

endUnloadingAt
Any of 2 types

  • Type: TimestampTZWContactOutput

    Example
    {
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

externalExecutor
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerExternalExecutor

    Example
    {
  "contactEmail": "example",
  "contactName": "example",
  "contactPhone": "example",
  "country": "example",
  "name": "example",
  "orgType": "example",
  "tin": "example",
  "vat": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contactEmail": "example",
  "contactName": "example",
  "contactPhone": "example",
  "country": "example",
  "name": "example",
  "orgType": "example",
  "tin": "example",
  "vat": 0.5
}

goToTheLoadingAt
Any of 2 types

  • Type: TimestampTZWContactOutput

    Example
    {
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

loadingOrder

Type: integer | null

responsibleLogistician
Any of 2 types

  • Type: TimestampTZOutputContact

    Example
    {
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

startLoadingAt
Any of 2 types

  • Type: TimestampTZWContactOutput

    Example
    {
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

startUnloadingAt
Any of 2 types

  • Type: TimestampTZWContactOutput

    Example
    {
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

trailerInfo
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerCarInfo

    Example
    {
  "bodyType": "example",
  "brand": "example",
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "palletCount": 0,
  "type": "example",
  "volume": 0.5,
  "width": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "bodyType": "example",
  "brand": "example",
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "palletCount": 0,
  "type": "example",
  "volume": 0.5,
  "width": 0.5
}

unloadingOrder

Type: integer | null
Example
{
  "arrivalLoadingAt": {
    "contact": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "arrivalUnloadingAt": null,
  "canSetCar": true,
  "canSetDriver": true,
  "canSetStatus": true,
  "carHeadInfo": {
    "bodyType": "example",
    "brand": "example",
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "palletCount": 0,
    "type": "example",
    "volume": 0.5,
    "width": 0.5
  },
  "departureLoadingAt": null,
  "departureUnloadingAt": null,
  "driverInfo": {
    "id": "example",
    "isActual": true,
    "masked_phone": "example",
    "name": "example"
  },
  "endLoadingAt": null,
  "endUnloadingAt": null,
  "externalExecutor": {
    "contactEmail": "example",
    "contactName": "example",
    "contactPhone": "example",
    "country": "example",
    "name": "example",
    "orgType": "example",
    "tin": "example",
    "vat": 0.5
  },
  "flightId": "example",
  "flightStatus": "example",
  "flightTaskId": "example",
  "flightTaskStatus": "example",
  "goToTheLoadingAt": null,
  "loadingOrder": 0,
  "responsibleLogistician": null,
  "startLoadingAt": null,
  "startUnloadingAt": null,
  "subStatus": "example",
  "trailerInfo": null,
  "unloadingOrder": 0
}

OrdersV0TransferOrderGetFlatForCustomerNodalPointAdditionalContact

Name

Description

id

Type: string

Example: example

npcName

Type: string

Имя контактного лица.

Example: example

npcPhone

Type: string

Телефон контактного лица.

Example: example

npcCountry

Type: string | null

Страна контактного лица.

Example: example

npcEmail

Type: string | null

Электронные адреса контактного лица.

Example: example

npcExternalId

Type: string | null

Идентификатор контакта в системе клиента.

Example: example
Example
{
  "id": "example",
  "npcCountry": "example",
  "npcEmail": "example",
  "npcExternalId": "example",
  "npcName": "example",
  "npcPhone": "example"
}

OrdersV0TransferOrderGetFlatForCustomerAddress

Name

Description

address

Type: string

@address адрес, например Калужское шоссе, 22-й километр, 10

Example: example

countryCode

Type: string

@countryCode код страны

Example: example

lat

Type: number

@lat широта

lon

Type: number

@lon долгота

accuracy

Type: string | null

@accuracy уровень точности

Example: example

area

Type: string | null

@area район

Example: example

displayAddress

Type: string | null

@display_address адрес для основного отображения, например Фудсити, или Москва, ул. Медиков, д 18

Example: example

geoData

Type: string | null

Ответ геокодера или иной системы

Example: example

house

Type: string | null

@house дом

Example: example

locality

Type: string | null

@locality город

Example: example

postalCode

Type: string | null

@postalCode почтовый индекс

Example: example

province

Type: string | null

@province провинция

Example: example

regionCode

Type: string | null

@regionCode код региона

Example: example

street

Type: string | null

@street улица

Example: example
Example
{
  "accuracy": "example",
  "address": "example",
  "area": "example",
  "countryCode": "example",
  "displayAddress": "example",
  "geoData": "example",
  "house": "example",
  "lat": 0.5,
  "locality": "example",
  "lon": 0.5,
  "postalCode": "example",
  "province": "example",
  "regionCode": "example",
  "street": "example"
}

OrdersV0TransferOrderGetFlatForCustomerNpAddress

Name

Description

address

Type: string | null

Example: example

lat

Type: number | null

locality

Type: string | null

Example: example

long

Type: number | null

npAddress
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerAddress

    Example
    {
  "accuracy": "example",
  "address": "example",
  "area": "example",
  "countryCode": "example",
  "displayAddress": "example",
  "geoData": "example",
  "house": "example",
  "lat": 0.5,
  "locality": "example",
  "lon": 0.5,
  "postalCode": "example",
  "province": "example",
  "regionCode": "example",
  "street": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Обязательно к заполнению, если не заполнены поля lat, lon, address

Example
{
  "accuracy": "example",
  "address": "example",
  "area": "example",
  "countryCode": "example",
  "displayAddress": "example",
  "geoData": "example",
  "house": "example",
  "lat": 0.5,
  "locality": "example",
  "lon": 0.5,
  "postalCode": "example",
  "province": "example",
  "regionCode": "example",
  "street": "example"
}

province

Type: string | null

Example: example
Example
{
  "address": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "npAddress": {
    "accuracy": "example",
    "address": "example",
    "area": "example",
    "countryCode": "example",
    "displayAddress": "example",
    "geoData": "example",
    "house": "example",
    "lat": 0.5,
    "locality": "example",
    "lon": 0.5,
    "postalCode": "example",
    "province": "example",
    "regionCode": "example",
    "street": "example"
  },
  "province": "example"
}

OrdersV0TransferOrderGetFlatForCustomerNodalPointShipmentPeriod

Name

Description

from

Type: TimestampTZOutput

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

to
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}
Example
{
  "from": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "to": null
}

OrdersV0TransferOrderGetFlatForCustomerNodalPointShipment

Name

Description

content

Type: string

Содержимое разгрузки/погрузки.

Example: example

country

Type: string

Страна разгрузки/погрузки.

Example: example

id

Type: string

Example: example

name

Type: string

Название разгрузки/погрузки.

Example: example

npGeoAddress
All of 1 type

  • Type: OrdersV0TransferOrderGetFlatForCustomerNpAddress

    Example
    {
  "address": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "npAddress": {
    "accuracy": "example",
    "address": "example",
    "area": "example",
    "countryCode": "example",
    "displayAddress": "example",
    "geoData": "example",
    "house": "example",
    "lat": 0.5,
    "locality": "example",
    "lon": 0.5,
    "postalCode": "example",
    "province": "example",
    "regionCode": "example",
    "street": "example"
  },
  "province": "example"
}

Геоадрес разгрузки/погрузки.
Геоадрес разгрузки/погрузки.

Example
{
  "address": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "npAddress": {
    "accuracy": "example",
    "address": "example",
    "area": "example",
    "countryCode": "example",
    "displayAddress": "example",
    "geoData": "example",
    "house": "example",
    "lat": 0.5,
    "locality": "example",
    "lon": 0.5,
    "postalCode": "example",
    "province": "example",
    "regionCode": "example",
    "street": "example"
  },
  "province": "example"
}

npLegalType

Type: string

Юридический тип разгрузки/погрузки.

Example: example

npTin

Type: string

ИНН разгрузки/погрузки.

Example: example

period
All of 1 type

Период разгрузки/погрузки. если в периоде, не заполнено поле to, то считаем не периодом, а точной датой

Example
{
  "from": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "to": null
}

position

Type: integer

очередь разгрузки/погрузки.

addressComment

Type: string | null

Комментарий к адресу (до 1000 символов)

Example: example

legalAddress

Type: string | null

юридический адрес компании которая производит разгрузку/погрузку

Example: example

legalPhone

Type: string | null

Example: example

npAdditionalContact

Type: OrdersV0TransferOrderGetFlatForCustomerNodalPointAdditionalContact[] | null

Дополнительные контакты разгрузки/погрузки.

Example
[
  {
    "id": "example",
    "npcCountry": "example",
    "npcEmail": "example",
    "npcExternalId": "example",
    "npcName": "example",
    "npcPhone": "example"
  }
]

npGeoLegalAddress
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerNpAddress

    Example
    {
  "address": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "npAddress": {
    "accuracy": "example",
    "address": "example",
    "area": "example",
    "countryCode": "example",
    "displayAddress": "example",
    "geoData": "example",
    "house": "example",
    "lat": 0.5,
    "locality": "example",
    "lon": 0.5,
    "postalCode": "example",
    "province": "example",
    "regionCode": "example",
    "street": "example"
  },
  "province": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Юридический Геоадрес разгрузки/погрузки.

Example
{
  "address": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "npAddress": {
    "accuracy": "example",
    "address": "example",
    "area": "example",
    "countryCode": "example",
    "displayAddress": "example",
    "geoData": "example",
    "house": "example",
    "lat": 0.5,
    "locality": "example",
    "lon": 0.5,
    "postalCode": "example",
    "province": "example",
    "regionCode": "example",
    "street": "example"
  },
  "province": "example"
}

npShipmentId

Type: string | null

Идентификатор разгрузки/погрузки.

Example: example

sequenceOrder

Type: integer | null

transshipmentTypes

Type: string[] | null

Example
[
  "example"
]
Example
{
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "id": "example",
      "npcCountry": "example",
      "npcEmail": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "locality": "example",
    "long": 0.5,
    "npAddress": {
      "accuracy": "example",
      "address": "example",
      "area": "example",
      "countryCode": "example",
      "displayAddress": "example",
      "geoData": "example",
      "house": "example",
      "lat": 0.5,
      "locality": "example",
      "lon": 0.5,
      "postalCode": "example",
      "province": "example",
      "regionCode": "example",
      "street": "example"
    },
    "province": "example"
  },
  "npGeoLegalAddress": null,
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "to": null
  },
  "position": 0,
  "sequenceOrder": 0,
  "transshipmentTypes": [
    "example"
  ]
}

OrdersV0TransferOrderGetFlatForCustomerDangerousCargo

Name

Description

hazardClass

Type: string

Example: example

classificationCode

Type: string | null

Example: example

competentAuthoritySign

Type: string | null

Example: example

controlTemperature

Type: string | null

Example: example

description

Type: string | null

Example: example

emergencyTemperature

Type: string | null

Example: example

explosiveNetMass

Type: string | null

Example: example

explosiveNetMassTotal

Type: string | null

Example: example

hazardLabel

Type: string | null

Example: example

holdTimeExpiryDate

Type: string | null

Example: 2006-01-02T00:00:00Z

maxActivity

Type: string | null

Example: example

mixtureCompositionPercent

Type: string | null

Example: example

packageCategory

Type: string | null

Example: example

packingGroup

Type: string | null

Example: example

physicalChemicalDescription

Type: string | null

Example: example

properShippingName

Type: string | null

Example: example

radionuclideName

Type: string | null

Example: example

regulatoryAct

Type: string | null

Example: example

safetyIndex

Type: string | null

Example: example

technicalName

Type: string | null

Example: example

totalActivity

Type: string | null

Example: example

transportIndex

Type: string | null

Example: example

tunnelRestrictionCode

Type: string | null

Example: example

unHazardId

Type: string | null

Example: example
Example
{
  "classificationCode": "example",
  "competentAuthoritySign": "example",
  "controlTemperature": "example",
  "description": "example",
  "emergencyTemperature": "example",
  "explosiveNetMass": "example",
  "explosiveNetMassTotal": "example",
  "hazardClass": "example",
  "hazardLabel": "example",
  "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
  "maxActivity": "example",
  "mixtureCompositionPercent": "example",
  "packageCategory": "example",
  "packingGroup": "example",
  "physicalChemicalDescription": "example",
  "properShippingName": "example",
  "radionuclideName": "example",
  "regulatoryAct": "example",
  "safetyIndex": "example",
  "technicalName": "example",
  "totalActivity": "example",
  "transportIndex": "example",
  "tunnelRestrictionCode": "example",
  "unHazardId": "example"
}

OrdersV0TransferOrderGetFlatForCustomerPackagesRuEdo

Name

Description

cargoState

Type: string | null

состояние груза

Example: example

codeToVNom

Type: string | null

код товарной номенклатуры

Example: example

dangerousCargo
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerDangerousCargo

    Example
    {
  "classificationCode": "example",
  "competentAuthoritySign": "example",
  "controlTemperature": "example",
  "description": "example",
  "emergencyTemperature": "example",
  "explosiveNetMass": "example",
  "explosiveNetMassTotal": "example",
  "hazardClass": "example",
  "hazardLabel": "example",
  "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
  "maxActivity": "example",
  "mixtureCompositionPercent": "example",
  "packageCategory": "example",
  "packingGroup": "example",
  "physicalChemicalDescription": "example",
  "properShippingName": "example",
  "radionuclideName": "example",
  "regulatoryAct": "example",
  "safetyIndex": "example",
  "technicalName": "example",
  "totalActivity": "example",
  "transportIndex": "example",
  "tunnelRestrictionCode": "example",
  "unHazardId": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

сведения об опасном грузе

Example
{
  "classificationCode": "example",
  "competentAuthoritySign": "example",
  "controlTemperature": "example",
  "description": "example",
  "emergencyTemperature": "example",
  "explosiveNetMass": "example",
  "explosiveNetMassTotal": "example",
  "hazardClass": "example",
  "hazardLabel": "example",
  "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
  "maxActivity": "example",
  "mixtureCompositionPercent": "example",
  "packageCategory": "example",
  "packingGroup": "example",
  "physicalChemicalDescription": "example",
  "properShippingName": "example",
  "radionuclideName": "example",
  "regulatoryAct": "example",
  "safetyIndex": "example",
  "technicalName": "example",
  "totalActivity": "example",
  "transportIndex": "example",
  "tunnelRestrictionCode": "example",
  "unHazardId": "example"
}

mark

Type: string[] | null

маркировка

Example
[
  "example"
]

pkgType

Type: string | null

тип упаковки

Example: example
Example
{
  "cargoState": "example",
  "codeToVNom": "example",
  "dangerousCargo": {
    "classificationCode": "example",
    "competentAuthoritySign": "example",
    "controlTemperature": "example",
    "description": "example",
    "emergencyTemperature": "example",
    "explosiveNetMass": "example",
    "explosiveNetMassTotal": "example",
    "hazardClass": "example",
    "hazardLabel": "example",
    "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
    "maxActivity": "example",
    "mixtureCompositionPercent": "example",
    "packageCategory": "example",
    "packingGroup": "example",
    "physicalChemicalDescription": "example",
    "properShippingName": "example",
    "radionuclideName": "example",
    "regulatoryAct": "example",
    "safetyIndex": "example",
    "technicalName": "example",
    "totalActivity": "example",
    "transportIndex": "example",
    "tunnelRestrictionCode": "example",
    "unHazardId": "example"
  },
  "mark": [
    "example"
  ],
  "pkgType": "example"
}

OrdersV0TransferOrderGetFlatForCustomerTemperatureRegime

Name

Description

from

Type: integer

Температура градусов в цельсиях, минимум.

to

Type: integer

Температура градусов в цельсиях, максимум.
Example
{
  "from": 0,
  "to": 0
}

OrdersV0TransferOrderGetFlatForCustomerPackages

Name

Description

count

Type: integer

Количество

hazardClass

Type: string

класс опасности

Example: example

isDeleted

Type: boolean

packageId

Type: string

Example: example

packageName

Type: string

Отображаемое имя единицы товара.

Example: example

stackability

Type: string

стакающийся?

Example: example

amount

Type: number | null

Объявленная стоимость

capacity

Type: number | null

Объем

cargoCategory
Any of 2 types
Example
{
  "category": "example",
  "categoryComment": "example"
}

comment

Type: string | null

Example: example

currency

Type: string | null

Валюта

Example: example

dimensionHeight

Type: number | null

dimensionLength

Type: number | null

dimensionWeight

Type: number | null

executorRequirementPackageId

Type: string | null

Example: example

packageExternalId

Type: string | null

Идентификатор единицы товара со стороны заказчика.

Example: example

requirementPackageId

Type: string | null

Example: example

ruEdo
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerPackagesRuEdo

    Example
    {
  "cargoState": "example",
  "codeToVNom": "example",
  "dangerousCargo": {
    "classificationCode": "example",
    "competentAuthoritySign": "example",
    "controlTemperature": "example",
    "description": "example",
    "emergencyTemperature": "example",
    "explosiveNetMass": "example",
    "explosiveNetMassTotal": "example",
    "hazardClass": "example",
    "hazardLabel": "example",
    "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
    "maxActivity": "example",
    "mixtureCompositionPercent": "example",
    "packageCategory": "example",
    "packingGroup": "example",
    "physicalChemicalDescription": "example",
    "properShippingName": "example",
    "radionuclideName": "example",
    "regulatoryAct": "example",
    "safetyIndex": "example",
    "technicalName": "example",
    "totalActivity": "example",
    "transportIndex": "example",
    "tunnelRestrictionCode": "example",
    "unHazardId": "example"
  },
  "mark": [
    "example"
  ],
  "pkgType": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Данные для Российского ЭДО

Example
{
  "cargoState": "example",
  "codeToVNom": "example",
  "dangerousCargo": {
    "classificationCode": "example",
    "competentAuthoritySign": "example",
    "controlTemperature": "example",
    "description": "example",
    "emergencyTemperature": "example",
    "explosiveNetMass": "example",
    "explosiveNetMassTotal": "example",
    "hazardClass": "example",
    "hazardLabel": "example",
    "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
    "maxActivity": "example",
    "mixtureCompositionPercent": "example",
    "packageCategory": "example",
    "packingGroup": "example",
    "physicalChemicalDescription": "example",
    "properShippingName": "example",
    "radionuclideName": "example",
    "regulatoryAct": "example",
    "safetyIndex": "example",
    "technicalName": "example",
    "totalActivity": "example",
    "transportIndex": "example",
    "tunnelRestrictionCode": "example",
    "unHazardId": "example"
  },
  "mark": [
    "example"
  ],
  "pkgType": "example"
}

shipmentBodyType

Type: string | null

Тип упаковки груза.

Example: example

temperatureRegime

Type: OrdersV0TransferOrderGetFlatForCustomerTemperatureRegime[] | null

Example
[
  {
    "from": 0,
    "to": 0
  }
]

weight

Type: number | null

Вес
Example
{
  "amount": 0.5,
  "capacity": 0.5,
  "cargoCategory": {
    "category": "example",
    "categoryComment": "example"
  },
  "comment": "example",
  "count": 0,
  "currency": "example",
  "dimensionHeight": 0.5,
  "dimensionLength": 0.5,
  "dimensionWeight": 0.5,
  "executorRequirementPackageId": "example",
  "hazardClass": "example",
  "isDeleted": true,
  "packageExternalId": "example",
  "packageId": "example",
  "packageName": "example",
  "requirementPackageId": "example",
  "ruEdo": {
    "cargoState": "example",
    "codeToVNom": "example",
    "dangerousCargo": {
      "classificationCode": "example",
      "competentAuthoritySign": "example",
      "controlTemperature": "example",
      "description": "example",
      "emergencyTemperature": "example",
      "explosiveNetMass": "example",
      "explosiveNetMassTotal": "example",
      "hazardClass": "example",
      "hazardLabel": "example",
      "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
      "maxActivity": "example",
      "mixtureCompositionPercent": "example",
      "packageCategory": "example",
      "packingGroup": "example",
      "physicalChemicalDescription": "example",
      "properShippingName": "example",
      "radionuclideName": "example",
      "regulatoryAct": "example",
      "safetyIndex": "example",
      "technicalName": "example",
      "totalActivity": "example",
      "transportIndex": "example",
      "tunnelRestrictionCode": "example",
      "unHazardId": "example"
    },
    "mark": [
      "example"
    ],
    "pkgType": "example"
  },
  "shipmentBodyType": "example",
  "stackability": "example",
  "temperatureRegime": [
    {
      "from": 0,
      "to": 0
    }
  ],
  "weight": 0.5
}

OrdersV0TransferOrderGetFlatForCustomerShipment

Name

Description

isDeleted

Type: boolean

Помечен ли на удаление

name

Type: string

Example: example

npShipment

Type: OrdersV0TransferOrderGetFlatForCustomerNodalPointShipment

Example
{
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "id": "example",
      "npcCountry": "example",
      "npcEmail": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "locality": "example",
    "long": 0.5,
    "npAddress": {
      "accuracy": "example",
      "address": "example",
      "area": "example",
      "countryCode": "example",
      "displayAddress": "example",
      "geoData": "example",
      "house": "example",
      "lat": 0.5,
      "locality": "example",
      "lon": 0.5,
      "postalCode": "example",
      "province": "example",
      "regionCode": "example",
      "street": "example"
    },
    "province": "example"
  },
  "npGeoLegalAddress": null,
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "to": null
  },
  "position": 0,
  "sequenceOrder": 0,
  "transshipmentTypes": [
    "example"
  ]
}

npShipmentId

Type: string

Погрузка

Example: example

npUnshipment
All of 1 type

  • Type: OrdersV0TransferOrderGetFlatForCustomerNodalPointShipment

    Example
    {
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "id": "example",
      "npcCountry": "example",
      "npcEmail": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "locality": "example",
    "long": 0.5,
    "npAddress": {
      "accuracy": "example",
      "address": "example",
      "area": "example",
      "countryCode": "example",
      "displayAddress": "example",
      "geoData": "example",
      "house": "example",
      "lat": 0.5,
      "locality": "example",
      "lon": 0.5,
      "postalCode": "example",
      "province": "example",
      "regionCode": "example",
      "street": "example"
    },
    "province": "example"
  },
  "npGeoLegalAddress": null,
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "to": null
  },
  "position": 0,
  "sequenceOrder": 0,
  "transshipmentTypes": [
    "example"
  ]
}

Разгрузка

Example
{
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "id": "example",
      "npcCountry": "example",
      "npcEmail": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "locality": "example",
    "long": 0.5,
    "npAddress": {},
    "province": "example"
  },
  "npGeoLegalAddress": null,
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "to": null
  },
  "position": 0,
  "sequenceOrder": 0,
  "transshipmentTypes": [
    "example"
  ]
}

packageType

Type: string

Example: example

shipmentId

Type: string

Example: example

status

Type: string

Example: example

taskStatus

Type: string

Example: example

transferOrderTaskID

Type: string

Example: example

comment

Type: string | null

Example: example

distributionPriority

Type: integer | null

executorRequirementId

Type: string | null

ID потребности исполнителя

Example: example

executorRequirementShipmentId

Type: string | null

ID груза потребности исполнителя

Example: example

flightInfo
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerFlightInfo

    Example
    {
  "arrivalLoadingAt": {
    "contact": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "arrivalUnloadingAt": null,
  "canSetCar": true,
  "canSetDriver": true,
  "canSetStatus": true,
  "carHeadInfo": {
    "bodyType": "example",
    "brand": "example",
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "palletCount": 0,
    "type": "example",
    "volume": 0.5,
    "width": 0.5
  },
  "departureLoadingAt": null,
  "departureUnloadingAt": null,
  "driverInfo": {
    "id": "example",
    "isActual": true,
    "masked_phone": "example",
    "name": "example"
  },
  "endLoadingAt": null,
  "endUnloadingAt": null,
  "externalExecutor": {
    "contactEmail": "example",
    "contactName": "example",
    "contactPhone": "example",
    "country": "example",
    "name": "example",
    "orgType": "example",
    "tin": "example",
    "vat": 0.5
  },
  "flightId": "example",
  "flightStatus": "example",
  "flightTaskId": "example",
  "flightTaskStatus": "example",
  "goToTheLoadingAt": null,
  "loadingOrder": 0,
  "responsibleLogistician": null,
  "startLoadingAt": null,
  "startUnloadingAt": null,
  "subStatus": "example",
  "trailerInfo": null,
  "unloadingOrder": 0
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "arrivalLoadingAt": {
    "contact": {},
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "arrivalUnloadingAt": null,
  "canSetCar": true,
  "canSetDriver": true,
  "canSetStatus": true,
  "carHeadInfo": {
    "bodyType": "example",
    "brand": "example",
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "palletCount": 0,
    "type": "example",
    "volume": 0.5,
    "width": 0.5
  },
  "departureLoadingAt": null,
  "departureUnloadingAt": null,
  "driverInfo": {
    "id": "example",
    "isActual": true,
    "masked_phone": "example",
    "name": "example"
  },
  "endLoadingAt": null,
  "endUnloadingAt": null,
  "externalExecutor": {
    "contactEmail": "example",
    "contactName": "example",
    "contactPhone": "example",
    "country": "example",
    "name": "example",
    "orgType": "example",
    "tin": "example",
    "vat": 0.5
  },
  "flightId": "example",
  "flightStatus": "example",
  "flightTaskId": "example",
  "flightTaskStatus": "example",
  "goToTheLoadingAt": null,
  "loadingOrder": 0,
  "responsibleLogistician": null,
  "startLoadingAt": null,
  "startUnloadingAt": null,
  "subStatus": "example",
  "trailerInfo": null,
  "unloadingOrder": 0
}

flightTaskId

Type: string | null

Example: example

packages

Type: OrdersV0TransferOrderGetFlatForCustomerPackages[] | null

Example
[
  {
    "amount": 0.5,
    "capacity": 0.5,
    "cargoCategory": {
      "category": "example",
      "categoryComment": "example"
    },
    "comment": "example",
    "count": 0,
    "currency": "example",
    "dimensionHeight": 0.5,
    "dimensionLength": 0.5,
    "dimensionWeight": 0.5,
    "executorRequirementPackageId": "example",
    "hazardClass": "example",
    "isDeleted": true,
    "packageExternalId": "example",
    "packageId": "example",
    "packageName": "example",
    "requirementPackageId": "example",
    "ruEdo": {
      "cargoState": "example",
      "codeToVNom": "example",
      "dangerousCargo": {},
      "mark": [
        "example"
      ],
      "pkgType": "example"
    },
    "shipmentBodyType": "example",
    "stackability": "example",
    "temperatureRegime": [
      {
        "from": 0,
        "to": 0
      }
    ],
    "weight": 0.5
  }
]

quantizationMethod

Type: string | null

QuantizationMethod - способ разделения

Example: example

requirementId

Type: string | null

ID потребности

Example: example

requirementShipmentId

Type: string | null

ID груза потребности

Example: example

shipmentExternalID

Type: string | null

Название или номер груза заказа в вашей системе нутрений. Не отображается в интерфейсе

Example: example
Example
{
  "comment": "example",
  "distributionPriority": 0,
  "executorRequirementId": "example",
  "executorRequirementShipmentId": "example",
  "flightInfo": {
    "arrivalLoadingAt": {
      "contact": null,
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "arrivalUnloadingAt": null,
    "canSetCar": true,
    "canSetDriver": true,
    "canSetStatus": true,
    "carHeadInfo": {
      "bodyType": "example",
      "brand": "example",
      "height": 0.5,
      "hydroBort": true,
      "id": "example",
      "length": 0.5,
      "loadCapacity": 0.5,
      "model": "example",
      "number": "example",
      "palletCount": 0,
      "type": "example",
      "volume": 0.5,
      "width": 0.5
    },
    "departureLoadingAt": null,
    "departureUnloadingAt": null,
    "driverInfo": {
      "id": "example",
      "isActual": true,
      "masked_phone": "example",
      "name": "example"
    },
    "endLoadingAt": null,
    "endUnloadingAt": null,
    "externalExecutor": {
      "contactEmail": "example",
      "contactName": "example",
      "contactPhone": "example",
      "country": "example",
      "name": "example",
      "orgType": "example",
      "tin": "example",
      "vat": 0.5
    },
    "flightId": "example",
    "flightStatus": "example",
    "flightTaskId": "example",
    "flightTaskStatus": "example",
    "goToTheLoadingAt": null,
    "loadingOrder": 0,
    "responsibleLogistician": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "startLoadingAt": null,
    "startUnloadingAt": null,
    "subStatus": "example",
    "trailerInfo": null,
    "unloadingOrder": 0
  },
  "flightTaskId": "example",
  "isDeleted": true,
  "name": "example",
  "npShipment": {
    "addressComment": "example",
    "content": "example",
    "country": "example",
    "id": "example",
    "legalAddress": "example",
    "legalPhone": "example",
    "name": "example",
    "npAdditionalContact": [
      {
        "id": "example",
        "npcCountry": "example",
        "npcEmail": "example",
        "npcExternalId": "example",
        "npcName": "example",
        "npcPhone": "example"
      }
    ],
    "npGeoAddress": {
      "address": "example",
      "lat": 0.5,
      "locality": "example",
      "long": 0.5,
      "npAddress": {},
      "province": "example"
    },
    "npGeoLegalAddress": null,
    "npLegalType": "example",
    "npShipmentId": "example",
    "npTin": "example",
    "period": {
      "from": {
        "displayTZ": "+03:00",
        "time": "2020-01-01T00:00:00"
      },
      "to": null
    },
    "position": 0,
    "sequenceOrder": 0,
    "transshipmentTypes": [
      "example"
    ]
  },
  "npShipmentId": "example",
  "npUnshipment": null,
  "packageType": "example",
  "packages": [
    {
      "amount": 0.5,
      "capacity": 0.5,
      "cargoCategory": {
        "category": "example",
        "categoryComment": "example"
      },
      "comment": "example",
      "count": 0,
      "currency": "example",
      "dimensionHeight": 0.5,
      "dimensionLength": 0.5,
      "dimensionWeight": 0.5,
      "executorRequirementPackageId": "example",
      "hazardClass": "example",
      "isDeleted": true,
      "packageExternalId": "example",
      "packageId": "example",
      "packageName": "example",
      "requirementPackageId": "example",
      "ruEdo": {
        "cargoState": "example",
        "codeToVNom": "example",
        "dangerousCargo": null,
        "mark": [
          null
        ],
        "pkgType": "example"
      },
      "shipmentBodyType": "example",
      "stackability": "example",
      "temperatureRegime": [
        {
          "from": 0,
          "to": 0
        }
      ],
      "weight": 0.5
    }
  ],
  "quantizationMethod": "example",
  "requirementId": "example",
  "requirementShipmentId": "example",
  "shipmentExternalID": "example",
  "shipmentId": "example",
  "status": "example",
  "taskStatus": "example",
  "transferOrderTaskID": "example"
}

JSONObject

Type: object

Example
{}

OrdersV0TransferOrderGetFlatForCustomerPrice

Name

Description

currency

Type: string

Валюта.

Example: example

price

Type: number

Цена с точностью до 2х знаков.
Example
{
  "currency": "example",
  "price": 0.5
}

OrdersV0TransferOrderGetFlatForCustomerUTM

Name

Description

utmSource

Type: string

Example: example

utmCampaign

Type: string | null

Example: example

utmContent

Type: string | null

Example: example

utmMedium

Type: string | null

Example: example

utmTerm

Type: string | null

Example: example
Example
{
  "utmCampaign": "example",
  "utmContent": "example",
  "utmMedium": "example",
  "utmSource": "example",
  "utmTerm": "example"
}

OrdersV0TransferOrderGetFlatForCustomerVolumeAuction

Name

Description

auctionType

Type: string

Example: example

duration

Type: integer

tarifficationType

Type: string

Example: example

transitDistance

Type: number

endDate
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

flightsCount

Type: number | null

startDate
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

tonsCount

Type: number | null

vehicleCapacityFrom

Type: number | null

vehicleCapacityTo

Type: number | null
Example
{
  "auctionType": "example",
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "flightsCount": 0.5,
  "startDate": null,
  "tarifficationType": "example",
  "tonsCount": 0.5,
  "transitDistance": 0.5,
  "vehicleCapacityFrom": 0.5,
  "vehicleCapacityTo": 0.5
}

OrdersV0TransferOrderGetFlatForCustomerVolumeDemand

Name

Description

isOpenAuction

Type: boolean

offersCount

Type: integer

status

Type: string

Example: example

uniqueOrganizationsCount

Type: integer

volumeAuction

Type: OrdersV0TransferOrderGetFlatForCustomerVolumeAuction

Example
{
  "auctionType": "example",
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "flightsCount": 0.5,
  "startDate": null,
  "tarifficationType": "example",
  "tonsCount": 0.5,
  "transitDistance": 0.5,
  "vehicleCapacityFrom": 0.5,
  "vehicleCapacityTo": 0.5
}

actualEndDate
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

volumeAuctionId

Type: string | null

Example: example
Example
{
  "actualEndDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "isOpenAuction": true,
  "offersCount": 0,
  "status": "example",
  "uniqueOrganizationsCount": 0,
  "volumeAuction": {
    "auctionType": "example",
    "duration": 0,
    "endDate": null,
    "flightsCount": 0.5,
    "startDate": null,
    "tarifficationType": "example",
    "tonsCount": 0.5,
    "transitDistance": 0.5,
    "vehicleCapacityFrom": 0.5,
    "vehicleCapacityTo": 0.5
  },
  "volumeAuctionId": "example"
}

OrdersV0TransferOrderGetFlatForCustomerOrder

Name

Description

bodyTypeComment

Type: string

Комментарий к типу кузова.

Example: example

cargoCategory
All of 1 type

Категория груза.

Example
{
  "category": "example",
  "categoryComment": "example"
}

created

Type: TimestampTZWContactOutput

Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

currency

Type: string

Example: example

customer
All of 1 type

  • Type: OrdersV0TransferOrderGetFlatForCustomerCustomer

    Example
    {
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerComment": "example",
  "customerCountry": "example",
  "customerForwarderId": "example",
  "customerForwarderTin": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example",
  "id": "example"
}

Инфорация о перевозке.

Example
{
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerComment": "example",
  "customerCountry": "example",
  "customerForwarderId": "example",
  "customerForwarderTin": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example",
  "id": "example"
}

forwarder
All of 1 type

Сведения о заказчике

Example
{
  "forwarderComment": "example",
  "forwarderId": "example",
  "forwarderName": "example",
  "forwarderTin": "example",
  "isUnverified": true
}

id

Type: string

Example: example

isActual

Type: boolean

isArchived

Type: boolean

isReadonly

Type: boolean

isVolumeAuction

Type: boolean

maxUpdatedDate

Type: TimestampTZOutput

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

status

Type: string

Example: example

transferOrderAdditionalConfiguration

Type: JSONObject

Example
{}

transferOrderType

Type: string

FTL LTL

Example: example

transIdentity

Type: string

Сквозной идентификатор заказа. Объединяет связанные заказы в едниый набор

Example: example

updated

Type: TimestampTZWContactOutput

Example
{
  "contact": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

additionalConditions
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerAdditionalConditions

    Example
    {
  "additionalComment": "example",
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "emails": [
    "example"
  ],
  "externalOrderID": "example",
  "fullName": "example",
  "isVatPayer": true,
  "phones": [
    "example"
  ],
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "specifyConditions": true,
  "vat": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

Дополнительные условия заказа

Example
{
  "additionalComment": "example",
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "emails": [
    "example"
  ],
  "externalOrderID": "example",
  "fullName": "example",
  "isVatPayer": true,
  "phones": [
    "example"
  ],
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "specifyConditions": true,
  "vat": 0.5
}

agreementRules
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerAgreementRules

    Example
    {
  "isDriverCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangeShipmentsWithoutApproval": true,
  "isForwarderCanChangePackagesWithoutApproval": true,
  "isForwarderCanChangeShipmentsWithoutApproval": true,
  "isWarehouseCanChangePackagesWithoutApproval": true
}

  • Type: object | null

    Const: null

    Example
    {}

Правила согласования

Example
{
  "isDriverCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangeShipmentsWithoutApproval": true,
  "isForwarderCanChangePackagesWithoutApproval": true,
  "isForwarderCanChangeShipmentsWithoutApproval": true,
  "isWarehouseCanChangePackagesWithoutApproval": true
}

alerts

Type: OrdersV0TransferOrderGetFlatForCustomerAlertInfo[] | null

Alerts Яркие уведомления

Example
[
  {
    "alertType": "example",
    "description": "example"
  }
]

auction
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerAuction

    Example
    {
  "allowMultimodal": true,
  "amount": 0.5,
  "auctionType": "example",
  "autoExtension": true,
  "autoExtensionActive": 0,
  "autoExtensionDuration": 0,
  "autoExtensionTime": 0,
  "autoSelection": true,
  "bargainingIsPossible": true,
  "bidStep": 0.5,
  "buyNowPrice": 0.5,
  "currency": "example",
  "decreaseOnly": true,
  "decreaseOnlyFromDeclaredPrice": true,
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "hideBidsFromCarrier": true,
  "isDirect": true,
  "isOpenAuction": true,
  "possibleMatcherExecutors": [
    {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example"
    }
  ],
  "startDate": null,
  "tariffMatrixParams": {
    "isWhoFirst": true,
    "tariffMatrixIds": [
      {
        "tariffMatrixId": "example"
      }
    ]
  },
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5,
  "vatInPriceNotConsider": true
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "allowMultimodal": true,
  "amount": 0.5,
  "auctionType": "example",
  "autoExtension": true,
  "autoExtensionActive": 0,
  "autoExtensionDuration": 0,
  "autoExtensionTime": 0,
  "autoSelection": true,
  "bargainingIsPossible": true,
  "bidStep": 0.5,
  "buyNowPrice": 0.5,
  "currency": "example",
  "decreaseOnly": true,
  "decreaseOnlyFromDeclaredPrice": true,
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "hideBidsFromCarrier": true,
  "isDirect": true,
  "isOpenAuction": true,
  "possibleMatcherExecutors": [
    {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example"
    }
  ],
  "startDate": null,
  "tariffMatrixParams": {
    "isWhoFirst": true,
    "tariffMatrixIds": [
      {}
    ]
  },
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5,
  "vatInPriceNotConsider": true
}

basicConditionsTemplateId

Type: string | null

Example: example

bodyType

Type: string[] | null

Тип кузова.

Example
[
  "example"
]

cancelComment

Type: string[] | null

Example
[
  "example"
]

cancelReasonKey

Type: string | null

Example: example

cargoComment

Type: string | null

Example: example

cargoId

Type: string | null

Example: example

carHeadInfos

Type: OrdersV0TransferOrderGetFlatForCustomerCarInfo[] | null

Example
[
  {
    "bodyType": "example",
    "brand": "example",
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "palletCount": 0,
    "type": "example",
    "volume": 0.5,
    "width": 0.5
  }
]

demandId

Type: string | null

Id аукциона. Каждый раз когда заказ отправляется на торги появляется новый идентификатор аукциона.

Example: example

deprecatedAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

dimensions
Any of 2 types

Вес и объём.

Example
{
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "pallet_count": 0,
  "palletCount": 0,
  "volume": 0.5,
  "weight": 0.5
}

distribution
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerDistribution

    Example
    {
  "amount": 0.5,
  "comment": "example",
  "currency": "example",
  "dayDocClose": 0,
  "dayDocDelay": 0,
  "docFormat": "example",
  "groupsId": [
    "example"
  ],
  "partners": [
    {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example",
      "uniqueTemplateId": "example"
    }
  ],
  "publicMatcher": true,
  "type": "example",
  "typeDocClose": "example",
  "typeDocDelay": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Тип опредения исполнителя.

Example
{
  "amount": 0.5,
  "comment": "example",
  "currency": "example",
  "dayDocClose": 0,
  "dayDocDelay": 0,
  "docFormat": "example",
  "groupsId": [
    "example"
  ],
  "partners": [
    {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example",
      "uniqueTemplateId": "example"
    }
  ],
  "publicMatcher": true,
  "type": "example",
  "typeDocClose": "example",
  "typeDocDelay": "example"
}

drivers

Type: OrdersV0TransferOrderGetFlatForCustomerDriverInfo[] | null

Example
[
  {
    "id": "example",
    "isActual": true,
    "masked_phone": "example",
    "name": "example"
  }
]

execOrder
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerExecOrder

    Example
    {
  "allowChangeWithoutConsentForExec": true,
  "allowChangeWithoutConsentForFwd": true,
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "currency": "example",
  "execFinalPrice": 0.5,
  "execPrice": 0.5,
  "execPriceSrc": "example",
  "execPriceVersion": "example",
  "execVat": 0.5,
  "id": "example",
  "isVatPayer": true,
  "settedAt": null,
  "updatedAt": null
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "allowChangeWithoutConsentForExec": true,
  "allowChangeWithoutConsentForFwd": true,
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "currency": "example",
  "execFinalPrice": 0.5,
  "execPrice": 0.5,
  "execPriceSrc": "example",
  "execPriceVersion": "example",
  "execVat": 0.5,
  "id": "example",
  "isVatPayer": true,
  "settedAt": null,
  "updatedAt": null
}

execOrderId

Type: string | null

Идентификатор исполнения. Каждый раз когда у заказа меняется исполнитель будет содан новый идентификатор. По сути это договор на перевозку

Example: example

execResponsibleLogistician
Any of 2 types

  • Type: TimestampTZOutputContact

    Example
    {
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

executionPrice
Any of 2 types
Example
{
  "notVATPayer": true,
  "priceFinal": 0.5,
  "priceVAT": 0.5,
  "priceWOVAT": 0.5,
  "vat": 0.5
}

executionSettings
Any of 2 types

Дополнительные настройки исполнения заказа

Example
{
  "driverAssignmentDeadline": {
    "duration": 0,
    "endDate": {}
  }
}

executor
Any of 2 types
Example
{
  "id": "example",
  "isInBlackList": true,
  "isUnverified": true,
  "name": "example",
  "tin": "example"
}

executorConditionsTemplate
Any of 2 types

-- Содержит реквизиты шаблона, актуального для победителя (уникальный / базовый / системный)

Example
{
  "id": "example",
  "type": "example"
}

executorViews

Type: OrdersV0TransferOrderGetFlatForCustomerExecutorView[] | null

Example
[
  {
    "executorId": "example",
    "name": "example",
    "tin": "example"
  }
]

files

Type: OrdersV0TransferOrderGetFlatForCustomerFileMeta[] | null

Example
[
  {
    "createdAt": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "fileId": "example",
    "fileName": "example"
  }
]

flightCreator
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerFlightCreator

    Example
    {
  "car": {
    "bodyType": "example",
    "brand": "example",
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "palletCount": 0,
    "type": "example",
    "volume": 0.5,
    "width": 0.5
  },
  "comment": "example",
  "companyInfo": {
    "companyName": "example",
    "companyType": "example",
    "country": "example",
    "email": "example",
    "fullName": "example",
    "phone": "example",
    "tin": "example"
  },
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "driver": {
    "id": "example",
    "isActual": true,
    "masked_phone": "example",
    "name": "example"
  },
  "externalFlightId": "example",
  "flightName": "example",
  "isVatPayer": true,
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "trailer": null,
  "vat": 0.5,
  "willNotCarryMyself": true
}

  • Type: object | null

    Const: null

    Example
    {}

Создатель рейса

Example
{
  "car": {
    "bodyType": "example",
    "brand": "example",
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "palletCount": 0,
    "type": "example",
    "volume": 0.5,
    "width": 0.5
  },
  "comment": "example",
  "companyInfo": {
    "companyName": "example",
    "companyType": "example",
    "country": "example",
    "email": "example",
    "fullName": "example",
    "phone": "example",
    "tin": "example"
  },
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "driver": {
    "id": "example",
    "isActual": true,
    "masked_phone": "example",
    "name": "example"
  },
  "externalFlightId": "example",
  "flightName": "example",
  "isVatPayer": true,
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "trailer": null,
  "vat": 0.5,
  "willNotCarryMyself": true
}

freeTagsInfo

Type: OrdersV0TransferOrderGetFlatForCustomerTag[] | null

Теги заказчика

Example
[
  {
    "id": "example",
    "name": "example"
  }
]

fwdResponsibleLogistician
Any of 2 types

  • Type: TimestampTZOutputContact

    Example
    {
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

latestRevokeOnExecute
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

latestSendOnExecute
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

latestSendOnMatcher
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

latestWinnerAssigned
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

matcher
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerMatcher

    Example
    {
  "bestBet": {
    "betComment": "example",
    "betMultimodal": {
      "isPriceByArc": true,
      "route": [
        null
      ]
    },
    "cancelDate": {
      "contact": null,
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "cancelExecutorComment": "example",
    "cancelForwarderComment": "example",
    "comment": "example",
    "condition": "example",
    "executor": {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example"
    },
    "finalPrice": 0.5,
    "id": "example",
    "isCanceled": true,
    "isCanceledByForwarder": true,
    "isOpenMarket": true,
    "isWinner": true,
    "notVatPayer": true,
    "price": 0.5,
    "setDate": null,
    "tariffMatrix": {
      "tariffMatrixId": "example"
    },
    "taxablePrice": {
      "base": "100.18",
      "currency": "RUB",
      "isVatPayer": false,
      "subTotalPrice": "122.21",
      "vat": "22",
      "vatAmount": "22.03"
    },
    "useMultimodal": true,
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatAmount": 0.5
  },
  "bestBetOpenAuction": null,
  "bets": [
    null
  ],
  "canSelectWinner": true,
  "demandId": "example",
  "lastBet": null,
  "lastBetOpenAuction": null,
  "matcherAuction": {
    "actualEndDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "allowMultimodal": true,
    "amount": 0.5,
    "auctionType": "example",
    "autoExtension": true,
    "autoExtensionActive": 0,
    "autoExtensionCount": 0,
    "autoExtensionDuration": 0,
    "autoExtensionTime": 0,
    "autoSelection": true,
    "bargainingIsPossible": true,
    "bidStep": 0.5,
    "buyNowPrice": 0.5,
    "currency": "example",
    "decreaseOnly": true,
    "decreaseOnlyFromDeclaredPrice": true,
    "duration": 0,
    "endDate": null,
    "hideBidsFromCarrier": true,
    "isDirect": true,
    "isOpenAuction": true,
    "possibleMatcherExecutors": [
      null
    ],
    "prolongationDatetimeMax": null,
    "startDate": null,
    "tariffMatrixParams": {
      "isWhoFirst": true,
      "tariffMatrixInfos": [
        {}
      ]
    },
    "timeLeftUntilEnd": 0,
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatAmount": 0.5,
    "vatInPriceNotConsider": true
  },
  "matcherStatus": "example",
  "refuseByExecuterAt": null,
  "refuseByExecuterReason": "example",
  "winBet": null,
  "winnerExecutor": null
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "bestBet": {
    "betComment": "example",
    "betMultimodal": {},
    "cancelDate": {},
    "cancelExecutorComment": "example",
    "cancelForwarderComment": "example",
    "comment": "example",
    "condition": "example",
    "executor": {
      "id": "example",
      "isInBlackList": true,
      "isUnverified": true,
      "name": "example",
      "tin": "example"
    },
    "finalPrice": 0.5,
    "id": "example",
    "isCanceled": true,
    "isCanceledByForwarder": true,
    "isOpenMarket": true,
    "isWinner": true,
    "notVatPayer": true,
    "price": 0.5,
    "setDate": null,
    "tariffMatrix": {},
    "taxablePrice": {
      "base": "100.18",
      "currency": "RUB",
      "isVatPayer": false,
      "subTotalPrice": "122.21",
      "vat": "22",
      "vatAmount": "22.03"
    },
    "useMultimodal": true,
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatAmount": 0.5
  },
  "bestBetOpenAuction": null,
  "bets": [
    null
  ],
  "canSelectWinner": true,
  "demandId": "example",
  "lastBet": null,
  "lastBetOpenAuction": null,
  "matcherAuction": {
    "actualEndDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "allowMultimodal": true,
    "amount": 0.5,
    "auctionType": "example",
    "autoExtension": true,
    "autoExtensionActive": 0,
    "autoExtensionCount": 0,
    "autoExtensionDuration": 0,
    "autoExtensionTime": 0,
    "autoSelection": true,
    "bargainingIsPossible": true,
    "bidStep": 0.5,
    "buyNowPrice": 0.5,
    "currency": "example",
    "decreaseOnly": true,
    "decreaseOnlyFromDeclaredPrice": true,
    "duration": 0,
    "endDate": null,
    "hideBidsFromCarrier": true,
    "isDirect": true,
    "isOpenAuction": true,
    "possibleMatcherExecutors": [
      null
    ],
    "prolongationDatetimeMax": null,
    "startDate": null,
    "tariffMatrixParams": {
      "isWhoFirst": true,
      "tariffMatrixInfos": [
        null
      ]
    },
    "timeLeftUntilEnd": 0,
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatAmount": 0.5,
    "vatInPriceNotConsider": true
  },
  "matcherStatus": "example",
  "refuseByExecuterAt": null,
  "refuseByExecuterReason": "example",
  "winBet": null,
  "winnerExecutor": null
}

orderExternalID

Type: string | null

Название или номер заказа в вашей системе нутрений. Не отображается в интерфейсе

Example: example

orderWay
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerOrderWay

    Example
    {
  "archivedAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "createdAt": null,
  "distanceKilometers": 0.5,
  "generationType": "example",
  "id": "example",
  "updatedAt": null,
  "visits": [
    {
      "actions": [
        {
          "actionId": "example",
          "actionType": "example",
          "orderInVisit": 0,
          "relation": null
        }
      ],
      "endAt": null,
      "id": "example",
      "orderInWay": 0,
      "startAt": null,
      "wayPoint": {
        "address": "example",
        "addressComment": "example",
        "id": "example",
        "lat": 0.5,
        "locality": "example",
        "long": 0.5,
        "name": "example",
        "province": "example",
        "tin": "example"
      }
    }
  ]
}

  • Type: object | null

    Const: null

    Example
    {}

Версия связанного маршрута заказа. Заполняется асинхронно, может ссылаться на заархивированную версию

Example
{
  "archivedAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "createdAt": null,
  "distanceKilometers": 0.5,
  "generationType": "example",
  "id": "example",
  "updatedAt": null,
  "visits": [
    {
      "actions": [
        {}
      ],
      "endAt": null,
      "id": "example",
      "orderInWay": 0,
      "startAt": null,
      "wayPoint": {}
    }
  ]
}

parentId

Type: string | null

Example: example

paymentDelayPeriod
Any of 2 types

Отсрочка платежа.

Example
{
  "daysDelayPeriod": 0,
  "paymentType": "example",
  "postPayCalendarType": "example"
}

responsibleCustomer
Any of 2 types

  • Type: TimestampTZOutputContact

    Example
    {
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

rootId

Type: string | null

Example: example

shipments

Type: OrdersV0TransferOrderGetFlatForCustomerShipment[] | null

Example
[
  {
    "comment": "example",
    "distributionPriority": 0,
    "executorRequirementId": "example",
    "executorRequirementShipmentId": "example",
    "flightInfo": {
      "arrivalLoadingAt": {},
      "arrivalUnloadingAt": null,
      "canSetCar": true,
      "canSetDriver": true,
      "canSetStatus": true,
      "carHeadInfo": {},
      "departureLoadingAt": null,
      "departureUnloadingAt": null,
      "driverInfo": {},
      "endLoadingAt": null,
      "endUnloadingAt": null,
      "externalExecutor": {},
      "flightId": "example",
      "flightStatus": "example",
      "flightTaskId": "example",
      "flightTaskStatus": "example",
      "goToTheLoadingAt": null,
      "loadingOrder": 0,
      "responsibleLogistician": {},
      "startLoadingAt": null,
      "startUnloadingAt": null,
      "subStatus": "example",
      "trailerInfo": null,
      "unloadingOrder": 0
    },
    "flightTaskId": "example",
    "isDeleted": true,
    "name": "example",
    "npShipment": {
      "addressComment": "example",
      "content": "example",
      "country": "example",
      "id": "example",
      "legalAddress": "example",
      "legalPhone": "example",
      "name": "example",
      "npAdditionalContact": [
        {
          "id": "example",
          "npcCountry": "example",
          "npcEmail": "example",
          "npcExternalId": "example",
          "npcName": "example",
          "npcPhone": "example"
        }
      ],
      "npGeoAddress": {
        "address": "example",
        "lat": 0.5,
        "locality": "example",
        "long": 0.5,
        "npAddress": null,
        "province": "example"
      },
      "npGeoLegalAddress": null,
      "npLegalType": "example",
      "npShipmentId": "example",
      "npTin": "example",
      "period": {
        "from": {},
        "to": null
      },
      "position": 0,
      "sequenceOrder": 0,
      "transshipmentTypes": [
        "example"
      ]
    },
    "npShipmentId": "example",
    "npUnshipment": null,
    "packageType": "example",
    "packages": [
      {
        "amount": 0.5,
        "capacity": 0.5,
        "cargoCategory": {},
        "comment": "example",
        "count": 0,
        "currency": "example",
        "dimensionHeight": 0.5,
        "dimensionLength": 0.5,
        "dimensionWeight": 0.5,
        "executorRequirementPackageId": "example",
        "hazardClass": "example",
        "isDeleted": true,
        "packageExternalId": "example",
        "packageId": "example",
        "packageName": "example",
        "requirementPackageId": "example",
        "ruEdo": {},
        "shipmentBodyType": "example",
        "stackability": "example",
        "temperatureRegime": [
          {}
        ],
        "weight": 0.5
      }
    ],
    "quantizationMethod": "example",
    "requirementId": "example",
    "requirementShipmentId": "example",
    "shipmentExternalID": "example",
    "shipmentId": "example",
    "status": "example",
    "taskStatus": "example",
    "transferOrderTaskID": "example"
  }
]

systemConditionsTemplateId

Type: string | null

Example: example

tag
Any of 2 types
Example
{
  "id": "example",
  "name": "example"
}

temperatureRegime

Type: OrdersV0TransferOrderGetFlatForCustomerTemperatureRegime[] | null

Температурный режим.

Example
[
  {
    "from": 0,
    "to": 0
  }
]

trailerInfos

Type: OrdersV0TransferOrderGetFlatForCustomerCarInfo[] | null

Example
[
  {
    "bodyType": "example",
    "brand": "example",
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "palletCount": 0,
    "type": "example",
    "volume": 0.5,
    "width": 0.5
  }
]

transferOrderAdditionalConditions

Type: string | null

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

Example: example

transferOrderCost
Any of 2 types

Стоимость заказа.

Example
{
  "currency": "example",
  "price": 0.5
}

transferOrderName

Type: string | null

Отображаемое имя заказа на перевозку.

Example: example

transshipmentTypes

Type: string[] | null

Тип загрузки и выгрузки.

Example
[
  "example"
]

typePaymentAndTax

Type: string | null

Тип оплаты платежа.

Example: example

utm
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerUTM

    Example
    {
  "utmCampaign": "example",
  "utmContent": "example",
  "utmMedium": "example",
  "utmSource": "example",
  "utmTerm": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Utm информация.

Example
{
  "utmCampaign": "example",
  "utmContent": "example",
  "utmMedium": "example",
  "utmSource": "example",
  "utmTerm": "example"
}

volumeDemand
Any of 2 types

  • Type: OrdersV0TransferOrderGetFlatForCustomerVolumeDemand

    Example
    {
  "actualEndDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "isOpenAuction": true,
  "offersCount": 0,
  "status": "example",
  "uniqueOrganizationsCount": 0,
  "volumeAuction": {
    "auctionType": "example",
    "duration": 0,
    "endDate": null,
    "flightsCount": 0.5,
    "startDate": null,
    "tarifficationType": "example",
    "tonsCount": 0.5,
    "transitDistance": 0.5,
    "vehicleCapacityFrom": 0.5,
    "vehicleCapacityTo": 0.5
  },
  "volumeAuctionId": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "actualEndDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "isOpenAuction": true,
  "offersCount": 0,
  "status": "example",
  "uniqueOrganizationsCount": 0,
  "volumeAuction": {
    "auctionType": "example",
    "duration": 0,
    "endDate": null,
    "flightsCount": 0.5,
    "startDate": null,
    "tarifficationType": "example",
    "tonsCount": 0.5,
    "transitDistance": 0.5,
    "vehicleCapacityFrom": 0.5,
    "vehicleCapacityTo": 0.5
  },
  "volumeAuctionId": "example"
}
Example
{
  "additionalConditions": {
    "additionalComment": "example",
    "currency": "example",
    "documentsDelay": {
      "daysTypeAfterDocuments": "example",
      "daysTypeBeforeDocuments": "example",
      "delayAfterDocuments": 0,
      "delayBeforeDocuments": 0
    },
    "emails": [
      "example"
    ],
    "externalOrderID": "example",
    "fullName": "example",
    "isVatPayer": true,
    "phones": [
      "example"
    ],
    "price": 0.5,
    "priceComment": "example",
    "priceWithVat": 0.5,
    "specifyConditions": true,
    "vat": 0.5
  },
  "agreementRules": {
    "isDriverCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangeShipmentsWithoutApproval": true,
    "isForwarderCanChangePackagesWithoutApproval": true,
    "isForwarderCanChangeShipmentsWithoutApproval": true,
    "isWarehouseCanChangePackagesWithoutApproval": true
  },
  "alerts": [
    {
      "alertType": "example",
      "description": "example"
    }
  ],
  "auction": {
    "allowMultimodal": true,
    "amount": 0.5,
    "auctionType": "example",
    "autoExtension": true,
    "autoExtensionActive": 0,
    "autoExtensionDuration": 0,
    "autoExtensionTime": 0,
    "autoSelection": true,
    "bargainingIsPossible": true,
    "bidStep": 0.5,
    "buyNowPrice": 0.5,
    "currency": "example",
    "decreaseOnly": true,
    "decreaseOnlyFromDeclaredPrice": true,
    "duration": 0,
    "endDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "hideBidsFromCarrier": true,
    "isDirect": true,
    "isOpenAuction": true,
    "possibleMatcherExecutors": [
      {
        "id": "example",
        "isInBlackList": true,
        "isUnverified": true,
        "name": "example",
        "tin": "example"
      }
    ],
    "startDate": null,
    "tariffMatrixParams": {
      "isWhoFirst": true,
      "tariffMatrixIds": [
        null
      ]
    },
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatAmount": 0.5,
    "vatInPriceNotConsider": true
  },
  "basicConditionsTemplateId": "example",
  "bodyType": [
    "example"
  ],
  "bodyTypeComment": "example",
  "cancelComment": [
    "example"
  ],
  "cancelReasonKey": "example",
  "carHeadInfos": [
    {
      "bodyType": "example",
      "brand": "example",
      "height": 0.5,
      "hydroBort": true,
      "id": "example",
      "length": 0.5,
      "loadCapacity": 0.5,
      "model": "example",
      "number": "example",
      "palletCount": 0,
      "type": "example",
      "volume": 0.5,
      "width": 0.5
    }
  ],
  "cargoCategory": {
    "category": "example",
    "categoryComment": "example"
  },
  "cargoComment": "example",
  "cargoId": "example",
  "created": {
    "contact": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "currency": "example",
  "customer": {
    "customerAddress": "example",
    "customerCargoPrice": 0.5,
    "customerComment": "example",
    "customerCountry": "example",
    "customerForwarderId": "example",
    "customerForwarderTin": "example",
    "customerLegalForm": "example",
    "customerName": "example",
    "customerPhone": "example",
    "customerTin": "example",
    "id": "example"
  },
  "demandId": "example",
  "deprecatedAt": null,
  "dimensions": {
    "breadth": 0.5,
    "height": 0.5,
    "length": 0.5,
    "pallet_count": 0,
    "palletCount": 0,
    "volume": 0.5,
    "weight": 0.5
  },
  "distribution": {
    "amount": 0.5,
    "comment": "example",
    "currency": "example",
    "dayDocClose": 0,
    "dayDocDelay": 0,
    "docFormat": "example",
    "groupsId": [
      "example"
    ],
    "partners": [
      {
        "id": "example",
        "isInBlackList": true,
        "isUnverified": true,
        "name": "example",
        "tin": "example",
        "uniqueTemplateId": "example"
      }
    ],
    "publicMatcher": true,
    "type": "example",
    "typeDocClose": "example",
    "typeDocDelay": "example"
  },
  "drivers": [
    {
      "id": "example",
      "isActual": true,
      "masked_phone": "example",
      "name": "example"
    }
  ],
  "execOrder": {
    "allowChangeWithoutConsentForExec": true,
    "allowChangeWithoutConsentForFwd": true,
    "createdAt": null,
    "currency": "example",
    "execFinalPrice": 0.5,
    "execPrice": 0.5,
    "execPriceSrc": "example",
    "execPriceVersion": "example",
    "execVat": 0.5,
    "id": "example",
    "isVatPayer": true,
    "settedAt": null,
    "updatedAt": null
  },
  "execOrderId": "example",
  "execResponsibleLogistician": null,
  "executionPrice": {
    "notVATPayer": true,
    "priceFinal": 0.5,
    "priceVAT": 0.5,
    "priceWOVAT": 0.5,
    "vat": 0.5
  },
  "executionSettings": {
    "driverAssignmentDeadline": {
      "duration": 0,
      "endDate": null
    }
  },
  "executor": null,
  "executorConditionsTemplate": {
    "id": "example",
    "type": "example"
  },
  "executorViews": [
    {
      "executorId": "example",
      "name": "example",
      "tin": "example"
    }
  ],
  "files": [
    {
      "createdAt": null,
      "fileId": "example",
      "fileName": "example"
    }
  ],
  "flightCreator": {
    "car": null,
    "comment": "example",
    "companyInfo": {
      "companyName": "example",
      "companyType": "example",
      "country": "example",
      "email": "example",
      "fullName": "example",
      "phone": "example",
      "tin": "example"
    },
    "currency": "example",
    "documentsDelay": {
      "daysTypeAfterDocuments": "example",
      "daysTypeBeforeDocuments": "example",
      "delayAfterDocuments": 0,
      "delayBeforeDocuments": 0
    },
    "driver": null,
    "externalFlightId": "example",
    "flightName": "example",
    "isVatPayer": true,
    "price": 0.5,
    "priceComment": "example",
    "priceWithVat": 0.5,
    "trailer": null,
    "vat": 0.5,
    "willNotCarryMyself": true
  },
  "forwarder": {
    "forwarderComment": "example",
    "forwarderId": "example",
    "forwarderName": "example",
    "forwarderTin": "example",
    "isUnverified": true
  },
  "freeTagsInfo": [
    {
      "id": "example",
      "name": "example"
    }
  ],
  "fwdResponsibleLogistician": null,
  "id": "example",
  "isActual": true,
  "isArchived": true,
  "isReadonly": true,
  "isVolumeAuction": true,
  "latestRevokeOnExecute": null,
  "latestSendOnExecute": null,
  "latestSendOnMatcher": null,
  "latestWinnerAssigned": null,
  "matcher": {
    "bestBet": {
      "betComment": "example",
      "betMultimodal": null,
      "cancelDate": null,
      "cancelExecutorComment": "example",
      "cancelForwarderComment": "example",
      "comment": "example",
      "condition": "example",
      "executor": null,
      "finalPrice": 0.5,
      "id": "example",
      "isCanceled": true,
      "isCanceledByForwarder": true,
      "isOpenMarket": true,
      "isWinner": true,
      "notVatPayer": true,
      "price": 0.5,
      "setDate": null,
      "tariffMatrix": null,
      "taxablePrice": {},
      "useMultimodal": true,
      "useTariffMatrix": true,
      "vat": 0.5,
      "vatAmount": 0.5
    },
    "bestBetOpenAuction": null,
    "bets": [
      null
    ],
    "canSelectWinner": true,
    "demandId": "example",
    "lastBet": null,
    "lastBetOpenAuction": null,
    "matcherAuction": {
      "actualEndDate": null,
      "allowMultimodal": true,
      "amount": 0.5,
      "auctionType": "example",
      "autoExtension": true,
      "autoExtensionActive": 0,
      "autoExtensionCount": 0,
      "autoExtensionDuration": 0,
      "autoExtensionTime": 0,
      "autoSelection": true,
      "bargainingIsPossible": true,
      "bidStep": 0.5,
      "buyNowPrice": 0.5,
      "currency": "example",
      "decreaseOnly": true,
      "decreaseOnlyFromDeclaredPrice": true,
      "duration": 0,
      "endDate": null,
      "hideBidsFromCarrier": true,
      "isDirect": true,
      "isOpenAuction": true,
      "possibleMatcherExecutors": [
        null
      ],
      "prolongationDatetimeMax": null,
      "startDate": null,
      "tariffMatrixParams": {},
      "timeLeftUntilEnd": 0,
      "useTariffMatrix": true,
      "vat": 0.5,
      "vatAmount": 0.5,
      "vatInPriceNotConsider": true
    },
    "matcherStatus": "example",
    "refuseByExecuterAt": null,
    "refuseByExecuterReason": "example",
    "winBet": null,
    "winnerExecutor": null
  },
  "maxUpdatedDate": null,
  "orderExternalID": "example",
  "orderWay": {
    "archivedAt": null,
    "createdAt": null,
    "distanceKilometers": 0.5,
    "generationType": "example",
    "id": "example",
    "updatedAt": null,
    "visits": [
      {
        "actions": [
          null
        ],
        "endAt": null,
        "id": "example",
        "orderInWay": 0,
        "startAt": null,
        "wayPoint": null
      }
    ]
  },
  "parentId": "example",
  "paymentDelayPeriod": {
    "daysDelayPeriod": 0,
    "paymentType": "example",
    "postPayCalendarType": "example"
  },
  "responsibleCustomer": null,
  "rootId": "example",
  "shipments": [
    {
      "comment": "example",
      "distributionPriority": 0,
      "executorRequirementId": "example",
      "executorRequirementShipmentId": "example",
      "flightInfo": {
        "arrivalLoadingAt": null,
        "arrivalUnloadingAt": null,
        "canSetCar": true,
        "canSetDriver": true,
        "canSetStatus": true,
        "carHeadInfo": null,
        "departureLoadingAt": null,
        "departureUnloadingAt": null,
        "driverInfo": null,
        "endLoadingAt": null,
        "endUnloadingAt": null,
        "externalExecutor": null,
        "flightId": "example",
        "flightStatus": "example",
        "flightTaskId": "example",
        "flightTaskStatus": "example",
        "goToTheLoadingAt": null,
        "loadingOrder": 0,
        "responsibleLogistician": null,
        "startLoadingAt": null,
        "startUnloadingAt": null,
        "subStatus": "example",
        "trailerInfo": null,
        "unloadingOrder": 0
      },
      "flightTaskId": "example",
      "isDeleted": true,
      "name": "example",
      "npShipment": {
        "addressComment": "example",
        "content": "example",
        "country": "example",
        "id": "example",
        "legalAddress": "example",
        "legalPhone": "example",
        "name": "example",
        "npAdditionalContact": [
          {}
        ],
        "npGeoAddress": null,
        "npGeoLegalAddress": null,
        "npLegalType": "example",
        "npShipmentId": "example",
        "npTin": "example",
        "period": null,
        "position": 0,
        "sequenceOrder": 0,
        "transshipmentTypes": [
          "example"
        ]
      },
      "npShipmentId": "example",
      "npUnshipment": null,
      "packageType": "example",
      "packages": [
        {
          "amount": 0.5,
          "capacity": 0.5,
          "cargoCategory": null,
          "comment": "example",
          "count": 0,
          "currency": "example",
          "dimensionHeight": 0.5,
          "dimensionLength": 0.5,
          "dimensionWeight": 0.5,
          "executorRequirementPackageId": "example",
          "hazardClass": "example",
          "isDeleted": true,
          "packageExternalId": "example",
          "packageId": "example",
          "packageName": "example",
          "requirementPackageId": "example",
          "ruEdo": null,
          "shipmentBodyType": "example",
          "stackability": "example",
          "temperatureRegime": [
            null
          ],
          "weight": 0.5
        }
      ],
      "quantizationMethod": "example",
      "requirementId": "example",
      "requirementShipmentId": "example",
      "shipmentExternalID": "example",
      "shipmentId": "example",
      "status": "example",
      "taskStatus": "example",
      "transferOrderTaskID": "example"
    }
  ],
  "status": "example",
  "systemConditionsTemplateId": "example",
  "tag": null,
  "temperatureRegime": [
    {
      "from": 0,
      "to": 0
    }
  ],
  "trailerInfos": [
    null
  ],
  "transIdentity": "example",
  "transferOrderAdditionalConditions": "example",
  "transferOrderAdditionalConfiguration": {},
  "transferOrderCost": {
    "currency": "example",
    "price": 0.5
  },
  "transferOrderName": "example",
  "transferOrderType": "example",
  "transshipmentTypes": [
    "example"
  ],
  "typePaymentAndTax": "example",
  "updated": null,
  "utm": {
    "utmCampaign": "example",
    "utmContent": "example",
    "utmMedium": "example",
    "utmSource": "example",
    "utmTerm": "example"
  },
  "volumeDemand": {
    "actualEndDate": null,
    "isOpenAuction": true,
    "offersCount": 0,
    "status": "example",
    "uniqueOrganizationsCount": 0,
    "volumeAuction": {
      "auctionType": "example",
      "duration": 0,
      "endDate": null,
      "flightsCount": 0.5,
      "startDate": null,
      "tarifficationType": "example",
      "tonsCount": 0.5,
      "transitDistance": 0.5,
      "vehicleCapacityFrom": 0.5,
      "vehicleCapacityTo": 0.5
    },
    "volumeAuctionId": "example"
  }
}

OrdersV0TransferOrderGetFlatForCustomerResponse

Name

Description

orders

Type: OrdersV0TransferOrderGetFlatForCustomerOrder[] | null

Example
[
  {
    "additionalConditions": {
      "additionalComment": "example",
      "currency": "example",
      "documentsDelay": {},
      "emails": [
        "example"
      ],
      "externalOrderID": "example",
      "fullName": "example",
      "isVatPayer": true,
      "phones": [
        "example"
      ],
      "price": 0.5,
      "priceComment": "example",
      "priceWithVat": 0.5,
      "specifyConditions": true,
      "vat": 0.5
    },
    "agreementRules": {
      "isDriverCanChangePackagesWithoutApproval": true,
      "isExecutorCanChangePackagesWithoutApproval": true,
      "isExecutorCanChangeShipmentsWithoutApproval": true,
      "isForwarderCanChangePackagesWithoutApproval": true,
      "isForwarderCanChangeShipmentsWithoutApproval": true,
      "isWarehouseCanChangePackagesWithoutApproval": true
    },
    "alerts": [
      {
        "alertType": "example",
        "description": "example"
      }
    ],
    "auction": {
      "allowMultimodal": true,
      "amount": 0.5,
      "auctionType": "example",
      "autoExtension": true,
      "autoExtensionActive": 0,
      "autoExtensionDuration": 0,
      "autoExtensionTime": 0,
      "autoSelection": true,
      "bargainingIsPossible": true,
      "bidStep": 0.5,
      "buyNowPrice": 0.5,
      "currency": "example",
      "decreaseOnly": true,
      "decreaseOnlyFromDeclaredPrice": true,
      "duration": 0,
      "endDate": {},
      "hideBidsFromCarrier": true,
      "isDirect": true,
      "isOpenAuction": true,
      "possibleMatcherExecutors": [
        {}
      ],
      "startDate": null,
      "tariffMatrixParams": {},
      "useTariffMatrix": true,
      "vat": 0.5,
      "vatAmount": 0.5,
      "vatInPriceNotConsider": true
    },
    "basicConditionsTemplateId": "example",
    "bodyType": [
      "example"
    ],
    "bodyTypeComment": "example",
    "cancelComment": [
      "example"
    ],
    "cancelReasonKey": "example",
    "carHeadInfos": [
      {
        "bodyType": "example",
        "brand": "example",
        "height": 0.5,
        "hydroBort": true,
        "id": "example",
        "length": 0.5,
        "loadCapacity": 0.5,
        "model": "example",
        "number": "example",
        "palletCount": 0,
        "type": "example",
        "volume": 0.5,
        "width": 0.5
      }
    ],
    "cargoCategory": {
      "category": "example",
      "categoryComment": "example"
    },
    "cargoComment": "example",
    "cargoId": "example",
    "created": {
      "contact": {
        "name": "example",
        "orgId": "example",
        "orgName": "example",
        "orgTin": "example",
        "publicEmail": "example",
        "publicPhone": "example",
        "type": "example",
        "value": "example"
      },
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "currency": "example",
    "customer": {
      "customerAddress": "example",
      "customerCargoPrice": 0.5,
      "customerComment": "example",
      "customerCountry": "example",
      "customerForwarderId": "example",
      "customerForwarderTin": "example",
      "customerLegalForm": "example",
      "customerName": "example",
      "customerPhone": "example",
      "customerTin": "example",
      "id": "example"
    },
    "demandId": "example",
    "deprecatedAt": null,
    "dimensions": {
      "breadth": 0.5,
      "height": 0.5,
      "length": 0.5,
      "pallet_count": 0,
      "palletCount": 0,
      "volume": 0.5,
      "weight": 0.5
    },
    "distribution": {
      "amount": 0.5,
      "comment": "example",
      "currency": "example",
      "dayDocClose": 0,
      "dayDocDelay": 0,
      "docFormat": "example",
      "groupsId": [
        "example"
      ],
      "partners": [
        {}
      ],
      "publicMatcher": true,
      "type": "example",
      "typeDocClose": "example",
      "typeDocDelay": "example"
    },
    "drivers": [
      {
        "id": "example",
        "isActual": true,
        "masked_phone": "example",
        "name": "example"
      }
    ],
    "execOrder": {
      "allowChangeWithoutConsentForExec": true,
      "allowChangeWithoutConsentForFwd": true,
      "createdAt": null,
      "currency": "example",
      "execFinalPrice": 0.5,
      "execPrice": 0.5,
      "execPriceSrc": "example",
      "execPriceVersion": "example",
      "execVat": 0.5,
      "id": "example",
      "isVatPayer": true,
      "settedAt": null,
      "updatedAt": null
    },
    "execOrderId": "example",
    "execResponsibleLogistician": null,
    "executionPrice": {
      "notVATPayer": true,
      "priceFinal": 0.5,
      "priceVAT": 0.5,
      "priceWOVAT": 0.5,
      "vat": 0.5
    },
    "executionSettings": {
      "driverAssignmentDeadline": {}
    },
    "executor": null,
    "executorConditionsTemplate": {
      "id": "example",
      "type": "example"
    },
    "executorViews": [
      {
        "executorId": "example",
        "name": "example",
        "tin": "example"
      }
    ],
    "files": [
      {
        "createdAt": null,
        "fileId": "example",
        "fileName": "example"
      }
    ],
    "flightCreator": {
      "car": null,
      "comment": "example",
      "companyInfo": {},
      "currency": "example",
      "documentsDelay": {},
      "driver": null,
      "externalFlightId": "example",
      "flightName": "example",
      "isVatPayer": true,
      "price": 0.5,
      "priceComment": "example",
      "priceWithVat": 0.5,
      "trailer": null,
      "vat": 0.5,
      "willNotCarryMyself": true
    },
    "forwarder": {
      "forwarderComment": "example",
      "forwarderId": "example",
      "forwarderName": "example",
      "forwarderTin": "example",
      "isUnverified": true
    },
    "freeTagsInfo": [
      {
        "id": "example",
        "name": "example"
      }
    ],
    "fwdResponsibleLogistician": null,
    "id": "example",
    "isActual": true,
    "isArchived": true,
    "isReadonly": true,
    "isVolumeAuction": true,
    "latestRevokeOnExecute": null,
    "latestSendOnExecute": null,
    "latestSendOnMatcher": null,
    "latestWinnerAssigned": null,
    "matcher": {
      "bestBet": {},
      "bestBetOpenAuction": null,
      "bets": [
        null
      ],
      "canSelectWinner": true,
      "demandId": "example",
      "lastBet": null,
      "lastBetOpenAuction": null,
      "matcherAuction": {
        "actualEndDate": null,
        "allowMultimodal": true,
        "amount": 0.5,
        "auctionType": "example",
        "autoExtension": true,
        "autoExtensionActive": 0,
        "autoExtensionCount": 0,
        "autoExtensionDuration": 0,
        "autoExtensionTime": 0,
        "autoSelection": true,
        "bargainingIsPossible": true,
        "bidStep": 0.5,
        "buyNowPrice": 0.5,
        "currency": "example",
        "decreaseOnly": true,
        "decreaseOnlyFromDeclaredPrice": true,
        "duration": 0,
        "endDate": null,
        "hideBidsFromCarrier": true,
        "isDirect": true,
        "isOpenAuction": true,
        "possibleMatcherExecutors": [
          null
        ],
        "prolongationDatetimeMax": null,
        "startDate": null,
        "tariffMatrixParams": null,
        "timeLeftUntilEnd": 0,
        "useTariffMatrix": true,
        "vat": 0.5,
        "vatAmount": 0.5,
        "vatInPriceNotConsider": true
      },
      "matcherStatus": "example",
      "refuseByExecuterAt": null,
      "refuseByExecuterReason": "example",
      "winBet": null,
      "winnerExecutor": null
    },
    "maxUpdatedDate": null,
    "orderExternalID": "example",
    "orderWay": {
      "archivedAt": null,
      "createdAt": null,
      "distanceKilometers": 0.5,
      "generationType": "example",
      "id": "example",
      "updatedAt": null,
      "visits": [
        {}
      ]
    },
    "parentId": "example",
    "paymentDelayPeriod": {
      "daysDelayPeriod": 0,
      "paymentType": "example",
      "postPayCalendarType": "example"
    },
    "responsibleCustomer": null,
    "rootId": "example",
    "shipments": [
      {
        "comment": "example",
        "distributionPriority": 0,
        "executorRequirementId": "example",
        "executorRequirementShipmentId": "example",
        "flightInfo": {},
        "flightTaskId": "example",
        "isDeleted": true,
        "name": "example",
        "npShipment": {
          "addressComment": "example",
          "content": "example",
          "country": "example",
          "id": "example",
          "legalAddress": "example",
          "legalPhone": "example",
          "name": "example",
          "npAdditionalContact": [
            null
          ],
          "npGeoAddress": null,
          "npGeoLegalAddress": null,
          "npLegalType": "example",
          "npShipmentId": "example",
          "npTin": "example",
          "period": null,
          "position": 0,
          "sequenceOrder": 0,
          "transshipmentTypes": [
            null
          ]
        },
        "npShipmentId": "example",
        "npUnshipment": null,
        "packageType": "example",
        "packages": [
          {}
        ],
        "quantizationMethod": "example",
        "requirementId": "example",
        "requirementShipmentId": "example",
        "shipmentExternalID": "example",
        "shipmentId": "example",
        "status": "example",
        "taskStatus": "example",
        "transferOrderTaskID": "example"
      }
    ],
    "status": "example",
    "systemConditionsTemplateId": "example",
    "tag": null,
    "temperatureRegime": [
      {
        "from": 0,
        "to": 0
      }
    ],
    "trailerInfos": [
      null
    ],
    "transIdentity": "example",
    "transferOrderAdditionalConditions": "example",
    "transferOrderAdditionalConfiguration": {},
    "transferOrderCost": {
      "currency": "example",
      "price": 0.5
    },
    "transferOrderName": "example",
    "transferOrderType": "example",
    "transshipmentTypes": [
      "example"
    ],
    "typePaymentAndTax": "example",
    "updated": null,
    "utm": {
      "utmCampaign": "example",
      "utmContent": "example",
      "utmMedium": "example",
      "utmSource": "example",
      "utmTerm": "example"
    },
    "volumeDemand": {
      "actualEndDate": null,
      "isOpenAuction": true,
      "offersCount": 0,
      "status": "example",
      "uniqueOrganizationsCount": 0,
      "volumeAuction": {
        "auctionType": "example",
        "duration": 0,
        "endDate": null,
        "flightsCount": 0.5,
        "startDate": null,
        "tarifficationType": "example",
        "tonsCount": 0.5,
        "transitDistance": 0.5,
        "vehicleCapacityFrom": 0.5,
        "vehicleCapacityTo": 0.5
      },
      "volumeAuctionId": "example"
    }
  }
]
Example
{
  "orders": [
    {
      "additionalConditions": {
        "additionalComment": "example",
        "currency": "example",
        "documentsDelay": null,
        "emails": [
          null
        ],
        "externalOrderID": "example",
        "fullName": "example",
        "isVatPayer": true,
        "phones": [
          null
        ],
        "price": 0.5,
        "priceComment": "example",
        "priceWithVat": 0.5,
        "specifyConditions": true,
        "vat": 0.5
      },
      "agreementRules": {
        "isDriverCanChangePackagesWithoutApproval": true,
        "isExecutorCanChangePackagesWithoutApproval": true,
        "isExecutorCanChangeShipmentsWithoutApproval": true,
        "isForwarderCanChangePackagesWithoutApproval": true,
        "isForwarderCanChangeShipmentsWithoutApproval": true,
        "isWarehouseCanChangePackagesWithoutApproval": true
      },
      "alerts": [
        {
          "alertType": "example",
          "description": "example"
        }
      ],
      "auction": {
        "allowMultimodal": true,
        "amount": 0.5,
        "auctionType": "example",
        "autoExtension": true,
        "autoExtensionActive": 0,
        "autoExtensionDuration": 0,
        "autoExtensionTime": 0,
        "autoSelection": true,
        "bargainingIsPossible": true,
        "bidStep": 0.5,
        "buyNowPrice": 0.5,
        "currency": "example",
        "decreaseOnly": true,
        "decreaseOnlyFromDeclaredPrice": true,
        "duration": 0,
        "endDate": null,
        "hideBidsFromCarrier": true,
        "isDirect": true,
        "isOpenAuction": true,
        "possibleMatcherExecutors": [
          null
        ],
        "startDate": null,
        "tariffMatrixParams": null,
        "useTariffMatrix": true,
        "vat": 0.5,
        "vatAmount": 0.5,
        "vatInPriceNotConsider": true
      },
      "basicConditionsTemplateId": "example",
      "bodyType": [
        "example"
      ],
      "bodyTypeComment": "example",
      "cancelComment": [
        "example"
      ],
      "cancelReasonKey": "example",
      "carHeadInfos": [
        {
          "bodyType": "example",
          "brand": "example",
          "height": 0.5,
          "hydroBort": true,
          "id": "example",
          "length": 0.5,
          "loadCapacity": 0.5,
          "model": "example",
          "number": "example",
          "palletCount": 0,
          "type": "example",
          "volume": 0.5,
          "width": 0.5
        }
      ],
      "cargoCategory": {
        "category": "example",
        "categoryComment": "example"
      },
      "cargoComment": "example",
      "cargoId": "example",
      "created": {
        "contact": {},
        "displayTZ": "+03:00",
        "time": "2020-01-01T00:00:00"
      },
      "currency": "example",
      "customer": {
        "customerAddress": "example",
        "customerCargoPrice": 0.5,
        "customerComment": "example",
        "customerCountry": "example",
        "customerForwarderId": "example",
        "customerForwarderTin": "example",
        "customerLegalForm": "example",
        "customerName": "example",
        "customerPhone": "example",
        "customerTin": "example",
        "id": "example"
      },
      "demandId": "example",
      "deprecatedAt": {
        "displayTZ": "+03:00",
        "time": "2020-01-01T00:00:00"
      },
      "dimensions": {
        "breadth": 0.5,
        "height": 0.5,
        "length": 0.5,
        "pallet_count": 0,
        "palletCount": 0,
        "volume": 0.5,
        "weight": 0.5
      },
      "distribution": {
        "amount": 0.5,
        "comment": "example",
        "currency": "example",
        "dayDocClose": 0,
        "dayDocDelay": 0,
        "docFormat": "example",
        "groupsId": [
          null
        ],
        "partners": [
          null
        ],
        "publicMatcher": true,
        "type": "example",
        "typeDocClose": "example",
        "typeDocDelay": "example"
      },
      "drivers": [
        {
          "id": "example",
          "isActual": true,
          "masked_phone": "example",
          "name": "example"
        }
      ],
      "execOrder": {
        "allowChangeWithoutConsentForExec": true,
        "allowChangeWithoutConsentForFwd": true,
        "createdAt": null,
        "currency": "example",
        "execFinalPrice": 0.5,
        "execPrice": 0.5,
        "execPriceSrc": "example",
        "execPriceVersion": "example",
        "execVat": 0.5,
        "id": "example",
        "isVatPayer": true,
        "settedAt": null,
        "updatedAt": null
      },
      "execOrderId": "example",
      "execResponsibleLogistician": null,
      "executionPrice": {
        "notVATPayer": true,
        "priceFinal": 0.5,
        "priceVAT": 0.5,
        "priceWOVAT": 0.5,
        "vat": 0.5
      },
      "executionSettings": {
        "driverAssignmentDeadline": null
      },
      "executor": {
        "id": "example",
        "isInBlackList": true,
        "isUnverified": true,
        "name": "example",
        "tin": "example"
      },
      "executorConditionsTemplate": {
        "id": "example",
        "type": "example"
      },
      "executorViews": [
        {
          "executorId": "example",
          "name": "example",
          "tin": "example"
        }
      ],
      "files": [
        {
          "createdAt": null,
          "fileId": "example",
          "fileName": "example"
        }
      ],
      "flightCreator": {
        "car": null,
        "comment": "example",
        "companyInfo": null,
        "currency": "example",
        "documentsDelay": null,
        "driver": null,
        "externalFlightId": "example",
        "flightName": "example",
        "isVatPayer": true,
        "price": 0.5,
        "priceComment": "example",
        "priceWithVat": 0.5,
        "trailer": null,
        "vat": 0.5,
        "willNotCarryMyself": true
      },
      "forwarder": {
        "forwarderComment": "example",
        "forwarderId": "example",
        "forwarderName": "example",
        "forwarderTin": "example",
        "isUnverified": true
      },
      "freeTagsInfo": [
        {
          "id": "example",
          "name": "example"
        }
      ],
      "fwdResponsibleLogistician": null,
      "id": "example",
      "isActual": true,
      "isArchived": true,
      "isReadonly": true,
      "isVolumeAuction": true,
      "latestRevokeOnExecute": null,
      "latestSendOnExecute": null,
      "latestSendOnMatcher": null,
      "latestWinnerAssigned": null,
      "matcher": {
        "bestBet": null,
        "bestBetOpenAuction": null,
        "bets": [
          null
        ],
        "canSelectWinner": true,
        "demandId": "example",
        "lastBet": null,
        "lastBetOpenAuction": null,
        "matcherAuction": {},
        "matcherStatus": "example",
        "refuseByExecuterAt": null,
        "refuseByExecuterReason": "example",
        "winBet": null,
        "winnerExecutor": null
      },
      "maxUpdatedDate": null,
      "orderExternalID": "example",
      "orderWay": {
        "archivedAt": null,
        "createdAt": null,
        "distanceKilometers": 0.5,
        "generationType": "example",
        "id": "example",
        "updatedAt": null,
        "visits": [
          null
        ]
      },
      "parentId": "example",
      "paymentDelayPeriod": {
        "daysDelayPeriod": 0,
        "paymentType": "example",
        "postPayCalendarType": "example"
      },
      "responsibleCustomer": null,
      "rootId": "example",
      "shipments": [
        {
          "comment": "example",
          "distributionPriority": 0,
          "executorRequirementId": "example",
          "executorRequirementShipmentId": "example",
          "flightInfo": null,
          "flightTaskId": "example",
          "isDeleted": true,
          "name": "example",
          "npShipment": {},
          "npShipmentId": "example",
          "npUnshipment": null,
          "packageType": "example",
          "packages": [
            null
          ],
          "quantizationMethod": "example",
          "requirementId": "example",
          "requirementShipmentId": "example",
          "shipmentExternalID": "example",
          "shipmentId": "example",
          "status": "example",
          "taskStatus": "example",
          "transferOrderTaskID": "example"
        }
      ],
      "status": "example",
      "systemConditionsTemplateId": "example",
      "tag": null,
      "temperatureRegime": [
        {
          "from": 0,
          "to": 0
        }
      ],
      "trailerInfos": [
        null
      ],
      "transIdentity": "example",
      "transferOrderAdditionalConditions": "example",
      "transferOrderAdditionalConfiguration": {},
      "transferOrderCost": {
        "currency": "example",
        "price": 0.5
      },
      "transferOrderName": "example",
      "transferOrderType": "example",
      "transshipmentTypes": [
        "example"
      ],
      "typePaymentAndTax": "example",
      "updated": null,
      "utm": {
        "utmCampaign": "example",
        "utmContent": "example",
        "utmMedium": "example",
        "utmSource": "example",
        "utmTerm": "example"
      },
      "volumeDemand": {
        "actualEndDate": null,
        "isOpenAuction": true,
        "offersCount": 0,
        "status": "example",
        "uniqueOrganizationsCount": 0,
        "volumeAuction": {},
        "volumeAuctionId": "example"
      }
    }
  ]
}

400 Bad Request

Bad Request

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

Error

Name

Description

info

Type: object

Example
{}

message

Type: string

Example: example

message_code

Type: string

Example: example
Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

403 Forbidden

Forbidden

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

500 Internal Server Error

Internal Server Error

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

No longer supported, please use an alternative and newer version.

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