Перейти к содержанию

Методы API, модели и значения

Во всех путях <baseUrl> — адрес API CARGO.RUN. Адреса тестовой и промышленной сред запрашиваются у команды CARGO.RUN при подключении. Все методы, кроме Account/Token, требуют Authorization: Bearer <token>.

Сводная таблица

Метод Назначение
POST /api/Account/Token Получить M2M-токен
GET /api/integrations/Organizations/Check Проверить организацию по ИНН
POST /api/integrations/Organizations/Apply Создать организацию или получить доступ
POST /api/integrations/Bids/Apply Создать или обновить заявку
GET /api/integrations/Bids/GetList Получить созданные партнёром и транслируемые ему заявки
GET /api/integrations/Bids/Get Получить карточку заявки
GET /api/integrations/Bids/GetEvents Получить события заявки
GET /api/integrations/Bids/GetPlannedRoute Получить плановый маршрут
GET /api/integrations/Bids/GetActualRoute Получить фактический маршрут
GET /api/integrations/Bids/GetDriverMessages Получить сообщения и файлы водителя
POST /api/integrations/Tasks/Queue Поставить команды в очередь
GET /api/integrations/Tasks/Queue Получить результат задачи
POST /api/integrations/Tasks/Ping Проверить callback

POST /api/Account/Token

Получает токен по client_credentials. Авторизация не требуется.

Тело: ClientCredentialsTokenModel. Ответ: ClientCredentialsTokenResponse.

{
  "grantType": "client_credentials",
  "clientId": "partner-client-id",
  "clientSecret": "partner-client-secret"
}

Успех: 200 OK. Используйте accessToken.token и accessToken.expiresIn. Не вызывайте метод чаще двух раз за 30 секунд.

GET /api/integrations/Organizations/Check

Параметр Где Тип Обязательно Описание
inn query string Да ИНН организации

Успех: 200 OK, модель IntegrationOrganizationCheckModel.

POST /api/integrations/Organizations/Apply

Тело: CreateIntegrationOrganizationContext.

Поля name и inn обязательны. Поиск организации выполняется по inn. Для новой организации, создаваемой партнёрским сервисом, сразу включается модуль «Температурный режим». Успех: 200 OK, модель OrganizationApplyResult.

POST /api/integrations/Bids/Apply

Тело: ApplyBidFromIntegrationContext. Результат: ApplyBidResultModel.

Создаёт или полностью обновляет заявку, создаёт недостающие транспорт, водителей и контрагента, применяет характеристики ТС и температурный режим и запускает заявку в работу. Если координаты точки не переданы, CARGO.RUN определяет их по обязательному адресу.

Успех: 200 OK:

{
  "id": 12345,
  "isRouteBuilt": true
}

При нарушении валидации возвращается 400 Bad Request с текстовым сообщением.

GET /api/integrations/Bids/GetList

Возвращает IntegrationBidListModel[]:

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

Поле isCreatedByPlatform различает эти виды. Для собственной заявки externalId содержит ID, переданный в Apply; для транслируемой — ID заказа, указанный перевозчиком для платформы.

Заголовок Обязательно Поведение
X-Organization-Id Нет Если передан, возвращаются заявки только этой доступной организации. Без заголовка возвращаются заявки всех организаций, доступных интеграционному клиенту.

Без непустого $filter сервер ограничивает список заявками, изменёнными за последние 30 дней. Любой явно переданный непустой $filter отменяет это окно, поэтому для инкрементальной синхронизации всегда указывайте границу по updatedAt.

Сортировка по умолчанию — updatedAt,id. Ответ также содержит несервисные точки points и их события events. События вычисляются после основной выборки и не участвуют в $filter и $orderby.

Поддерживает OData-параметры и заголовок X-MetaCount.

Миграция с GetCurrentList

GET /api/integrations/Bids/GetCurrentList удалён. Используйте GetList и определяйте источник заявки по isCreatedByPlatform. Отсутствие X-Organization-Id означает выборку по всем доступным организациям, а не по одной текущей организации.

GET /api/integrations/Bids/Get

Параметр Где Тип Обязательно Описание
id query int64 Да ID заявки CARGO.RUN

Успех: 200 OK, модель BidForExternalSyncModel.

GET /api/integrations/Bids/GetEvents

Параметр id — обязательный ID заявки CARGO.RUN. Успех: IntegrationBidEventModel[]. Значения type: IntegrationBidEventType.

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

GET /api/integrations/Bids/GetPlannedRoute

Параметр id — обязательный ID заявки. Успех: RouteSimpleModel. Модель содержит расчётные показатели; геометрия планового маршрута в базовом синхронном ответе не используется партнёрским сценарием.

GET <baseUrl>/api/integrations/Bids/GetPlannedRoute?id=12345
Authorization: Bearer <accessToken.token>
{
  "id": 98765,
  "distance": 820000,
  "duration": 43200,
  "distanceWithoutEmptyMileage": 820000,
  "emptyMileageDistance": 0,
  "durationWithoutEmptyMileage": 43200
}

Расстояния указаны в метрах, продолжительность — в секундах.

GET /api/integrations/Bids/GetActualRoute

Параметр Тип Обязательно По умолчанию Описание
id int64 Да — ID заявки CARGO.RUN
coordinateIntervalSeconds int32 Нет 60 Минимальный интервал между координатами; 0 отключает прореживание

Успех: CarRouteForExternalModel[].

GET /api/integrations/Bids/GetDriverMessages

Параметр id — обязательный ID заявки. Возвращает ChatMessageGetModel[], поддерживает OData и X-MetaCount.

Ссылки files[].accessUrlLink временные; не храните их как постоянные.

POST /api/integrations/Tasks/Queue

Тело: QueuedApiTaskCommandsCollectionModel. Ответ: EnqueueApiTasksResponseModel.

Необязательный заголовок:

Заголовок Ограничение Назначение
Idempotency-Key До 100 символов Возвращает те же задачи при повторе в течение 24 часов

Поддерживаются только комбинации Write/Read/ReadQuery для Bid, перечисленные в разделе Асинхронная очередь. Write использует тот же контракт, что Bids/Apply. ReadQuery эквивалентен Bids/GetList без X-Organization-Id.

Успешная постановка возвращает сведения о созданных задачах и их id. Для каждой команды может быть status="Success" или status="Failed".

GET /api/integrations/Tasks/Queue

Параметр Тип Обязательно Описание
id int64 Да ID задачи текущего интеграционного клиента

Успех: QueuedApiTaskGetResultsModel. Пока задача выполняется, ответ содержит Retry-After.

POST /api/integrations/Tasks/Ping

Не принимает тело. Отправляет тестовый подписанный webhook на настроенный callback и возвращает результат доставки.

Общие HTTP-коды

Код Значение
200 Успешное чтение или синхронная команда
202 Асинхронная команда принята в обработку; фактическое поведение постановки задач
400 Ошибка формата, валидации или бизнес-правила
401 Токен отсутствует, недействителен или истёк
403 Нет доступа к операции или организации
404 Заявка не существует или недоступна текущему партнёру
429 Превышена допустимая частота запросов

Дополнительные интеграционные методы

Методы Organizations/GetClients, Organizations/MarkClientPaid и Drivers/ConfirmAuthorization относятся к привлечению клиентов и подтверждению авторизации водителей, а не к основному сценарию обмена заявками. Их нельзя включать в реализацию партнёра без отдельного согласования бизнес-сценария и прав с CARGO.RUN.


Модели запросов и ответов

Колонка «Обязательно» отражает контракт партнёрского API с учётом бизнес-валидации конкретных операций. Все enum в JSON передаются строковыми значениями из раздела «Возможные значения полей».

Результаты операций

ClientCredentialsTokenResponse

Поле Тип Обязательно null Описание
accessToken AccessToken Да Нет Токен доступа и срок действия

AccessToken

Поле Тип Обязательно null Описание
token string Да Нет JWT для заголовка Authorization
expiresIn int32 Да Нет Срок действия в секундах

ApplyBidResultModel

Поле Тип Обязательно null Описание
id int64 Да Нет ID созданной или обновлённой заявки CARGO.RUN
isRouteBuilt boolean Да Нет Маршрут успешно построен

OrganizationApplyResult

Поле Тип Обязательно null Описание
id int64 Да Нет ID созданной или найденной организации

EnqueueApiTasksResponseModel

Поле Тип Обязательно null Описание
latencyMsec int32 Да Нет Оценка задержки очереди в миллисекундах
enqueuedInMsec int32 Да Нет Время постановки команд в миллисекундах
commands EnqueuedApiTaskResponseModel[] Да Нет Результат постановки каждой команды

EnqueuedApiTaskResponseModel

Поле Тип Обязательно null Описание
id int64 Нет Да ID задачи; отсутствует, если команда не поставлена
action QueuedApiTaskAction Да Нет Действие задачи
status QueuedApiTaskEnqueueStatus Да Нет Результат постановки
readyInMsec int64 Да Нет Ориентировочная задержка до готовности
message string Нет Да Причина отказа в постановке

QueuedApiTaskEnqueueStatus

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

QueuedApiTaskCallbackPayload

Поле Тип Обязательно null Описание
eventId uuid Да Нет Уникальный ID события для дедупликации
taskId int64 Да Нет ID задачи
action QueuedApiTaskAction Да Нет Действие задачи
status QueuedApiTaskStatus Да Нет Статус задачи
origin QueuedApiTaskOrigin Да Нет Запрос партнёра или подписка
completedAt date-time Нет Да Время завершения
attemptCount int32 Да Нет Число попыток обработки задачи
maxAttemptCount int32 Да Нет Максимум попыток обработки
message string Нет Да Сообщение задачи
objects QueuedApiTaskObjectResultModel[] Нет Да Результаты объектов

Основные модели запросов и ответов

ClientCredentialsTokenModel

Поле Тип Обязательно null Ограничения Описание
grantType string Да Нет значение: client_credentials Тип выдачи токена. Передавайте фиксированное значение client_credentials.
clientId string Да Нет — Идентификатор интеграционного клиента, выданный CARGO.RUN.
clientSecret string Да Нет — Секрет интеграционного клиента, выданный CARGO.RUN.

IntegrationOrganizationCheckModel

Результат проверки доступности организации для партнёрского сервиса.

Поле Тип Обязательно null Ограничения Описание
exists boolean Да Нет — Организация с указанным ИНН существует.
canCreateBids boolean Да Нет — Для организации разрешено создавать заявки партнёрским сервисам.
hasAccess boolean Да Нет — Текущий партнёрский сервис уже имеет доступ к организации.

CreateIntegrationOrganizationContext

Поле Тип Обязательно null Ограничения Описание
name string Да Нет — Название организации.
inn string Да Нет — ИНН организации.
kpp string Нет Да — КПП
ogrn string Нет Да — ОГРН

ApplyBidFromIntegrationContext

Поле Тип Обязательно null Ограничения Описание
bid IntegrationBidEditModel Да Нет — Данные заявки.
inn string Да Нет — ИНН организации перевозчика: 10 цифр для организации или 12 цифр для ИП. Обязателен при синхронном и асинхронном создании или обновлении заявки.

IntegrationBidEditModel

Данные заявки, полученные от партнёрского сервиса.

Поле Тип Обязательно null Ограничения Описание
id int64 Нет Нет — Внутренний идентификатор заявки CARGO.RUN. Не указывается при создании. При обновлении используется, если поиск по externalId не нашёл заявку; найденная по externalId заявка имеет приоритет.
externalId string Нет Да max length: 72 Идентификатор заявки в партнёрском сервисе.
comment string Нет Да max length: 4096 Комментарий.
clientBidNumber string Нет Да max length: 256 Номер заявки клиента.
clientBidDate date-time Нет Да — Дата заявки клиента.
price double Нет Да min: 0; max: 9999999999 Стоимость перевозки.
Если не указана, заявка создаётся как заявка на порожний пробег.
isVatTop boolean Нет Да — НДС начисляется сверху.
vat string Нет Да — Ставка НДС: текст должен содержать 0, 10, 20 или 22.
Обязательна, если указана стоимость перевозки.
bidPoints IntegrationBidPointModel[] Да Нет min items: 2 Точки маршрута: минимум одна точка погрузки и одна точка выгрузки. CARGO.RUN сортирует точки по planEnterDate.
cargos CargoModel[] Да Нет — Грузы. Передайте как минимум один груз; у каждого груза обязательно поле name.
car IntegrationVehicleModel Да Нет — ТС.
trailer IntegrationVehicleModel Нет Нет — Прицеп. Необязателен; если объект передан, поле number обязательно.
driver IntegrationDriverModel Да Нет — Водитель.
secondaryDriver IntegrationDriverModel Нет Нет — Второй водитель.
counterparty IntegrationCounterpartyModel Нет Нет — Заказчик перевозки. Если передан, name обязателен. Контрагент ищется в организации по ИНН, а без ИНН — по наименованию без учёта регистра; при отсутствии создаётся.
temperatureRegime IntegrationTemperatureRegimeModel Нет Нет — Температурный режим перевозки, °C. Если объект передан, обязательны обе границы.
vehicleType IntegrationVehicleTypeModel Нет Нет — Тип и вместимость ТС. Значения записываются в прицеп, а при его отсутствии — в автомобиль.

IntegrationCounterpartyModel

Контрагент во внешней заявке.

Поле Тип Обязательно null Ограничения Описание
name string Да Нет max length: 256 Наименование контрагента.
inn string Нет Да 10 или 12 цифр ИНН организации или ИП.

IntegrationTemperatureRegimeModel

Поле Тип Обязательно null Ограничения Описание
minimum float Да Нет от -30 до 30 Минимальная температура, °C; должна быть меньше maximum.
maximum float Да Нет от -30 до 30 Максимальная температура, °C; должна быть больше minimum.

IntegrationVehicleTypeModel

Хотя бы одно из полей name, tonnage и volume должно быть заполнено.

Поле Тип Обязательно null Ограничения Описание
name string Нет Да max length: 128 Тип ТС, например Рефрижератор.
tonnage double Нет Да > 0 Грузоподъёмность, т.
volume double Нет Да > 0 Объём кузова, м³.

IntegrationBidListModel

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

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — Идентификатор заявки Cargo.Run.
externalId string Нет Да — Для собственной заявки — идентификатор, переданный партнёром при создании; для транслируемой — идентификатор заказа, указанный перевозчиком для платформы партнёра.
isCreatedByPlatform boolean Да Нет — true, если заявку создал текущий партнёр; false, если перевозчик транслирует её платформе.
status BidStatus Да Нет — Статус заявки BidStatus
isDeleted boolean Да Нет — Заявка удалена. Данные удалённой заявки не читаются, партнёрскому сервису следует прекратить её отслеживание
createdAt date-time Да Нет — Дата создания в часовом поясе организации
updatedAt date-time Да Нет — Дата последнего изменения заявки. Для курсорной выборки используйте $filter=updatedAt gt {курсор}&$orderby=updatedAt,id и небольшое перекрытие интервалов. Пересчёт points[].estimatedEnterDate не изменяет это поле.
points IntegrationBidListPointModel[] Да Нет — Несервисные точки маршрута в порядке следования. Даты представлены в часовом поясе точки.
events IntegrationBidEventModel[] Да Нет — События заявки и несервисных точек. Не участвуют в $filter и $orderby.

IntegrationBidListPointModel

Точка маршрута в объединённом списке заявок. Сервисные точки в массив не включаются.

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — ID точки CARGO.RUN; совпадает с bidPointId связанного события.
order int32 Да Нет — Порядок точки в маршруте.
externalId string Нет Да — Идентификатор точки в партнёрском сервисе.
type BidPointType Да Нет — Тип точки.
planEnterDate date-time Да Нет — Плановое время прибытия в часовом поясе точки.
estimatedEnterDate date-time Нет Да — Расчётное время прибытия в часовом поясе точки. Может меняться без изменения updatedAt заявки.
loadUnloadStatus BidPointLoadUnloadStatus Нет Да — Статус погрузки или выгрузки.
enteredAt date-time Нет Да — Время прибытия, отмеченное водителем, в часовом поясе точки.
loadUnloadedAt date-time Нет Да — Время погрузки или выгрузки, отмеченное водителем, в часовом поясе точки.
documentsReceivedAt date-time Нет Да — Время получения документов, отмеченное водителем, в часовом поясе точки.

BidForExternalSyncModel

Модель заявки для синхронизации с внешними сервисами

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
price double Нет Да — Цена
priceWithoutVatOnTop double Нет Да — Цена без НДС. Будет null, если isVatTop = false
status BidStatus Да Нет — Статус заявки
createdAt date-time Да Нет — Дата создания заявки
externalUpdatedAt date-time Нет Да — Дата обновления из внешней системы
acceptedByDriverForwarderAt date-time Нет Да — Дата принятия водителем-экспедитором
hasFactoring boolean Да Нет — Заявка отправлена на факторинг?
createdById int64 Да Нет — Идентификатор пользователя, кто создал заявку
paymentTypeId int64 Нет Да — Идентификатор Типа оплаты
ndsTypeId int64 Нет Да — Идентификатор Типа ндс
isVatTop boolean Да Нет — НДС сверху
counterpartyId int64 Нет Да — Контрагент
contractId int64 Нет Да — Договор контрагента
isEmptyMileageBid boolean Да Нет — Порожняя заявка?
driverId int64 Нет Да — Текущий водитель заявки
isDriverForwarder boolean Да Нет — Является ли водитель экспедитором?
secondaryDriverId int64 Нет Да — Второй водитель заявки
approvedById int64 Нет Да — Идентификатор пользователя-оператора, который согласовал заявку
(используется если у организации включен модуль согласования заявок)
approvedAt date-time Нет Да — Дата согласования оператором (используется если у организации включен модуль согласования заявок)
responsibleId int64 Нет Да — Идентификатор ответственного
salesManagerId int64 Нет Да — Идентификатор менеджера по продажам
carLogistId int64 Нет Да — Идентификатор логиста, который был привязан к машине на момент создания заявки
distributionBidId int64 Нет Да — Идентификатор заказа, из которого создана эта заявка
routeId int64 Нет Да — Идентификатор маршрута
planMileage double Да Нет — Плановый пробег (метры)
factMileage double Да Нет — Фактический пробег (метры)
planEmptyMileageBefore double Да Нет — Плановый порожний пробег до текущей заявки от предыдущей (метры)
factEmptyMileageBefore double Да Нет — Фактический порожний пробег до первой точки текущей заявки, включая пробег предыдущей порожней заявки (метры)
factEmptyMileageFromStartPoint double Да Нет — Фактический порожний пробег внутри заявки. Включает в себя пробег от нулевой до первой точки текущей заявки (метры)
factEmptyOdometerMileageBefore double Да Нет — Фактический порожний пробег по одометру до первой точки текущей заявки, включая пробег предыдущей порожней заявки (метры)
factEmptyOdometerMileageFromStartPoint double Да Нет — Фактический порожний пробег по одометру внутри заявки. Включает в себя пробег от нулевой до первой точки текущей заявки (метры)
updatedAt date-time Да Нет — Дата обновления
car CarSimpleModel Нет Нет — Машина
trailer TrailerListViewModel Нет Нет — Прицеп
legalPerson IdNameModel Нет Нет — Юр. лицо
estimation BidEstimationModel Нет Нет — Расчетная информация
bidPointLoadUnloadStatus BidPointLoadUnloadStatus Нет Да — —
bidPoints BidPointViewModel[] Нет Да — Точки загрузки
cargos CargoModel[] Нет Да — Грузы
typeOptions TypeOptionModel[] Нет Да — Дополнительные опции типов для заявки
temperatureRegime BidTemperatureRegimeModel Нет Нет — Температурный режим заявки
temperature TemperatureValueModel Нет Нет — Текущая информация о температуре
isInternational boolean Да Нет — —
documents RelatedDocumentModel[] Нет Да — Список документов
extendedProperties PropertyNameValueJsonObject[] Нет Да — Дополнительные поля заявки
externalId string Нет Да — —
contractNumber string Нет Да — Номер договора
comment string Нет Да — Комментарий
clientBidNumber string Нет Да — Номер заявки клиента
clientBidDate date-time Нет Да — Дата заявки клиента
paymentPeriodInDays int32 Нет Да — Срок оплаты в днях
paymentPeriodType PaymentPeriodType Нет Да — —
invoiceTriggerType InvoiceTriggerType Нет Да — —
sourceType SourceType Да Нет — Источник заявки в CARGO.RUN. Поле возвращается сервером; партнёр его не задаёт.
acceptedByDriverAt date-time Нет Да — Дата принятия заявки водителем
hasItemsChange boolean Да Нет — true если есть перецепка/пересменка
isDeleted boolean Да Нет — Является ли сущность удаленной?
createDocumentAssignment boolean Да Нет — Нужно ли создавать задание сдачи документов водителю после завершения заявки?
hasServicePoints boolean Да Нет — true если есть точки сервисных работ
isPreBid boolean Да Нет — Предзаявка
payment BidPaymentGetModel Нет Нет — Информация об оплате заявки
accessPermitIds int64[] Нет Да — Допуски и разрешения

IntegrationBidDetailsModel

Все данные заявки для партнёрского сервиса одним телом. Возвращается при чтении заявки через очередь заданий (Read). Фактический маршрут не включается из-за объёма, он доступен методом Bids/GetActualRoute.

Поле Тип Обязательно null Ограничения Описание
externalId string Нет Да — Идентификатор заявки на стороне партнёрского сервиса: внешний идентификатор для собственных заявок
или идентификатор заказа в партнёрском сервисе для транслируемых.
bid IntegrationBidDetailsModel.bid Нет Нет — Модель заявки для синхронизации с внешними сервисами
plannedRoute IntegrationBidDetailsModel.plannedRoute Нет Нет — —
events IntegrationBidDetailsModel.events[] Нет Да — События по заявке, вычисленные из фактических дат, как в методе Bids/GetEvents.
driverMessages IntegrationBidDetailsModel.driverMessages[] Нет Да — Сокращённые сообщения водителя. Поля type и flags доступны только в синхронной модели ChatMessageGetModel.

IntegrationBidEventModel

Событие по заявке, вычисленное из фактических дат заявки и ее точек.

Поле Тип Обязательно null Ограничения Описание
type IntegrationBidEventType Да Нет — Тип события.
fixedAt date-time Да Нет — Дата события.
bidPointId int64 Нет Да — Идентификатор точки заявки, если событие относится к точке.
bidPointOrder int32 Нет Да — Порядок точки в маршруте.
bidPointExternalId string Нет Да — Идентификатор точки в партнёрском сервисе, если событие относится к точке.

RouteSimpleModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
distance double Да Нет — Дистанция маршрута в метрах
duration double Да Нет — Продолжительность маршрута в секундах
distanceWithoutEmptyMileage double Да Нет — Дистанция маршрута от первой точки до последней, в метрах
emptyMileageDistance double Да Нет — Дистанция маршрута от нулевой точки до первой точки, в метрах
durationWithoutEmptyMileage double Да Нет — Продолжительность маршрута от первой точки до последней, в секундах
routeOptions RouteOptions Нет Нет — Опции графхоппера

CarRouteForExternalModel

Поле Тип Обязательно null Ограничения Описание
emptyMileageRoute TraveledRouteFixedAtPartModel[] Нет Да — Пройденный маршрут от точки 0 до точки А (координаты + время фиксации)
mainRoute TraveledRouteFixedAtPartModel[] Нет Да — Пройденный маршрут от точки А до конца маршрута (координаты + время фиксации)
carId int64 Да Нет — Идентификатор машины
carNumber string Нет Да — Номер машины
hasActiveMileage boolean Да Нет — У заявки есть активный пробег (заехала в первую точку по заявке)
isMobile boolean Да Нет — Данная часть маршрута построена из мобильных координат

ChatMessageGetModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
text string Нет Да — Текст
createdAt date-time Да Нет — Дата написания
chatId int64 Да Нет — —
createdById int64 Нет Да — —
fileId int64 Нет Да — Устаревшее поле. В новой интеграции используйте files[].
fileIds int64[] Нет Да — Устаревшее поле. В новой интеграции используйте files[].
file FileModel Нет Нет — Устаревшее поле. В новой интеграции используйте files[].
createdBy UserChatModel Нет Нет — Профиль того, кто написал сообщение
isDeleted boolean Да Нет — —
userMessagesInfo UserMessageInfoModel[] Нет Да — —
files FileModel[] Нет Да — Авторитетный список файлов сообщения для новой интеграции.
type UserMessageType Нет Нет — —

QueuedApiTaskCommandsCollectionModel

Коллекция команд на выполнение

Поле Тип Обязательно null Ограничения Описание
commands QueuedApiTaskAddCommandsModel[] Нет Да — Команды

QueuedApiTaskAddCommandsModel

Модель задания с указанным типом действия и объектами

Поле Тип Обязательно null Ограничения Описание
action QueuedApiTaskAction Да Нет — Действие
objects QueuedApiTaskObjectAddModel[] Нет Да — Объекты

QueuedApiTaskObjectAddModel

Модель объекта задания со статусом

Поле Тип Обязательно null Ограничения Описание
modelType QueuedApiTaskModelType Да Нет — Тип модели объекта
status QueuedApiTaskObjectStatusJson Нет Нет — Диагностический статус. В документированных партнёрских командах не передаётся.
body JsonObject Нет Нет — Тело объекта. Обязательно для action=Write; для Read и ReadQuery не передаётся.
key string Нет Да — Внешний ключ объекта
type InternalEntityType Да Нет — Тип объекта
sourceType SourceType Нет Да — Служебное поле. В документированных партнёрских командах не передаётся.
id int64 Нет Да — Внутренний идентификатор объекта, если null или 0, то будет создан новый объект
version uuid Нет Да — Версия объекта. Если указано id, а version не передан, проверка версии не выполняется.
query string Нет Да — OData-запрос для ReadQuery. При его использовании поля id, version и key не передаются.

QueuedApiTaskGetResultsModel

Модель для получения результатов

Поле Тип Обязательно null Ограничения Описание
message string Нет Да — Сообщение
status QueuedApiTaskStatus Да Нет — Статус задания
origin QueuedApiTaskOrigin Да Нет — Источник задания: запрос клиента или подписка на изменения
readyInMsec int64 Да Нет — Примерное время, через которое можно будет получить результат
remainingObjectCount int32 Да Нет — Оставшееся количество объектов на выполнение
attemptCount int32 Да Нет — Текущая попытка обработки
maxAttemptCount int32 Да Нет — Максимально допустимое количество попыток
nextRetryAt date-time Нет Да — Следующее запланированное время повтора
callbackStatus QueuedApiTaskCallbackStatus Да Нет — Статус доставки webhook
callbackAttemptCount int32 Да Нет — Текущая попытка доставки задачи
callbackMaxAttemptCount int32 Да Нет — Максимально допустимое количество попыток доставки
callbackNextRetryAt date-time Нет Да — Следующее запланированное время повтора доставки
callbackDeliveredAt date-time Нет Да — Дата успешной доставки
lastError string Нет Да — Последняя ошибка доставки
objects QueuedApiTaskObjectResultModel[] Нет Да — Объекты

QueuedApiTaskObjectResultModel

Модель для элемента объекта при получении сформированных данных

Поле Тип Обязательно null Ограничения Описание
message string Нет Да — Сообщение
status QueuedApiTaskObjectResultStatus Да Нет — Статус
body JsonObject Нет Нет — Данные
key string Нет Да — Внешний ключ объекта
type InternalEntityType Да Нет — Тип объекта
sourceType SourceType Нет Да — —
id int64 Нет Да — Внутренний идентификатор обработанного объекта CARGO.RUN.
version uuid Нет Да — Версия объекта. Если указано id, а version отсутствует, проверка версии не выполнялась.
query string Нет Да — OData-запрос задачи ReadQuery; поля id, version и key для такой задачи отсутствуют.

Связанные модели

AverageAxisLoadValueModel

Поле Тип Обязательно null Ограничения Описание
averageValue double Нет Да — Среднее значение

AvoidSpecialRoadFlags

Схема не содержит именованных полей.

AvoidTollRoadFlags

Схема не содержит именованных полей.

BidEstimationModel

Поле Тип Обязательно null Ограничения Описание
estimatedDate date-time Нет Да — Расчётная дата въезда
manualEstimatedLeaveDate date-time Нет Да — Ручная дата выезда из точки

BidPaymentGetModel

Поле Тип Обязательно null Ограничения Описание
documentsTrackingStatus DocumentsTrackingStatus Нет Да — —
plannedArrivalDate date Нет Да — —
documentsReceiptDate date Нет Да — —
invoiceDate date Нет Да — —
planPaymentDate date Нет Да — —
factPaymentDate date Нет Да — —
paymentStatus BidPaymentStatus Да Нет — —
isPaymentOverdue boolean Да Нет — —
remainingPayment double Нет Да — —
comment string Нет Да — —
updatedAt date-time Да Нет — —

BidPaymentStatus

Схема не содержит именованных полей.

BidPointLoadUnloadStatus

Схема не содержит именованных полей.

BidPointType

Схема не содержит именованных полей.

BidPointViewModel

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

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
order int32 Да Нет — Порядок точки
type BidPointType Да Нет — Тип точки
counterpartyPointId int64 Нет Да — —
customPointTypeId int64 Нет Да — —
enteredAt date-time Нет Да — Дата въезда в геозону от водителя
loadUnloadedAt date-time Нет Да — Дата загрузки/выгрузки от водителя
documentsReceivedAt date-time Нет Да — Дата получения документов, от водителя
autoEnteredAt date-time Нет Да — Автоматическая дата въезда в точку
autoLeavedAt date-time Нет Да — Автоматическая дата выезда из точки
enteredAtByLogist date-time Нет Да — Дата въезда в точку, проставленная логистом
loadUnloadedAtByLogist date-time Нет Да — Дата выгрузки/выезда из точки, проставленная логистом
axisLoadAfterLeaving AverageAxisLoadValueModel Нет Нет — Нагрузка на ось после выезда из точки
servicePoint ServicePointViewModel Нет Нет — Точка сервисных работ
scenarioId int64 Нет Да — Сценарий для водителя
planDistance double Нет Да — Плановое расстояние от предыдущей точки до текущей (метры)
factDistance double Нет Да — Фактическое расстояние от предыдущей точки до текущей (метры)
intOptions int32 Нет Да — Опции точки
client string Нет Да — —
comment string Нет Да — Комментарий к точке
externalId string Нет Да — Внешний ид точки
externalCity string Нет Да — Город для внешних систем
planEnterDate date-time Да Нет — Плановая локальная дата загрузки/выгрузки (по местному времени адреса точки).
planEnterDateOffset date-time Да Нет — Плановая дата загрузки/выгрузки, вычисленная по плановой локальной дате, учитывая часовой пояс точки.
planLeaveDateOffset date-time Нет Да — Плановая дата выезда. Если модуль планирования включен, вычисляется как плановая дата въезда + X часов.
secondaryPlanEnterDate date-time Нет Да — Вторая плановая дата въезда
secondaryPlanEnterDateOffset date-time Нет Да — Вторая плановая дата загрузки/выгрузки, вычисленная по плановой локальной дате, учитывая часовой пояс точки.
planLeaveDate date-time Нет Да — Плановая дата выезда
createdById int64 Да Нет — —
geozone MapObjectModel Нет Нет — Геозона
contactPerson ContactPersonModel Нет Нет — Контактное лицо
counterparty CounterpartyViewModel Нет Нет — Контрагент
loadOptions IdModel[] Нет Да — Типы загрузок/выгрузок на точке
typeOptions TypeOptionModel[] Нет Да — Дополнительные опции типов для точки
extendedProperties PropertyNameValueJsonObject[] Нет Да — Дополнительные поля точки заявки
customPointType CustomPointTypeModel Нет Нет — Тип произвольной точки

BidStatus

Схема не содержит именованных полей.

BidTemperatureRegimeModel

Поле Тип Обязательно null Ограничения Описание
temperatureMinimum float Нет Да — —
temperatureMaximum float Нет Да — —

CarSimpleModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
number string Нет Да — —
typeId int64 Да Нет — —
trackerId int64 Нет Да — —

CargoModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Да Нет — Наименование
weight double Нет Да — Вес
volume double Нет Да — Объём
length double Нет Да — Длина
height double Нет Да — Высота
width double Нет Да — Ширина
price double Нет Да — Стоимость
comment string Нет Да — Комментарий
description string Нет Да — Описание
typeId int64 Нет Да — Идентификатор типа Тип груза
loadingTypeId int64 Нет Да — Идентификатор типа Тип загрузки
unloadingTypeId int64 Нет Да — Идентификатор типа Тип выгрузки
packType string Нет Да — Тип упаковки
placesCount int16 Нет Да — Количество грузовых мест
unitOfMeasure UnitOfMeasure Нет Да — —
extendedProperties PropertyNameValueJsonObject[] Нет Да — Дополнительные поля груза заявки
typeOptions TypeOptionModel[] Нет Да — Дополнительные опции типов для груза

ContactPersonModel

Контактное лицо

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
phoneNumber string Нет Да — Номер телефона, если такой контакт был введен ранее, существующие данные будут использованы
name string Нет Да — Имя

CounterpartyRegistryEntryViewModel

Запись реестра недобросовестных контрагентов

Поле Тип Обязательно null Ограничения Описание
inn string Нет Да — —
ratings CounterpartyRegistryRatingViewModel[] Нет Да — —
insolvencyRank int32 Да Нет — —
comments string[] Нет Да — —

CounterpartyRegistryRatingViewModel

Оценка контрагента в реестре

Поле Тип Обязательно null Ограничения Описание
organizationName string Нет Да — —
comment string Нет Да — —

CounterpartyViewModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Нет Да — —
insolvencyRegistryEntry CounterpartyRegistryEntryViewModel Нет Нет — —

CustomPointTypeModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Нет Да — —
planStayPeriod int32 Да Нет — Плановое время нахождения на точке (ч)
isVisitOptional boolean Да Нет — —

DocumentsTrackingStatus

Схема не содержит именованных полей.

FileModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
originalFileName string Нет Да — —
fileName string Нет Да — —
extension string Нет Да — —
size int64 Да Нет — —
accessUrlLink string Нет Да — —
hashsum string Нет Да — —
mountPoint string Нет Да — —
relativePath string Нет Да — —
storageType int32 Да Нет — —
lastAccessedAt date-time Нет Да — —

IdModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —

IdNameModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Нет Да — —

IntegrationBidEventType

Схема не содержит именованных полей.

IntegrationBidPointAddressModel

Адрес точки маршрута во внешней заявке.

Поле Тип Обязательно null Ограничения Описание
location PointEditModel Нет Да — Координаты точки: [долгота, широта]. Если не переданы, CARGO.RUN определяет их по адресу.
city string Нет Да — —
address string Да Нет Непустая строка Адрес точки; обязателен даже при переданных координатах.
village string Нет Да — —
state string Нет Да — —
county string Нет Да — —
street string Нет Да — —
houseNumber string Нет Да — —
federalDistrict string Нет Да — —

IntegrationBidPointModel

Точка маршрута во внешней заявке.

Поле Тип Обязательно null Ограничения Описание
isLoadPoint boolean Да Нет — Признак точки погрузки. Если false — точка выгрузки.
planEnterDate date-time Да Нет — Плановая локальная дата прибытия.
planLeaveDate date-time Нет Да — Плановая локальная дата выезда.
secondaryPlanEnterDate date-time Нет Да — Вторая граница диапазона плановой даты прибытия.
externalId string Нет Да max length: 72 Идентификатор точки в партнёрском сервисе.
client string Нет Да — Клиент.
comment string Нет Да max length: 8092 Комментарий.
geozone IntegrationBidPointAddressModel Да Нет — Адрес и координаты точки.
contactPerson IntegrationContactPersonModel Нет Нет — Контактное лицо.

IntegrationContactPersonModel

Контактное лицо точки маршрута.

Поле Тип Обязательно null Ограничения Описание
phoneNumber string Нет Да — Номер телефона.
name string Нет Да — Имя.

IntegrationDriverModel

Водитель во внешней заявке.

Поле Тип Обязательно null Ограничения Описание
firstName string Нет Да — Имя.
lastName string Нет Да — Фамилия.
patronymic string Нет Да — Отчество.
phoneNumber string Да Да — Номер телефона.

IntegrationVehicleModel

Транспортное средство во внешней заявке.

Поле Тип Обязательно null Ограничения Описание
number string Да Да — Государственный номер.
brandName string Нет Да — Марка транспортного средства.

InternalEntityType

Тип внутренней сущности

Схема не содержит именованных полей.

InvoiceTriggerType

Схема не содержит именованных полей.

JsonObject

Схема не содержит именованных полей.

MapObjectModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
city string Нет Да — —
address string Нет Да — —
village string Нет Да — —
state string Нет Да — —
county string Нет Да — —
street string Нет Да — —
houseNumber string Нет Да — —
federalDistrict string Нет Да — —
radius double Нет Да — —
type MapObjectType Да Нет — —
coordinates double[][] Нет Нет min items: 3 Координаты полигона как массив точек: [[долгота, широта], ...].
location Point Да Нет — —

MapObjectType

Схема не содержит именованных полей.

PaymentPeriodType

Схема не содержит именованных полей.

Point

Поле Тип Обязательно null Ограничения Описание
type string Нет Нет — Тип геометрии (Point). Поле возвращается сервером и не передаётся в PointEditModel.
coordinates double[] Да Нет — Координаты точки в формате [долгота, широта], WGS 84.

PointEditModel

Поле Тип Обязательно null Ограничения Описание
coordinates double[] Да Нет min items: 2; max items: 2 Координаты точки в формате [долгота, широта], WGS 84.

PropertyNameValueJsonObject

Поле Тип Обязательно null Ограничения Описание
propertyName string Нет Да — —
value string Нет Да — Строковое значение дополнительного поля. Числа, даты и boolean передаются в строковом представлении.

QueuedApiTaskAction

Схема не содержит именованных полей.

QueuedApiTaskCallbackStatus

Схема не содержит именованных полей.

QueuedApiTaskModelType

Схема не содержит именованных полей.

QueuedApiTaskObjectResultStatus

Статус результата обработки объекта

Схема не содержит именованных полей.

QueuedApiTaskObjectStatusJson

Статус очереди заданий

Поле Тип Обязательно null Ограничения Описание
message string Нет Да — —
type QueuedApiTaskSyncStatus Да Нет — —

QueuedApiTaskOrigin

Источник задания

Схема не содержит именованных полей.

QueuedApiTaskStatus

Статус очереди заданий

Схема не содержит именованных полей.

QueuedApiTaskSyncStatus

Статус очереди заданий

Схема не содержит именованных полей.

RecipientInfoModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
fullName string Нет Да — —
bidRoles string[] Нет Да — —
isIntegrationAccount boolean Да Нет — —

RelatedDocumentModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Нет Да — —
count int32 Да Нет — —

ResourceInactivityInfoJsonObject

Поле Тип Обязательно null Ограничения Описание
inactivityReason string Нет Да — —
inactiveSince date-time Да Нет — —
inactiveUntil date-time Да Нет — —

RouteOptions

Поле Тип Обязательно null Ограничения Описание
avoidTollRoadFlags AvoidTollRoadFlags Да Нет — —
avoidSpecialRoadFlags AvoidSpecialRoadFlags Да Нет — —
disallowToll boolean Да Нет — —
disallowTollExceptM4 boolean Да Нет — —
disallowTollExceptM12DRT boolean Да Нет — —
allowFerry boolean Да Нет — —
calcTolls boolean Да Нет — —
country RouterCountryType Нет Да — —
routerProfile RouterProfile Нет Да — —
useSpecialProfileForEmptyRoute boolean Да Нет — —

RouterCountryType

Схема не содержит именованных полей.

RouterProfile

Схема не содержит именованных полей.

ServicePointViewModel

Поле Тип Обязательно null Ограничения Описание
serviceStationName string Нет Да — Наименование СТО
serviceType string Нет Да — Тип сервисной работы
phoneNumber string Нет Да — Cотовый телефон
initiator string Нет Да — Инициатор
withoutCargo boolean Да Нет — Опция "Без груза"
externalId string Нет Да — Идентификатор сервисной работы в Эксплуатации

SourceType

Схема не содержит именованных полей.

TemperatureValueModel

Поле Тип Обязательно null Ограничения Описание
values float[] Нет Да — Значения
fixedAt date-time Да Нет — Дата и время фиксации

TrailerListFuelTankModel

Топливный бак прицепа

Поле Тип Обязательно null Ограничения Описание
totalVolume double Да Нет — Общий объём
fuelConsumption double Да Нет — Расход топлива

TrailerListViewModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
trackerId int64 Нет Да — Идентификатор трекера
typeId int64 Нет Да — Тип прицепа.
brandTypeId int64 Нет Да — Марка прицепа.
number string Нет Да — Номер.
trackerDeviceNumber string Нет Да — Номер трекера
comment string Нет Да — —
loadUnloadOptions IdModel[] Нет Да — Типы загрузки/выгрузки
isActive boolean Да Нет — Признак активности
resourceInactivityInfo ResourceInactivityInfoJsonObject Нет Нет — Сведения о неактивности
transportColumn IdNameModel Нет Нет — Транспортная колонна
mechanic IdNameModel Нет Нет — Механик
isDeleted boolean Да Нет — Признак удаления
isInRefuelingSyncList boolean Да Нет — Участвует в планировании заправок?
fuelTank TrailerListFuelTankModel Нет Нет — Данные бака
lastDieselSensorValueFixedAt date-time Нет Да — Время последней фиксации ДУТ
accessPermitIds int64[] Нет Да — Допуски и разрешения

TraveledRouteFixedAtPartModel

Поле Тип Обязательно null Ограничения Описание
coordinate double[] Нет Да min items: 2; max items: 2 Координата фактического маршрута в формате [долгота, широта], WGS 84.
fixedAt date-time Да Нет — —

TypeOptionModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — Идентификатор типа
entityOptionId int64 Да Нет — Идентификатор опции сущности

UnitOfMeasure

Схема не содержит именованных полей.

UserChatModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
fullName string Нет Да — —

UserMessageFlag

Схема не содержит именованных полей.

UserMessageInfoModel

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
createdAt date-time Да Нет — —
readAt date-time Нет Да — —
isRead boolean Да Нет — —
isDeleted boolean Да Нет — —
type UserMessageType Да Нет — —
flags UserMessageFlag Да Нет — —
recipient RecipientInfoModel Нет Нет — —

UserMessageType

Схема не содержит именованных полей.

Вложенные модели

IntegrationBidDetailsModel.bid

Модель заявки для синхронизации с внешними сервисами

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
price double Нет Да — Цена
priceWithoutVatOnTop double Нет Да — Цена без НДС. Будет null, если isVatTop = false
status BidStatus Да Нет — —
createdAt date-time Да Нет — Дата создания заявки
externalUpdatedAt date-time Нет Да — Дата обновления из внешней системы
acceptedByDriverForwarderAt date-time Нет Да — Дата принятия водителем-экспедитором
hasFactoring boolean Да Нет — Заявка отправлена на факторинг?
createdById int64 Да Нет — Идентификатор пользователя, кто создал заявку
paymentTypeId int64 Нет Да — Идентификатор Типа оплаты
ndsTypeId int64 Нет Да — Идентификатор Типа ндс
isVatTop boolean Да Нет — НДС сверху
counterpartyId int64 Нет Да — Контрагент
contractId int64 Нет Да — Договор контрагента
isEmptyMileageBid boolean Да Нет — Порожняя заявка?
driverId int64 Нет Да — Текущий водитель заявки
isDriverForwarder boolean Да Нет — Является ли водитель экспедитором?
secondaryDriverId int64 Нет Да — Второй водитель заявки
approvedById int64 Нет Да — Идентификатор пользователя-оператора, который согласовал заявку
(используется если у организации включен модуль согласования заявок)
approvedAt date-time Нет Да — Дата согласования оператором (используется если у организации включен модуль согласования заявок)
responsibleId int64 Нет Да — Идентификатор ответственного
salesManagerId int64 Нет Да — Идентификатор менеджера по продажам
carLogistId int64 Нет Да — Идентификатор логиста, который был привязан к машине на момент создания заявки
distributionBidId int64 Нет Да — Идентификатор заказа, из которого создана эта заявка
routeId int64 Нет Да — Идентификатор маршрута
planMileage double Да Нет — Плановый пробег (метры)
factMileage double Да Нет — Фактический пробег (метры)
planEmptyMileageBefore double Да Нет — Плановый порожний пробег до текущей заявки от предыдущей (метры)
factEmptyMileageBefore double Да Нет — Фактический порожний пробег до первой точки текущей заявки, включая пробег предыдущей порожней заявки (метры)
factEmptyMileageFromStartPoint double Да Нет — Фактический порожний пробег внутри заявки. Включает в себя пробег от нулевой до первой точки текущей заявки (метры)
factEmptyOdometerMileageBefore double Да Нет — Фактический порожний пробег по одометру до первой точки текущей заявки, включая пробег предыдущей порожней заявки (метры)
factEmptyOdometerMileageFromStartPoint double Да Нет — Фактический порожний пробег по одометру внутри заявки. Включает в себя пробег от нулевой до первой точки текущей заявки (метры)
updatedAt date-time Да Нет — Дата обновления
car IntegrationBidDetailsModel.bid.car Нет Нет — —
trailer IntegrationBidDetailsModel.bid.trailer Нет Нет — —
legalPerson IntegrationBidDetailsModel.bid.legalPerson Нет Нет — —
estimation IntegrationBidDetailsModel.bid.estimation Нет Нет — —
bidPointLoadUnloadStatus BidPointLoadUnloadStatus Нет Нет — —
bidPoints IntegrationBidDetailsModel.bid.bidPoints[] Нет Да — Точки загрузки
cargos IntegrationBidDetailsModel.bid.cargos[] Нет Да — Грузы
typeOptions IntegrationBidDetailsModel.bid.typeOptions[] Нет Да — Дополнительные опции типов для заявки
temperatureRegime IntegrationBidDetailsModel.bid.temperatureRegime Нет Нет — —
temperature IntegrationBidDetailsModel.bid.temperature Нет Нет — —
isInternational boolean Да Нет — —
documents IntegrationBidDetailsModel.bid.documents[] Нет Да — Список документов
extendedProperties IntegrationBidDetailsModel.bid.extendedProperties[] Нет Да — Дополнительные поля заявки
externalId string Нет Да — —
contractNumber string Нет Да — Номер договора
comment string Нет Да — Комментарий
clientBidNumber string Нет Да — Номер заявки клиента
clientBidDate date-time Нет Да — Дата заявки клиента
paymentPeriodInDays int32 Нет Да — Срок оплаты в днях
paymentPeriodType PaymentPeriodType Нет Нет — —
invoiceTriggerType InvoiceTriggerType Нет Нет — —
sourceType SourceType Да Нет — Источник заявки в CARGO.RUN. Поле возвращается сервером; партнёр его не задаёт.
acceptedByDriverAt date-time Нет Да — Дата принятия заявки водителем
hasItemsChange boolean Да Нет — true если есть перецепка/пересменка
isDeleted boolean Да Нет — Является ли сущность удаленной?
createDocumentAssignment boolean Да Нет — Нужно ли создавать задание сдачи документов водителю после завершения заявки?
hasServicePoints boolean Да Нет — true если есть точки сервисных работ
isPreBid boolean Да Нет — Предзаявка
payment IntegrationBidDetailsModel.bid.payment Нет Нет — —
accessPermitIds int64[] Нет Да — Допуски и разрешения

IntegrationBidDetailsModel.plannedRoute

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
distance double Да Нет — Дистанция маршрута в метрах
duration double Да Нет — Продолжительность маршрута в секундах
distanceWithoutEmptyMileage double Да Нет — Дистанция маршрута от первой точки до последней, в метрах
emptyMileageDistance double Да Нет — Дистанция маршрута от нулевой точки до первой точки, в метрах
durationWithoutEmptyMileage double Да Нет — Продолжительность маршрута от первой точки до последней, в секундах
routeOptions IntegrationBidDetailsModel.plannedRoute.routeOptions Нет Нет — —

IntegrationBidDetailsModel.events

Событие по заявке, вычисленное из фактических дат заявки и ее точек.

Поле Тип Обязательно null Ограничения Описание
type IntegrationBidEventType Да Нет — —
fixedAt date-time Да Нет — Дата события.
bidPointId int64 Нет Да — Идентификатор точки заявки, если событие относится к точке.
bidPointOrder int32 Нет Да — Порядок точки в маршруте.

IntegrationBidDetailsModel.driverMessages

Сообщение водителя по заявке.

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — Идентификатор сообщения.
text string Нет Да — Текст сообщения.
createdAt date-time Да Нет — Дата отправки сообщения.
displayName string Нет Да — Имя водителя, отправившего сообщение.
files IntegrationBidDetailsModel.driverMessages.files[] Нет Да — Прикреплённые файлы.

IntegrationBidDetailsModel.bid.car

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
number string Нет Да — —
typeId int64 Да Нет — —
trackerId int64 Нет Да — —

IntegrationBidDetailsModel.bid.trailer

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
trackerId int64 Нет Да — Идентификатор трекера
typeId int64 Нет Да — Тип прицепа.
brandTypeId int64 Нет Да — Марка прицепа.
number string Нет Да — Номер.
trackerDeviceNumber string Нет Да — Номер трекера
comment string Нет Да — —
loadUnloadOptions IntegrationBidDetailsModel.bid.trailer.loadUnloadOptions[] Нет Да — Типы загрузки/выгрузки
isActive boolean Да Нет — Признак активности
resourceInactivityInfo IntegrationBidDetailsModel.bid.trailer.resourceInactivityInfo Нет Нет — —
transportColumn IntegrationBidDetailsModel.bid.trailer.transportColumn Нет Нет — —
mechanic IntegrationBidDetailsModel.bid.trailer.mechanic Нет Нет — —
isDeleted boolean Да Нет — Признак удаления
isInRefuelingSyncList boolean Да Нет — Участвует в планировании заправок?
fuelTank IntegrationBidDetailsModel.bid.trailer.fuelTank Нет Нет — Топливный бак прицепа
lastDieselSensorValueFixedAt date-time Нет Да — Время последней фиксации ДУТ
accessPermitIds int64[] Нет Да — Допуски и разрешения

IntegrationBidDetailsModel.bid.legalPerson

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Нет Да — —

IntegrationBidDetailsModel.bid.estimation

Поле Тип Обязательно null Ограничения Описание
estimatedDate date-time Нет Да — Расчётная дата въезда
manualEstimatedLeaveDate date-time Нет Да — Ручная дата выезда из точки

IntegrationBidDetailsModel.bid.bidPoints

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

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
order int32 Да Нет — Порядок точки
type BidPointType Да Нет — —
counterpartyPointId int64 Нет Да — —
customPointTypeId int64 Нет Да — —
enteredAt date-time Нет Да — Дата въезда в геозону от водителя
loadUnloadedAt date-time Нет Да — Дата загрузки/выгрузки от водителя
documentsReceivedAt date-time Нет Да — Дата получения документов, от водителя
autoEnteredAt date-time Нет Да — Автоматическая дата въезда в точку
autoLeavedAt date-time Нет Да — Автоматическая дата выезда из точки
enteredAtByLogist date-time Нет Да — Дата въезда в точку, проставленная логистом
loadUnloadedAtByLogist date-time Нет Да — Дата выгрузки/выезда из точки, проставленная логистом
axisLoadAfterLeaving IntegrationBidDetailsModel.bid.bidPoints.axisLoadAfterLeaving Нет Нет — —
servicePoint IntegrationBidDetailsModel.bid.bidPoints.servicePoint Нет Нет — —
scenarioId int64 Нет Да — Сценарий для водителя
planDistance double Нет Да — Плановое расстояние от предыдущей точки до текущей (метры)
factDistance double Нет Да — Фактическое расстояние от предыдущей точки до текущей (метры)
intOptions int32 Нет Да — Опции точки
client string Нет Да — —
comment string Нет Да — Комментарий к точке
externalId string Нет Да — Внешний ид точки
externalCity string Нет Да — Город для внешних систем
planEnterDate date-time Да Нет — Плановая локальная дата загрузки/выгрузки (по местному времени адреса точки).
planEnterDateOffset date-time Да Нет — Плановая дата загрузки/выгрузки, вычисленная по плановой локальной дате, учитывая часовой пояс точки.
planLeaveDateOffset date-time Нет Да — Плановая дата выезда. Если модуль планирования включен, вычисляется как плановая дата въезда + X часов.
secondaryPlanEnterDate date-time Нет Да — Вторая плановая дата въезда
secondaryPlanEnterDateOffset date-time Нет Да — Вторая плановая дата загрузки/выгрузки, вычисленная по плановой локальной дате, учитывая часовой пояс точки.
planLeaveDate date-time Нет Да — Плановая дата выезда
createdById int64 Да Нет — —
geozone IntegrationBidDetailsModel.bid.bidPoints.geozone Нет Нет — —
contactPerson IntegrationBidDetailsModel.bid.bidPoints.contactPerson Нет Нет — Контактное лицо
counterparty IntegrationBidDetailsModel.bid.bidPoints.counterparty Нет Нет — —
loadOptions IntegrationBidDetailsModel.bid.bidPoints.loadOptions[] Нет Да — Типы загрузок/выгрузок на точке
typeOptions IntegrationBidDetailsModel.bid.bidPoints.typeOptions[] Нет Да — Дополнительные опции типов для точки
extendedProperties IntegrationBidDetailsModel.bid.bidPoints.extendedProperties[] Нет Да — Дополнительные поля точки заявки
customPointType IntegrationBidDetailsModel.bid.bidPoints.customPointType Нет Нет — —

IntegrationBidDetailsModel.bid.cargos

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Да Нет — Наименование
weight double Нет Да — Вес
volume double Нет Да — Объём
length double Нет Да — Длина
height double Нет Да — Высота
width double Нет Да — Ширина
price double Нет Да — Стоимость
comment string Нет Да — Комментарий
description string Нет Да — Описание
typeId int64 Нет Да — Идентификатор типа Тип груза
loadingTypeId int64 Нет Да — Идентификатор типа Тип загрузки
unloadingTypeId int64 Нет Да — Идентификатор типа Тип выгрузки
packType string Нет Да — Тип упаковки
placesCount int16 Нет Да — Количество грузовых мест
unitOfMeasure UnitOfMeasure Нет Нет — —
extendedProperties IntegrationBidDetailsModel.bid.cargos.extendedProperties[] Нет Да — Дополнительные поля груза заявки
typeOptions IntegrationBidDetailsModel.bid.cargos.typeOptions[] Нет Да — Дополнительные опции типов для груза

IntegrationBidDetailsModel.bid.typeOptions

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — Идентификатор типа
entityOptionId int64 Да Нет — Идентификатор опции сущности

IntegrationBidDetailsModel.bid.temperatureRegime

Поле Тип Обязательно null Ограничения Описание
temperatureMinimum float Нет Да — —
temperatureMaximum float Нет Да — —

IntegrationBidDetailsModel.bid.temperature

Поле Тип Обязательно null Ограничения Описание
values float[] Нет Да — Значения
fixedAt date-time Да Нет — Дата и время фиксации

IntegrationBidDetailsModel.bid.documents

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Нет Да — —
count int32 Да Нет — —

IntegrationBidDetailsModel.bid.extendedProperties

Поле Тип Обязательно null Ограничения Описание
propertyName string Нет Да — —
value string Нет Да — Строковое значение дополнительного поля. Числа, даты и boolean передаются в строковом представлении.

IntegrationBidDetailsModel.bid.payment

Поле Тип Обязательно null Ограничения Описание
documentsTrackingStatus DocumentsTrackingStatus Нет Нет — —
plannedArrivalDate date Нет Да — —
documentsReceiptDate date Нет Да — —
invoiceDate date Нет Да — —
planPaymentDate date Нет Да — —
factPaymentDate date Нет Да — —
paymentStatus BidPaymentStatus Да Нет — —
isPaymentOverdue boolean Да Нет — —
remainingPayment double Нет Да — —
comment string Нет Да — —
updatedAt date-time Да Нет — —

IntegrationBidDetailsModel.plannedRoute.routeOptions

Поле Тип Обязательно null Ограничения Описание
avoidTollRoadFlags AvoidTollRoadFlags Да Нет — —
avoidSpecialRoadFlags AvoidSpecialRoadFlags Да Нет — —
disallowToll boolean Да Нет — —
disallowTollExceptM4 boolean Да Нет — —
disallowTollExceptM12DRT boolean Да Нет — —
allowFerry boolean Да Нет — —
calcTolls boolean Да Нет — —
country RouterCountryType Нет Нет — —
routerProfile RouterProfile Нет Нет — —
useSpecialProfileForEmptyRoute boolean Да Нет — —

IntegrationBidDetailsModel.driverMessages.files

Файл для партнёрского сервиса.

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — Идентификатор файла.
originalFileName string Нет Да — Исходное имя файла.
accessUrlLink string Нет Да — Временная ссылка для скачивания файла.
Срок действия ссылки ограничен, после его истечения данные нужно прочитать заново.

IntegrationBidDetailsModel.bid.trailer.loadUnloadOptions

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —

IntegrationBidDetailsModel.bid.trailer.resourceInactivityInfo

Поле Тип Обязательно null Ограничения Описание
inactivityReason string Нет Да — —
inactiveSince date-time Да Нет — —
inactiveUntil date-time Да Нет — —

IntegrationBidDetailsModel.bid.trailer.transportColumn

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Нет Да — —

IntegrationBidDetailsModel.bid.trailer.mechanic

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Нет Да — —

IntegrationBidDetailsModel.bid.trailer.fuelTank

Топливный бак прицепа

Поле Тип Обязательно null Ограничения Описание
totalVolume double Да Нет — Общий объём
fuelConsumption double Да Нет — Расход топлива

IntegrationBidDetailsModel.bid.bidPoints.axisLoadAfterLeaving

Поле Тип Обязательно null Ограничения Описание
averageValue double Нет Да — Среднее значение

IntegrationBidDetailsModel.bid.bidPoints.servicePoint

Поле Тип Обязательно null Ограничения Описание
serviceStationName string Нет Да — Наименование СТО
serviceType string Нет Да — Тип сервисной работы
phoneNumber string Нет Да — Cотовый телефон
initiator string Нет Да — Инициатор
withoutCargo boolean Да Нет — Опция "Без груза"
externalId string Нет Да — Идентификатор сервисной работы в Эксплуатации

IntegrationBidDetailsModel.bid.bidPoints.geozone

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
city string Нет Да — —
address string Нет Да — —
village string Нет Да — —
state string Нет Да — —
county string Нет Да — —
street string Нет Да — —
houseNumber string Нет Да — —
federalDistrict string Нет Да — —
radius double Нет Да — —
type MapObjectType Да Нет — —
coordinates double[][] Нет Нет min items: 3 Координаты полигона как массив точек: [[долгота, широта], ...].
location IntegrationBidDetailsModel.bid.bidPoints.geozone.location Да Нет — —

IntegrationBidDetailsModel.bid.bidPoints.contactPerson

Контактное лицо

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
phoneNumber string Нет Да — Номер телефона, если такой контакт был введен ранее, существующие данные будут использованы
name string Нет Да — Имя

IntegrationBidDetailsModel.bid.bidPoints.counterparty

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Нет Да — —
insolvencyRegistryEntry IntegrationBidDetailsModel.bid.bidPoints.counterparty.insolvencyRegistryEntry Нет Нет — Запись реестра недобросовестных контрагентов

IntegrationBidDetailsModel.bid.bidPoints.loadOptions

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —

IntegrationBidDetailsModel.bid.bidPoints.typeOptions

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — Идентификатор типа
entityOptionId int64 Да Нет — Идентификатор опции сущности

IntegrationBidDetailsModel.bid.bidPoints.extendedProperties

Поле Тип Обязательно null Ограничения Описание
propertyName string Нет Да — —
value string Нет Да — Строковое значение дополнительного поля. Числа, даты и boolean передаются в строковом представлении.

IntegrationBidDetailsModel.bid.bidPoints.customPointType

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — —
name string Нет Да — —
planStayPeriod int32 Да Нет — Плановое время нахождения на точке (ч)
isVisitOptional boolean Да Нет — —

IntegrationBidDetailsModel.bid.cargos.extendedProperties

Поле Тип Обязательно null Ограничения Описание
propertyName string Нет Да — —
value string Нет Да — Строковое значение дополнительного поля. Числа, даты и boolean передаются в строковом представлении.

IntegrationBidDetailsModel.bid.cargos.typeOptions

Поле Тип Обязательно null Ограничения Описание
id int64 Да Нет — Идентификатор типа
entityOptionId int64 Да Нет — Идентификатор опции сущности

IntegrationBidDetailsModel.bid.bidPoints.geozone.location

Поле Тип Обязательно null Ограничения Описание
type string Нет Нет — Тип геометрии (Point). Поле возвращается сервером.
coordinates double[] Нет Нет — Координата (долгота, широта)

IntegrationBidDetailsModel.bid.bidPoints.counterparty.insolvencyRegistryEntry

Запись реестра недобросовестных контрагентов

Поле Тип Обязательно null Ограничения Описание
inn string Нет Да — —
ratings IntegrationBidDetailsModel.bid.bidPoints.counterparty.insolvencyRegistryEntry.ratings[] Нет Да — —
insolvencyRank int32 Да Нет — —
comments string[] Нет Да — —

IntegrationBidDetailsModel.bid.bidPoints.counterparty.insolvencyRegistryEntry.ratings

Оценка контрагента в реестре

Поле Тип Обязательно null Ограничения Описание
organizationName string Нет Да — —
comment string Нет Да — —

Возможные значения полей

Все enum в запросах, синхронных ответах, результатах очереди и webhook передаются в JSON строковыми именами, указанными в колонке JSON. Числовые коды приведены только как справочная информация и не являются wire-форматом API.

BidStatus

JSON Код в реализации Значение
New 0 Черновик
Planned 5 Запланирована, но ещё не запущена
Started 10 Запущена в работу
Canceled 20 Отменена
Done 30 Выполнена

Жизненный цикл заявки

Для заявки, успешно созданной через Bids/Apply, основной наблюдаемый путь выглядит так:

Started → Done
   └──→ Canceled

New означает черновик, Planned — запланированную заявку до запуска, Started — заявку в работе, Done — завершённую, Canceled — отменённую. Метод Bids/Apply после успешного создания запускает заявку в работу, поэтому партнёр обычно получает Started. CARGO.RUN может вернуть заявку в работу, поэтому обработчик партнёра не должен считать статусы монотонными. Диаграмма описывает партнёрский сценарий, а не полный перечень разрешённых переходов пользовательского интерфейса CARGO.RUN.

Текущий статус всегда определяется по полю status карточки или краткой модели заявки. Изменение статуса также может поступить через entity.changed.

IntegrationBidEventType

JSON Код Значение
BidStarted 1 Заявка запущена
AcceptedByDriver 2 Принята водителем
AcceptedByDriverForwarder 3 Принята водителем-экспедитором
EnteredPointByDriver 4 Водитель отметил прибытие на точку
LoadUnloadedByDriver 5 Водитель отметил погрузку/выгрузку и выезд
DocumentsReceivedByDriver 6 Водитель подтвердил получение документов
BidCompleted 7 Заявка завершена
BidCanceled 8 Заявка отменена
BidDeleted 9 Заявка удалена

IntegrationBidEventType описывает этапы исполнения, вычисленные по фактическим датам заявки и её точек, включая отмену и удаление.

QueuedApiTaskAction

JSON Код Доступность партнёру
Write 0 Да, для Bid
Read 1 Да, для Bid с указанным id
ReadConfirmation 2 Нет
ReadQuery 3 Да, для Bid
Delete 4 Нет

QueuedApiTaskStatus

JSON Код Значение
Awaiting 0 Ожидает выполнения
InProgress 1 Выполняется
Completed 2 Завершена; нужно проверить каждый объект
Error 3 Задача завершилась системной ошибкой

QueuedApiTaskEnqueueStatus

JSON Код Значение
Success 0 Команда поставлена в очередь; поле id заполнено
Failed 1 Команда не поставлена; причина находится в message

QueuedApiTaskOrigin

JSON Код Значение
Request 0 Задача создана запросом партнёра
Subscription 1 Задача создана CARGO.RUN по подписке

QueuedApiTaskCallbackStatus

JSON Код Значение
None 0 Callback отсутствует или доставка ещё не назначена
Awaiting 1 Ожидает доставки
InProgress 2 Выполняется попытка доставки
Delivered 3 Доставлен успешно
Error 4 Доставка завершилась ошибкой

QueuedApiTaskObjectResultStatus

JSON Код Значение
Created 0 Результат создан, обработка не завершена
Success 1 Объект обработан успешно
Error 2 Ошибка конкретного объекта
VersionMismatch 3 Версия не совпала; относится к недоступному партнёру действию ReadConfirmation

Значения ошибок в разных enum

Одинаковое имя Error относится к разным уровням обработки:

Поле Enum Что означает Error
QueuedApiTaskGetResultsModel.status QueuedApiTaskStatus Системная ошибка задачи целиком; результат мог не быть сформирован
objects[].status QueuedApiTaskObjectResultStatus Ошибка обработки конкретного объекта; остальные объекты задачи могут быть успешны
callbackStatus QueuedApiTaskCallbackStatus Все предусмотренные попытки доставки webhook для задачи завершились ошибкой
QueuedApiTaskObjectStatusJson.type QueuedApiTaskSyncStatus Диагностический уровень статуса синхронизации объекта

Проверяйте эти поля независимо. Например, задача может иметь status=Completed, один объект — status=Error, а webhook — callbackStatus=Delivered.

QueuedApiTaskModelType

JSON Код Доступность партнёру
Default 0 Полная модель или стандартная модель операции
BidSharedInfoForForwardingModel 1 Не используется партнёрским API
Summary 2 Краткая карточка заявки

InternalEntityType

JSON Код Доступность в партнёрской очереди
Bid 1 Поддерживается
DistributionBid 2 Не поддерживается
Car 3 Не поддерживается
Trailer 4 Не поддерживается
Driver 5 Не поддерживается
Counterparty 6 Не поддерживается

SourceType

Поле является выходным признаком источника заявки. Партнёр не передаёт sourceType при Bids/Apply и в документированных командах очереди. Для заявки, созданной партнёрской интеграцией, CARGO.RUN устанавливает ExternalIntegration; у связанной заявки, созданной перевозчиком, может вернуться другой источник.

JSON Код
Web 0
Enterprise 1
Forwarding 2
Exploitation 3
Kontur 4
ExternalIntegration 5

Типы webhook

Это строковые значения заголовка, а не enum JSON:

Значение Смысл
queued-task.finished Завершение задачи партнёра
entity.changed Изменение связанной заявки
ping Тест callback

UserMessageType

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

JSON Код Значение
User 0 Сообщение пользователя
System 10 Системное уведомление
BidStart 20 Запуск заявки
BidApproved 21 Согласование заявки
DriverControlPoints 22 Задание водителю
BidLateness 30 Опоздание по заявке
BidPointLateness 31 Опоздание на точку
TrackerLogsStopped 32 Нет данных трекера
CarStopped 33 Длительная стоянка
RouteEvents 34 Отклонение от маршрута
AxisLoadMonitoring 35 Отклонение нагрузки на ось
CarStaysAtBidPoint 36 Задержка на точке
BidAcceptLateness 37 Заявка не принята вовремя
TemperatureMonitoring 38 Отклонение температуры
BidRefuelingPointArrival 40 Прибытие/выезд с заправки
BidPlannedRefuelings 41 Планирование заправок
RefuelingSkipped 42 Пропуск заправки
PointVisiting 50 Прибытие/выезд с точки
LoadLateness 60 Опоздание на загрузку
ServicePoints 70 Сервисная точка
Waybills 80 Электронные путевые документы
EmergencyAreaVisit 90 Посещение аварийной зоны
DocumentStatus 100 Изменение статуса документа
DocumentFile 101 Файл документа
RouteControlPoints 102 Контроль планового маршрута

Остальные enum моделей заявки

Эти перечисления встречаются во вложенных полях полной карточки заявки.

BidPointType

JSON Код Значение
StartPoint 0 Начальная, или нулевая, точка
LoadPoint 1 Погрузка
UnloadPoint 2 Выгрузка
CustomPoint 3 Пользовательская точка
ServicePoint 4 Сервисная точка

BidPointLoadUnloadStatus

JSON Код Значение
AtLoading 0 Автомобиль находится на погрузке
Loaded 10 Погрузка завершена
AtUnloading 20 Автомобиль находится на выгрузке
Unloaded 30 Выгрузка завершена

BidPaymentStatus

JSON Код Значение
NotPaid 0 Не оплачено
Paid 1 Оплачено полностью
PartiallyPaid 2 Оплачено частично

DocumentsTrackingStatus

JSON Код Значение
NotShipped 0 Документы не отправлены
InTransit 10 Документы в пути
Delivered 20 Документы доставлены

InvoiceTriggerType

JSON Код Значение
ByOriginal 1 Счёт выставляется после получения оригиналов
ByScan 2 Счёт выставляется по скан-копиям
AtUnloading 3 Счёт выставляется после выгрузки

PaymentPeriodType

JSON Код Значение
InCalendarDays 1 Срок в календарных днях
InBankingDays 2 Срок в банковских днях

MapObjectType

Классификация возвращаемых объектов карты и геозон. В текущем сценарии создания заявки партнёр передаёт адрес и точечные координаты, но не задаёт MapObjectType.

JSON Код
None 0
BidPoint 10
RouteSupportPoint 20
GasStation 21
StartBidPoint 40
PostamatPoint 50
ItemChangePoint 60
ItemChangePointAddress 61
ServicePoint 70
CounterpartyPoint 80
TripCouplingPoint 90
PlatonPoint 100
EmergencyAreaPoint 110
RouteControlPoint 120

RouterCountryType

JSON Код Значение
Russia 1 Россия; поле относится к параметрам рассчитанного маршрута

RouterProfile

JSON Код Значение
HgvOptimal 1 Оптимальный маршрут для грузового автомобиля
HgvShortest 2 Кратчайший маршрут для грузового автомобиля
Hgv15tOptimal 3 Оптимальный маршрут для грузового автомобиля массой до 15 тонн
Lcv 4 Маршрут для лёгкого коммерческого транспорта

QueuedApiTaskSyncStatus

JSON Код Значение
Info 0 Информационное сообщение, действий не требуется
Warn 1 Предупреждение: обработка продолжена, сообщение следует записать в журнал
Error 2 Ошибка синхронизации объекта

UserMessageFlag

В JSON поле передаётся строковым именем. В текущем партнёрском сценарии используются None и Mentioned; числовые комбинации партнёру формировать не требуется.

UnitOfMeasure

В JSON передаётся строковое имя из первой колонки. Числовой классификационный код приведён только для справки.

JSON Классификационный код
None 0
Piece 796
Kilogram 166
Gram 163
Tonne 168
Litre 112
Millilitre 111
Meter 6
Centimeter 4
Millimeter 3
LinearMeter 18
SquareMeter 55
CubicMeter 113
Package 778
Box 8751
Bottle 868
Can 881
Pack 728
Set 839
Pair 715
Hour 356
Minute 355
Day 359
Month 362
Year 366
ConditionalUnit 876
HorsePower 251