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

Этот раздел описывает методы API CARGO.RUN для работы с электронными транспортными накладными (ЭТРН) со стороны внешних систем, включая 1С и провайдеров ЭТРН.

Общие принципы работы API и авторизации см.:

1. Методы для 1С¶

1.1. Получение списка титулов со статусами¶

GET /api/1c/bills/gettitles

Назначение¶

Получение списка титулов ЭТРН с их текущими статусами в формате OData.

Метод возвращает коллекцию TitleExternalModel, в которой для каждого титула указаны:

id — идентификатор титула;
type — тип титула (TitleType);
status — статус (WaybillTitleStatus);
statusDate — дата и время изменения статуса;
bill — данные по накладной (WaybillExternalModel).

Статусы титулов ЭТРН

Параметры запроса¶

Метод поддерживает стандартные OData-параметры:

$filter — фильтр по полям модели TitleExternalModel;
$orderBy — сортировка;
$top — ограничение количества;
$skip — смещение;
$count — возврат количества записей;
$select — выбор полей.

Примеры:

Получить все титулы в статусе ReceivedOrCreated:

GET /api/1c/bills/gettitles?$filter=status eq 'ReceivedOrCreated'

Получить первые 50 титулов, отсортированных по дате статуса:

GET /api/1c/bills/gettitles?$orderby=statusDate desc&$top=50

1.2. Получение титула по заявке¶

GET /api/1c/Bills/GetTitle?titleId={titleId}&bidId={bidId}&bidExternalId={bidExternalId}

Назначение¶

Получение данных одного титула ЭТРН.

Метод может искать титул:

по идентификатору заявки и по идентификатору титула;
по внешнему идентификатору заявки и по идентификатору титула.

Параметры запроса¶

Метод поддерживает следующие query-параметры:

titleId — идентификатор титула (int64);
bidId — идентификатор заявки (int64);
bidExternalId — внешний идентификатор заявки (string).

Ответ — модель TitleWithRemarksExternalModel, содержащая:

данные титула;
статус и дату статуса;
комментарии и замечания, если есть.

1.3. Смена статуса титула¶

POST /api/1c/bills/applystatus

Назначение¶

Изменение статуса титула ЭТРН со стороны внешней системы.

Метод позволяет:

подтвердить титул;
отклонить титул;
передать новый статус обработки титула в CARGO.RUN.

Тело запроса¶

Тело описано моделью TitleStatusApplyExternalModel:

{
  "id": 0,
  "status": "Accepted",
  "bidId": 0,
  "bidExternalId": "string"
}

Поля:

id — идентификатор титула, обязательное поле;
status — новый статус титула, обязательное поле;
bidId — идентификатор заявки;
bidExternalId — внешний идентификатор заявки.

Поддерживаемые значения статуса¶

Список статусов задаётся enum WaybillTitleStatus:

Значение	Описание
`ReceivedOrCreated`	Титул получен или создан системой.
`Accepted`	Титул принят.
`Signed`	Титул подписан.
`Sent`	Титул передан на отправку.
`Processed`	Титул обработан.
`Declined`	Титул отклонён.
`Failed`	При обработке титула возникла ошибка.

2. Методы внешней Waybill-интеграции¶

Эти методы используются внешним сервисом ЭТРН для обмена данными с CARGO.RUN.

Метод	Описание
`GET /api/waybill/Bids/Get/{bidId}`	Получение данных заявки по идентификатору.
`GET /api/waybill/Bids/GetLoadPoints`	Получение активных точек загрузки для формирования первого титула.
`POST /api/waybill/Bids/BatchMarkBidPoints`	Отметка точек заявки как переданных в обработку.
`POST /api/waybill/Bids/ApplyTitle`	Сохранение титула в заявке.
`GET /api/waybill/Bids/GetAcceptedTitles`	Получение принятых титулов для последующей генерации QR-кодов.
`POST /api/waybill/Bids/BatchMarkTitles`	Отметка титулов как переданных в обработку.
`POST /api/waybill/Bids/ApplyQrCodes`	Сохранение QR-кодов в заявке.
`GET /api/waybill/Bids/GetTitleSignatures`	Получение электронных подписей титулов.
`POST /api/waybill/Bids/BatchMarkTitleSignatures`	Отметка подписей как переданных в обработку.
`GET /api/waybill/Bids/GetPaymentDetailsList`	Получение данных для оплаты.

3. Enum'ы¶

3.1. WaybillProviderType¶

Флаговый enum провайдера ЭТРН:

Значение	Код	Описание
`ProviderEmulator`	`0`	Эмулятор провайдера.
`Astral`	`1`	Провайдер Астрал.
`Kontur`	`2`	Провайдер Контур.

3.2. WaybillTitleStatus¶

Значение	Код	Описание
`ReceivedOrCreated`	`0`	Титул получен или создан системой.
`Accepted`	`1`	Титул принят.
`Signed`	`2`	Титул подписан.
`Sent`	`3`	Титул передан на отправку.
`Processed`	`4`	Титул обработан.
`Declined`	`5`	Титул отклонён.
`Failed`	`6`	При обработке титула возникла ошибка.

3.3. Дополнительные значения¶

Enum	Значение	Код
`FeatureModuleType`	`Waybills`	`32`
`Role`	`WaybillIntegrationAccount`	`180`
`UserMessageType`	`Waybills`	`80`
`PushType`	`WaybillQrCodes`	`8`
`PushTemplateType`	`WaybillQrCodes`	`12`