cargo.run-api-docs

Обзор API CARGO.RUN

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

API CARGO.RUN построен на REST и использует:

Все структуры данных и модели определены в swagger (раздел components/schemas).

Большинство методов требует токен:

Authorization: Bearer <token>

Полное описание авторизации приведено в разделе:
Auth API

Структуры объектов строго соответствуют схемам swagger:

components → schemas

Объекты Заявки и Заказы содержат поле updatedAt, но официальная инкрементальная синхронизация реализована только методом:

GET /api/bids/GetListForExternal

API-методы по справочникам не поддерживают фильтрацию по updatedAt.

API принимает и возвращает JSON.
Подробные правила работы с форматами описаны в:
Форматы данных

Swagger задаёт даты как:

string (date-time)

Это формат ISO 8601.
Используйте смещения времени так, как указано в swagger-примерах (как правило, UTC).

Поддерживаются параметры OData:

Они применимы только к методам, в swagger которых явно описаны query‑параметры.

API CARGO.RUN регистронезависим.
Однако для единообразия во всей документации используется нижний регистр URL.

Swagger не описывает универсальную структуру ошибок.

API возвращает:

API CARGO.RUN использует только два HTTP‑метода:

GET — получение данных
POST — создание, обновление, удаление, отмена, восстановление, смена статусов

Методы DELETE, PUT, PATCH не используются.

Примеры POST-команд:

POST /api/bids/delete
POST /api/bids/restore
POST /api/truckingbids/revert
POST /api/truckingbids/setstatus
POST /api/truckingbids/forcecomplete

Для большинства сущностей используется единый подход:

POST /api/.../apply
{
  "id": 0,
  ...
}

POST /api/.../apply
{
  "id": <фактический идентификатор объекта>,
  ...
}

Общая синхронизация справочников и заявок:
Синхронизация данных