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

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

Назначение

Найдите идентификаторы заказов от организаций, доступных пользователю в роли заказчика. Сопоставьте условия пользователя с фильтрами ниже. Выберите нужные идентификаторы и передайте их в data.exactOrderIds метода получения деталей. Описывайте статус, маршрут, груз и участников по ответу метода деталей.

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

Доступ


Аутентификация	Требуется
Роли организаций	`exp`
Права пользователя	`view_all_orders`
Область доступа	Организации с ролью заказчика, доступные текущему пользователю


Эффект	Только чтение
Повтор вызова	Безопасно повторять
Повтор после ошибки	Только после временных ошибок
Автоматизация	Требуется подтверждение
Чувствительность данных	Содержит чувствительные данные

Нужны аутентификация, роль exp и право view_all_orders. Метод ищет среди заказов организаций с ролью заказчика, доступных пользователю. Если таких организаций нет, метод возвращает успешный пустой результат.

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

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

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

Идентификаторы и текст

Поле	Тип или формат JSON	Условие
`exactOrderIds`	Массив строк	Точные идентификаторы заказов. Непустой список замещает `partialOrderIds` и включает поиск по архиву.
`partialOrderIds`	Массив строк	Фрагменты идентификаторов заказов. Применяется при пустом `exactOrderIds`.
`exactCargoIds`	Массив строк	Точные идентификаторы грузов. Замещает `partialCargoIds`.
`partialCargoIds`	Массив строк	Начала или фрагменты идентификаторов грузов. Применяется при пустом `exactCargoIds`.
`exactDemandIds`	Массив строк	Точные идентификаторы заявок любой из поддерживаемых форм торгов. Замещает `partialDemandIds`.
`partialDemandIds`	Массив строк	Фрагменты идентификаторов заявок. Применяется при пустом `exactDemandIds`.
`externalID`	Массив строк	Точные внешние идентификаторы заказов.
`flightIds`	Массив строк	Точные идентификаторы рейсов заказа.
`customerIds`	Массив строк	Точные идентификаторы владельцев груза.
`npShipmentIds` / `npUnshipmentIds`	Массивы строк	Точные идентификаторы узловых точек погрузки и выгрузки.
`shipmentNames`	Массив строк	Начала или фрагменты названий грузов.
`packageNames`	Массив строк	Начала или фрагменты названий грузовых мест.
`additionalConditionsExternalOrderID`	Массив строк	Точные внешние идентификаторы заказа из дополнительных условий перевозки.

Статус заказа, торгов и рейса

Поле	Тип или формат JSON	Условие
`statuses`	Массив значений `draft`, `onMatch`, `onExecute`, `completeExecute`, `cancel`, `matchHistory`, `revoke`	При пустом списке действуют пять неархивных статусов: `draft`, `onMatch`, `onExecute`, `completeExecute` и `cancel`. Для архивных статусов включите видимость архива.
`isArchive`	Необязательный логический флаг	`true` включает архив. При `false` и при отсутствии значения действует обычная видимость. Непустой `exactOrderIds` также включает архив.
`isOptimized`	Необязательный логический флаг	`false` исключает заказы, созданные оптимизацией. `true` и отсутствие значения пропускают условие.
`matchStatuses`	Массив значений `waitForMatcher`, `onMatching`, `waitForResolution`, `refused`, `completed`, `completedWin`, `completedLoss`, `completedSpectator`	Статусы торгов. Пустой список пропускает условие.
`hubType`	Массив значений `1x1Hub`, `closedHub`, `openHub`, `closedHubVolume`, `openHubVolume`	Типы хабов торгов. Пустой список пропускает условие.
`shipmentFilterStatus`	Массив со значением `withoutFlight`	Грузы без рейса. Пустой список пропускает условие.
`flightStatus`	Массив значений `notStarted`, `onFlight`, `complete`, `canceledAndNeverStarted`, `canceledAfterStarted`	Статусы рейса. Пустой список пропускает условие.
`flightSubStatus`	Массив значений `waitForDriverSet`, `waitForTruckSet`, `waitForTrailerSet`, `waitForFlightStart`	Операционные подстатусы рейса. Пустой список пропускает условие.
`etrnState`	Массив строк	Состояния ЭТрН. Опустите поле, если состояние не важно для задачи.

Электронный документооборот

В edm значения одного списка считаются альтернативами. Для каждого непустого списка статусов нужен документ соответствующего типа. documentIds ограничивает каждый подходящий документ. Если указан actionRequiredDocumentTypes, условие по организации в фильтрах статусов применяется к перечисленным типам. Для поиска документов, по которым требуется действие, API берёт организации, доступные пользователю в текущей роли. Если передан actionRequiredFromOrganizationIds, API ограничивает выборку пересечением этих списков. При пустом пересечении совпадений нет.

Флаги has* должны совпасть у одного груза. Условие о требуемом действии проверяется отдельно по документу.

Поле	Тип или формат JSON	Условие
`edm.documentIds`	Массив строк	Точные идентификаторы документов ЭДО. Пустой список пропускает условие.
`edm.actionRequiredFromOrganizationIds`	Массив строк	Организации, от которых ждут действия по документу. С заданными типами документов пустой список означает все организации, доступные в текущей роли. Без типов пустой список пропускает условие.
`edm.etrnStatuses`	Массив строк	Статусы ЭТрН.
`edm.ezzStatuses`	Массив строк	Статусы ЭЗЗ.
`edm.epeStatuses`	Массив строк	Статусы ЭПЭ.
`edm.exprStatuses`	Массив строк	Статусы ЭПР.
`edm.actionRequiredDocumentTypes`	Массив строк	Нужен документ одного из типов `etrn`, `ezz`, `epe` или `expr`, по которому требуется действие доступной организации. Опустите поле, чтобы пропустить условие.
`edm.hasEtrn`, `edm.hasEzz`, `edm.hasEpe`, `edm.hasExpr`	Необязательные логические флаги	`true` проверяет наличие документа у груза, `false` — отсутствие. Опущенный флаг пропускает условие.

Диапазоны времени

Передайте метку времени RFC 3339 со смещением или объект с time, displayTZ и необязательным useLocation. Обе границы погрузки или выгрузки применяются к одному грузу.

Поля	Условие
`fromCreateTS` / `toCreateTS`	Время создания заказа.
`fromUpdateTS` / `toUpdateTS`	Время обновления заказа. Используйте для поиска изменённых заказов без чтения ленты изменений.
`fromLoadingTS` / `toLoadingTS`	Интервал погрузки хотя бы одного груза должен укладываться в заданные границы. Если в данных груза есть только одна граница, она должна попасть в диапазон.
`fromUnloadingTS` / `toUnloadingTS`	Интервал выгрузки хотя бы одного груза должен укладываться в заданные границы. Если в данных груза есть только одна граница, она должна попасть в диапазон.
`fromChooseWinnerTS` / `toChooseWinnerTS`	Время выбора победителя.
`fromFirstLoadTS` / `toFirstLoadTS`	Время первой погрузки.
`fromFirstLoadDate` / `toFirstLoadDate`	Местная дата первой погрузки в формате `YYYY-MM-DD`. Последняя дата включается. Используется при отсутствии обеих границ следующей пары.
`fromFirstLoadDateTs` / `toFirstLoadDateTs`	Местная дата первой погрузки в виде меток времени. Если указана хотя бы одна граница, эта пара имеет приоритет над `fromFirstLoadDate` / `toFirstLoadDate`.
`fromOrderWayFirstLoadingWayPointStartAtTS` / `toOrderWayFirstLoadingWayPointStartAtTS`	Плановое время начала на первой точке погрузки маршрута.
`fromOrderWayLastUnloadingWayPointEndAtTS` / `toOrderWayLastUnloadingWayPointEndAtTS`	Плановое время окончания или начала на последней точке выгрузки маршрута.

Маршрут и география

Поле	Тип или формат JSON	Условие
`loadPoint` / `unloadPoint`	Объект `{lat: number, long: number, radiusM: number}`	Груз с погрузкой или выгрузкой рядом с координатами. `radiusM` — положительный радиус в метрах. Для поиска без радиуса опустите объект целиком.
`orderWayFirstLoadingWayPointAddresses`	Массив строк	Варианты текста адреса первой точки погрузки маршрута.
`orderWayLastUnloadingWayPointAddresses`	Массив строк	Варианты текста адреса последней точки выгрузки маршрута.
`orderWayFirstLoadingWayPoint` / `orderWayLastUnloadingWayPoint`	Объект `{lat, long, radiusM}`	Поиск первой точки погрузки или последней точки выгрузки маршрута по радиусу.

Груз, транспорт и водитель

Поле	Тип или формат JSON	Условие
`cargoCategories`	Массив строк	Варианты категории груза.
`bodyTypes`	Массив строк	Варианты требуемого типа кузова.
`temperatureRegime`	Массив объектов `{from: integer, to: integer, label?: string}`	Для каждого элемента с непустым `label` требуется точное совпадение по названию. Без названия должны совпасть обе границы одного режима. Достаточно одного подходящего элемента.
`truckIds` / `trailerIds` / `driverIds`	Массивы строк	Точные идентификаторы назначенных тягачей, прицепов или водителей.
`hasAssignedDriverInAnyFlight`	Необязательный логический флаг	`true` — водитель назначен хотя бы на один рейс. `false` — водитель не назначен ни на один рейс.
`hasAssignedDriverInAllFlights`	Необязательный логический флаг	`true` — есть хотя бы один рейс и у каждого рейса есть водитель. `false` исключает заказы, удовлетворяющие этому условию.
`fromWeight` / `toWeight`	Десятичные числа JSON	Вес груза в тоннах. Границы включаются.
`fromVolume` / `toVolume`	Десятичные числа JSON	Объём груза в кубических метрах. Границы включаются.
`fromPalletCount` / `toPalletCount`	Целые числа	Число паллет. Границы включаются.
`bodyTypeComments`	Массив строк	Варианты текста комментария к типу кузова.

Участники, логисты и торги

Поле	Тип или формат JSON	Условие
`tin`	Массив строк	Фрагменты ИНН основных участников заказа и точек груза.
`participantTINs`	Массив строк	Фрагменты ИНН участников заказа, перевозки и активных торгов.
`responsibleLogisticianByExecutor`	Массив строк	Идентификаторы ответственных логистов со стороны исполнителя.
`responsibleLogisticianByForwarder`	Массив строк	Идентификаторы ответственных логистов со стороны заказчика.
`responsibleLogisticianNamedByForwarder`	Массив строк	Имена ответственных логистов со стороны заказчика. Поиск учитывает транслитерацию и совпадение по фрагменту или началу фразы.
`responsibleLogisticianNamedByExecutor`	Массив строк	Поиск по имени логиста со стороны исполнителя по тем же правилам.
`responsibleLogisticianForFlightByExecutor`	Массив строк	Идентификаторы ответственных логистов исполнителя, назначенных на рейсы.
`flightExternalExecutor`	Массив строк	Идентификаторы организаций внешних исполнителей рейсов.
`matcherParticipants`	Массив строк	Нужна хотя бы одна активная ставка или оферта от перечисленных организаций-исполнителей.
`excludeMatcherParticipants`	Массив строк	Исключает заказы с активной ставкой или офертой от любой перечисленной организации-исполнителя.

Поле	Тип или формат JSON	Условие
`customerComment`	Массив строк	Варианты начала комментария к владельцу груза.
`distributionComment`	Массив строк	Варианты начала комментария к условиям перевозки.

Простые задачи и события

Условия по простой задаче должны совпасть в одной задаче. Пустые поля пропускают соответствующее условие.

Поле	Тип или формат JSON	Условие
`simpleTaskTypeIds` / `simpleTaskTypeNames`	Массивы строк	Идентификаторы или названия типов задач.
`simpleTaskStatuses`	Массив значений `active`, `completed`, `canceled`	Варианты статуса задачи.
`simpleTaskDocumentNumbers`	Массив строк	Варианты номера документа задачи.
`simpleTaskParticipantRoles`	Массив значений `setter`, `performer`, `observer`	Нужна задача, в которой доступная пользователю организация участвует в одной из указанных ролей.
`fromSimpleTaskDeadlineTS` / `toSimpleTaskDeadlineTS`	Метки времени	Диапазон срока исполнения задачи.
`latestSendToMatchEvent`	Объект с необязательными `fromTS`, `toTS`	Время последней отправки на торги. Пустой объект пропускает условие.
`latestSendToExecutEvent`	Объект с необязательными `fromTS`, `toTS`	Время последней отправки на исполнение.
`latestWinnerAssignedEvent`	Объект с необязательными `fromTS`, `toTS`	Время последнего назначения победителя.
`latestRevokeOnExecuteEvent`	Объект с необязательными `fromTS`, `toTS`	Время последнего отзыва в ходе исполнения.

Поля без влияния на выдачу

Следующие поля принимает общая схема запроса. Опускайте их для этого метода.

Вместо cargoID используйте exactCargoIds или partialCargoIds.
Вместо loadNPIds и unloadNPIds используйте npShipmentIds и npUnshipmentIds.
carType, carBrand, carNumber и carBodyType.
participantNames.

Сортировка и лимит

data.sort.sortSettings — упорядоченный список условий. Поддерживаемые значения field — CreatedAt и FirstLoadAt. Для убывания укажите order: "desc". Отсутствие order или значение "asc" означает возрастание. Неподдерживаемые поля, в том числе need_driver_assign, пропускаются. Порядок без поддерживаемого условия сортировки не гарантируется.

При действующей сортировке размер ответа ограничивает filter.limit. Если его опустить, действует лимит 1000.
Без действующей сортировки метод возвращает до 10 000 идентификаторов независимо от filter.limit.
Ответ не содержит курсора, общего числа заказов или признака следующей страницы.

Точный поиск и архив

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

Фильтры заказчика

Поле	Тип или формат JSON	Условие
`isDeprecated`	Необязательный логический флаг	`false` и отсутствие значения исключают устаревшие заказы. `true` включает их вместе с остальными.
`forwarderIDs`	Массив строк	Сужает область поиска, если хотя бы одна организация из списка доступна.
`executorIds`	Массив строк	Идентификаторы организаций-исполнителей, победивших на торгах.
`cargoComment`	Массив строк	Варианты внутреннего комментария к грузу в поиске заказчика.

Опустите withMyBets. Это поле общей схемы не влияет на выдачу для этой роли.

Результат

Читайте идентификаторы из data.orderIds. Пустой массив означает успешный поиск без совпадений в доступной области. В этом случае завершите поиск без запроса деталей.

`response.data.orderIds[]`

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

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

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

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

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

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

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

Поле	Класс данных	Субъект	По умолчанию	Ограничения
`request.data.filter.additionalConditionsExternalOrderID[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.bodyTypeComments[]`	Чувствительный свободный текст	Смешанный или неизвестный	Скрывать полностью	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.carNumber[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.cargoComment[]`	Чувствительный свободный текст	Смешанный или неизвестный	Скрывать полностью	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.cargoID[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.customerComment[]`	Чувствительный свободный текст	Смешанный или неизвестный	Скрывать полностью	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.customerIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.distributionComment[]`	Чувствительный свободный текст	Смешанный или неизвестный	Скрывать полностью	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.driverIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.edm.actionRequiredFromOrganizationIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.edm.documentIds[]`	Идентификатор документа	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.exactCargoIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.exactDemandIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.exactOrderIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.excludeMatcherParticipants[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.executorIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.externalID[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.flightExternalExecutor[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.flightIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.forwarderIDs[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.loadNPIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.loadPoint.lat`	Точное местоположение	Коммерческие данные	Показывать агрегированно	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.loadPoint.long`	Точное местоположение	Коммерческие данные	Показывать агрегированно	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.matcherParticipants[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.npShipmentIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.npUnshipmentIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.orderWayFirstLoadingWayPoint.lat`	Точное местоположение	Коммерческие данные	Показывать агрегированно	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.orderWayFirstLoadingWayPoint.long`	Точное местоположение	Коммерческие данные	Показывать агрегированно	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.orderWayFirstLoadingWayPointAddresses[]`	Чувствительный адрес	Смешанный или неизвестный	Маскировать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.orderWayLastUnloadingWayPoint.lat`	Точное местоположение	Коммерческие данные	Показывать агрегированно	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.orderWayLastUnloadingWayPoint.long`	Точное местоположение	Коммерческие данные	Показывать агрегированно	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.orderWayLastUnloadingWayPointAddresses[]`	Чувствительный адрес	Смешанный или неизвестный	Маскировать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.packageNames[]`	Чувствительный свободный текст	Смешанный или неизвестный	Скрывать полностью	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.partialCargoIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.partialDemandIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.partialOrderIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.participantNames[]`	Название стороны	Смешанный или неизвестный	Маскировать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.participantTINs[]`	Налоговый идентификатор	Смешанный или неизвестный	Скрывать полностью	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.responsibleLogisticianByExecutor[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.responsibleLogisticianByForwarder[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.responsibleLogisticianForFlightByExecutor[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.responsibleLogisticianNamedByExecutor[]`	Название стороны	Физическое лицо	Маскировать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.responsibleLogisticianNamedByForwarder[]`	Название стороны	Физическое лицо	Маскировать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.shipmentNames[]`	Чувствительный свободный текст	Смешанный или неизвестный	Скрывать полностью	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.simpleTaskDocumentNumbers[]`	Идентификатор документа	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.simpleTaskTypeIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.simpleTaskTypeNames[]`	Чувствительный свободный текст	Смешанный или неизвестный	Скрывать полностью	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.temperatureRegime[].label`	Чувствительный свободный текст	Смешанный или неизвестный	Скрывать полностью	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.tin[]`	Налоговый идентификатор	Смешанный или неизвестный	Скрывать полностью	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.trailerIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.truckIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.unloadNPIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.unloadPoint.lat`	Точное местоположение	Коммерческие данные	Показывать агрегированно	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения
`request.data.filter.unloadPoint.long`	Точное местоположение	Коммерческие данные	Показывать агрегированно	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения

Поле	Класс данных	Субъект	По умолчанию	Ограничения
`response.data.orderIds[]`	Внутренний идентификатор	Коммерческие данные	Не показывать	Пользователю: только при явной подтверждённой необходимости; в AI-контекст: только при явной подтверждённой необходимости; во внешние системы: только при явной подтверждённой необходимости; в журналы, трассировки и метрики: не передавать исходное значение; примеры: только синтетические значения

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

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

Найти идентификатор синтетического заказа · синтетический пример

Точный поиск возвращает идентификатор доступного синтетического заказа.

Запрос

{
  "data": {
    "filter": {
      "exactOrderIds": [
        "0-example-0000-00-00-101"
      ],
      "limit": 1
    },
    "sort": {
      "sortSettings": [
        {
          "field": "CreatedAt",
          "order": "desc"
        }
      ]
    }
  }
}

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

{
  "data": {
    "orderIds": [
      "0-example-0000-00-00-101"
    ]
  }
}

Нет доступного совпадения · синтетический пример

Успешный точный поиск без доступного совпадения возвращает пустой список.

Запрос

{
  "data": {
    "filter": {
      "exactOrderIds": [
        "0-example-0000-00-00-102"
      ],
      "limit": 1
    },
    "sort": {
      "sortSettings": [
        {
          "field": "CreatedAt",
          "order": "desc"
        }
      ]
    }
  }
}

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

{
  "data": {
    "orderIds": []
  }
}

Заказы, изменённые за период

Передайте fromUpdateTS и toUpdateTS. Пример сортирует заказы по CreatedAt. Время обновления поддерживается как фильтр.

{
  "data": {
    "filter": {
      "fromUpdateTS": {
        "display_tz": "+00:00",
        "ts": "2030-01-10T00:00:00Z",
        "user_id": null
      },
      "limit": 20,
      "toUpdateTS": {
        "display_tz": "+00:00",
        "ts": "2030-01-11T00:00:00Z",
        "user_id": null
      }
    },
    "sort": {
      "sortSettings": [
        {
          "field": "CreatedAt",
          "order": "desc"
        }
      ]
    }
  }
}

{
  "data": {
    "orderIds": [
      "0-example-0000-00-00-111",
      "0-example-0000-00-00-112"
    ]
  }
}

Ближайшие погрузки по заказам в исполнении

Задайте диапазон даты первой погрузки и statuses: ["onExecute"]. Сортировка FirstLoadAt по возрастанию покажет ближайшую погрузку первой.

{
  "data": {
    "filter": {
      "fromFirstLoadDate": "2030-02-01",
      "limit": 10,
      "statuses": [
        "onExecute"
      ],
      "toFirstLoadDate": "2030-02-07"
    },
    "sort": {
      "sortSettings": [
        {
          "field": "FirstLoadAt",
          "order": "asc"
        }
      ]
    }
  }
}

{
  "data": {
    "orderIds": [
      "0-example-0000-00-00-121",
      "0-example-0000-00-00-122"
    ]
  }
}

Заказы на открытых торгах

Укажите статус заказа, статус торгов и тип хаба.

{
  "data": {
    "filter": {
      "hubType": [
        "openHub"
      ],
      "limit": 20,
      "matchStatuses": [
        "onMatching"
      ],
      "statuses": [
        "onMatch"
      ]
    },
    "sort": {
      "sortSettings": [
        {
          "field": "CreatedAt",
          "order": "desc"
        }
      ]
    }
  }
}

{
  "data": {
    "orderIds": [
      "0-example-0000-00-00-131",
      "0-example-0000-00-00-132"
    ]
  }
}

ЭТрН, по которым требуется действие

Запрос ищет заказы с ЭТрН, ожидающей действия доступной организации заказчика. В заказе должен быть груз с ЭТрН и без ЭЗЗ.

{
  "data": {
    "filter": {
      "edm": {
        "actionRequiredDocumentTypes": [
          "etrn"
        ],
        "hasEtrn": true,
        "hasEzz": false
      },
      "limit": 10
    },
    "sort": {
      "sortSettings": [
        {
          "field": "CreatedAt",
          "order": "desc"
        }
      ]
    }
  }
}

{
  "data": {
    "orderIds": [
      "0-example-0000-00-00-141"
    ]
  }
}

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

Request

POST

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

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

Body

application/json

{
  "data": {
    "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
    },
    "sort": {
      "sortSettings": [
        {}
      ]
    }
  }
}

Name

Description

data

Type: OrderGetIdsForCustomerV0Request

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": [
        "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
  },
  "sort": {
    "sortSettings": [
      {
        "field": "example",
        "order": "example"
      }
    ]
  }
}

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 - Пусто == 11+закрытый 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"
    }
  ]
}

OrderGetIdsForCustomerV0Request

Name

Description

filter

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
}

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"
    }
  ]
}

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": [
        "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
  },
  "sort": {
    "sortSettings": [
      {
        "field": "example",
        "order": "example"
      }
    ]
  }
}

{
  "data": {
    "orderIds": [
      "example"
    ]
  }
}

Name	Description
data	Type: OrderGetIdsForCustomerV0Response Example `{ "orderIds": [ "example" ] }`

OrderGetIdsForCustomerV0Response

Name	Description
orderIds	Type: string[] \| null Example `[ "example" ]`

Example

{
  "orderIds": [
    "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" }`

Получить заказ для редактирования

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

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

НазначениеНазначение

ДоступДоступ

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

Идентификаторы и текстИдентификаторы и текст

Статус заказа, торгов и рейсаСтатус заказа, торгов и рейса

Электронный документооборотЭлектронный документооборот

Диапазоны времениДиапазоны времени

Маршрут и географияМаршрут и география

Груз, транспорт и водительГруз, транспорт и водитель

Участники, логисты и торгиУчастники, логисты и торги

КомментарииКомментарии

Простые задачи и событияПростые задачи и события

Поля без влияния на выдачуПоля без влияния на выдачу

Сортировка и лимитСортировка и лимит

Точный поиск и архивТочный поиск и архив

Фильтры заказчикаФильтры заказчика

РезультатРезультат

response.data.orderIds[]response.data.orderIds[]

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

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

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

Заказы, изменённые за периодЗаказы, изменённые за период

Ближайшие погрузки по заказам в исполненииБлижайшие погрузки по заказам в исполнении

Заказы на открытых торгахЗаказы на открытых торгах

ЭТрН, по которым требуется действиеЭТрН, по которым требуется действие

RequestRequest

BodyBody

OrderSearchEdmFilterOrderSearchEdmFilter

TimestampTZInputTimestampTZInput

OrderSearchMeddFilterOrderSearchMeddFilter

OrderSearchPointRequestOrderSearchPointRequest

OrderSearchTemperatureRegimeOrderSearchTemperatureRegime

OrderSearchFilterOrderSearchFilter

OrderSearchSortSettingOrderSearchSortSetting

OrderSearchSortOrderSearchSort

OrderGetIdsForCustomerV0RequestOrderGetIdsForCustomerV0Request

ResponsesResponses

200 OK200 OK

BodyBody

OrderGetIdsForCustomerV0ResponseOrderGetIdsForCustomerV0Response

400 Bad Request400 Bad Request

BodyBody

ErrorError

403 Forbidden403 Forbidden

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

Назначение

Доступ

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

Идентификаторы и текст

Статус заказа, торгов и рейса

Электронный документооборот

Диапазоны времени

Маршрут и география

Груз, транспорт и водитель

Участники, логисты и торги

Комментарии

Простые задачи и события

Поля без влияния на выдачу

Сортировка и лимит

Точный поиск и архив

Фильтры заказчика

Результат

`response.data.orderIds[]`

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

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

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

Заказы, изменённые за период

Ближайшие погрузки по заказам в исполнении

Заказы на открытых торгах

ЭТрН, по которым требуется действие

Request

Body

OrderSearchEdmFilter

TimestampTZInput

OrderSearchMeddFilter

OrderSearchPointRequest

OrderSearchTemperatureRegime

OrderSearchFilter

OrderSearchSortSetting

OrderSearchSort

OrderGetIdsForCustomerV0Request

Responses

200 OK

Body

OrderGetIdsForCustomerV0Response

400 Bad Request

Body

Error

403 Forbidden

Body

500 Internal Server Error

Body