cargo.run-api-docs

Глоссарий

Этот раздел содержит основные термины, используемые в документации и API CARGO.RUN Логистика.
Определения даны в техническом и интеграционном контексте.

Заявка (Bid)

Основная сущность планирования перевозки. Содержит:

информацию о контрагенте (заказчике),
параметры груза,
маршрутные точки,
сроки посещения точек,
стоимость и условия оплаты,
транспортное средство,
водитель,
полуприцеп.

Заявка является основой для формирования рейса.

Заказ (DistributionBid)

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

Используется для управления нераспределёнными рейсами.

Маршрутная точка (BidPoints)

Элемент маршрута, включающий:

адрес,
геокоординаты,
даты,
вид операции (погрузка, выгрузка, пересортировка).

Передаются массивом в сущности Заявка (Bid).

Контрагент (Counterparty)

Юридическое лицо заказчика перевозки:

В API используются поля counterpartyId и связанные справочники.

Организация (Organization)

Юридическое лицо перевозчика (транспортной компании).

Водитель (Driver)

Сотрудник транспортной компании, закреплённый за рейсом.
Связан с мобильным приложением CARGO.RUN Driver.

Машина (Car)

Транспортное средство — тягач или грузовик.
В API содержит:

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

Прицеп / Полуприцеп (Trailer)

Дополнительное транспортное средство, используемое с тягачом.
В API содержит:

государственный номер,
модель и марка,
тип полуприцепа (тент, изотерм, рефрижератор).

Может иметь привязанный трекер.

Трекер (Tracker)

Устройство телематики, передающее координаты и технические данные.

В API используются методы привязки/отвязки трекеров.

ЭТРН / Электронная транспортная накладная (EBill)

Электронный аналог транспортной накладной, содержащий:

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

API позволяет получать статусы ЭТРН и изменять титулы.

Сотрудник (Employee)

Человек, имеющий доступ в систему или связанный с операционными процессами:

логист,
водитель,
администратор,
бухгалтер.

Статус (Status)

Текущее состояние сущности:

заявки,
оплаты,
контрагента,
ЭТРН.

Перечни статусов находятся в разделе “Статусы”.

Идентификатор (ID)

Числовое значение, определяющее сущность в системе.
Все идентификаторы передаются как числа (не строки).

Токен (Token)

Ключ авторизации в API, выдаётся методом авторизации.
Передаётся в заголовке: Authorization: Bearer

Обновление данных (Sync / Synchronization)

Регулярное сравнение данных между внешней системой (1С, ERP) и CARGO.RUN:

синхронизация справочников,
обновление заявок,
передача статусов.

Описано в разделе “Синхронизация данных”.