Справочники

Справочники нужны, чтобы получить cityId и districtId для поиска постоматов. Пути указаны относительно {host}/api/v1/integration/company, запросы требуют Authorization: Bearer YOUR_API_KEY.

Набор эндпоинтов у справочников разный:

Справочник	Список	Элемент по ID
Страны	GET /country	—
Города	GET /city	GET /city/{id}
Районы	GET /district/list	—

Во всех списках возвращаются только активные записи в форме { "total": number, "data": [...] }.

Страны

GET /country

Параметр	Тип	По умолчанию	Описание
withCities	boolean	false	Добавить активные города страны в поле cities

Пагинации у списка стран нет — возвращаются все активные страны.

curl "https://postomat-api-1.inlog.ai/api/v1/integration/company/country?withCities=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "total": 1,
  "data": [
    {
      "id": "k3j9s8d7f6g5h4j3k2l1z0x9",
      "title": "Кыргызстан",
      "isActive": true,
      "cities": [{ "id": "pfh0haxfpzowht3oi213cqos", "title": "Бишкек", "countryId": "k3j9s8d7f6g5h4j3k2l1z0x9" }]
    }
  ]
}

Города

Список городов

GET /city

Параметр	Тип	По умолчанию	Описание
page	integer, ≥ 1	—	Номер страницы. Пагинация включается, только если переданы и page, и pageSize
pageSize	integer, ≥ 1	—	Размер страницы
withCountry	boolean	false	Добавить страну country

curl

curl "https://postomat-api-1.inlog.ai/api/v1/integration/company/city?page=1&pageSize=50&withCountry=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

Node.js

const cities = await client.cities.list({ page: 1, pageSize: 50, withCountry: true })
cities.data.forEach((c) => console.log(c.id, c.title))

Java

import ai.inlog.sdk.postomat.model.GetCitiesQuery;

PageResponse<JsonNode> cities = client.cities().list(
    GetCitiesQuery.builder().page(1).pageSize(50).withCountry(true).build()
);

Город по ID

GET /city/{id}

Параметр	Где	Тип	По умолчанию	Описание
id	path	string (cuid2)	—	ID города
withCountry	query	boolean	false	Добавить страну country

Если город не найден, API возвращает 200 с телом null.

Районы

GET /district/list

Параметр	Тип	По умолчанию	Описание
cityId	string (cuid2)	—	Районы конкретного города
page	integer, ≥ 1	—	Номер страницы. Пагинация включается, только если переданы и page, и pageSize
pageSize	integer, ≥ 1	—	Размер страницы

curl

curl "https://postomat-api-1.inlog.ai/api/v1/integration/company/district/list?cityId=pfh0haxfpzowht3oi213cqos" \
  -H "Authorization: Bearer YOUR_API_KEY"

Node.js

const districts = await client.districts.list({ cityId: 'pfh0haxfpzowht3oi213cqos' })

Java

import ai.inlog.sdk.postomat.model.GetDistrictsQuery;

PageResponse<JsonNode> districts = client.districts().list(
    GetDistrictsQuery.builder().cityId("pfh0haxfpzowht3oi213cqos").build()
);

{
  "total": 1,
  "data": [
    { "id": "c9m2k1z0q8w7e6r5t4y3u2i1", "title": "Октябрьский", "isActive": true, "cityId": "pfh0haxfpzowht3oi213cqos" }
  ]
}