Глоссарий¶

В документации используются термины CARGO.RUN Загрузки. Их важно различать, потому что часть терминов в интерфейсе и API может звучать похоже.

Заказ¶

Потенциальная перевозка, которую грузоотправитель или экспедитор создает в CARGO.RUN.

Заказ содержит:

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

Основные методы:

POST /api/Orders/Apply;
GET /api/Orders/GetIntegrationList;
GET /api/Orders/GetInfo.

Заявка¶

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

В API перевозчика для таких рейсов используются методы TransporterBids.

Отклик¶

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

Отклик может содержать:

перевозчика;
ТС;
прицеп;
водителя;
логиста перевозчика;
предложенную ставку;
статус отклика.

В деталях заказа отклики доступны в поле matchingCars.

Матчинг¶

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

В документации термины "отклик" и "матчинг" могут использоваться рядом:

"отклик" — пользовательский термин;
"матчинг" — термин API и моделей данных.

Владелец заказа¶

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

Владелец заказа получает отклики и принимает выбранного перевозчика.

Перевозчик¶

Организация, которая видит доступные заказы и отправляет отклики.

Перевозчик работает со своими справочниками:

ТС;
прицепы;
водители.

Технический пользователь¶

Учетная запись, используемая внешней системой для авторизации в API.

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

Тип цены заказа¶

Поле orderPriceType определяет механику цены:

Код	Значение	Описание
`10`	`Static`	Фиксированная стоимость
`20`	`Auction`	Аукцион
`30`	`Offer`	Предложение цены

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

Погрузка, выгрузка или транзитная точка.

Поле pointType:

Код	Значение	Описание
`0`	`Default`	Не задано
`10`	`Load`	Погрузка
`20`	`Unload`	Выгрузка
`30`	`Transit`	Транзит