Прочие эндпоинты

На этой странице перечислены интеграционные эндпоинты платформы, которые не описаны подробно на других страницах раздела. Для каждого указаны метод, путь, назначение и схема авторизации. Параметры запросов и форму ответов смотрите в Swagger UI соответствующей группы (путь указывается от хоста, например https://api.test.inlog.ai/integration/logistic/docs).

Если эндпоинт нужен вашей интеграции, уточните детали у менеджера InLog: подробная документация по этим группам будет добавляться.

Обозначения авторизации

• x-api-token — API-ключ компании, см. Авторизация.
• x-api-token (сортировочная компания) — API-ключ компании типа «сортировочная».
• JWT (роли …) — токен пользователя с одной из указанных ролей.

Пути без /v1 и с integration

Обратите внимание на отличия в префиксах: часть путей начинается с /api/v1/integration/ (без s), а уведомления — с /api/integrations/ (без /v1). Используйте пути ровно так, как они указаны в таблице.

Курьерские компании: партии, заказы, постоматы

Swagger UI: /platform/docs

Метод	Путь	Назначение	Авторизация
GET	/api/v1/integrations/courier-company/batch/parcel/{batchId}/list	Посылки в партии курьерской компании	JWT (роли ADMIN, COURIER)
GET	/api/v1/integrations/courier-company/batch/list	Партии курьерской компании	JWT (роли ADMIN, COURIER)
POST	/api/v1/integrations/courier-company/batch/come	Отметить прибытие партии	JWT (роли ADMIN, COURIER)
GET	/api/v1/integrations/courier-company/parcel/order/list	Заказы курьера на доставку посылок в постоматы	JWT (роли ADMIN, COURIER)
GET	/api/v1/integrations/courier-company/parcel/order/{id}	Заказ курьера по ID	JWT (роли ADMIN, COURIER)
POST	/api/v1/integrations/courier-company/parcel/order/{id}/complete	Завершить заказ курьера (посылки сданы в постомат)	JWT (роли ADMIN, COURIER)
PATCH	/api/v1/integrations/courier-company/parcel/update/{id}/weight	Изменить вес посылки	JWT (роли ADMIN, COURIER)
GET	/api/v1/integrations/courier-company/postomat/grouped/list	Постоматы с посылками курьера, сгруппированные	JWT (роли ADMIN, COURIER)
GET	/api/v1/integrations/courier-company/postomat/{id}/code/up	Код up заявки в постомат по заказу курьера	JWT (роли ADMIN, COURIER)

Логистические компании

Swagger UI: /integration/logistic/docs

Метод	Путь	Назначение	Авторизация
GET	/api/v1/integrations/logistic-company/advertisement/list	Рекламные материалы компании	x-api-token
POST	/api/v1/integrations/logistic-company/analytics/client-order-counts	Количество заказов клиентов (аналитика)	x-api-token
POST	/api/v1/integrations/logistic-company/analytics/client-order-stats	Статистика заказов клиентов (аналитика)	x-api-token
GET	/api/v1/integrations/logistic-company/banners/list	Баннеры компании	x-api-token
GET	/api/v1/integrations/logistic-company/batch/list	Партии компании	x-api-token
GET	/api/v1/integrations/logistic-company/cargo/by-code	Поиск грузов по коду клиента	x-api-token
GET	/api/v1/integrations/logistic-company/cargo/{id}/photos	Фотографии груза	x-api-token
GET	/api/v1/integrations/logistic-company/cargo/{id}/location	Местоположение груза	x-api-token
PATCH	/api/v1/integrations/logistic-company/cargo/{id}/description	Изменить описание груза	x-api-token
PATCH	/api/v1/integrations/logistic-company/cargo/{id}/images	Изменить изображения груза	x-api-token
GET	/api/v1/integrations/logistic-company/cargo/{id}/order	Заказ на оплату по грузу	x-api-token
GET	/api/v1/integrations/logistic-company/cargo/{id}	Груз по ID	x-api-token
GET	/api/v1/integrations/logistic-company/cargo/statuses/{id}	История статусов груза	x-api-token
GET	/api/v1/integrations/logistic-company/cargo/expenses/{id}	Расходы по грузу	x-api-token
GET	/api/v1/integrations/logistic-company/cargo/cargo-types	Типы грузов компании (для грузов)	x-api-token
GET	/api/v1/integrations/logistic-company/cargo/{cargoId}/documents	Документы груза	x-api-token
POST	/api/v1/integrations/logistic-company/cargo/{cargoId}/documents	Загрузить документ груза	x-api-token
DELETE	/api/v1/integrations/logistic-company/cargo/{cargoId}/documents/{documentId}	Удалить документ груза	x-api-token
GET	/api/v1/integrations/logistic-company/cargo/{cargoId}/documents/{documentId}/preview	Предпросмотр документа груза	x-api-token
GET	/api/v1/integrations/logistic-company/cargo/{cargoId}/documents/{documentId}/download	Скачать документ груза	x-api-token
PATCH	/api/v1/integrations/logistic-company/client/{code}/postomat/set-current/{id}	Назначить клиенту текущий постомат	x-api-token
GET	/api/v1/integrations/logistic-company/client/{code}/postomat/current	Текущий постомат клиента	x-api-token
GET	/api/v1/integrations/logistic-company/client/{code}	Клиент компании по коду	x-api-token
GET	/api/v1/integrations/logistic-company/client	Клиент компании по телефону	x-api-token
POST	/api/v1/integrations/logistic-company/client/create	Создать клиента компании	x-api-token
PATCH	/api/v1/integrations/logistic-company/client/update/{code}	Изменить клиента компании	x-api-token
POST	/api/v1/integrations/logistic-company/client/{code}/change-address	Изменить адрес клиента	x-api-token
GET	/api/v1/integrations/logistic-company/client/warehouse-opp/{id}/select/{code}	Выбрать клиенту пункт выдачи	x-api-token
GET	/api/v1/integrations/logistic-company/client/warehouse-opp/{code}/selected-warehouse-opp	Выбранный пункт выдачи клиента	x-api-token
GET	/api/v1/integrations/logistic-company/code/all	Коды компании	x-api-token
GET	/api/v1/integrations/logistic-company/delivery-type/all	Типы доставки компании	x-api-token
GET	/api/v1/integrations/logistic-company/document-types/list	Типы документов	x-api-token
GET	/api/v1/integrations/logistic-company/files/preview	Предпросмотр файла	x-api-token
GET	/api/v1/integrations/logistic-company/files/download	Скачать файл	x-api-token
GET	/api/integrations/logistic-company/notification/list/{clientCode}	Уведомления клиента	x-api-token
POST	/api/integrations/logistic-company/notification/create	Создать уведомление клиенту	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/lost/search	Поиск потерянных посылок по трек-коду	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/holding/{trackCode}	Посылка на удержании по трек-коду	x-api-token
POST	/api/v1/integrations/logistic-company/parcel/holding/{trackCode}/assign	Назначить посылку на удержании клиенту	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/{companyId}/{code}/list	Посылки клиента по ID компании и коду клиента	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/{id}/photos	Фотографии посылки	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/{id}/location	Местоположение посылки	x-api-token
PATCH	/api/v1/integrations/logistic-company/parcel/{id}/description	Изменить описание посылки	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/{id}	Посылка по ID	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/statuses/{id}	История статусов посылки	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/expenses/{id}	Расходы по посылке	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/cargo-types	Типы грузов компании (для посылок)	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/order/total-amount	Сумма к оплате по посылкам клиента	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/order/{id}/code/up	Код up заявки в постомат по заказу	x-api-token
PATCH	/api/v1/integrations/logistic-company/parcel/update/title/{id}	Изменить название посылки	x-api-token
POST	/api/v1/integrations/logistic-company/parcel/non-found/{trackCode}	Сообщить о ненайденной посылке по трек-коду	x-api-token
POST	/api/v1/integrations/logistic-company/parcel/add	Добавить посылку	x-api-token
POST	/api/v1/integrations/logistic-company/parcel/add/{companyId}	Добавить посылку от имени компании	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/{parcelId}/documents	Документы посылки	x-api-token
POST	/api/v1/integrations/logistic-company/parcel/{parcelId}/documents	Загрузить документ посылки	x-api-token
DELETE	/api/v1/integrations/logistic-company/parcel/{parcelId}/documents/{documentId}	Удалить документ посылки	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/{parcelId}/documents/{documentId}/preview	Предпросмотр документа посылки	x-api-token
GET	/api/v1/integrations/logistic-company/parcel/{parcelId}/documents/{documentId}/download	Скачать документ посылки	x-api-token
GET	/api/v1/integrations/logistic-company/postomat/list	Постоматы	x-api-token
GET	/api/v1/integrations/logistic-company/postomat/{id}	Постомат по ID	x-api-token
POST	/api/v1/integrations/logistic-company/postomat/{postomatId}/create/parcels	Создать посылки в постомат	x-api-token
GET	/api/v1/integrations/logistic-company/tariff/list	Тарифы компании	x-api-token
GET	/api/v1/integrations/logistic-company/tariff/by-warehouse/{warehouseId}	Тарифы по пункту выдачи	x-api-token
GET	/api/v1/integrations/logistic-company/tariff/by-id/{tariffId}	Тариф по ID	x-api-token
GET	/api/v1/integrations/logistic-company/tariff/calculator/reference	Справочные данные калькулятора тарифов	x-api-token
POST	/api/v1/integrations/logistic-company/tariff/calculate	Рассчитать стоимость по тарифу	x-api-token
GET	/api/v1/integrations/logistic-company/tariff/{companyId}/list	Тарифы компании по ID компании	x-api-token
GET	/api/v1/integrations/logistic-company/tariff/{code}	Тариф по коду	x-api-token
POST	/api/v1/integrations/logistic-company/upload/file	Загрузить файл	x-api-token
GET	/api/v1/integration/logistic-company/warehouse-opp/list	Пункты выдачи (с пагинацией)	x-api-token
GET	/api/v1/integration/logistic-company/warehouse-opp/count	Количество пунктов выдачи	x-api-token
GET	/api/v1/integration/logistic-company/warehouse-opp/all	Все пункты выдачи	x-api-token
GET	/api/v1/integration/logistic-company/warehouse-opp/count/all	Общее количество пунктов выдачи	x-api-token
GET	/api/v1/integration/logistic-company/warehouse-opp/{id}	Пункт выдачи по ID	x-api-token
GET	/api/v1/integration/logistic-company/warehouse/all	Склады компании	x-api-token

Маркетплейс: постоматы и заявки

Swagger UI: /integration/market/docs

Метод	Путь	Назначение	Авторизация
GET	/api/v1/integrations/market-company/postomat/order/{id}	Заявка в постомат по ID	x-api-token
GET	/api/v1/integrations/market-company/postomat/order/{id}/down-code	Код закладки заявки в постомат	x-api-token
GET	/api/v1/integrations/market-company/postomat/order/{id}/up-code	Код получения заявки в постомат	x-api-token
GET	/api/v1/integrations/market-company/postomat/city	Города постоматов	x-api-token
GET	/api/v1/integrations/market-company/postomat/city/{id}	Город постоматов по ID	x-api-token
GET	/api/v1/integrations/market-company/postomat/postomat/list	Постоматы	x-api-token
GET	/api/v1/integrations/market-company/postomat/postomat/{id}	Постомат по ID	x-api-token
GET	/api/v1/integrations/market-company/postomat/free-cells/{id}	Свободные ячейки постомата	x-api-token

Компании-партнёры

Swagger UI: /integration/partners/docs

Метод	Путь	Назначение	Авторизация
GET	/api/v1/integrations/partners/warehouse-company/batch/list	Партии	x-api-token
GET	/api/v1/integrations/partners/warehouse-company/batch/{id}	Партия по ID	x-api-token
GET	/api/v1/integrations/partners/warehouse-company/batch/receive/{id}	Приёмка партии по ID	x-api-token
GET	/api/v1/integrations/partners/warehouse-company/batch/{id}/error	Отметить ошибку по партии	x-api-token
GET	/api/v1/integrations/partners/warehouse-company/batch/{id}/return	Возврат партии	x-api-token
POST	/api/v1/integrations/partners/warehouse-company/batch/create	Создать партию	x-api-token
POST	/api/v1/integrations/partners/warehouse-company/batch/come/{id}	Отметить прибытие партии	x-api-token
POST	/api/v1/integrations/partners/warehouse-company/batch/{id}/come/error	Отметить прибытие партии с ошибкой	x-api-token
PUT	/api/v1/integrations/partners/warehouse-company/batch/{id}	Изменить партию	x-api-token
DELETE	/api/v1/integrations/partners/warehouse-company/batch/{id}	Удалить партию	x-api-token
GET	/api/v1/integrations/partners/warehouse-company/batch/{shipmentId}/receive	Приёмка партии по ID отправления	x-api-token
POST	/api/v1/integrations/partners/warehouse-company/batch/{shipmentId}/come	Отметить прибытие партии по ID отправления	x-api-token
GET	/api/v1/integrations/partners/warehouse-company/parcel/{trackCode}	Посылка по трек-коду	x-api-token
POST	/api/v1/integrations/partners/warehouse-company/parcel/set-status/{trackCode}	Установить статус посылки по трек-коду	x-api-token
POST	/api/v1/integrations/partners/warehouse-company/parcel/qr-to-code	Расшифровать QR-код клиента в код клиента	x-api-token
POST	/api/v1/integrations/partners/warehouse-company/parcel/postomat/create	Создать посылку в постомат	x-api-token
GET	/api/v1/integrations/partners/postomat/city	Города постоматов	x-api-token
GET	/api/v1/integrations/partners/postomat/city/{id}	Город постоматов по ID	x-api-token
GET	/api/v1/integrations/partners/postomat/list	Постоматы	x-api-token
GET	/api/v1/integrations/partners/postomat/{id}	Постомат по ID	x-api-token
GET	/api/v1/integrations/partners/postomat/free-cells/{id}	Свободные ячейки постомата	x-api-token

Сортировочные компании

Swagger UI: /integration/sorting/docs

Метод	Путь	Назначение	Авторизация
POST	/api/v1/integrations/sorting-company/parcel/get-exit	Получить выход сортировки для посылки	x-api-token (сортировочная компания)
POST	/api/v1/integrations/sorting-company/parcel/jx/get-exit	Получить выход сортировки для посылки (формат линии JX)	x-api-token (сортировочная компания)
GET	/api/v1/integrations/sorting-company/parcel/{id}	Посылка по ID	x-api-token (сортировочная компания)
POST	/api/v1/integrations/sorting-company/parcel/import	Импорт посылок на сортировку	x-api-token (сортировочная компания)

Складские компании

Swagger UI: /integration/warehouse/docs

Метод	Путь	Назначение	Авторизация
POST	/api/v1/integrations/warehouse-company/cargo/import	Импорт грузов	x-api-token
GET	/api/v1/integrations/warehouse-company/cargo/list	Грузы	x-api-token
POST	/api/v1/integrations/warehouse-company/parcel/create	Создать посылку	x-api-token
POST	/api/v1/integrations/warehouse-company/parcel/get-exit	Получить выход для посылки	x-api-token
GET	/api/v1/integrations/warehouse-company/parcel/{id}	Посылка по ID	x-api-token
POST	/api/v1/integrations/warehouse-company/parcel/transfer-to-client/list	Передать посылки клиенту	x-api-token
GET	/api/v1/integrations/warehouse-company/{id}	Складская компания по ID	x-api-token
GET	/api/v1/integrations/warehouse-company/list	Складские компании	x-api-token