Клиенты

Клиент — получатель посылок и грузов, зарегистрированный у компании. У клиента есть числовой код (code), уникальный внутри компании. Полный код клиента, который видит получатель, имеет вид <название кода>-<код клиента>, например INL-123: название кода — это код компании для конкретного типа груза.

Все запросы требуют заголовок x-api-token: YOUR_API_KEY (см. Авторизация).

Клиент по ID

GET /api/v1/integrations/client/{id}

Параметр	Где	Тип	Ограничения	Описание
id	path	integer	≥ 1	ID клиента

curl

curl "https://api.inlog.ai/api/v1/integrations/client/1024" \
  -H "x-api-token: YOUR_API_KEY"

JavaScript (fetch)

const res = await fetch('https://api.inlog.ai/api/v1/integrations/client/1024', {
  headers: { 'x-api-token': 'YOUR_API_KEY' },
})
const client = await res.json() // null, если клиент не найден

Ответ 200 — объект клиента или null, если клиент не найден:

{
  "id": 1024,
  "name": "Иван Иванов",
  "phone": "+996700000000",
  "code": 123,
  "address": "ул. Примерная, 1",
  "isActive": true,
  "companyId": 12,
  "countryId": 1,
  "cityId": 1,
  "deliveryWarehouseCompanyId": 40,
  "country": { "id": 1, "title": "Кыргызстан" },
  "city": { "id": 1, "title": "Бишкек" },
  "company": { "id": 12, "title": "Логистическая компания", "codes": [{ "id": 3, "title": "INL" }] },
  "deliveryWarehouseCompany": { "id": 40, "title": "Склад выдачи" }
}

Поле	Описание
id, name, phone, address	Основные данные клиента
code	Код клиента в компании
companyId, company	Компания клиента и её коды (company.codes)
countryId, cityId, country, city	Страна и город
deliveryWarehouseCompanyId, deliveryWarehouseCompany	Склад выдачи клиента

Поиск по коду клиента

GET /api/v1/integrations/client/search-by-code

Ищет клиентов вашей компании по полному или частичному коду. Работает для API-ключей логистических (LOGIST) и складских (WAREHOUSE) компаний: логистическая компания ищет среди своих клиентов, складская — среди клиентов логистических компаний, с которыми работает. Для других типов компаний возвращается пустой массив.

Параметр	Тип	Обязательный	Описание
search	string	да	Строка поиска; приводится к верхнему регистру, пробелы по краям обрезаются. Форматы — в таблице ниже
cargoTypes	enum[]: CARGO, CAR, PACKAGE, FREIGHT	нет	Оставить в company.codes ответа только коды указанных типов груза. На отбор клиентов не влияет. Повторяйте параметр для нескольких значений

Формат search	Пример	Что ищется
<название>-<число>	INL-123	Клиент с кодом 123 у компании с кодом INL
-<число>	-123	Клиент с кодом 123
Только цифры	123	Клиент с кодом 123
Только латинские буквы	INL	Клиенты компании с кодом INL
Другое	A-B-C	Пустой массив

Возвращается не больше 20 клиентов.

curl

curl "https://api.inlog.ai/api/v1/integrations/client/search-by-code?search=INL-123&cargoTypes=PACKAGE" \
  -H "x-api-token: YOUR_API_KEY"

JavaScript (fetch)

const url = new URL('https://api.inlog.ai/api/v1/integrations/client/search-by-code')
url.searchParams.set('search', 'INL-123')
url.searchParams.append('cargoTypes', 'PACKAGE')

const clients = await (await fetch(url, { headers: { 'x-api-token': 'YOUR_API_KEY' } })).json()

Ответ 200 — массив клиентов той же формы, что у клиента по ID. Если cargoTypes передан, элементы company.codes дополнительно содержат cargoType.