Тема
Курьерские компании
Корневая группа /api/v1/integrations/courier-company. Запросы требуют заголовок x-api-token: YOUR_API_KEY.
Компания по ID
GET /api/v1/integrations/courier-company/{id}Возвращает карточку активной компании платформы по её ID.
| Параметр | Где | Тип | Описание |
|---|---|---|---|
id | path | integer | ID компании |
bash
curl "https://api.inlog.ai/api/v1/integrations/courier-company/57" \
-H "x-api-token: YOUR_API_KEY"js
const res = await fetch('https://api.inlog.ai/api/v1/integrations/courier-company/57', {
headers: { 'x-api-token': 'YOUR_API_KEY' },
})
const company = await res.json() // null, если компания не найдена или неактивнаОтвет 200 — объект компании или null, если активная компания с таким ID не найдена. Основные поля:
| Поле | Описание |
|---|---|
id | ID компании |
title, titleRU, titleCN, titleEN, titleKY, displayTitle | Название и переводы |
type, subtype | Тип компании (COURIER, LOGIST и др.) и подтип |
address, lat, lng | Адрес и координаты |
contactName, contactPhone, phones | Контакты |
schedule, schedules | Режим работы |
countryId, cityId | Страна и город |
isActive | Признак активной компании |
Подгруппы
Эндпоинты подгрупп /api/v1/integrations/courier-company/batch, /batch/parcel, /parcel и /postomat рассчитаны на сотрудников курьерской компании и авторизуются JWT пользователя. Они перечислены на странице Прочие эндпоинты.