cargo.run-api-docs

CARGO.RUN Logistics — Документация по API

Добро пожаловать в документацию по интеграции с CARGO.RUN Логистика.
Здесь собраны:

• правила работы с API (форматы данных, статусы, обязательные поля),
• сценарии интеграции с учетными системами (1С и др.),
• справочник методов API (по доменам: заявки, заказы, справочники, ЭТРН и пр.).

---

1. С чего начать

1. Прочитать общие принципы и архитектуру интеграции:
   Введение

2. Ознакомиться с базовыми понятиями и терминами:
   Глоссарий

3. Посмотреть, какие форматы данных используются во всех методах:
   Форматы данных

4. Понять, какие статусы бывают у заявок, контрагентов, ЭТРН и т.д.:
   Статусные модели

5. Уточнить минимальные требования к полям при создании сущностей:
   Минимальные требования к запросам

---

2. Сценарии интеграции

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

• Общий обзор интеграции
  Общий обзор

• Сценарий: заявка создается в CARGO.RUN
  CARGO.RUN → учетная система

• Сценарий: заявка создается во внешней системе
  Учетная система → CARGO.RUN

• Синхронизация справочников и статусов
  Синхронизация данных

• Примеры интеграции с 1С
  Примеры для 1С

---

3. API Reference

Технический справочник методов API, сгруппированных по доменам.
Раздел для разработчиков, которые пишут интеграцию.

• Общие принципы работы API, заголовки, ошибки
  Обзор API

• Авторизация и работа с токенами
  Auth API

• Справочники API справочников

• Заявки и рейсы
  Bids API

• Заказы / распределительные заявки
  Distribution bids API

• Трекеры и привязка к ТС
  Trackers API

• Электронные транспортные накладные (ЭТРН)
  ЭТРН API