Skip to content
Для ИИ NEW Мои токены Поддержка
Чат для вопросов по API Мгновенно ответим на ваши вопросы
api@ati.su Электронная почта техподдержки
Тикетная система Оставить заявку на отдел "Консультанты по интеграции (API)"
api.ati.su - заказы, торги, площадки Наш телеграм-канал
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя
Отменить
For LLMs and AI agents: canonical Markdown source of this documentation page (plain-text .md — fetch this URL to use the page content in tools and RAG). For LLMs and AI agents: developers documentation index in llms.txt format — ordered list of key documentation URLs for the developers section.

OpenAPI · Markdown

Словари для работы с грузами

Данные, полученные с помощью указанных ниже методов, вы сможете использовать при работе с Грузами.

Каждому наименованию груза, типу кузова, типу документов, валюте, упаковке или варианту загрузки присвоен свой уникальный идентификатор в базе данных ATI.SU. Воспользуйтесь словарями из списка ниже, чтобы найти нужные id.

В версии v3 словарь отдаёт метод GET https://api.ati.su/gw/dictionaries/v1/{название_словаря}. Каждый элемент ответа содержит идентификатор dictionary_item_id и объект attributes с полями словаря. Значения полей — строки, даже если внутри число. Язык значений задаёт параметр locale, например locale=en.

В версии v2 справочники отдаются через API Marshak: GET https://api.ati.su/gw/marshak/v1/{dictionary_type}.

Для человекочитаемого ответа v2 добавляйте параметр запроса attributeFieldFormat=2. В этом формате атрибуты каждого элемента возвращаются словарём ключ: значение, а идентификатор — в поле dictionary_item_id.

Пример: https://api.ati.su/gw/marshak/v1/cargo_typ?attributeFieldFormat=2.

Типы кузова

Id элемента передают в поле truck.body_types в API грузов v2. Поле mask — бит кузова для методов v1.0: чтобы передать несколько кузовов, сложите их маски.

Версия
Получить словарь типов кузова Типы кузова транспорта. Элементы `5000`, `20000`, `30000` и `50000` — группы кузовов, например «все открытые»: их `mask` объединяет биты всех кузовов группы. `dictionary_item_id` совпадает с `TypeId`, а `mask` — с `Id` устаревшего метода `GET /v1.0/dictionaries/carTypes`.
get /gw/dictionaries/v1/cartypes
Параметры
Параметр Тип Расположение Описание
locale string query
Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: ru
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/dictionaries/v1/cartypes' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Элементы словаря cartypes
Модель
[{...}]

Типы кузова транспорта. Элементы 5000, 20000, 30000 и 50000 — группы кузовов, например «все открытые»: их mask объединяет биты всех кузовов группы. dictionary_item_id совпадает с TypeId, а mask — с Id устаревшего метода GET /v1.0/dictionaries/carTypes.

dictionary_item_id: integer

Идентификатор элемента словаря

}]
Пример
[...]
{...}
"dictionary_item_id":1,
"attributes":{...}
"car_type":"тентованный",
"mask":"1",
"short":"тент."
}
}
]

Наименования грузов

Для публикации груза словарь не нужен: в API грузов v2 наименование передают строкой в поле name. Id наименования приходит в ответе в поле name_id, сервис подбирает его по названию.

Версия
Получить словарь наименований грузов Наименования грузов. В API грузов v2 наименование передают строкой, а id из словаря сервис подбирает по названию и возвращает в поле `name_id`.
get /gw/dictionaries/v1/cargo_typ
Параметры
Параметр Тип Расположение Описание
locale string query
Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: ru
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/dictionaries/v1/cargo_typ' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Элементы словаря cargo_typ
Модель
[{...}]

Наименования грузов. В API грузов v2 наименование передают строкой, а id из словаря сервис подбирает по названию и возвращает в поле name_id.

dictionary_item_id: integer

Идентификатор элемента словаря

}]
Пример
[...]
{...}
"dictionary_item_id":1,
"attributes":{...}
"cargo_name":"Автошины"
}
}
]

Валюты

Словарь валют в v2 отдаёт атрибут vat_percents — доступные проценты НДС для валюты, строкой через запятую. У валют без НДС-процентов (доллар, евро и др.) атрибута нет — не читайте ключ безусловно. Как применять — в разделе Ставки НДС. Метод v1.0 этот атрибут не возвращает.

Версия
Получение списка валют
get /gw/marshak/v1/currency
Параметры
Параметр Тип Расположение Описание
attributeFieldFormat integer query
Формат атрибутов в ответе. Для человекочитаемого варианта используйте значение `2` — атрибуты вернутся словарём `ключ: значение`. Пример: 0
locale string query
Пример: string
lastUpdate string (date-time) query
Пример: 1970-01-01T00:00:00.000Z
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/marshak/v1/currency' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Элементы словаря
Модель
[{...}]
dictionary_item_id: integer

Идентификатор элемента словаря

}]
Пример
[...]
{...}
"dictionary_item_id":0,
"attributes_dictionary":{...}
"any-key":"string"
}
}
]

Типы документов

Версия
Получение списка типов документов для груза
get /gw/marshak/v1/ati_docs_document_types
Параметры
Параметр Тип Расположение Описание
attributeFieldFormat integer query
Формат атрибутов в ответе. Для человекочитаемого варианта используйте значение `2` — атрибуты вернутся словарём `ключ: значение`. Пример: 0
locale string query
Пример: string
lastUpdate string (date-time) query
Пример: 1970-01-01T00:00:00.000Z
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/marshak/v1/ati_docs_document_types' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Элементы словаря
Модель
[{...}]
dictionary_item_id: integer

Идентификатор элемента словаря

}]
Пример
[...]
{...}
"dictionary_item_id":0,
"attributes_dictionary":{...}
"any-key":"string"
}
}
]

Формы оплаты

Id элемента передают в поле MoneyType методов v1.0. Значение 22 «любая» используется по умолчанию и единственно допустимо, если ставка не фиксирована. В API грузов v2 форму оплаты задают поля объекта payment, словарь там не нужен.

Версия
Получить словарь форм оплаты Формы оплаты груза. Элемент `22` «любая» — значение по умолчанию.
get /gw/dictionaries/v1/money_type
Параметры
Параметр Тип Расположение Описание
locale string query
Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: ru
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/dictionaries/v1/money_type' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Элементы словаря money_type
Модель
[{...}]

Формы оплаты груза. Элемент 22 «любая» — значение по умолчанию.

dictionary_item_id: integer

Идентификатор элемента словаря

}]
Пример
[...]
{...}
"dictionary_item_id":1,
"attributes":{...}
"name":"нал"
}
}
]

Типы упаковки

Id элемента передают в поле packaging.type груза.

Версия
Получить словарь типов упаковки Типы упаковки груза. Элемент `0` «не указано» — служебный: упаковка не задана, его короткое название — пробел. Словарь `type_of_package` с кодами упаковки ООН к грузам не относится.
get /gw/dictionaries/v1/pack_types
Параметры
Параметр Тип Расположение Описание
locale string query
Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: ru
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/dictionaries/v1/pack_types' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Элементы словаря pack_types
Модель
[{...}]

Типы упаковки груза. Элемент 0 «не указано» — служебный: упаковка не задана, его короткое название — пробел. Словарь type_of_package с кодами упаковки ООН к грузам не относится.

dictionary_item_id: integer

Идентификатор элемента словаря

}]
Пример
[...]
{...}
"dictionary_item_id":1,
"attributes":{...}
"name":"коробки",
"short_name":"кор"
}
}
]

Способы загрузки и разгрузки

В API грузов v2 id элементов передают списком в полях body_loading.types и body_unloading.types, в методах v1.0 — суммой.

Версия
Получить словарь способов загрузки и разгрузки Способы загрузки и разгрузки кузова: верхняя, боковая, задняя и другие. Один словарь используют и для загрузки, и для разгрузки. `dictionary_item_id` — степень двойки, в методах грузов версии 1.0 несколько способов передают суммой. Не путайте словарь с полем `truck.load_type`: там передают вариант загрузки машины.
get /gw/dictionaries/v1/load_type
Параметры
Параметр Тип Расположение Описание
locale string query
Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: ru
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/dictionaries/v1/load_type' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Элементы словаря load_type
Модель
[{...}]

Способы загрузки и разгрузки кузова: верхняя, боковая, задняя и другие. Один словарь используют и для загрузки, и для разгрузки. dictionary_item_id — степень двойки, в методах грузов версии 1.0 несколько способов передают суммой. Не путайте словарь с полем truck.load_type: там передают вариант загрузки машины.

dictionary_item_id: integer

Идентификатор элемента словаря

}]
Пример
[...]
{...}
"dictionary_item_id":1,
"attributes":{...}
"name":"боковая",
"short":"бок."
}
}
]

Периодичность загрузки

Id элемента передают в поле PeriodicityId методов v1.0. В API грузов v2 периодичность передают строкой: everyday или workdays.

Получить словарь периодичности загрузки Периодичность постоянной загрузки груза. При создании груза методы принимают только `1` «ежедневно» и `100` «по рабочим дням», остальные значения встречаются в старых грузах. Элемент `0` «не выбрано» — служебный, поля `period` у него нет.
get /gw/dictionaries/v1/periods
Параметры
Параметр Тип Расположение Описание
locale string query
Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: ru
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/dictionaries/v1/periods' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Элементы словаря periods
Модель
[{...}]

Периодичность постоянной загрузки груза. При создании груза методы принимают только 1 «ежедневно» и 100 «по рабочим дням», остальные значения встречаются в старых грузах. Элемент 0 «не выбрано» — служебный, поля period у него нет.

dictionary_item_id: integer

Идентификатор элемента словаря

}]
Пример
[...]
{...}
"dictionary_item_id":1,
"attributes":{...}
"name":"ежедневно",
"period":"ежедн."
}
}
]

Причины запрета операций с грузом

Код из поля code приходит в полях EditRestriction, DeleteRestriction, RestoreRestriction и AccessDeniedReason методов v1.0.

Версия
Получить словарь причин запрета операций с грузом Причины, по которым операция с грузом запрещена. Элемент `0` с кодом `None` означает, что операция разрешена.
get /gw/dictionaries/v1/load_access_denied_reasons
Параметры
Параметр Тип Расположение Описание
locale string query
Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy Пример: ru
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/dictionaries/v1/load_access_denied_reasons' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Элементы словаря load_access_denied_reasons
Модель
[{...}]

Причины, по которым операция с грузом запрещена. Элемент 0 с кодом None означает, что операция разрешена.

dictionary_item_id: integer

Идентификатор элемента словаря

}]
Пример
[...]
{...}
"dictionary_item_id":1,
"attributes":{...}
"code":"LoadReserved",
"text":"Груз зарезервирован/взят, операции с грузом запрещены"
}
}
]