Опубликованные грузы

Методы для работы с грузами

Добавление груза

Добавляемый груз проверяется на дублирование: если такой груз уже опубликован, новый не добавится и вернётся ошибка 409 Conflict с кодом duplicate_error.

Безналичную ставку с НДС передавайте набором payment.rates_with_vat — в нём может быть несколько ставок с разными процентами НДС. Допустимые проценты зависят от валюты груза — см. Ставки НДС. Одиночное поле rate_with_vat устарело. Метод v1.0 проценты НДС не поддерживает.

Ограничения метода

Ограничение частоты: не более 500 запросов на создание грузов за 24 часа на один контакт. Лимит обнуляется ежедневно в 00:00.
Общий лимит для фирмы рассчитывается так: количество контактов × 500 — это суточный суммарный лимит на все операции всех контактов.
При достижении лимита сервер возвращает статус-код 429 Too Many Requests. Новые запросы будут отклоняться до следующего обнуления в 00:00.

Пример. У фирмы 3 контакта — общий лимит 3 × 500 = 1500 операций в сутки. После достижения 1500 операций все последующие запросы на выполнение операции до 00:00 будут отклоняться сервером с кодом 429 Too Many Requests.

Версия 2 2 (прежний адрес) 1.0

Создать заявку на груз. API для интеграции. Публикует новую заявку на груз от имени текущего пользователя.

post /gw/cargos_create_v2/integration/v2/cargos

Модель и примеры

Параметры

Параметров нет

Запрос

Модель

{...}

Запрос на создание заявки на груз через Integration API.

cargo_application*:{...}

Заявка груза

external_id: null,string

Внешний номер груза или заказа Поле не должно содержать emoji-символы и emoji-последовательности

route*:{...}

Маршрут

loading*:{...}

Основная точка загрузки — начало маршрута. Здесь задают даты загрузки и грузы, которые забирают в начале маршрута.

dates*:{...}

Даты загрузки. Обязательны, вид задаёт дискриминатор type.

type: enum

[ready]

Тип даты — готов к загрузке (ready).

readyfrom-datepermanentrate-request

is_available_tomorrow: null,boolean

Готов к загрузке сегодня и завтра

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

first_date: date-time

Первый день, когда груз можно забрать. Обязателен, отстоит от сегодняшнего дня не больше чем на 60 дней.

last_date: date-time

Последний день, когда груз можно забрать. Обязателен, не раньше first_date и не в прошлом.

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

periodicity*: string

Периодичность постоянной загрузки. Обязательна, другие значения отклоняются. - everyday — каждый день - workdays — по рабочим дням

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

cargos*:[{...}]

Грузы заявки, хотя бы один. id груза сквозной по всей заявке: по нему точки разгрузки указывают, что снимают.

name*: string

От (0 до 200 символов)

Наименование груза Поле не должно содержать emoji-символы и emoji-последовательности

weight*:

Вес груза. Можно не указывать, если задан объём.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume*:

Объём груза. Можно не указывать, если задан вес.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

near_cities: [int32]

Ближайшие крупные города — не больше 10, без повторов. Нельзя указывать, если сам город точки является региональным центром. dict: GET /v1.0/dictionaries/cities/{cityId}/near → id

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}

unloading*:{...}

Основная точка разгрузки — конец маршрута.

dates:

Даты разгрузки. Поле необязательное.

ONE-OF

1:{...}

Даты разгрузки. Значима календарная дата, а не момент времени: день определяется по смещению, которое прислал клиент. Даты в примерах условные: подставляйте актуальные, иначе запрос отклонят.

first_date: date-time

Первый день разгрузки. Не в прошлом. Обязателен, если задан last_date.

last_date: date-time

Последний день разгрузки. Не раньше first_date.

time:

Время разгрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

near_cities: [int32]

Ближайшие крупные города — не больше 10, без повторов. Нельзя указывать, если сам город точки является региональным центром. dict: GET /v1.0/dictionaries/cities/{cityId}/near → id

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}

way_points:[{...}]

Промежуточные точки между загрузкой и разгрузкой, не больше 15. Перечисляйте их в порядке проезда: по этому порядку сервис проверяет, что груз, снятый на промежуточной разгрузке, был загружен раньше.

type: enum

[loading]

Тип промежуточной точки — загрузка (loading).

loadingunloadingcustomsgo-through

cargos:[{...}]

Грузы, которые забирают в этой точке. id каждого груза уникален в пределах заявки.

name*: string

От (0 до 200 символов)

Наименование груза Поле не должно содержать emoji-символы и emoji-последовательности

weight*:

Вес груза. Можно не указывать, если задан объём.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume*:

Объём груза. Можно не указывать, если задан вес.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

loading_date:

Дата и время загрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

cargos:[{...}]

Грузы, которые снимают в этой точке. id ссылается на груз из route.loading.cargos либо из более ранней точки loading.

weight:

Снимаемая часть веса. Обязательна, если вес был задан при загрузке этого груза, и запрещена, если не был.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume:

Снимаемая часть объёма. Обязательна, если объём был задан при загрузке этого груза, и запрещена, если не был.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging_quantity: int32

Снимаемое количество упаковок.

is_defined_by_ttn: null,boolean

Снимаемая часть груза будет определена в ТТН.

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

unloading_date:

Дата и время разгрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}]

is_round_trip: null,boolean

Кругорейс

}

truck*:{...}

Транспорт

trucks_count: int32

Количество машин

load_type*: string

Загрузка: - ftl — отдельной машиной - ltl — догрузом - dont-care — отдельной машиной или догрузом

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

body_loading:

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

ONE-OF

1:{...}

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

types: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required: null,boolean

Обязательны все выбранные

}

null

body_unloading:

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

ONE-OF

1:{...}

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

types: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required: null,boolean

Обязательны все выбранные

}

null

temperature:

Температура

ONE-OF

1:{...}

Температура.

from: int32

От

to: int32

До

}

null

documents:

Разрешения

ONE-OF

1:{...}

Разрешения транспорта.

tir: null,boolean

TIR todo ссылка на фак

cmr: null,boolean

CMR todo ссылка на фак

t1: null,boolean

T1 todo ссылка на фак

medical_card: null,boolean

Медкнижка

}

null

requirements:

Требования

ONE-OF

1:{...}

Требования к транспорту.

logging_truck: null,boolean

Коники

road_train: null,boolean

Сцепка

air_suspension: null,boolean

Пневмоход

team_driving: null,boolean

Для груза необходимы два водителя

}

null

adr: int32

ADR

belts_count: int32

Количество ремней

is_tracking: null,boolean

Трекинг через АТИ Водитель

required_capacity: double

Требуемая грузоподъемность в тоннах

}

payment*:{...}

Оплата

type: enum

[with-bargaining]

Тип оплаты — возможен торг (with-bargaining).

with-bargainingwithout-bargainingrate-requestauction

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

rate_with_vat_available: null,boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available: null,boolean

Можно предлагать ставки безнал без НДС

cash_available: null,boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

accept_bids_with_vat*: null,boolean

Принимать ставки с НДС

accept_bids_without_vat: null,boolean

Принимать ставки без НДС

vat_percents: int32

Размер НДС, в процентах

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты, в которой будут вестись Торги. Значение из словаря валют

bid_step*: double

Шаг ставок

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: null,string

Длительность торгов: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов - 1d — 1 день - 2d — 2 дня - 3d — 3 дня - 4d — 4 дня - 5d — 5 дней

count_from_first_bid: null,boolean

Отсчитывать длительность Торгов с момента первой ставки

finish_until: date-time

Точные дата и время завершения Торгов

}

accept_counter_offers:

Параметры доступности встречных предложений во время проведения Торгов

ONE-OF

1:{...}

Параметры доступности встречных предложений во время Торгов.

acceptance_delay: null,string

Принимать встречные предложения через: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

until_first_bid: null,boolean

Принимать встречные предложения до первой ставки по Торгам

}

null

auto_renew:

Параметры автопродления Торгов

ONE-OF

1:{...}

Параметры автопродления Торгов.

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

null

is_antisniper: null,boolean

Опция Антиснайпер

rate_rise:

Параметры повышения ставки Торгов при отсутствии ставок

ONE-OF

1:{...}

Параметры повышения ставки Торгов при отсутствии ставок.

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

null

winner_criteria*: string

Критерий выбора победителя: - best-rate — по лучшей ставке - matching-date — с учётом даты загрузки и лучшей ставки

time_to_provide_documents*: null,string

Время, за которое победитель обязан предоставить документы

winner_reselection_count: int32

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_restart:

Параметры перезапуска Торгов в случае отсутствия ставок

ONE-OF

1:{...}

Параметры перезапуска Торгов при отсутствии ставок.

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

rate_increase:

Параметры повышения начальной ставки после перезапуска торгов.

ONE-OF

1:{...}

Параметры повышения начальной ставки после перезапуска Торгов.

type: enum

[currency]

Тип повышения — абсолютное значение в валюте (currency).

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

null

}

null

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type: enum

[archive]

Действие — переместить заявку в архив (archive).

archivepublish-with-ratepublish-rate-request

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

rate_with_vat_available: null,boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available: null,boolean

Можно предлагать ставки безнал без НДС

cash_available: null,boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

}

keep_rates: null,boolean

Сохранять ставки при редактировании груза

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

}

documents:[{...}]

Фото груза и документов

id: string

Старый id документа

file_id: string

Новый id документа

}]

boards:[{...}]

Площадки груза

id*: string

Id площадки

publication_mode: string

Опубликовать груз - now – сразу - 15m – через 15 минут - 30m – через 30 минут - 1h – через час - 3h – через 3 часа - 6h – через 6 часов - exact-time - в точное время

publication_time: date-time

Точное время публикации груза, для publication_mode = 'exact-time'

cancel_publish_on_auction_bet: null,boolean

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

reservation_enabled: null,boolean

Разрешить перевозчикам бронировать груз

}]

paid_features:{...}

Платные услуги: приоритетный показ, стелс

priority_view:

Приоритетный показ

ONE-OF

1:{...}

Приоритетный показ.

rate*: double

Ставка за просмотр

limit: double

Лимит на заявку

daily_limit: double

Суточный лимит

only_for_paid_users: null,boolean

Показывать приоритетный груз только платным пользователям

}

null

stealth:

Стэлс

ONE-OF

1:{...}

Стелс.

list_id: uuid

Id списка фирм для скрытия

minimal_registration_date: date-time

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32

Минимальное количество звёзд фирм, которые будут видеть груз

}

null

}

note: null,string

Примечание к заявке Поле не должно содержать emoji-символы и emoji-последовательности

contacts*: [int32]

Id контактов заявки

}

}

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargos_create_v2/integration/v2/cargos' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"cargo_application":{"external_id":"EXT-12345","route":{"loading":{"dates":{"type":"ready","is_available_tomorrow":true,"time":{"0":"?"}},"cargos":[{"name":"Автомобиль(ли)","weight":{"0":"?"},"volume":{"0":"?"},"packaging":{"0":"?"},"sizes":{"0":"?"},"id":1}],"near_cities":[0],"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}},"unloading":{"dates":{"0":"?"},"near_cities":[0],"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}},"way_points":[{"type":"loading","cargos":[{"name":"Автомобиль(ли)","weight":{"0":"?"},"volume":{"0":"?"},"packaging":{"0":"?"},"sizes":{"0":"?"},"id":1}],"loading_date":{"0":"?"},"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}}],"is_round_trip":true},"truck":{"trucks_count":1,"load_type":"ftl","body_types":[0],"body_loading":{"0":"?"},"body_unloading":{"0":"?"},"temperature":{"0":"?"},"documents":{"0":"?"},"requirements":{"0":"?"},"adr":3,"belts_count":4,"is_tracking":true,"required_capacity":20},"payment":{"type":"with-bargaining","auto_invites_settings":{"0":"?"},"currency_type":1,"rate_with_vat":50000,"rate_without_vat":50000,"cash":50000,"on_card":true,"rates_with_vat":[{"rate_with_vat":50000,"vat_percent":22}],"hide_counter_offers":true,"direct_offer":true,"prepayment":{"0":"?"},"payment_mode":{"0":"?"}},"documents":[{"id":"9c6cce94-c0e3-eb11-bb99-002590fdcfdb","file_id":"6b35842b8386446c82a43726f139abe1"}],"boards":[{"id":"a0a0a0a0a0a0a0a0a0a0a0a0","publication_mode":"now","publication_time":"2024-01-15T10:30:00+00:00","cancel_publish_on_auction_bet":true,"reservation_enabled":true}],"paid_features":{"priority_view":{"0":"?"},"stealth":{"0":"?"}},"note":"Тестовый груз","contacts":[0]}}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/gw/cargos_create_v2/integration/v2/cargos", "{""cargo_application"":{""external_id"":""EXT-12345"",""route"":{""loading"":{""dates"":{""type"":""ready"",""is_available_tomorrow"":true,""time"":{""0"":""?""}},""cargos"":[{""name"":""Автомобиль(ли)"",""weight"":{""0"":""?""},""volume"":{""0"":""?""},""packaging"":{""0"":""?""},""sizes"":{""0"":""?""},""id"":1}],""near_cities"":[0],""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}},""unloading"":{""dates"":{""0"":""?""},""near_cities"":[0],""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}},""way_points"":[{""type"":""loading"",""cargos"":[{""name"":""Автомобиль(ли)"",""weight"":{""0"":""?""},""volume"":{""0"":""?""},""packaging"":{""0"":""?""},""sizes"":{""0"":""?""},""id"":1}],""loading_date"":{""0"":""?""},""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}}],""is_round_trip"":true},""truck"":{""trucks_count"":1,""load_type"":""ftl"",""body_types"":[0],""body_loading"":{""0"":""?""},""body_unloading"":{""0"":""?""},""temperature"":{""0"":""?""},""documents"":{""0"":""?""},""requirements"":{""0"":""?""},""adr"":3,""belts_count"":4,""is_tracking"":true,""required_capacity"":20},""payment"":{""type"":""with-bargaining"",""auto_invites_settings"":{""0"":""?""},""currency_type"":1,""rate_with_vat"":50000,""rate_without_vat"":50000,""cash"":50000,""on_card"":true,""rates_with_vat"":[{""rate_with_vat"":50000,""vat_percent"":22}],""hide_counter_offers"":true,""direct_offer"":true,""prepayment"":{""0"":""?""},""payment_mode"":{""0"":""?""}},""documents"":[{""id"":""9c6cce94-c0e3-eb11-bb99-002590fdcfdb"",""file_id"":""6b35842b8386446c82a43726f139abe1""}],""boards"":[{""id"":""a0a0a0a0a0a0a0a0a0a0a0a0"",""publication_mode"":""now"",""publication_time"":""2024-01-15T10:30:00+00:00"",""cancel_publish_on_auction_bet"":true,""reservation_enabled"":true}],""paid_features"":{""priority_view"":{""0"":""?""},""stealth"":{""0"":""?""}},""note"":""Тестовый груз"",""contacts"":[0]}}");

Ответ

200 Заявка на груз успешно создана и опубликована.

Модель

{...}

Ответ на создание заявки на груз через Integration API.

cargo_application*:{...}

Заявка груза

cargo_id: uuid

ID груза OBSOLETE используй поле CargoApplicationId

cargo_number: string

Номер груза, автоматически генерируемый ATI.SU OBSOLETE используй поле CargoApplicationNumber

source: int32

OBSOLETE используй поле OriginSource

contacts: [int32]

Контакты OBSOLETE используй поле ApplicationContacts

distance: int32

Дистанция, км

cargo_application_id*: uuid

Id груза

snapshot_id*: int64

Id состояния груза (меняется при каждом редактировании)

cargo_application_number*: string

Номер груза, автоматически генерируемый ATI.SU

department_id*: int32

Подразделение, которому принадлежит заявка.

persistent_user_id*: int32

Идентификатор пользователя, разместившего заявку

actor_contact_id: int32

Идентификатор контакта, разместившего заявку

external_id: null,string

Внешний номер груза или заказа

added_at*: date-time

Время добавления груза, UTC

updated_at*: date-time

Время последнего изменения груза, UTC

refreshed_at: date-time

Время последнего поднятия груза, UTC

origin_source*: string

Использованный api при создания груза: - web-cargos-api, - mobile-cargos-api, - public-cargos-api

route*:{...}

Маршрут

loading*:{...}

Основная точка загрузки — начало маршрута. Здесь даты загрузки и грузы, которые забирают в начале маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates*:{...}

Даты загрузки. Вид задаёт дискриминатор type.

type: enum

[from-date]

Тип даты — в промежутке дат (from-date).

from-datereadypermanentrate-request

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

is_available_tomorrow*: boolean

Готов к загрузке сегодня и завтра (TODO возможно убрать)

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

periodicity*: string

Периодичность постоянной загрузки: - everyday — "каждый день" - workdays — "по рабочим дням"

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

}

cargos*:[{...}]

Грузы заявки. cargo_id сквозной по всей заявке: по нему точки разгрузки указывают, что снимают.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

unloading*:{...}

Основная точка разгрузки — конец маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates:

Даты разгрузки. Могут быть не заданы.

ONE-OF

1:{...}

Даты разгрузки. Значима календарная дата, а не момент времени: день определяется по смещению в значении.

first_date: date-time

Первый день разгрузки.

last_date: date-time

Последний день разгрузки.

time:

Время разгрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

way_points:[{...}]

Промежуточные точки между загрузкой и разгрузкой, не больше 15, в порядке проезда.

type: enum

[loading]

Тип промежуточной точки — точка загрузки (loading).

loadingunloadingcustomsgo-through

cargos:[{...}]

Грузы, которые забирают в этой точке.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

loading_date:

Дата и время загрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

cargos:[{...}]

Грузы, которые снимают в этой точке.

packaging_quantity: int32

Снимаемое количество упаковок.

is_defined_by_ttn: null,boolean

Снимаемая часть груза будет определена в ТТН.

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

unloading_date:

Дата и время разгрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}]

is_round_trip: null,boolean

Кругорейс

}

truck*:{...}

Транспорт

trucks_count*: int32

Количество машин

load_type*: string

Загрузка: - ftl — отдельной машиной - dont-care — не важно

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

is_tracking*: boolean

Трекинг через АТИ Водитель

adr: int32

ADR

belts_count: int32

Количество ремней

required_capacity: double

Требуемая грузоподъемность в тоннах

body_loading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

body_unloading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

temperature:

Температура

ONE-OF

1:{...}

Температура.

from: int32

От

to: int32

До

}

null

documents:

Разрешения

ONE-OF

1:{...}

Разрешения транспорта.

tir*: boolean

TIR

cmr*: boolean

CMR

t1*: boolean

T1

medical_card*: boolean

Медкнижка

}

null

requirements:

Требования

ONE-OF

1:{...}

Требования к транспорту.

logging_truck*: boolean

Коники

road_train*: boolean

Сцепка

air_suspension*: boolean

Пневмоход

team_driving*: boolean

Для груза необходимы два водителя

}

null

}

payment*:{...}

Оплата

type: enum

[with-bargaining]

Тип оплаты — с возможностью торга (with-bargaining).

with-bargainingwithout-bargainingrate-requestauction

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

auction_id*: uuid

Id Торгов

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты из словаря валют

bid_step*: double

Шаг ставки Торгов

accept_bids_with_vat*: boolean

Принимать ставки с НДС

accept_bids_without_vat: null,boolean

Принимать ставки без НДС

vat_percents: int32

Размер НДС, в процентах

is_antisniper*: boolean

Опция Антиснайпер

time_to_provide_documents*: string

Время, за которое победитель обязан предоставить документы

winner_criteria*: string

Критерий выбора победителя: best-rate — по лучшей ставке matching-date — с учётом даты загрузки и лучшей ставки

winner_reselection_count: int32

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: null,string

Может быть null, если есть значение у поля FinishUntil. Длительность проведения Торгов: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов 1d — 1 день 2d — 2 дня 3d — 3 дня 4d — 4 дня 5d — 5 дней

count_from_first_bid*: boolean

Отсчитывать длительность Торгов с момента первой ставки

finish_until: date-time

Точные дата и время завершения Торгов

}

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type: enum

[archive]

Действие — переместить заявку в архив (archive).

archivepublish-with-ratepublish-rate-request

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

}

accept_counter_offers:

Параметры доступности встречных предложений во время проведения Торгов

ONE-OF

1:{...}

Параметры доступности встречных предложений во время Торгов.

acceptance_delay: null,string

Может быть null, в таком случае будем принимать встречные предложения сразу. Принимать встречные предложения через: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

until_first_bid*: boolean

Принимать встречные предложения до первой ставки по Торгам

}

null

auto_renew:

Параметры автопродления Торгов

ONE-OF

1:{...}

Параметры автопродления Торгов.

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

null

rate_rise:

Параметры повышения ставки Торгов при отсутствии ставок

ONE-OF

1:{...}

Параметры повышения ставки Торгов при отсутствии ставок.

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

null

auction_restart:

Параметры перезапуска Торгов в случае отсутствия ставок

ONE-OF

1:{...}

Параметры перезапуска Торгов при отсутствии ставок.

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов

rate_increase:

Параметры повышения начальной ставки после перезапуска торгов.

ONE-OF

1:{...}

Параметры повышения начальной ставки после перезапуска Торгов.

type: enum

[currency]

Тип повышения — абсолютное значение в валюте (currency).

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

null

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

}

boards*:[{...}]

Площадки груза

id*: string

Id площадки

publication_mode*: string

Опубликовать груз: now – сразу 15m – через 15 минут 30m – через 30 минут 1h – через час 3h – через 3 часа 6h – через 6 часов exact-time - в точное время

publication_time*: date-time

Точное время публикации груза, для publication_mode = 'exact-time'

cancel_publish_on_auction_bet*: boolean

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

publication_restriction: integer

Стратегия ограничений публикации груза на площадке

reservation_enabled*: boolean

Разрешить перевозчикам бронировать груз

is_published*: boolean

Груз опубликован на площадке

}]

documents:[{...}]

Фото груза и документов

id: string

Старый id документа OBSOLETE используй поле FileID

file_id*: string

Id документа в API Плюшкин (TODO ссылка)

name*: string

Название документа

link*: string

Ссылка на документ

}]

application_contacts*:[{...}]

Информация о контактах груза

id*: int32

Id контакта

}]

paid_features:

Платные услуги

ONE-OF

1:{...}

Платные услуги: приоритетный показ, стелс.

priority_view:

Приоритетный показ

ONE-OF

1:{...}

Приоритетный показ.

money_spent_per_day: double

Потрачено атисов за день OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

money_spent_per_order: double

Потрачено атисов на эту заявку OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

rate*: double

Ставка за просмотр

only_for_paid_users*: boolean

Показывать приоритетный груз только платным пользователям

limit: double

Лимит на заявку

daily_limit: double

Суточный лимит

}

null

stealth:

Стэлс

ONE-OF

1:{...}

Стелс.

list_id: uuid

Id списка фирм для скрытия

minimal_registration_date: date-time

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32

Минимальное количество звёзд фирм, которые будут видеть груз

}

null

}

null

note: null,string

Примечание к грузу

lot_id: uuid

Id Лота, к которому прикреплён данный груз

lot_number: int32

Номер Лота, к которому прикреплён данный груз

is_pass_through_copy: null,boolean

Является ли груз сквозной копией

is_archived: null,boolean

Отправлен ли груз в архив

archive_date: date-time

Время отправки груза в архив, UTC

true_price: int32

Истинная ставка на груз после жалоб "Озвученная ставка"

true_currency_id: int32

Истинная валюта ставки на груз после жалоб "Озвученная ставка"

client_application_id: null,string

Идентификатор интегратора (клиентского приложения), через которое был создан груз

}

}

Пример

{...}

"cargo_application":{...}

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"ABC1234",

"source":2,

"contacts":[...],

0

],

"distance":1794,

"cargo_application_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"snapshot_id":1000500,

"cargo_application_number":"ABC1234",

"department_id":7654321,

"persistent_user_id":1234567,

"actor_contact_id":0,

"external_id":"EXT-12345",

"added_at":"2024-01-15T10:30:00+00:00",

"updated_at":"2024-01-15T10:30:00+00:00",

"refreshed_at":"2024-01-15T10:30:00+00:00",

"origin_source":"public-cargos-api",

"route":{...},

"loading":{...},

"near_cities":[...],

0

],

"dates":{...},

"type":"from-date",

"time":{...},

"0":"?"

},

"first_date":"2024-08-27T00:00:00+03:00",

"last_date":"2024-08-29T00:00:00+03:00"

},

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"unloading":{...},

"near_cities":[...],

0

],

"dates":{...},

"0":"?"

},

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"way_points":[...],

{...}

"type":"loading",

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"loading_date":{...},

"0":"?"

},

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

}

],

"is_round_trip":true

},

"truck":{...},

"trucks_count":1,

"load_type":"ftl",

"body_types":[...],

0

],

"is_tracking":true,

"adr":3,

"belts_count":4,

"required_capacity":20,

"body_loading":{...},

"0":"?"

},

"body_unloading":{...},

"0":"?"

},

"temperature":{...},

"0":"?"

},

"documents":{...},

"0":"?"

},

"requirements":{...}

"0":"?"

}

},

"payment":{...},

"type":"with-bargaining",

"auto_invites_settings":{...},

"0":"?"

},

"currency_type":1,

"rate_with_vat":50000,

"rate_without_vat":50000,

"cash":50000,

"on_card":true,

"rates_with_vat":[...],

{...}

"rate_with_vat":50000,

"vat_percent":22

}

],

"hide_counter_offers":true,

"direct_offer":true,

"prepayment":{...},

"0":"?"

},

"payment_mode":{...}

"0":"?"

}

},

"boards":[...],

{...}

"id":"a0a0a0a0a0a0a0a0a0a0a0a0",

"publication_mode":"now",

"publication_time":"2024-01-15T10:30:00+00:00",

"cancel_publish_on_auction_bet":true,

"publication_restriction":0,

"reservation_enabled":true,

"is_published":true

}

],

"documents":[...],

{...}

"id":"9c6cce94-c0e3-eb11-bb99-002590fdcfdb",

"file_id":"6b35842b8386446c82a43726f139abe1",

"name":"Транспортная накладная.pdf",

"link":"https://api.ati.su/webapi/filestorage/files/6b35842b8386446c82a43726f139abe1"

}

],

"application_contacts":[...],

{...}

"id":0

}

],

"paid_features":{...},

"0":"?"

},

"note":"Тестовый груз",

"lot_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"lot_number":38,

"is_pass_through_copy":true,

"is_archived":true,

"archive_date":"2024-01-15T10:30:00+00:00",

"true_price":50000,

"true_currency_id":1,

"client_application_id":"ati"

}

}

400 Невалидные данные запроса.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

402 Недостаточно средств на счёте для размещения.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

403 Нет прав на размещение или кошелёк заблокирован.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

404 Связанный ресурс не найден.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

409 Обнаружен дубликат заявки.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

417 Изменилась цена размещения.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

429 Достигнут ежедневный лимит публикации грузов.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

Нет параметров

{ "cargo_application": { "external_id": "EXT-12345", "route": { "loading": { "dates": { "type": "ready", "is_available_tomorrow": true, "time": { "0": "?" } }, "cargos": [ { "name": "Автомобиль(ли)", "weight": { "0": "?" }, "volume": { "0": "?" }, "packaging": { "0": "?" }, "sizes": { "0": "?" }, "id": 1 } ], "near_cities": [ 0 ], "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } }, "unloading": { "dates": { "0": "?" }, "near_cities": [ 0 ], "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } }, "way_points": [ { "type": "loading", "cargos": [ { "name": "Автомобиль(ли)", "weight": { "0": "?" }, "volume": { "0": "?" }, "packaging": { "0": "?" }, "sizes": { "0": "?" }, "id": 1 } ], "loading_date": { "0": "?" }, "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } } ], "is_round_trip": true }, "truck": { "trucks_count": 1, "load_type": "ftl", "body_types": [ 0 ], "body_loading": { "0": "?" }, "body_unloading": { "0": "?" }, "temperature": { "0": "?" }, "documents": { "0": "?" }, "requirements": { "0": "?" }, "adr": 3, "belts_count": 4, "is_tracking": true, "required_capacity": 20 }, "payment": { "type": "with-bargaining", "auto_invites_settings": { "0": "?" }, "currency_type": 1, "rate_with_vat": 50000, "rate_without_vat": 50000, "cash": 50000, "on_card": true, "rates_with_vat": [ { "rate_with_vat": 50000, "vat_percent": 22 } ], "hide_counter_offers": true, "direct_offer": true, "prepayment": { "0": "?" }, "payment_mode": { "0": "?" } }, "documents": [ { "id": "9c6cce94-c0e3-eb11-bb99-002590fdcfdb", "file_id": "6b35842b8386446c82a43726f139abe1" } ], "boards": [ { "id": "a0a0a0a0a0a0a0a0a0a0a0a0", "publication_mode": "now", "publication_time": "2024-01-15T10:30:00+00:00", "cancel_publish_on_auction_bet": true, "reservation_enabled": true } ], "paid_features": { "priority_view": { "0": "?" }, "stealth": { "0": "?" } }, "note": "Тестовый груз", "contacts": [ 0 ] } }

Создать заявку на груз. API для интеграции. Публикует новую заявку на груз от имени текущего пользователя.

Прежний адрес метода. Он продолжает работать, но для новых интеграций используйте актуальную версию.

post /v2/cargos

Модель и примеры

Параметры

Параметров нет

Запрос

Модель

{...}

Запрос на создание заявки на груз через Integration API.

cargo_application*:{...}

Заявка груза

external_id: null,string

Внешний номер груза или заказа Поле не должно содержать emoji-символы и emoji-последовательности

route*:{...}

Маршрут

loading*:{...}

Основная точка загрузки — начало маршрута. Здесь задают даты загрузки и грузы, которые забирают в начале маршрута.

dates*:{...}

Даты загрузки. Обязательны, вид задаёт дискриминатор type.

type: enum

[ready]

Тип даты — готов к загрузке (ready).

readyfrom-datepermanentrate-request

is_available_tomorrow: null,boolean

Готов к загрузке сегодня и завтра

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

first_date: date-time

Первый день, когда груз можно забрать. Обязателен, отстоит от сегодняшнего дня не больше чем на 60 дней.

last_date: date-time

Последний день, когда груз можно забрать. Обязателен, не раньше first_date и не в прошлом.

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

periodicity*: string

Периодичность постоянной загрузки. Обязательна, другие значения отклоняются. - everyday — каждый день - workdays — по рабочим дням

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

cargos*:[{...}]

Грузы заявки, хотя бы один. id груза сквозной по всей заявке: по нему точки разгрузки указывают, что снимают.

name*: string

От (0 до 200 символов)

Наименование груза Поле не должно содержать emoji-символы и emoji-последовательности

weight*:

Вес груза. Можно не указывать, если задан объём.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume*:

Объём груза. Можно не указывать, если задан вес.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

near_cities: [int32]

Ближайшие крупные города — не больше 10, без повторов. Нельзя указывать, если сам город точки является региональным центром. dict: GET /v1.0/dictionaries/cities/{cityId}/near → id

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}

unloading*:{...}

Основная точка разгрузки — конец маршрута.

dates:

Даты разгрузки. Поле необязательное.

ONE-OF

1:{...}

Даты разгрузки. Значима календарная дата, а не момент времени: день определяется по смещению, которое прислал клиент. Даты в примерах условные: подставляйте актуальные, иначе запрос отклонят.

first_date: date-time

Первый день разгрузки. Не в прошлом. Обязателен, если задан last_date.

last_date: date-time

Последний день разгрузки. Не раньше first_date.

time:

Время разгрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

near_cities: [int32]

Ближайшие крупные города — не больше 10, без повторов. Нельзя указывать, если сам город точки является региональным центром. dict: GET /v1.0/dictionaries/cities/{cityId}/near → id

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}

way_points:[{...}]

Промежуточные точки между загрузкой и разгрузкой, не больше 15. Перечисляйте их в порядке проезда: по этому порядку сервис проверяет, что груз, снятый на промежуточной разгрузке, был загружен раньше.

type: enum

[loading]

Тип промежуточной точки — загрузка (loading).

loadingunloadingcustomsgo-through

cargos:[{...}]

Грузы, которые забирают в этой точке. id каждого груза уникален в пределах заявки.

name*: string

От (0 до 200 символов)

Наименование груза Поле не должно содержать emoji-символы и emoji-последовательности

weight*:

Вес груза. Можно не указывать, если задан объём.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume*:

Объём груза. Можно не указывать, если задан вес.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

loading_date:

Дата и время загрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

cargos:[{...}]

Грузы, которые снимают в этой точке. id ссылается на груз из route.loading.cargos либо из более ранней точки loading.

weight:

Снимаемая часть веса. Обязательна, если вес был задан при загрузке этого груза, и запрещена, если не был.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume:

Снимаемая часть объёма. Обязательна, если объём был задан при загрузке этого груза, и запрещена, если не был.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging_quantity: int32

Снимаемое количество упаковок.

is_defined_by_ttn: null,boolean

Снимаемая часть груза будет определена в ТТН.

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

unloading_date:

Дата и время разгрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}]

is_round_trip: null,boolean

Кругорейс

}

truck*:{...}

Транспорт

trucks_count: int32

Количество машин

load_type*: string

Загрузка: - ftl — отдельной машиной - ltl — догрузом - dont-care — отдельной машиной или догрузом

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

body_loading:

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

ONE-OF

1:{...}

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

types: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required: null,boolean

Обязательны все выбранные

}

null

body_unloading:

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

ONE-OF

1:{...}

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

types: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required: null,boolean

Обязательны все выбранные

}

null

temperature:

Температура

ONE-OF

1:{...}

Температура.

from: int32

От

to: int32

До

}

null

documents:

Разрешения

ONE-OF

1:{...}

Разрешения транспорта.

tir: null,boolean

TIR todo ссылка на фак

cmr: null,boolean

CMR todo ссылка на фак

t1: null,boolean

T1 todo ссылка на фак

medical_card: null,boolean

Медкнижка

}

null

requirements:

Требования

ONE-OF

1:{...}

Требования к транспорту.

logging_truck: null,boolean

Коники

road_train: null,boolean

Сцепка

air_suspension: null,boolean

Пневмоход

team_driving: null,boolean

Для груза необходимы два водителя

}

null

adr: int32

ADR

belts_count: int32

Количество ремней

is_tracking: null,boolean

Трекинг через АТИ Водитель

required_capacity: double

Требуемая грузоподъемность в тоннах

}

payment*:{...}

Оплата

type: enum

[with-bargaining]

Тип оплаты — возможен торг (with-bargaining).

with-bargainingwithout-bargainingrate-requestauction

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

rate_with_vat_available: null,boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available: null,boolean

Можно предлагать ставки безнал без НДС

cash_available: null,boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

accept_bids_with_vat*: null,boolean

Принимать ставки с НДС

accept_bids_without_vat: null,boolean

Принимать ставки без НДС

vat_percents: int32

Размер НДС, в процентах

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты, в которой будут вестись Торги. Значение из словаря валют

bid_step*: double

Шаг ставок

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: null,string

Длительность торгов: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов - 1d — 1 день - 2d — 2 дня - 3d — 3 дня - 4d — 4 дня - 5d — 5 дней

count_from_first_bid: null,boolean

Отсчитывать длительность Торгов с момента первой ставки

finish_until: date-time

Точные дата и время завершения Торгов

}

accept_counter_offers:

Параметры доступности встречных предложений во время проведения Торгов

ONE-OF

1:{...}

Параметры доступности встречных предложений во время Торгов.

acceptance_delay: null,string

Принимать встречные предложения через: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

until_first_bid: null,boolean

Принимать встречные предложения до первой ставки по Торгам

}

null

auto_renew:

Параметры автопродления Торгов

ONE-OF

1:{...}

Параметры автопродления Торгов.

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

null

is_antisniper: null,boolean

Опция Антиснайпер

rate_rise:

Параметры повышения ставки Торгов при отсутствии ставок

ONE-OF

1:{...}

Параметры повышения ставки Торгов при отсутствии ставок.

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

null

winner_criteria*: string

Критерий выбора победителя: - best-rate — по лучшей ставке - matching-date — с учётом даты загрузки и лучшей ставки

time_to_provide_documents*: null,string

Время, за которое победитель обязан предоставить документы

winner_reselection_count: int32

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_restart:

Параметры перезапуска Торгов в случае отсутствия ставок

ONE-OF

1:{...}

Параметры перезапуска Торгов при отсутствии ставок.

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

rate_increase:

Параметры повышения начальной ставки после перезапуска торгов.

ONE-OF

1:{...}

Параметры повышения начальной ставки после перезапуска Торгов.

type: enum

[currency]

Тип повышения — абсолютное значение в валюте (currency).

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

null

}

null

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type: enum

[archive]

Действие — переместить заявку в архив (archive).

archivepublish-with-ratepublish-rate-request

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

rate_with_vat_available: null,boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available: null,boolean

Можно предлагать ставки безнал без НДС

cash_available: null,boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

}

keep_rates: null,boolean

Сохранять ставки при редактировании груза

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

}

documents:[{...}]

Фото груза и документов

id: string

Старый id документа

file_id: string

Новый id документа

}]

boards:[{...}]

Площадки груза

id*: string

Id площадки

publication_mode: string

Опубликовать груз - now – сразу - 15m – через 15 минут - 30m – через 30 минут - 1h – через час - 3h – через 3 часа - 6h – через 6 часов - exact-time - в точное время

publication_time: date-time

Точное время публикации груза, для publication_mode = 'exact-time'

cancel_publish_on_auction_bet: null,boolean

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

reservation_enabled: null,boolean

Разрешить перевозчикам бронировать груз

}]

paid_features:{...}

Платные услуги: приоритетный показ, стелс

priority_view:

Приоритетный показ

ONE-OF

1:{...}

Приоритетный показ.

rate*: double

Ставка за просмотр

limit: double

Лимит на заявку

daily_limit: double

Суточный лимит

only_for_paid_users: null,boolean

Показывать приоритетный груз только платным пользователям

}

null

stealth:

Стэлс

ONE-OF

1:{...}

Стелс.

list_id: uuid

Id списка фирм для скрытия

minimal_registration_date: date-time

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32

Минимальное количество звёзд фирм, которые будут видеть груз

}

null

}

note: null,string

Примечание к заявке Поле не должно содержать emoji-символы и emoji-последовательности

contacts*: [int32]

Id контактов заявки

}

}

Пример запроса

CURL

curl 'https://api.ati.su/v2/cargos' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"cargo_application":{"external_id":"EXT-12345","route":{"loading":{"dates":{"type":"ready","is_available_tomorrow":true,"time":{"0":"?"}},"cargos":[{"name":"Автомобиль(ли)","weight":{"0":"?"},"volume":{"0":"?"},"packaging":{"0":"?"},"sizes":{"0":"?"},"id":1}],"near_cities":[0],"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}},"unloading":{"dates":{"0":"?"},"near_cities":[0],"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}},"way_points":[{"type":"loading","cargos":[{"name":"Автомобиль(ли)","weight":{"0":"?"},"volume":{"0":"?"},"packaging":{"0":"?"},"sizes":{"0":"?"},"id":1}],"loading_date":{"0":"?"},"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}}],"is_round_trip":true},"truck":{"trucks_count":1,"load_type":"ftl","body_types":[0],"body_loading":{"0":"?"},"body_unloading":{"0":"?"},"temperature":{"0":"?"},"documents":{"0":"?"},"requirements":{"0":"?"},"adr":3,"belts_count":4,"is_tracking":true,"required_capacity":20},"payment":{"type":"with-bargaining","auto_invites_settings":{"0":"?"},"currency_type":1,"rate_with_vat":50000,"rate_without_vat":50000,"cash":50000,"on_card":true,"rates_with_vat":[{"rate_with_vat":50000,"vat_percent":22}],"hide_counter_offers":true,"direct_offer":true,"prepayment":{"0":"?"},"payment_mode":{"0":"?"}},"documents":[{"id":"9c6cce94-c0e3-eb11-bb99-002590fdcfdb","file_id":"6b35842b8386446c82a43726f139abe1"}],"boards":[{"id":"a0a0a0a0a0a0a0a0a0a0a0a0","publication_mode":"now","publication_time":"2024-01-15T10:30:00+00:00","cancel_publish_on_auction_bet":true,"reservation_enabled":true}],"paid_features":{"priority_view":{"0":"?"},"stealth":{"0":"?"}},"note":"Тестовый груз","contacts":[0]}}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v2/cargos", "{""cargo_application"":{""external_id"":""EXT-12345"",""route"":{""loading"":{""dates"":{""type"":""ready"",""is_available_tomorrow"":true,""time"":{""0"":""?""}},""cargos"":[{""name"":""Автомобиль(ли)"",""weight"":{""0"":""?""},""volume"":{""0"":""?""},""packaging"":{""0"":""?""},""sizes"":{""0"":""?""},""id"":1}],""near_cities"":[0],""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}},""unloading"":{""dates"":{""0"":""?""},""near_cities"":[0],""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}},""way_points"":[{""type"":""loading"",""cargos"":[{""name"":""Автомобиль(ли)"",""weight"":{""0"":""?""},""volume"":{""0"":""?""},""packaging"":{""0"":""?""},""sizes"":{""0"":""?""},""id"":1}],""loading_date"":{""0"":""?""},""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}}],""is_round_trip"":true},""truck"":{""trucks_count"":1,""load_type"":""ftl"",""body_types"":[0],""body_loading"":{""0"":""?""},""body_unloading"":{""0"":""?""},""temperature"":{""0"":""?""},""documents"":{""0"":""?""},""requirements"":{""0"":""?""},""adr"":3,""belts_count"":4,""is_tracking"":true,""required_capacity"":20},""payment"":{""type"":""with-bargaining"",""auto_invites_settings"":{""0"":""?""},""currency_type"":1,""rate_with_vat"":50000,""rate_without_vat"":50000,""cash"":50000,""on_card"":true,""rates_with_vat"":[{""rate_with_vat"":50000,""vat_percent"":22}],""hide_counter_offers"":true,""direct_offer"":true,""prepayment"":{""0"":""?""},""payment_mode"":{""0"":""?""}},""documents"":[{""id"":""9c6cce94-c0e3-eb11-bb99-002590fdcfdb"",""file_id"":""6b35842b8386446c82a43726f139abe1""}],""boards"":[{""id"":""a0a0a0a0a0a0a0a0a0a0a0a0"",""publication_mode"":""now"",""publication_time"":""2024-01-15T10:30:00+00:00"",""cancel_publish_on_auction_bet"":true,""reservation_enabled"":true}],""paid_features"":{""priority_view"":{""0"":""?""},""stealth"":{""0"":""?""}},""note"":""Тестовый груз"",""contacts"":[0]}}");

Ответ

200 Заявка на груз успешно создана и опубликована.

Модель

{...}

Ответ на создание заявки на груз через Integration API.

cargo_application*:{...}

Заявка груза

cargo_id: uuid

ID груза OBSOLETE используй поле CargoApplicationId

cargo_number: string

Номер груза, автоматически генерируемый ATI.SU OBSOLETE используй поле CargoApplicationNumber

source: int32

OBSOLETE используй поле OriginSource

contacts: [int32]

Контакты OBSOLETE используй поле ApplicationContacts

distance: int32

Дистанция, км

cargo_application_id*: uuid

Id груза

snapshot_id*: int64

Id состояния груза (меняется при каждом редактировании)

cargo_application_number*: string

Номер груза, автоматически генерируемый ATI.SU

department_id*: int32

Подразделение, которому принадлежит заявка.

persistent_user_id*: int32

Идентификатор пользователя, разместившего заявку

actor_contact_id: int32

Идентификатор контакта, разместившего заявку

external_id: null,string

Внешний номер груза или заказа

added_at*: date-time

Время добавления груза, UTC

updated_at*: date-time

Время последнего изменения груза, UTC

refreshed_at: date-time

Время последнего поднятия груза, UTC

origin_source*: string

Использованный api при создания груза: - web-cargos-api, - mobile-cargos-api, - public-cargos-api

route*:{...}

Маршрут

loading*:{...}

Основная точка загрузки — начало маршрута. Здесь даты загрузки и грузы, которые забирают в начале маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates*:{...}

Даты загрузки. Вид задаёт дискриминатор type.

type: enum

[from-date]

Тип даты — в промежутке дат (from-date).

from-datereadypermanentrate-request

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

is_available_tomorrow*: boolean

Готов к загрузке сегодня и завтра (TODO возможно убрать)

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

periodicity*: string

Периодичность постоянной загрузки: - everyday — "каждый день" - workdays — "по рабочим дням"

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

}

cargos*:[{...}]

Грузы заявки. cargo_id сквозной по всей заявке: по нему точки разгрузки указывают, что снимают.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

unloading*:{...}

Основная точка разгрузки — конец маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates:

Даты разгрузки. Могут быть не заданы.

ONE-OF

1:{...}

Даты разгрузки. Значима календарная дата, а не момент времени: день определяется по смещению в значении.

first_date: date-time

Первый день разгрузки.

last_date: date-time

Последний день разгрузки.

time:

Время разгрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

way_points:[{...}]

Промежуточные точки между загрузкой и разгрузкой, не больше 15, в порядке проезда.

type: enum

[loading]

Тип промежуточной точки — точка загрузки (loading).

loadingunloadingcustomsgo-through

cargos:[{...}]

Грузы, которые забирают в этой точке.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

loading_date:

Дата и время загрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

cargos:[{...}]

Грузы, которые снимают в этой точке.

packaging_quantity: int32

Снимаемое количество упаковок.

is_defined_by_ttn: null,boolean

Снимаемая часть груза будет определена в ТТН.

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

unloading_date:

Дата и время разгрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}]

is_round_trip: null,boolean

Кругорейс

}

truck*:{...}

Транспорт

trucks_count*: int32

Количество машин

load_type*: string

Загрузка: - ftl — отдельной машиной - dont-care — не важно

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

is_tracking*: boolean

Трекинг через АТИ Водитель

adr: int32

ADR

belts_count: int32

Количество ремней

required_capacity: double

Требуемая грузоподъемность в тоннах

body_loading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

body_unloading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

temperature:

Температура

ONE-OF

1:{...}

Температура.

from: int32

От

to: int32

До

}

null

documents:

Разрешения

ONE-OF

1:{...}

Разрешения транспорта.

tir*: boolean

TIR

cmr*: boolean

CMR

t1*: boolean

T1

medical_card*: boolean

Медкнижка

}

null

requirements:

Требования

ONE-OF

1:{...}

Требования к транспорту.

logging_truck*: boolean

Коники

road_train*: boolean

Сцепка

air_suspension*: boolean

Пневмоход

team_driving*: boolean

Для груза необходимы два водителя

}

null

}

payment*:{...}

Оплата

type: enum

[with-bargaining]

Тип оплаты — с возможностью торга (with-bargaining).

with-bargainingwithout-bargainingrate-requestauction

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

auction_id*: uuid

Id Торгов

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты из словаря валют

bid_step*: double

Шаг ставки Торгов

accept_bids_with_vat*: boolean

Принимать ставки с НДС

accept_bids_without_vat: null,boolean

Принимать ставки без НДС

vat_percents: int32

Размер НДС, в процентах

is_antisniper*: boolean

Опция Антиснайпер

time_to_provide_documents*: string

Время, за которое победитель обязан предоставить документы

winner_criteria*: string

Критерий выбора победителя: best-rate — по лучшей ставке matching-date — с учётом даты загрузки и лучшей ставки

winner_reselection_count: int32

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: null,string

Может быть null, если есть значение у поля FinishUntil. Длительность проведения Торгов: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов 1d — 1 день 2d — 2 дня 3d — 3 дня 4d — 4 дня 5d — 5 дней

count_from_first_bid*: boolean

Отсчитывать длительность Торгов с момента первой ставки

finish_until: date-time

Точные дата и время завершения Торгов

}

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type: enum

[archive]

Действие — переместить заявку в архив (archive).

archivepublish-with-ratepublish-rate-request

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

}

accept_counter_offers:

Параметры доступности встречных предложений во время проведения Торгов

ONE-OF

1:{...}

Параметры доступности встречных предложений во время Торгов.

acceptance_delay: null,string

Может быть null, в таком случае будем принимать встречные предложения сразу. Принимать встречные предложения через: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

until_first_bid*: boolean

Принимать встречные предложения до первой ставки по Торгам

}

null

auto_renew:

Параметры автопродления Торгов

ONE-OF

1:{...}

Параметры автопродления Торгов.

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

null

rate_rise:

Параметры повышения ставки Торгов при отсутствии ставок

ONE-OF

1:{...}

Параметры повышения ставки Торгов при отсутствии ставок.

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

null

auction_restart:

Параметры перезапуска Торгов в случае отсутствия ставок

ONE-OF

1:{...}

Параметры перезапуска Торгов при отсутствии ставок.

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов

rate_increase:

Параметры повышения начальной ставки после перезапуска торгов.

ONE-OF

1:{...}

Параметры повышения начальной ставки после перезапуска Торгов.

type: enum

[currency]

Тип повышения — абсолютное значение в валюте (currency).

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

null

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

}

boards*:[{...}]

Площадки груза

id*: string

Id площадки

publication_mode*: string

Опубликовать груз: now – сразу 15m – через 15 минут 30m – через 30 минут 1h – через час 3h – через 3 часа 6h – через 6 часов exact-time - в точное время

publication_time*: date-time

Точное время публикации груза, для publication_mode = 'exact-time'

cancel_publish_on_auction_bet*: boolean

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

publication_restriction: integer

Стратегия ограничений публикации груза на площадке

reservation_enabled*: boolean

Разрешить перевозчикам бронировать груз

is_published*: boolean

Груз опубликован на площадке

}]

documents:[{...}]

Фото груза и документов

id: string

Старый id документа OBSOLETE используй поле FileID

file_id*: string

Id документа в API Плюшкин (TODO ссылка)

name*: string

Название документа

link*: string

Ссылка на документ

}]

application_contacts*:[{...}]

Информация о контактах груза

id*: int32

Id контакта

}]

paid_features:

Платные услуги

ONE-OF

1:{...}

Платные услуги: приоритетный показ, стелс.

priority_view:

Приоритетный показ

ONE-OF

1:{...}

Приоритетный показ.

money_spent_per_day: double

Потрачено атисов за день OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

money_spent_per_order: double

Потрачено атисов на эту заявку OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

rate*: double

Ставка за просмотр

only_for_paid_users*: boolean

Показывать приоритетный груз только платным пользователям

limit: double

Лимит на заявку

daily_limit: double

Суточный лимит

}

null

stealth:

Стэлс

ONE-OF

1:{...}

Стелс.

list_id: uuid

Id списка фирм для скрытия

minimal_registration_date: date-time

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32

Минимальное количество звёзд фирм, которые будут видеть груз

}

null

}

null

note: null,string

Примечание к грузу

lot_id: uuid

Id Лота, к которому прикреплён данный груз

lot_number: int32

Номер Лота, к которому прикреплён данный груз

is_pass_through_copy: null,boolean

Является ли груз сквозной копией

is_archived: null,boolean

Отправлен ли груз в архив

archive_date: date-time

Время отправки груза в архив, UTC

true_price: int32

Истинная ставка на груз после жалоб "Озвученная ставка"

true_currency_id: int32

Истинная валюта ставки на груз после жалоб "Озвученная ставка"

client_application_id: null,string

Идентификатор интегратора (клиентского приложения), через которое был создан груз

}

}

Пример

{...}

"cargo_application":{...}

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"ABC1234",

"source":2,

"contacts":[...],

0

],

"distance":1794,

"cargo_application_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"snapshot_id":1000500,

"cargo_application_number":"ABC1234",

"department_id":7654321,

"persistent_user_id":1234567,

"actor_contact_id":0,

"external_id":"EXT-12345",

"added_at":"2024-01-15T10:30:00+00:00",

"updated_at":"2024-01-15T10:30:00+00:00",

"refreshed_at":"2024-01-15T10:30:00+00:00",

"origin_source":"public-cargos-api",

"route":{...},

"loading":{...},

"near_cities":[...],

0

],

"dates":{...},

"type":"from-date",

"time":{...},

"0":"?"

},

"first_date":"2024-08-27T00:00:00+03:00",

"last_date":"2024-08-29T00:00:00+03:00"

},

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"unloading":{...},

"near_cities":[...],

0

],

"dates":{...},

"0":"?"

},

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"way_points":[...],

{...}

"type":"loading",

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"loading_date":{...},

"0":"?"

},

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

}

],

"is_round_trip":true

},

"truck":{...},

"trucks_count":1,

"load_type":"ftl",

"body_types":[...],

0

],

"is_tracking":true,

"adr":3,

"belts_count":4,

"required_capacity":20,

"body_loading":{...},

"0":"?"

},

"body_unloading":{...},

"0":"?"

},

"temperature":{...},

"0":"?"

},

"documents":{...},

"0":"?"

},

"requirements":{...}

"0":"?"

}

},

"payment":{...},

"type":"with-bargaining",

"auto_invites_settings":{...},

"0":"?"

},

"currency_type":1,

"rate_with_vat":50000,

"rate_without_vat":50000,

"cash":50000,

"on_card":true,

"rates_with_vat":[...],

{...}

"rate_with_vat":50000,

"vat_percent":22

}

],

"hide_counter_offers":true,

"direct_offer":true,

"prepayment":{...},

"0":"?"

},

"payment_mode":{...}

"0":"?"

}

},

"boards":[...],

{...}

"id":"a0a0a0a0a0a0a0a0a0a0a0a0",

"publication_mode":"now",

"publication_time":"2024-01-15T10:30:00+00:00",

"cancel_publish_on_auction_bet":true,

"publication_restriction":0,

"reservation_enabled":true,

"is_published":true

}

],

"documents":[...],

{...}

"id":"9c6cce94-c0e3-eb11-bb99-002590fdcfdb",

"file_id":"6b35842b8386446c82a43726f139abe1",

"name":"Транспортная накладная.pdf",

"link":"https://api.ati.su/webapi/filestorage/files/6b35842b8386446c82a43726f139abe1"

}

],

"application_contacts":[...],

{...}

"id":0

}

],

"paid_features":{...},

"0":"?"

},

"note":"Тестовый груз",

"lot_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"lot_number":38,

"is_pass_through_copy":true,

"is_archived":true,

"archive_date":"2024-01-15T10:30:00+00:00",

"true_price":50000,

"true_currency_id":1,

"client_application_id":"ati"

}

}

400 Невалидные данные запроса.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

402 Недостаточно средств на счёте для размещения.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

403 Нет прав на размещение или кошелёк заблокирован.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

404 Связанный ресурс не найден.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

409 Обнаружен дубликат заявки.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

417 Изменилась цена размещения.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

429 Достигнут ежедневный лимит публикации грузов.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

Нет параметров

{ "cargo_application": { "external_id": "EXT-12345", "route": { "loading": { "dates": { "type": "ready", "is_available_tomorrow": true, "time": { "0": "?" } }, "cargos": [ { "name": "Автомобиль(ли)", "weight": { "0": "?" }, "volume": { "0": "?" }, "packaging": { "0": "?" }, "sizes": { "0": "?" }, "id": 1 } ], "near_cities": [ 0 ], "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } }, "unloading": { "dates": { "0": "?" }, "near_cities": [ 0 ], "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } }, "way_points": [ { "type": "loading", "cargos": [ { "name": "Автомобиль(ли)", "weight": { "0": "?" }, "volume": { "0": "?" }, "packaging": { "0": "?" }, "sizes": { "0": "?" }, "id": 1 } ], "loading_date": { "0": "?" }, "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } } ], "is_round_trip": true }, "truck": { "trucks_count": 1, "load_type": "ftl", "body_types": [ 0 ], "body_loading": { "0": "?" }, "body_unloading": { "0": "?" }, "temperature": { "0": "?" }, "documents": { "0": "?" }, "requirements": { "0": "?" }, "adr": 3, "belts_count": 4, "is_tracking": true, "required_capacity": 20 }, "payment": { "type": "with-bargaining", "auto_invites_settings": { "0": "?" }, "currency_type": 1, "rate_with_vat": 50000, "rate_without_vat": 50000, "cash": 50000, "on_card": true, "rates_with_vat": [ { "rate_with_vat": 50000, "vat_percent": 22 } ], "hide_counter_offers": true, "direct_offer": true, "prepayment": { "0": "?" }, "payment_mode": { "0": "?" } }, "documents": [ { "id": "9c6cce94-c0e3-eb11-bb99-002590fdcfdb", "file_id": "6b35842b8386446c82a43726f139abe1" } ], "boards": [ { "id": "a0a0a0a0a0a0a0a0a0a0a0a0", "publication_mode": "now", "publication_time": "2024-01-15T10:30:00+00:00", "cancel_publish_on_auction_bet": true, "reservation_enabled": true } ], "paid_features": { "priority_view": { "0": "?" }, "stealth": { "0": "?" } }, "note": "Тестовый груз", "contacts": [ 0 ] } }

Добавление груза. API для интеграции. Груз публикуется от имени фирмы и контакта, для которых выпущен токен. Ответ содержит сохранённый груз с проставленными идентификаторами и датами.

Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

post /v1.0/loads

Модель и примеры

Параметры

Параметров нет

Запрос

Модель

{...}

Груз для публикации.

LoadMeta:

Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией

ONE-OF

1:{...}

Метаданные публикации.

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные. Максимальная длина 1024 символа

}

ContactId1*: int32

Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id. Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами. Контакт должен быть виден для остальных участников АТИ

ContactId2: int32 (nullable)

Идентификатор второго выбранного контакта, если не выбрано, то null. Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу. Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC. Минимальное значение равно текущей дате. При значении параметра DateType равным 0, допустимое значение поля - текущая дата. При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед. При значении параметра DateType равным 2, допустимое значение поля - текущая дата. При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC. Минимальное значение равно значению параметра FirstDate. При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед. При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед. При значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется. При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Тип готовности груза к перевозке, по умолчанию 0

• 0 - Готов к загрузке
• 1 - в период с FirstDate по LastDate
• 2 - постоянно
• 3 - груза нет, запрос ставки

PeriodicityId: int32

Периодичность загрузки. Если параметр DateType не равен 2, PeriodicityId равен 0. Иначе PeriodicityId может принимать следующие значения:

• 1 - ежедневно
• 100 - по рабочим дням

OrderNumber: string

Номер заказа. Ограничение по длине: 250 символов

Krugoreis: boolean

Включён ли кругорейс

Loading*:

Точка погрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

ExtraPoints:[{...}]

Дополнительные пункты маршрута между погрузкой и выгрузкой.
Максимум 15 штук. Может иметь значение null

CityId*: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

PointType*: int32

Тип точки:

• 1 - загрузка
• 2 - разгрузка
• 3 - таможня
• 8 - проехать через

Latitude: decimal (nullable)

Широта точки. Допустимое значение от -90 до 90; указывается вместе с долготой

Longitude: decimal (nullable)

Долгота точки. Допустимое значение от -180 до 180; указывается вместе с широтой

Street: string

Улица или район. Максимальная длина 200 символов

OrganizationId: guid (nullable)

Организация, принимающая или отгружающая груз в этой точке. Указывается только вместе с AddressId

AddressId: guid (nullable)

Адрес точки. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

OrdinalId: int32

Порядок точки на маршруте. Если у всех точек 0, сервис нумерует их по порядку списка

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeStart: string (nullable)

Время начала загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeEnd: string (nullable)

Время окончания загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingCargos:[{...}]

Позиции груза, которые берут в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

UnloadingCargos:[{...}]

Позиции груза, которые оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза (CargoId из точки загрузки)

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

PackagingQuantity: int32 (nullable)

Количество выгружаемых мест

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

}]

Unloading*:

Точка выгрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

Cargo*:

Что везём: наименование, вес, объём, упаковка

ONE-OF

1:{...}

Описание груза: что и сколько везём.

Weight: double

Вес груза в тоннах. Обязательный параметр, если не задан параметр Volume. Допустимое значение 0 либо от 0,001 до 9999, не более 3 знаков после запятой

Volume: double

Объём груза в кубических метрах. Обязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа

ADR: int32

Класс опасности груза по ADR. Допустимое значение от 0 до 9, по умолчанию 0. Для CargoTypeId = 53 обязателен ненулевой

CargoTypeId*: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes

CargoType: string

Наименование груза текстом. Обязательный параметр: при CargoTypeId = 59 («другое») это и есть наименование груза. Максимальная длина названия - 200 символов. В этом поле запрещено указывать контактную информацию

PackType: int32

Идентификатор типа упаковки (навалом, коробки, россыпью), 0 — упаковка не указана. dict: GET /v1.0/dictionaries/packTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-packTypes

PalletCount: int32

Количество упаковок для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

• 1 - только отдельной машиной
• 2 - отдельной или догрузом
• 3 - только догрузом

SborGruz: boolean

Сборный груз

Size:

Параметры размера груза

ONE-OF

1:{...}

Габариты груза.

Length: double

Длина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

HeightHighlight: boolean

Выделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

}

}

Transport*:

Требования к транспорту: кузов, варианты загрузки и выгрузки

ONE-OF

1:{...}

Требования к транспорту.

CarType*: int64

Битовая маска типов кузова: идентификаторы из справочника — степени двойки, несколько кузовов складываются (1 + 4 = 5). dict: GET /v1.0/dictionaries/carTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes

CarTypeString: string

Та же битовая маска типов кузова строкой. Только в ответе: в запросе значение игнорируется

LoadingType: int32

Битовая маска вариантов загрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/loadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes

LoadingLogicalOperator: string

Тип условия загрузки:

• OR - необходимо, чтобы присутствовал один из способов загрузки
• AND - необходимо, чтобы присутствовали все выбранные типы загрузки

UnloadingType: int32

Битовая маска вариантов разгрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/unloadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-unloadingTypes

UnloadingLogicalOperator: string

Тип условия разгрузки:

• OR - необходимо, чтобы присутствовал один из способов разгрузки
• AND - необходимо, чтобы присутствовали все выбранные типы разгрузки

TrucksQuantity: int32

Количество машин. Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

Минимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

TemperatureTo: int32 (nullable)

Максимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

Stsepka: boolean

Нужна ли сцепка для груза

Pnevmohod: boolean

Нужен ли пневмоход для груза

Koniki: boolean

Нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

Документы на транспорт, необходимые для провоза этого груза: медкнижка

IsTracking: boolean

Трекинг через АТИ Водитель

RequiredCapacity: double (nullable)

Требуемая грузоподъемность в тоннах. Допустимое значение от 0,01 до 9999, не более 3 знаков после запятой

}

Payment*:

Условия оплаты и ставка

ONE-OF

1:{...}

Условия оплаты и ставка.

CurrencyId: int32

Идентификатор валюты. dict: GET /v1.0/dictionaries/currencyTypes → Id. По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

MoneyType: int32

Идентификатор варианта оплаты. dict: GET /v1.0/dictionaries/moneyTypes → Id. По умолчанию - 22. Должен принимать значение 22, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-moneyTypes

RateSum: decimal

Ставка для груза. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов

SumWithNDS: decimal

Ставка по безналичному расчёту с НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов. Если заданы обе безналичные ставки, SumWithNDS должна быть не меньше SumWithoutNDS. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0

SumWithoutNDS: decimal

Ставка по безналичному расчёту без НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Значение не меньше 0, максимальная длина 10 символов. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0

PrepayPercent: int32

Процент предоплаты. Допустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

Через сколько банковских дней оплата. Допустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false

PayDaysEnabled: boolean

Включена ли оплата через банковские дни. По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true

FixedRate: boolean

true, если ставка задана, false если запрос ставки. По умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1

Torg: boolean

Возможен ли торг. По умолчанию - false. Должен быть false, если параметр FixedRate равен false; при торгах с публикацией ставки — true

DirectContract: boolean

Прямой договор

InFuel: boolean

Предоплата топливом. Должен быть false, если параметр PrepayPercentEnabled равен false

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

Скрыть встречные предложения

AcceptPaymentTypes: int32

Битовая маска форм оплаты, которые вы готовы принять при запросе ставки: флаги складываются

• 1 - наличные
• 2 - безналичный расчёт с НДС
• 4 - безналичный расчёт без НДС

Пример: 7 — все три формы. При запросе ставки значение 0 сервис заменяет на 7; при фиксированной ставке поле не используется

}

InviteSettings:

Настройки автоприглашений

ONE-OF

1:{...}

Настройки автоприглашений по встречным предложениям.

InviteDelayInSeconds: int32

Время в секундах сбора встречных предложений: через него сервис создаёт приглашение по лучшему предложению. Обязателен и больше 0, если объект настроек передан

InviteDurationInSeconds: int32

Время в секундах действия приглашения. Обязателен и больше 0, если объект настроек передан

MaxPercentDeviation: int32 (nullable)

На сколько процентов встречное предложение может превышать вашу ставку, чтобы приглашение всё-таки ушло

NeedArchiveOnInvite: boolean

Архивировать груз при срабатывании автоматического приглашения

}

PriorityView:

Приоритетный показ

ONE-OF

1:{...}

Общие параметры приоритетного показа.

DailyLimit: decimal

Суточный лимит списания по услуге в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

Показывать груз в приоритете только платным пользователям

OrderLimit: decimal

Лимит списания на груз в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

Ставка за просмотр в атисах

• Кратна 0,5
• Не меньше минимальной ставки сервиса и не больше баланса фирмы
• Должна иметь длину не более 5 символов

}

Stealth:

Настройки показа груза

ONE-OF

1:{...}

Ограничения показа груза платной услугой «Стелс»: списания идут с баланса фирмы. Если объект передан, нужен хотя бы один параметр.

ListIdToHide: guid (nullable)

Идентификатор списка фирм, которым груз не показывается. dict: GET https://api.ati.su/scrolls/v1/firms → id. docs: https://ati.su/developers/api/catalogs/firm-lists/

FirmRegDateToHide: date-time (nullable)

Фирмам, зарегистрированным позже этой даты, груз не показывается

ScoreToHide: double (nullable)

Минимальное число звёзд фирмы: фирмам с меньшим числом груз не показывается. Целое от 1 до 5; при включённом бронировании на общей площадке — от 2 до 5

}

LoadFiles:[{...}]

Файлы к грузу.
Перед добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. API для хранения файлов)

Id: guid

Устаревший идентификатор файла, используйте FileId

deprecated

FileId: string

Идентификатор файла, который вернул API хранения файлов при загрузке. dict: POST https://api.ati.su/v1.0/filestorage/files → id. docs: https://ati.su/developers/api/filestorage/

FileType: int32

Тип загруженного файла. Всегда 1 — документ

Attributes: int32

Устаревшее поле, всегда 0

Name: string

Имя файла. Только в ответе: приходит из хранилища файлов, в запросе значение игнорируется

Link: string

Ссылка, по которой можно скачать файл. Сервис собирает её из идентификатора файла в хранилище

Size: int32

Устаревшее поле, всегда -1

}]

Deal:

Сделка, в рамках которой размещён груз

ONE-OF

1:{...}

Сделка по грузу.

Auction:

Параметры аукциона

ONE-OF

1:{...}

Параметры торгов по грузу.

StartRate*: decimal

Начальная ставка аукциона. Параметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.

Currency*: int32

Валюта аукциона. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

Step*: decimal

Минимальное изменение ставки по аукциону. Параметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.

PaymentType*:

Тип оплаты в торгах: допустимы только 24 и 25

ONE-OF

enum

[1, 22, 23, 24, 25]

Тип оплаты.

• 1 - Наличные
• 22 - Любая
• 23 - На карту
• 24 - Безналичный расчёт с НДС
• 25 - Безналичный расчёт без НДС

AcceptSecondPayType: boolean

Принимать ставки и со вторым типом оплаты: без НДС при PaymentType = 24, с НДС при PaymentType = 25

StartDate: date-time

Время начала аукциона в UTC. Должно быть позже времени начала публикации груза на площадке.

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Время окончания аукциона "завершить не позже". Если указанное время, меньше значения Duration - аукцион заканчивается по времени "завершить не позже", если нет автопродления. Время устанавливается в формате UTC.

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.

AutoRenew: boolean

Нужно ли продлевать торги, если ставка пришла незадолго до окончания

RenewTime: int32 (nullable)

Время в минутах, на которое сдвигается окончание аукциона при включённом AutoRenew

MaxRenewTime: int32 (nullable)

Максимально допустимое время в минутах, на которое можно сдвинуть окончание аукциона при включённом AutoRenew. Указывать, если AutoRenew = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

Максимально допустимая ставка по аукциону. Обязателен при RaiseBid = true. Не меньше суммы StartRate и Step, не больше 9999999999, не более 10 символов.

RaiseBidInterval: int32 (nullable)

Период увеличения ставки в минутах при отсутствии предложений. Обязателен при RaiseBid = true: от 1 минуты и меньше Duration. При StartSinceFirstBet = true верхнее ограничение не действует.

ResponseInMinutes: int32 (nullable)

Через сколько минут после начала торгов принимать встречные предложения:

• 0 - сразу
• N - через N минут; допустимо любое значение от 0 и меньше Duration
• null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

Длительность торгов в минутах: целое число больше 0. Окончание торгов не может быть позже времени актуальности груза LastDate. Если не указана, вычисляется как разница EndDate и StartDate, при этом StartSinceFirstBet игнорируется

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчёт до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:

Параметры перезапуска аукциона.
Если объект не передан, действуют значения по умолчанию: до 3 автоматических перевыборов победителя, после исчерпания груз публикуется со ставкой

ONE-OF

1:{...}

Параметры перезапуска торгов.

AuctionFinishAction:

Действие после исчерпания перезапусков

ONE-OF

enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны.

• 1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
• 2 - Опубликовать груз с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе.
• 3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно. Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно. В переданном объекте параметров по умолчанию 0; если сам объект не передан, действует значение 3

DurationAfterRestart: int32 (nullable)

Длительность торгов в минутах после перезапуска. Необязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным

RateIncrease: decimal (nullable)

Повышение ставки при перезапуске

RateIncreaseOption: int32 (nullable)

Единица повышения ставки при перезапуске:

• 1 - в валюте
• 2 - в процентах

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

Принимать встречные предложения только до первой ставки

WinnerCriterion:

Критерий выбора победителя торгов

ONE-OF

enum

[0, 1]

Критерий победы в аукционе.

• 0 - Выбор победителя происходит автоматически по лучшей ставке
• 1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

Source:

Площадка, на которой идут торги. Значение выставляет система: передавайте 0 или не передавайте поле

ONE-OF

enum

[0, 2]

Площадка, на которой идут торги по грузу.

• 0 - Торги в АТИ
• 2 - Торги в Atrucks

}

}

Boards:[{...}]

Площадки публикации. Если не переданы, груз публикуется на общей площадке

BoardId: string

Идентификатор площадки из 24 символов. Значение общей площадки — a0a0a0a0a0a0a0a0a0a0a0a0

PublicationTime: date-time (nullable)

Время публикации на площадке. Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

Разрешено ли бронирование груза на общей площадке. Учитывается только для Общей площадки, только при включённом Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC. Может иметь значение null. Минимальное значение равно текущей дате. Не указывается при значении параметра DateType равным 3

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null. Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate. Не указывается при значении параметра DateType равным 3

}

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"LoadMeta":{"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","MetaData":"import-2026-09"},"ContactId1":1234567,"ContactId2":1234568,"Note":"Погрузка с 9 до 18, пропуск заказывать заранее","FirstDate":"2026-09-08T00:00:00.000Z","LastDate":"2026-09-10T00:00:00.000Z","DateType":1,"PeriodicityId":0,"OrderNumber":"ЗК-2026-0917","Krugoreis":false,"Loading":{"CityId":1,"Latitude":59.939095,"Longitude":30.315868,"Street":"ул. Салова, 57","OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","TimeStart":"2026-09-08T09:00:00.000Z","TimeEnd":"2026-09-08T18:00:00.000Z","IsRoundTheClock":false,"LargeCities":[0],"LoadingCargos":[{"CargoId":1,"NameId":1,"Name":"Продукты питания","PackagingType":1,"PackagingQuantity":20,"Weight":20,"Volume":82,"Sizes":{"Length":13.6,"Width":2.45,"Height":2.7,"Diameter":1.2,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}}]},"ExtraPoints":[{"CityId":1,"PointType":2,"Latitude":59.939095,"Longitude":30.315868,"Street":"пр. Ленина, 10","OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","OrdinalId":1,"IsRoundTheClock":false,"LoadingDateStart":"2026-09-09T00:00:00.000Z","LoadingDateEnd":"2026-09-09T00:00:00.000Z","LoadingTimeStart":"09:00:00","LoadingTimeEnd":"18:00:00","LoadingCargos":[{"CargoId":1,"NameId":1,"Name":"Продукты питания","PackagingType":1,"PackagingQuantity":20,"Weight":20,"Volume":82,"Sizes":{"Length":13.6,"Width":2.45,"Height":2.7,"Diameter":1.2,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}}],"UnloadingCargos":[{"CargoId":1,"Weight":10,"Volume":40,"PackagingQuantity":10,"IsDefinedByTtn":false}]}],"Unloading":{"CityId":1,"Latitude":59.939095,"Longitude":30.315868,"Street":"ул. Салова, 57","OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","TimeStart":"2026-09-08T09:00:00.000Z","TimeEnd":"2026-09-08T18:00:00.000Z","IsRoundTheClock":false,"LargeCities":[0],"LoadingCargos":[{"CargoId":1,"NameId":1,"Name":"Продукты питания","PackagingType":1,"PackagingQuantity":20,"Weight":20,"Volume":82,"Sizes":{"Length":13.6,"Width":2.45,"Height":2.7,"Diameter":1.2,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}}]},"Cargo":{"Weight":20,"Volume":82,"ADR":0,"CargoTypeId":59,"CargoType":"Стройматериалы","PackType":1,"PalletCount":33,"BeltCount":0,"DogruzType":1,"SborGruz":false,"Size":{"Length":13.6,"Width":2.45,"Height":2.7,"Diameter":1.2,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}},"Transport":{"CarType":5,"CarTypeString":"5","LoadingType":3,"LoadingLogicalOperator":"OR","UnloadingType":3,"UnloadingLogicalOperator":"OR","TrucksQuantity":1,"TemperatureFrom":-18,"TemperatureTo":4,"Stsepka":false,"Pnevmohod":false,"Koniki":false,"TIR":false,"CMR":false,"T1":false,"SanPassport":false,"IsTracking":false,"RequiredCapacity":20},"Payment":{"CurrencyId":1,"MoneyType":22,"RateSum":85000,"SumWithNDS":102000,"SumWithoutNDS":85000,"PrepayPercent":30,"PrepayPercentEnabled":true,"PayDays":5,"PayDaysEnabled":true,"FixedRate":true,"Torg":false,"DirectContract":false,"InFuel":false,"OnUnloading":false,"HideResponses":false,"AcceptPaymentTypes":0},"InviteSettings":{"InviteDelayInSeconds":600,"InviteDurationInSeconds":3600,"MaxPercentDeviation":10,"NeedArchiveOnInvite":false},"PriorityView":{"DailyLimit":500,"IsForPayedOnly":false,"OrderLimit":100,"ViewRate":1.5},"Stealth":{"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6","FirmRegDateToHide":"2024-01-01T00:00:00.000Z","ScoreToHide":3},"LoadFiles":[{"FileId":"a1b2c3d4e5f6a7b8c9d0e1f2","FileType":1,"Attributes":0,"Name":"Договор.pdf","Link":"https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2","Size":-1}],"Deal":{"Auction":{"StartRate":50000,"Currency":1,"Step":500,"PaymentType":0,"AcceptSecondPayType":false,"StartDate":"2026-09-08T09:00:00.000Z","EndDate":"2026-09-08T12:00:00.000Z","EndDateBoundary":"2026-09-09T09:00:00.000Z","Nds":20,"TimeToProvideDocuments":4,"AutoRenew":true,"RenewTime":5,"MaxRenewTime":30,"RaiseBid":false,"MaxRate":60000,"RaiseBidInterval":30,"ResponseInMinutes":15,"Duration":180,"StartSinceFirstBet":false,"AuctionRestartParameters":{"AuctionFinishAction":0,"InitRestartCount":1,"InitChangeWinnerCount":1,"DurationAfterRestart":120,"RateIncrease":500,"RateIncreaseOption":1},"AcceptCounterOffersOnlyBeforeFirstBet":false,"WinnerCriterion":0,"Source":0}},"Boards":[{"BoardId":"a0a0a0a0a0a0a0a0a0a0a0a0","PublicationTime":"2026-09-08T12:00:00.000Z","IsReservationEnabled":false,"PublicationOption":0}],"UnloadFirstDate":"2026-09-11T00:00:00.000Z","UnloadLastDate":"2026-09-12T00:00:00.000Z"}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v1.0/loads", "{""LoadMeta"":{""LoadMetaId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""MetaData"":""import-2026-09""},""ContactId1"":1234567,""ContactId2"":1234568,""Note"":""Погрузка с 9 до 18, пропуск заказывать заранее"",""FirstDate"":""2026-09-08T00:00:00.000Z"",""LastDate"":""2026-09-10T00:00:00.000Z"",""DateType"":1,""PeriodicityId"":0,""OrderNumber"":""ЗК-2026-0917"",""Krugoreis"":false,""Loading"":{""CityId"":1,""Latitude"":59.939095,""Longitude"":30.315868,""Street"":""ул. Салова, 57"",""OrganizationId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""AddressId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""TimeStart"":""2026-09-08T09:00:00.000Z"",""TimeEnd"":""2026-09-08T18:00:00.000Z"",""IsRoundTheClock"":false,""LargeCities"":[0],""LoadingCargos"":[{""CargoId"":1,""NameId"":1,""Name"":""Продукты питания"",""PackagingType"":1,""PackagingQuantity"":20,""Weight"":20,""Volume"":82,""Sizes"":{""Length"":13.6,""Width"":2.45,""Height"":2.7,""Diameter"":1.2,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}}]},""ExtraPoints"":[{""CityId"":1,""PointType"":2,""Latitude"":59.939095,""Longitude"":30.315868,""Street"":""пр. Ленина, 10"",""OrganizationId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""AddressId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""OrdinalId"":1,""IsRoundTheClock"":false,""LoadingDateStart"":""2026-09-09T00:00:00.000Z"",""LoadingDateEnd"":""2026-09-09T00:00:00.000Z"",""LoadingTimeStart"":""09:00:00"",""LoadingTimeEnd"":""18:00:00"",""LoadingCargos"":[{""CargoId"":1,""NameId"":1,""Name"":""Продукты питания"",""PackagingType"":1,""PackagingQuantity"":20,""Weight"":20,""Volume"":82,""Sizes"":{""Length"":13.6,""Width"":2.45,""Height"":2.7,""Diameter"":1.2,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}}],""UnloadingCargos"":[{""CargoId"":1,""Weight"":10,""Volume"":40,""PackagingQuantity"":10,""IsDefinedByTtn"":false}]}],""Unloading"":{""CityId"":1,""Latitude"":59.939095,""Longitude"":30.315868,""Street"":""ул. Салова, 57"",""OrganizationId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""AddressId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""TimeStart"":""2026-09-08T09:00:00.000Z"",""TimeEnd"":""2026-09-08T18:00:00.000Z"",""IsRoundTheClock"":false,""LargeCities"":[0],""LoadingCargos"":[{""CargoId"":1,""NameId"":1,""Name"":""Продукты питания"",""PackagingType"":1,""PackagingQuantity"":20,""Weight"":20,""Volume"":82,""Sizes"":{""Length"":13.6,""Width"":2.45,""Height"":2.7,""Diameter"":1.2,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}}]},""Cargo"":{""Weight"":20,""Volume"":82,""ADR"":0,""CargoTypeId"":59,""CargoType"":""Стройматериалы"",""PackType"":1,""PalletCount"":33,""BeltCount"":0,""DogruzType"":1,""SborGruz"":false,""Size"":{""Length"":13.6,""Width"":2.45,""Height"":2.7,""Diameter"":1.2,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}},""Transport"":{""CarType"":5,""CarTypeString"":""5"",""LoadingType"":3,""LoadingLogicalOperator"":""OR"",""UnloadingType"":3,""UnloadingLogicalOperator"":""OR"",""TrucksQuantity"":1,""TemperatureFrom"":-18,""TemperatureTo"":4,""Stsepka"":false,""Pnevmohod"":false,""Koniki"":false,""TIR"":false,""CMR"":false,""T1"":false,""SanPassport"":false,""IsTracking"":false,""RequiredCapacity"":20},""Payment"":{""CurrencyId"":1,""MoneyType"":22,""RateSum"":85000,""SumWithNDS"":102000,""SumWithoutNDS"":85000,""PrepayPercent"":30,""PrepayPercentEnabled"":true,""PayDays"":5,""PayDaysEnabled"":true,""FixedRate"":true,""Torg"":false,""DirectContract"":false,""InFuel"":false,""OnUnloading"":false,""HideResponses"":false,""AcceptPaymentTypes"":0},""InviteSettings"":{""InviteDelayInSeconds"":600,""InviteDurationInSeconds"":3600,""MaxPercentDeviation"":10,""NeedArchiveOnInvite"":false},""PriorityView"":{""DailyLimit"":500,""IsForPayedOnly"":false,""OrderLimit"":100,""ViewRate"":1.5},""Stealth"":{""ListIdToHide"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""FirmRegDateToHide"":""2024-01-01T00:00:00.000Z"",""ScoreToHide"":3},""LoadFiles"":[{""FileId"":""a1b2c3d4e5f6a7b8c9d0e1f2"",""FileType"":1,""Attributes"":0,""Name"":""Договор.pdf"",""Link"":""https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2"",""Size"":-1}],""Deal"":{""Auction"":{""StartRate"":50000,""Currency"":1,""Step"":500,""PaymentType"":0,""AcceptSecondPayType"":false,""StartDate"":""2026-09-08T09:00:00.000Z"",""EndDate"":""2026-09-08T12:00:00.000Z"",""EndDateBoundary"":""2026-09-09T09:00:00.000Z"",""Nds"":20,""TimeToProvideDocuments"":4,""AutoRenew"":true,""RenewTime"":5,""MaxRenewTime"":30,""RaiseBid"":false,""MaxRate"":60000,""RaiseBidInterval"":30,""ResponseInMinutes"":15,""Duration"":180,""StartSinceFirstBet"":false,""AuctionRestartParameters"":{""AuctionFinishAction"":0,""InitRestartCount"":1,""InitChangeWinnerCount"":1,""DurationAfterRestart"":120,""RateIncrease"":500,""RateIncreaseOption"":1},""AcceptCounterOffersOnlyBeforeFirstBet"":false,""WinnerCriterion"":0,""Source"":0}},""Boards"":[{""BoardId"":""a0a0a0a0a0a0a0a0a0a0a0a0"",""PublicationTime"":""2026-09-08T12:00:00.000Z"",""IsReservationEnabled"":false,""PublicationOption"":0}],""UnloadFirstDate"":""2026-09-11T00:00:00.000Z"",""UnloadLastDate"":""2026-09-12T00:00:00.000Z""}");

Ответ

200 Сохранённый груз.

Модель

{...}

Груз в ответе: поля публикации и вычисляемые сервисом.

LoadMeta:

Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией

ONE-OF

1:{...}

Метаданные публикации.

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные. Максимальная длина 1024 символа

}

ContactId1*: int32

Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id. Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами. Контакт должен быть виден для остальных участников АТИ

ContactId2: int32 (nullable)

Идентификатор второго выбранного контакта, если не выбрано, то null. Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу. Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC. Минимальное значение равно текущей дате. При значении параметра DateType равным 0, допустимое значение поля - текущая дата. При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед. При значении параметра DateType равным 2, допустимое значение поля - текущая дата. При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC. Минимальное значение равно значению параметра FirstDate. При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед. При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед. При значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется. При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Тип готовности груза к перевозке, по умолчанию 0

• 0 - Готов к загрузке
• 1 - в период с FirstDate по LastDate
• 2 - постоянно
• 3 - груза нет, запрос ставки

PeriodicityId: int32

Периодичность загрузки. Если параметр DateType не равен 2, PeriodicityId равен 0. Иначе PeriodicityId может принимать следующие значения:

• 1 - ежедневно
• 100 - по рабочим дням

OrderNumber: string

Номер заказа. Ограничение по длине: 250 символов

Krugoreis: boolean

Включён ли кругорейс

Loading*:

Точка погрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

ExtraPoints:[{...}]

Дополнительные пункты маршрута между погрузкой и выгрузкой.
Максимум 15 штук. Может иметь значение null

CityId*: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

PointType*: int32

Тип точки:

• 1 - загрузка
• 2 - разгрузка
• 3 - таможня
• 8 - проехать через

Latitude: decimal (nullable)

Широта точки. Допустимое значение от -90 до 90; указывается вместе с долготой

Longitude: decimal (nullable)

Долгота точки. Допустимое значение от -180 до 180; указывается вместе с широтой

Street: string

Улица или район. Максимальная длина 200 символов

OrganizationId: guid (nullable)

Организация, принимающая или отгружающая груз в этой точке. Указывается только вместе с AddressId

AddressId: guid (nullable)

Адрес точки. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

OrdinalId: int32

Порядок точки на маршруте. Если у всех точек 0, сервис нумерует их по порядку списка

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeStart: string (nullable)

Время начала загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeEnd: string (nullable)

Время окончания загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingCargos:[{...}]

Позиции груза, которые берут в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

UnloadingCargos:[{...}]

Позиции груза, которые оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза (CargoId из точки загрузки)

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

PackagingQuantity: int32 (nullable)

Количество выгружаемых мест

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

}]

Unloading*:

Точка выгрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

Cargo*:

Что везём: наименование, вес, объём, упаковка

ONE-OF

1:{...}

Описание груза: что и сколько везём.

Weight: double

Вес груза в тоннах. Обязательный параметр, если не задан параметр Volume. Допустимое значение 0 либо от 0,001 до 9999, не более 3 знаков после запятой

Volume: double

Объём груза в кубических метрах. Обязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа

ADR: int32

Класс опасности груза по ADR. Допустимое значение от 0 до 9, по умолчанию 0. Для CargoTypeId = 53 обязателен ненулевой

CargoTypeId*: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes

CargoType: string

Наименование груза текстом. Обязательный параметр: при CargoTypeId = 59 («другое») это и есть наименование груза. Максимальная длина названия - 200 символов. В этом поле запрещено указывать контактную информацию

PackType: int32

Идентификатор типа упаковки (навалом, коробки, россыпью), 0 — упаковка не указана. dict: GET /v1.0/dictionaries/packTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-packTypes

PalletCount: int32

Количество упаковок для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

• 1 - только отдельной машиной
• 2 - отдельной или догрузом
• 3 - только догрузом

SborGruz: boolean

Сборный груз

Size:

Параметры размера груза

ONE-OF

1:{...}

Габариты груза.

Length: double

Длина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

HeightHighlight: boolean

Выделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

}

}

Transport*:

Требования к транспорту: кузов, варианты загрузки и выгрузки

ONE-OF

1:{...}

Требования к транспорту.

CarType*: int64

Битовая маска типов кузова: идентификаторы из справочника — степени двойки, несколько кузовов складываются (1 + 4 = 5). dict: GET /v1.0/dictionaries/carTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes

CarTypeString: string

Та же битовая маска типов кузова строкой. Только в ответе: в запросе значение игнорируется

LoadingType: int32

Битовая маска вариантов загрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/loadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes

LoadingLogicalOperator: string

Тип условия загрузки:

• OR - необходимо, чтобы присутствовал один из способов загрузки
• AND - необходимо, чтобы присутствовали все выбранные типы загрузки

UnloadingType: int32

Битовая маска вариантов разгрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/unloadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-unloadingTypes

UnloadingLogicalOperator: string

Тип условия разгрузки:

• OR - необходимо, чтобы присутствовал один из способов разгрузки
• AND - необходимо, чтобы присутствовали все выбранные типы разгрузки

TrucksQuantity: int32

Количество машин. Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

Минимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

TemperatureTo: int32 (nullable)

Максимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

Stsepka: boolean

Нужна ли сцепка для груза

Pnevmohod: boolean

Нужен ли пневмоход для груза

Koniki: boolean

Нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

Документы на транспорт, необходимые для провоза этого груза: медкнижка

IsTracking: boolean

Трекинг через АТИ Водитель

RequiredCapacity: double (nullable)

Требуемая грузоподъемность в тоннах. Допустимое значение от 0,01 до 9999, не более 3 знаков после запятой

}

Payment*:

Условия оплаты и ставка

ONE-OF

1:{...}

Условия оплаты и ставка.

CurrencyId: int32

Идентификатор валюты. dict: GET /v1.0/dictionaries/currencyTypes → Id. По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

MoneyType: int32

Идентификатор варианта оплаты. dict: GET /v1.0/dictionaries/moneyTypes → Id. По умолчанию - 22. Должен принимать значение 22, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-moneyTypes

RateSum: decimal

Ставка для груза. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов

SumWithNDS: decimal

Ставка по безналичному расчёту с НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов. Если заданы обе безналичные ставки, SumWithNDS должна быть не меньше SumWithoutNDS. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0

SumWithoutNDS: decimal

Ставка по безналичному расчёту без НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Значение не меньше 0, максимальная длина 10 символов. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0

PrepayPercent: int32

Процент предоплаты. Допустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

Через сколько банковских дней оплата. Допустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false

PayDaysEnabled: boolean

Включена ли оплата через банковские дни. По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true

FixedRate: boolean

true, если ставка задана, false если запрос ставки. По умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1

Torg: boolean

Возможен ли торг. По умолчанию - false. Должен быть false, если параметр FixedRate равен false; при торгах с публикацией ставки — true

DirectContract: boolean

Прямой договор

InFuel: boolean

Предоплата топливом. Должен быть false, если параметр PrepayPercentEnabled равен false

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

Скрыть встречные предложения

AcceptPaymentTypes: int32

Битовая маска форм оплаты, которые вы готовы принять при запросе ставки: флаги складываются

• 1 - наличные
• 2 - безналичный расчёт с НДС
• 4 - безналичный расчёт без НДС

Пример: 7 — все три формы. При запросе ставки значение 0 сервис заменяет на 7; при фиксированной ставке поле не используется

}

InviteSettings:

Настройки автоприглашений

ONE-OF

1:{...}

Настройки автоприглашений по встречным предложениям.

InviteDelayInSeconds: int32

Время в секундах сбора встречных предложений: через него сервис создаёт приглашение по лучшему предложению. Обязателен и больше 0, если объект настроек передан

InviteDurationInSeconds: int32

Время в секундах действия приглашения. Обязателен и больше 0, если объект настроек передан

MaxPercentDeviation: int32 (nullable)

На сколько процентов встречное предложение может превышать вашу ставку, чтобы приглашение всё-таки ушло

NeedArchiveOnInvite: boolean

Архивировать груз при срабатывании автоматического приглашения

}

PriorityView:

Приоритетный показ

ONE-OF

1:{...}

Параметры приоритетного показа в ответе.

DailyLimit: decimal

Суточный лимит списания по услуге в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

Показывать груз в приоритете только платным пользователям

OrderLimit: decimal

Лимит списания на груз в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

Ставка за просмотр в атисах

• Кратна 0,5
• Не меньше минимальной ставки сервиса и не больше баланса фирмы
• Должна иметь длину не более 5 символов

MoneySpentPerDay: decimal

Сколько списано с баланса за груз в текущие сутки. Только для чтения

MoneySpentPerOrder: decimal

Сколько списано с баланса за груз за всё время. Только для чтения

}

Stealth:

Настройки показа груза

ONE-OF

1:{...}

Ограничения показа груза платной услугой «Стелс»: списания идут с баланса фирмы. Если объект передан, нужен хотя бы один параметр.

ListIdToHide: guid (nullable)

Идентификатор списка фирм, которым груз не показывается. dict: GET https://api.ati.su/scrolls/v1/firms → id. docs: https://ati.su/developers/api/catalogs/firm-lists/

FirmRegDateToHide: date-time (nullable)

Фирмам, зарегистрированным позже этой даты, груз не показывается

ScoreToHide: double (nullable)

Минимальное число звёзд фирмы: фирмам с меньшим числом груз не показывается. Целое от 1 до 5; при включённом бронировании на общей площадке — от 2 до 5

}

LoadFiles:[{...}]

Файлы к грузу.
Перед добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. API для хранения файлов)

Id: guid

Устаревший идентификатор файла, используйте FileId

deprecated

FileId: string

Идентификатор файла, который вернул API хранения файлов при загрузке. dict: POST https://api.ati.su/v1.0/filestorage/files → id. docs: https://ati.su/developers/api/filestorage/

FileType: int32

Тип загруженного файла. Всегда 1 — документ

Attributes: int32

Устаревшее поле, всегда 0

Name: string

Имя файла. Только в ответе: приходит из хранилища файлов, в запросе значение игнорируется

Link: string

Ссылка, по которой можно скачать файл. Сервис собирает её из идентификатора файла в хранилище

Size: int32

Устаревшее поле, всегда -1

}]

Deal:

Сделка, в рамках которой размещён груз

ONE-OF

1:{...}

Сделка по грузу в ответе.

Auction:

Параметры аукциона

ONE-OF

1:{...}

Торги по грузу в ответе.

StartRate*: decimal

Начальная ставка аукциона. Параметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.

Currency*: int32

Валюта аукциона. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

Step*: decimal

Минимальное изменение ставки по аукциону. Параметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.

PaymentType*:

Тип оплаты в торгах: допустимы только 24 и 25

ONE-OF

enum

[1, 22, 23, 24, 25]

Тип оплаты.

• 1 - Наличные
• 22 - Любая
• 23 - На карту
• 24 - Безналичный расчёт с НДС
• 25 - Безналичный расчёт без НДС

AcceptSecondPayType: boolean

Принимать ставки и со вторым типом оплаты: без НДС при PaymentType = 24, с НДС при PaymentType = 25

StartDate: date-time

Время начала аукциона в UTC. Должно быть позже времени начала публикации груза на площадке.

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Время окончания аукциона "завершить не позже". Если указанное время, меньше значения Duration - аукцион заканчивается по времени "завершить не позже", если нет автопродления. Время устанавливается в формате UTC.

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.

AutoRenew: boolean

Нужно ли продлевать торги, если ставка пришла незадолго до окончания

RenewTime: int32 (nullable)

Время в минутах, на которое сдвигается окончание аукциона при включённом AutoRenew

MaxRenewTime: int32 (nullable)

Максимально допустимое время в минутах, на которое можно сдвинуть окончание аукциона при включённом AutoRenew. Указывать, если AutoRenew = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

Максимально допустимая ставка по аукциону. Обязателен при RaiseBid = true. Не меньше суммы StartRate и Step, не больше 9999999999, не более 10 символов.

RaiseBidInterval: int32 (nullable)

Период увеличения ставки в минутах при отсутствии предложений. Обязателен при RaiseBid = true: от 1 минуты и меньше Duration. При StartSinceFirstBet = true верхнее ограничение не действует.

ResponseInMinutes: int32 (nullable)

Через сколько минут после начала торгов принимать встречные предложения:

• 0 - сразу
• N - через N минут; допустимо любое значение от 0 и меньше Duration
• null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

Длительность торгов в минутах: целое число больше 0. Окончание торгов не может быть позже времени актуальности груза LastDate. Если не указана, вычисляется как разница EndDate и StartDate, при этом StartSinceFirstBet игнорируется

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчёт до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:

Параметры перезапуска аукциона.
Если объект не передан, действуют значения по умолчанию: до 3 автоматических перевыборов победителя, после исчерпания груз публикуется со ставкой

ONE-OF

1:{...}

Параметры перезапуска торгов.

AuctionFinishAction:

Действие после исчерпания перезапусков

ONE-OF

enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны.

• 1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
• 2 - Опубликовать груз с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе.
• 3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно. Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно. В переданном объекте параметров по умолчанию 0; если сам объект не передан, действует значение 3

DurationAfterRestart: int32 (nullable)

Длительность торгов в минутах после перезапуска. Необязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным

RateIncrease: decimal (nullable)

Повышение ставки при перезапуске

RateIncreaseOption: int32 (nullable)

Единица повышения ставки при перезапуске:

• 1 - в валюте
• 2 - в процентах

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

Принимать встречные предложения только до первой ставки

WinnerCriterion:

Критерий выбора победителя торгов

ONE-OF

enum

[0, 1]

Критерий победы в аукционе.

• 0 - Выбор победителя происходит автоматически по лучшей ставке
• 1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

Source:

Площадка, на которой идут торги. Значение выставляет система: передавайте 0 или не передавайте поле

ONE-OF

enum

[0, 2]

Площадка, на которой идут торги по грузу.

• 0 - Торги в АТИ
• 2 - Торги в Atrucks

AuctionId: guid

Идентификатор аукциона

LoadId: guid

Идентификатор груза, для которого активен аукцион

ActiveDealId: guid (nullable)

Идентификатор сделки, привязанной к аукциону

State:

Статус аукциона

ONE-OF

enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона.

• -100 - Не удалось определить состояние аукциона
• -14 - Аукцион отменен руками грузовладельца
• -13 - Аукцион удален, т.к. расторгнут заказ
• -12 - Аукцион без ставок завершен
• -11 - Аукцион удален автоматически
• -10 - Аукцион удален т.к. сделка завершена
• -9 - Аукцион удален
• -8 - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет
• -7 - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель
• -6 - При включенном копировании грузов: торги завершены, экспедитор не является победителем
• -5 - Одна ставка лучшая по цене, другая по дате
• -4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
• -3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
• -2 - Закончился, ждем когда победитель возьмет груз
• -1 - Закончился, ставок нет
• 0 - Идет, ставок нет
• 1 - Идет (уже есть валидные ставки)

Finished: boolean

Завершён ли аукцион

WinDate: date-time (nullable)

Время, когда одна из ставок в AuctionRates стала победной

AuctionRates:[{...}]

Список ставок по аукциону

AuctionRateId: guid

Идентификатор ставки

AddedAt: date-time

Когда сделана ставка

RateFirm:

Фирма, сделавшая ставку

ONE-OF

1:{...}

Фирма-участник торгов: рейтинг, статус и контакт.

Score: double

Рейтинг фирмы в звёздах

Status:

Статус фирмы в АТИ. Коды описаны в FirmStatus

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7]

Статус фирмы по цвету звёзд.

• 0 - Серый
• 1 - Зелёный
• 2 - Жёлтый
• 3 - Красный
• 4 - Партнёр АТИ
• 5 - Сотрудник АТИ
• 6 - Гос. органы
• 7 - ОДКС

Name: string

Имя фирмы

ContactName: string

Имя контакта

AtiId: string

Идентификатор фирмы в АТИ

}

Rate: decimal

Ставка на груз, которую поставил пользователь

State:

Статус ставки. Коды описаны в AuctionRateState

ONE-OF

enum

[0, 1, -8, -7, -6, -5, -4, -3, -2, -1]

Статус ставки.

• -8 - Грузовладелец отклонил документ
• -7 - Победитель отклонил документ
• -6 - Победитель отменил сделку
• -5 - Грузовладелец отменил сделку
• -4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
• -3 - Бывший победитель
• -2 - Перевозчик отказался от участия
• -1 - Предложение отклонил грузовладелец/перевозчик
• 0 - Непобедная ставка при завершении торгов
• 1 - Победная ставка в аукционе

LoadingDate: date-time (nullable)

Ближайшая возможная для перевозчика дата загрузки. Используется только в аукционах с критерием победы по ставке и дате загрузки

FirmId: int32

Идентификатор фирмы, сделавшей ставку

ContactId: int32

Идентификатор контакта, сделавшего ставку

}]

}

}

Boards:[{...}]

Список площадок

BoardId: string

Идентификатор площадки из 24 символов. Значение общей площадки — a0a0a0a0a0a0a0a0a0a0a0a0

PublicationTime: date-time (nullable)

Время публикации на площадке. Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

Разрешено ли бронирование груза на общей площадке. Учитывается только для Общей площадки, только при включённом Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Является ли площадка общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC. Может иметь значение null. Минимальное значение равно текущей дате. Не указывается при значении параметра DateType равным 3

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null. Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate. Не указывается при значении параметра DateType равным 3

ArchiveDate: date-time (nullable)

Дата и время переноса в архив

ArchiveReason:

Причина переноса в архив

ONE-OF

(nullable)

enum

[Unknown, System, Manual, Complaints, UnwantedContent, DeleteCsvLoad, MergeLoadsAfterEdit, ContactDoesNotHaveAccessToVirtualPayments, VerticesLoadDelete, StealthStatisticError, CheckDuplicateComplaints, DeleteContact, DeleteFirm, CleanOldLoadsJob]

Причина, по которой груз оказался в архиве.

• VerticesLoadDelete - Снят при сквозной передаче груза
• StealthStatisticError - Снят из-за ошибки при подсчёте статистики Стелса
• CheckDuplicateComplaints - Снят при проверке дублирующих жалоб
• DeleteContact - Удалён контакт
• DeleteFirm - Удалена фирма
• CleanOldLoadsJob - Истёк срок актуальности
• Unknown - Причина не определена
• System - Снят системой
• Manual - Снят с публикации владельцем
• Complaints - Снят по жалобам
• UnwantedContent - Снят за недопустимое содержимое
• DeleteCsvLoad - Удалён вместе с CSV-загрузкой
• MergeLoadsAfterEdit - Объединён с другим грузом после редактирования
• ContactDoesNotHaveAccessToVirtualPayments - Снят: у контакта нет права оплачивать услугу со счёта фирмы

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

Идентификатор валюты озвученной ставки. dict: GET /v1.0/dictionaries/currencyTypes → Id

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Можно ли снять груз с публикации

HasPermissionsToLoad: boolean

Есть ли у текущего контакта доступ к грузу: контакт указан в грузе или имеет доступ к его подразделению

CanBeEdited: boolean

Можно ли редактировать груз

CanBeRenewed: boolean

Можно ли обновить груз

CanBeRestored: boolean

Можно ли восстановить груз из архива

EditRestriction:

Причина отказа в редактировании груза, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

DeleteRestriction:

Причина отказа в снятии груза с публикации, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RestoreRestriction:

Причина отказа в восстановлении груза из архива, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RenewRestriction: string

Причина отказа в обновлении груза. Пустая строка, если обновление доступно

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

UpdatedAt: date-time

Дата последнего изменения груза в UTC

AddedAt: date-time

Дата публикации груза в UTC

RefreshedAt: date-time

Дата последнего обновления груза в выдаче, в UTC

Distance: int32

Расстояние по дорогам в километрах

PlatonRoadsLength: int32

Протяжённость участков маршрута, за которые взимается плата по системе «Платон», в километрах

TollRoadsLength: int32

Протяжённость платных дорог на маршруте в километрах

TravelTime: string

Расчётное время в пути в формате [d.]hh:mm:ss

Zimnik: boolean

Учитывать ли зимники при построении маршрута

Ferries: boolean

Учитывать ли паромные переправы при построении маршрута

FirmId: string

Идентификатор фирмы

AuctionId: guid (nullable)

Идентификатор аукциона по грузу

}

Пример

{...}

"LoadMeta":{...},

"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"MetaData":"import-2026-09"

},

"ContactId1":1234567,

"ContactId2":1234568,

"Note":"Погрузка с 9 до 18, пропуск заказывать заранее",

"FirstDate":"2026-09-08T00:00:00.000Z",

"LastDate":"2026-09-10T00:00:00.000Z",

"DateType":1,

"PeriodicityId":0,

"OrderNumber":"ЗК-2026-0917",

"Krugoreis":false,

"Loading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"ExtraPoints":[...],

{...}

"CityId":1,

"PointType":2,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"пр. Ленина, 10",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"OrdinalId":1,

"IsRoundTheClock":false,

"LoadingDateStart":"2026-09-09T00:00:00.000Z",

"LoadingDateEnd":"2026-09-09T00:00:00.000Z",

"LoadingTimeStart":"09:00:00",

"LoadingTimeEnd":"18:00:00",

"LoadingCargos":[...],

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

],

"UnloadingCargos":[...]

{...}

"CargoId":1,

"Weight":10,

"Volume":40,

"PackagingQuantity":10,

"IsDefinedByTtn":false

}

]

}

],

"Unloading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"Cargo":{...},

"Weight":20,

"Volume":82,

"ADR":0,

"CargoTypeId":59,

"CargoType":"Стройматериалы",

"PackType":1,

"PalletCount":33,

"BeltCount":0,

"DogruzType":1,

"SborGruz":false,

"Size":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

},

"Transport":{...},

"CarType":5,

"CarTypeString":"5",

"LoadingType":3,

"LoadingLogicalOperator":"OR",

"UnloadingType":3,

"UnloadingLogicalOperator":"OR",

"TrucksQuantity":1,

"TemperatureFrom":-18,

"TemperatureTo":4,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false,

"RequiredCapacity":20

},

"Payment":{...},

"CurrencyId":1,

"MoneyType":22,

"RateSum":85000,

"SumWithNDS":102000,

"SumWithoutNDS":85000,

"PrepayPercent":30,

"PrepayPercentEnabled":true,

"PayDays":5,

"PayDaysEnabled":true,

"FixedRate":true,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

},

"InviteSettings":{...},

"InviteDelayInSeconds":600,

"InviteDurationInSeconds":3600,

"MaxPercentDeviation":10,

"NeedArchiveOnInvite":false

},

"PriorityView":{...},

"DailyLimit":500,

"IsForPayedOnly":false,

"OrderLimit":100,

"ViewRate":1.5,

"MoneySpentPerDay":12,

"MoneySpentPerOrder":45

},

"Stealth":{...},

"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"FirmRegDateToHide":"2024-01-01T00:00:00.000Z",

"ScoreToHide":3

},

"LoadFiles":[...],

{...}

"FileId":"a1b2c3d4e5f6a7b8c9d0e1f2",

"FileType":1,

"Attributes":0,

"Name":"Договор.pdf",

"Link":"https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2",

"Size":-1

}

],

"Deal":{...},

"Auction":{...}

"StartRate":50000,

"Currency":1,

"Step":500,

"PaymentType":0,

"AcceptSecondPayType":false,

"StartDate":"2026-09-08T09:00:00.000Z",

"EndDate":"2026-09-08T12:00:00.000Z",

"EndDateBoundary":"2026-09-09T09:00:00.000Z",

"Nds":20,

"TimeToProvideDocuments":4,

"AutoRenew":true,

"RenewTime":5,

"MaxRenewTime":30,

"RaiseBid":false,

"MaxRate":60000,

"RaiseBidInterval":30,

"ResponseInMinutes":15,

"Duration":180,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":1,

"InitChangeWinnerCount":1,

"DurationAfterRestart":120,

"RateIncrease":500,

"RateIncreaseOption":1

},

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

"Source":0,

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ActiveDealId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"State":0,

"Finished":false,

"WinDate":"2026-09-08T12:05:00.000Z",

"AuctionRates":[...]

{...}

"AuctionRateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddedAt":"2026-09-08T10:15:30.000Z",

"RateFirm":{...},

"Score":4.5,

"Status":0,

"Name":"ООО «Перевозчик»",

"ContactName":"Иван Петров",

"AtiId":"1234567"

},

"Rate":48000,

"State":0,

"LoadingDate":"2026-09-09T00:00:00.000Z",

"FirmId":7654321,

"ContactId":0

}

]

}

},

"Boards":[...],

{...}

"BoardId":"a0a0a0a0a0a0a0a0a0a0a0a0",

"PublicationTime":"2026-09-08T12:00:00.000Z",

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":true,

"IsCommonBoard":true

}

],

"UnloadFirstDate":"2026-09-11T00:00:00.000Z",

"UnloadLastDate":"2026-09-12T00:00:00.000Z",

"ArchiveDate":"2026-09-07T10:15:30.000Z",

"ArchiveReason":"Unknown",

"TruePrice":85000,

"TrueCurrencyId":1,

"ResponseCount":3,

"OfferCount":2,

"CanBeDeleted":true,

"HasPermissionsToLoad":true,

"CanBeEdited":true,

"CanBeRenewed":true,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"Груз можно обновить не ранее чем через 40 минут",

"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"12345678",

"UpdatedAt":"2026-09-07T10:15:30.000Z",

"AddedAt":"2026-09-05T08:00:00.000Z",

"RefreshedAt":"2026-09-07T09:00:00+00:00",

"Distance":712,

"PlatonRoadsLength":540,

"TollRoadsLength":120,

"TravelTime":"10:30:00",

"Zimnik":false,

"Ferries":false,

"FirmId":"1234567",

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

400 Тело запроса не разобрано или поля не прошли проверку.

Модель

{...}

Тело запроса не разобрано или не прошло проверку полей.

Error: string

Ключ ошибки: json_validation_error — поля не прошли проверку, deserialization_error — тело не разобрано

Reason: string

Причина ошибки для показа пользователю

ErrorsList:[{...}]

Ошибки по полям. Только при json_validation_error

property: string

Поле, не прошедшее проверку; вложенные поля через точку

reason: string

Причина ошибки для показа пользователю

error: string

Ключ нарушенного правила

context: {missing-type-info} (nullable)

Параметры нарушенного правила, если у него есть границы: например, Min и Max

}]

}

Пример

{...}

"Error":"json_validation_error",

"Reason":"Ошибка валидации json",

"ErrorsList":[...]

{...}

"property":"Cargo.Weight",

"reason":"Максимальная длина для параметра вес - 4 символа",

"error":"length_out_of_range",

"context":{...}

"Min":0,

"Max":4

}

}

]

}

402 Не хватает средств на платное размещение на выбранных площадках.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Недостаточно средств для платного размещения груза",

"Error":"low_balance_error"

}

403 Фирме или контакту запрещено публиковать грузы; причина — кодом в ответе.

Модель

{...}

Отказ в доступе к операции с грузом: ключ ошибки, пояснение и код причины.

Error: string

Ключ ошибки

Reason: string

Причина ошибки для показа пользователю

AccessDeniedReason:

Код причины отказа. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

ExceededLimit:

Какой лимит грузов исчерпан, если причина отказа — превышение лимита: 0 — общая площадка, 1 — персональные площадки. В остальных случаях null

ONE-OF

(nullable)

enum

[0, 1]

Лимит грузов, который исчерпан.

• 0 - Лимит грузов на общей площадке
• 1 - Лимит грузов на персональных площадках

}

Пример

{...}

"Error":"access_denied_error",

"Reason":"У вашего контакта недостаточно прав для работы с данным грузом",

"AccessDeniedReason":0,

"ExceededLimit":0

}

409 Среди опубликованных грузов фирмы уже есть такой же.

Модель

{...}

Отказ из-за дубликата: среди опубликованных грузов фирмы уже есть такой же.

Error: string

Ключ ошибки

Reason: string

Причина ошибки для показа пользователю

ConflictLoadId: guid

Идентификатор опубликованного груза, с которым найден дубликат

}

Пример

{...}

"Error":"load_conflict_error",

"Reason":"Найден дубликат в грузах",

"ConflictLoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

429 Исчерпан дневной лимит публикаций фирмы.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Достигнут ежедневный лимит на публикацию грузов",

"Error":"daily_cargos_creation_limit_reached"

}

Консоль

Отправить

Параметры

Нет параметров

{ "LoadMeta": { "LoadMetaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "MetaData": "import-2026-09" }, "ContactId1": 1234567, "ContactId2": 1234568, "Note": "Погрузка с 9 до 18, пропуск заказывать заранее", "FirstDate": "2026-09-08T00:00:00.000Z", "LastDate": "2026-09-10T00:00:00.000Z", "DateType": 1, "PeriodicityId": 0, "OrderNumber": "ЗК-2026-0917", "Krugoreis": false, "Loading": { "CityId": 1, "Latitude": 59.939095, "Longitude": 30.315868, "Street": "ул. Салова, 57", "OrganizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "AddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "TimeStart": "2026-09-08T09:00:00.000Z", "TimeEnd": "2026-09-08T18:00:00.000Z", "IsRoundTheClock": false, "LargeCities": [ 0 ], "LoadingCargos": [ { "CargoId": 1, "NameId": 1, "Name": "Продукты питания", "PackagingType": 1, "PackagingQuantity": 20, "Weight": 20, "Volume": 82, "Sizes": { "Length": 13.6, "Width": 2.45, "Height": 2.7, "Diameter": 1.2, "LengthHighlight": false, "WidthHighlight": false, "HeightHighlight": false } } ] }, "ExtraPoints": [ { "CityId": 1, "PointType": 2, "Latitude": 59.939095, "Longitude": 30.315868, "Street": "пр. Ленина, 10", "OrganizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "AddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "OrdinalId": 1, "IsRoundTheClock": false, "LoadingDateStart": "2026-09-09T00:00:00.000Z", "LoadingDateEnd": "2026-09-09T00:00:00.000Z", "LoadingTimeStart": "09:00:00", "LoadingTimeEnd": "18:00:00", "LoadingCargos": [ { "CargoId": 1, "NameId": 1, "Name": "Продукты питания", "PackagingType": 1, "PackagingQuantity": 20, "Weight": 20, "Volume": 82, "Sizes": { "Length": 13.6, "Width": 2.45, "Height": 2.7, "Diameter": 1.2, "LengthHighlight": false, "WidthHighlight": false, "HeightHighlight": false } } ], "UnloadingCargos": [ { "CargoId": 1, "Weight": 10, "Volume": 40, "PackagingQuantity": 10, "IsDefinedByTtn": false } ] } ], "Unloading": { "CityId": 1, "Latitude": 59.939095, "Longitude": 30.315868, "Street": "ул. Салова, 57", "OrganizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "AddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "TimeStart": "2026-09-08T09:00:00.000Z", "TimeEnd": "2026-09-08T18:00:00.000Z", "IsRoundTheClock": false, "LargeCities": [ 0 ], "LoadingCargos": [ { "CargoId": 1, "NameId": 1, "Name": "Продукты питания", "PackagingType": 1, "PackagingQuantity": 20, "Weight": 20, "Volume": 82, "Sizes": { "Length": 13.6, "Width": 2.45, "Height": 2.7, "Diameter": 1.2, "LengthHighlight": false, "WidthHighlight": false, "HeightHighlight": false } } ] }, "Cargo": { "Weight": 20, "Volume": 82, "ADR": 0, "CargoTypeId": 59, "CargoType": "Стройматериалы", "PackType": 1, "PalletCount": 33, "BeltCount": 0, "DogruzType": 1, "SborGruz": false, "Size": { "Length": 13.6, "Width": 2.45, "Height": 2.7, "Diameter": 1.2, "LengthHighlight": false, "WidthHighlight": false, "HeightHighlight": false } }, "Transport": { "CarType": 5, "CarTypeString": "5", "LoadingType": 3, "LoadingLogicalOperator": "OR", "UnloadingType": 3, "UnloadingLogicalOperator": "OR", "TrucksQuantity": 1, "TemperatureFrom": -18, "TemperatureTo": 4, "Stsepka": false, "Pnevmohod": false, "Koniki": false, "TIR": false, "CMR": false, "T1": false, "SanPassport": false, "IsTracking": false, "RequiredCapacity": 20 }, "Payment": { "CurrencyId": 1, "MoneyType": 22, "RateSum": 85000, "SumWithNDS": 102000, "SumWithoutNDS": 85000, "PrepayPercent": 30, "PrepayPercentEnabled": true, "PayDays": 5, "PayDaysEnabled": true, "FixedRate": true, "Torg": false, "DirectContract": false, "InFuel": false, "OnUnloading": false, "HideResponses": false, "AcceptPaymentTypes": 0 }, "InviteSettings": { "InviteDelayInSeconds": 600, "InviteDurationInSeconds": 3600, "MaxPercentDeviation": 10, "NeedArchiveOnInvite": false }, "PriorityView": { "DailyLimit": 500, "IsForPayedOnly": false, "OrderLimit": 100, "ViewRate": 1.5 }, "Stealth": { "ListIdToHide": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "FirmRegDateToHide": "2024-01-01T00:00:00.000Z", "ScoreToHide": 3 }, "LoadFiles": [ { "FileId": "a1b2c3d4e5f6a7b8c9d0e1f2", "FileType": 1, "Attributes": 0, "Name": "Договор.pdf", "Link": "https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2", "Size": -1 } ], "Deal": { "Auction": { "StartRate": 50000, "Currency": 1, "Step": 500, "PaymentType": 0, "AcceptSecondPayType": false, "StartDate": "2026-09-08T09:00:00.000Z", "EndDate": "2026-09-08T12:00:00.000Z", "EndDateBoundary": "2026-09-09T09:00:00.000Z", "Nds": 20, "TimeToProvideDocuments": 4, "AutoRenew": true, "RenewTime": 5, "MaxRenewTime": 30, "RaiseBid": false, "MaxRate": 60000, "RaiseBidInterval": 30, "ResponseInMinutes": 15, "Duration": 180, "StartSinceFirstBet": false, "AuctionRestartParameters": { "AuctionFinishAction": 0, "InitRestartCount": 1, "InitChangeWinnerCount": 1, "DurationAfterRestart": 120, "RateIncrease": 500, "RateIncreaseOption": 1 }, "AcceptCounterOffersOnlyBeforeFirstBet": false, "WinnerCriterion": 0, "Source": 0 } }, "Boards": [ { "BoardId": "a0a0a0a0a0a0a0a0a0a0a0a0", "PublicationTime": "2026-09-08T12:00:00.000Z", "IsReservationEnabled": false, "PublicationOption": 0 } ], "UnloadFirstDate": "2026-09-11T00:00:00.000Z", "UnloadLastDate": "2026-09-12T00:00:00.000Z" }

Редактирование груза

Отредактированный груз проверяется на дублирование: если такой груз уже опубликован, изменения не сохранятся и вернётся ошибка 409 Conflict с кодом duplicate_error.
При редактировании груза, как и при добавлении, нужно указывать все необходимые параметры, а не только изменяемые.
Набор payment.rates_with_vat тоже передаётся целиком: груз сохранит ровно те ставки, которые пришли в запросе.

Ограничения метода

Ограничение частоты: не более 5000 запросов за 24 часа на один контакт. При достижении лимита сервер возвращает 429 Too Many Requests в течение 24 часов.

Версия 2 2 (прежний адрес) 1.0

Редактировать опубликованную заявку на груз. API для интеграции. Редактирует опубликованную заявку от имени текущего пользователя.

put /gw/cargos_create_v2/integration/v2/cargos/{cargoApplicationId}

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoApplicationId обязательный	string (uuid)	path	Идентификатор редактируемой заявки на груз. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Модель

{...}

Запрос на обновление заявки на груз через Integration API.

cargo_application*:{...}

Заявка груза

external_id: null,string

Внешний номер груза или заказа Поле не должно содержать emoji-символы и emoji-последовательности

route*:{...}

Маршрут

loading*:{...}

Основная точка загрузки — начало маршрута. Здесь задают даты загрузки и грузы, которые забирают в начале маршрута.

dates*:{...}

Даты загрузки. Обязательны, вид задаёт дискриминатор type.

type: enum

[ready]

Тип даты — готов к загрузке (ready).

readyfrom-datepermanentrate-request

is_available_tomorrow: null,boolean

Готов к загрузке сегодня и завтра

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

first_date: date-time

Первый день, когда груз можно забрать. Обязателен, отстоит от сегодняшнего дня не больше чем на 60 дней.

last_date: date-time

Последний день, когда груз можно забрать. Обязателен, не раньше first_date и не в прошлом.

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

periodicity*: string

Периодичность постоянной загрузки. Обязательна, другие значения отклоняются. - everyday — каждый день - workdays — по рабочим дням

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

cargos*:[{...}]

Грузы заявки, хотя бы один. id груза сквозной по всей заявке: по нему точки разгрузки указывают, что снимают.

name*: string

От (0 до 200 символов)

Наименование груза Поле не должно содержать emoji-символы и emoji-последовательности

weight*:

Вес груза. Можно не указывать, если задан объём.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume*:

Объём груза. Можно не указывать, если задан вес.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

near_cities: [int32]

Ближайшие крупные города — не больше 10, без повторов. Нельзя указывать, если сам город точки является региональным центром. dict: GET /v1.0/dictionaries/cities/{cityId}/near → id

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}

unloading*:{...}

Основная точка разгрузки — конец маршрута.

dates:

Даты разгрузки. Поле необязательное.

ONE-OF

1:{...}

Даты разгрузки. Значима календарная дата, а не момент времени: день определяется по смещению, которое прислал клиент. Даты в примерах условные: подставляйте актуальные, иначе запрос отклонят.

first_date: date-time

Первый день разгрузки. Не в прошлом. Обязателен, если задан last_date.

last_date: date-time

Последний день разгрузки. Не раньше first_date.

time:

Время разгрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

near_cities: [int32]

Ближайшие крупные города — не больше 10, без повторов. Нельзя указывать, если сам город точки является региональным центром. dict: GET /v1.0/dictionaries/cities/{cityId}/near → id

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}

way_points:[{...}]

Промежуточные точки между загрузкой и разгрузкой, не больше 15. Перечисляйте их в порядке проезда: по этому порядку сервис проверяет, что груз, снятый на промежуточной разгрузке, был загружен раньше.

type: enum

[loading]

Тип промежуточной точки — загрузка (loading).

loadingunloadingcustomsgo-through

cargos:[{...}]

Грузы, которые забирают в этой точке. id каждого груза уникален в пределах заявки.

name*: string

От (0 до 200 символов)

Наименование груза Поле не должно содержать emoji-символы и emoji-последовательности

weight*:

Вес груза. Можно не указывать, если задан объём.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume*:

Объём груза. Можно не указывать, если задан вес.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

loading_date:

Дата и время загрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

cargos:[{...}]

Грузы, которые снимают в этой точке. id ссылается на груз из route.loading.cargos либо из более ранней точки loading.

weight:

Снимаемая часть веса. Обязательна, если вес был задан при загрузке этого груза, и запрещена, если не был.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume:

Снимаемая часть объёма. Обязательна, если объём был задан при загрузке этого груза, и запрещена, если не был.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging_quantity: int32

Снимаемое количество упаковок.

is_defined_by_ttn: null,boolean

Снимаемая часть груза будет определена в ТТН.

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

unloading_date:

Дата и время разгрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}]

is_round_trip: null,boolean

Кругорейс

}

truck*:{...}

Транспорт

trucks_count: int32

Количество машин

load_type*: string

Загрузка: - ftl — отдельной машиной - ltl — догрузом - dont-care — отдельной машиной или догрузом

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

body_loading:

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

ONE-OF

1:{...}

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

types: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required: null,boolean

Обязательны все выбранные

}

null

body_unloading:

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

ONE-OF

1:{...}

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

types: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required: null,boolean

Обязательны все выбранные

}

null

temperature:

Температура

ONE-OF

1:{...}

Температура.

from: int32

От

to: int32

До

}

null

documents:

Разрешения

ONE-OF

1:{...}

Разрешения транспорта.

tir: null,boolean

TIR todo ссылка на фак

cmr: null,boolean

CMR todo ссылка на фак

t1: null,boolean

T1 todo ссылка на фак

medical_card: null,boolean

Медкнижка

}

null

requirements:

Требования

ONE-OF

1:{...}

Требования к транспорту.

logging_truck: null,boolean

Коники

road_train: null,boolean

Сцепка

air_suspension: null,boolean

Пневмоход

team_driving: null,boolean

Для груза необходимы два водителя

}

null

adr: int32

ADR

belts_count: int32

Количество ремней

is_tracking: null,boolean

Трекинг через АТИ Водитель

required_capacity: double

Требуемая грузоподъемность в тоннах

}

payment*:{...}

Оплата

type: enum

[with-bargaining]

Тип оплаты — возможен торг (with-bargaining).

with-bargainingwithout-bargainingrate-requestauction

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

rate_with_vat_available: null,boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available: null,boolean

Можно предлагать ставки безнал без НДС

cash_available: null,boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

accept_bids_with_vat*: null,boolean

Принимать ставки с НДС

accept_bids_without_vat: null,boolean

Принимать ставки без НДС

vat_percents: int32

Размер НДС, в процентах

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты, в которой будут вестись Торги. Значение из словаря валют

bid_step*: double

Шаг ставок

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: null,string

Длительность торгов: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов - 1d — 1 день - 2d — 2 дня - 3d — 3 дня - 4d — 4 дня - 5d — 5 дней

count_from_first_bid: null,boolean

Отсчитывать длительность Торгов с момента первой ставки

finish_until: date-time

Точные дата и время завершения Торгов

}

accept_counter_offers:

Параметры доступности встречных предложений во время проведения Торгов

ONE-OF

1:{...}

Параметры доступности встречных предложений во время Торгов.

acceptance_delay: null,string

Принимать встречные предложения через: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

until_first_bid: null,boolean

Принимать встречные предложения до первой ставки по Торгам

}

null

auto_renew:

Параметры автопродления Торгов

ONE-OF

1:{...}

Параметры автопродления Торгов.

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

null

is_antisniper: null,boolean

Опция Антиснайпер

rate_rise:

Параметры повышения ставки Торгов при отсутствии ставок

ONE-OF

1:{...}

Параметры повышения ставки Торгов при отсутствии ставок.

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

null

winner_criteria*: string

Критерий выбора победителя: - best-rate — по лучшей ставке - matching-date — с учётом даты загрузки и лучшей ставки

time_to_provide_documents*: null,string

Время, за которое победитель обязан предоставить документы

winner_reselection_count: int32

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_restart:

Параметры перезапуска Торгов в случае отсутствия ставок

ONE-OF

1:{...}

Параметры перезапуска Торгов при отсутствии ставок.

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

rate_increase:

Параметры повышения начальной ставки после перезапуска торгов.

ONE-OF

1:{...}

Параметры повышения начальной ставки после перезапуска Торгов.

type: enum

[currency]

Тип повышения — абсолютное значение в валюте (currency).

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

null

}

null

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type: enum

[archive]

Действие — переместить заявку в архив (archive).

archivepublish-with-ratepublish-rate-request

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

rate_with_vat_available: null,boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available: null,boolean

Можно предлагать ставки безнал без НДС

cash_available: null,boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

}

keep_rates: null,boolean

Сохранять ставки при редактировании груза

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

}

documents:[{...}]

Фото груза и документов

id: string

Старый id документа

file_id: string

Новый id документа

}]

boards:[{...}]

Площадки груза

id*: string

Id площадки

publication_mode: string

Опубликовать груз - now – сразу - 15m – через 15 минут - 30m – через 30 минут - 1h – через час - 3h – через 3 часа - 6h – через 6 часов - exact-time - в точное время

publication_time: date-time

Точное время публикации груза, для publication_mode = 'exact-time'

cancel_publish_on_auction_bet: null,boolean

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

reservation_enabled: null,boolean

Разрешить перевозчикам бронировать груз

}]

paid_features:{...}

Платные услуги: приоритетный показ, стелс

priority_view:

Приоритетный показ

ONE-OF

1:{...}

Приоритетный показ.

rate*: double

Ставка за просмотр

limit: double

Лимит на заявку

daily_limit: double

Суточный лимит

only_for_paid_users: null,boolean

Показывать приоритетный груз только платным пользователям

}

null

stealth:

Стэлс

ONE-OF

1:{...}

Стелс.

list_id: uuid

Id списка фирм для скрытия

minimal_registration_date: date-time

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32

Минимальное количество звёзд фирм, которые будут видеть груз

}

null

}

note: null,string

Примечание к заявке Поле не должно содержать emoji-символы и emoji-последовательности

contacts*: [int32]

Id контактов заявки

}

}

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargos_create_v2/integration/v2/cargos/{cargoApplicationId}' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"cargo_application":{"external_id":"EXT-12345","route":{"loading":{"dates":{"type":"ready","is_available_tomorrow":true,"time":{"0":"?"}},"cargos":[{"name":"Автомобиль(ли)","weight":{"0":"?"},"volume":{"0":"?"},"packaging":{"0":"?"},"sizes":{"0":"?"},"id":1}],"near_cities":[0],"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}},"unloading":{"dates":{"0":"?"},"near_cities":[0],"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}},"way_points":[{"type":"loading","cargos":[{"name":"Автомобиль(ли)","weight":{"0":"?"},"volume":{"0":"?"},"packaging":{"0":"?"},"sizes":{"0":"?"},"id":1}],"loading_date":{"0":"?"},"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}}],"is_round_trip":true},"truck":{"trucks_count":1,"load_type":"ftl","body_types":[0],"body_loading":{"0":"?"},"body_unloading":{"0":"?"},"temperature":{"0":"?"},"documents":{"0":"?"},"requirements":{"0":"?"},"adr":3,"belts_count":4,"is_tracking":true,"required_capacity":20},"payment":{"type":"with-bargaining","auto_invites_settings":{"0":"?"},"currency_type":1,"rate_with_vat":50000,"rate_without_vat":50000,"cash":50000,"on_card":true,"rates_with_vat":[{"rate_with_vat":50000,"vat_percent":22}],"hide_counter_offers":true,"direct_offer":true,"prepayment":{"0":"?"},"payment_mode":{"0":"?"}},"documents":[{"id":"9c6cce94-c0e3-eb11-bb99-002590fdcfdb","file_id":"6b35842b8386446c82a43726f139abe1"}],"boards":[{"id":"a0a0a0a0a0a0a0a0a0a0a0a0","publication_mode":"now","publication_time":"2024-01-15T10:30:00+00:00","cancel_publish_on_auction_bet":true,"reservation_enabled":true}],"paid_features":{"priority_view":{"0":"?"},"stealth":{"0":"?"}},"note":"Тестовый груз","contacts":[0]}}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/gw/cargos_create_v2/integration/v2/cargos/{cargoApplicationId}", "{""cargo_application"":{""external_id"":""EXT-12345"",""route"":{""loading"":{""dates"":{""type"":""ready"",""is_available_tomorrow"":true,""time"":{""0"":""?""}},""cargos"":[{""name"":""Автомобиль(ли)"",""weight"":{""0"":""?""},""volume"":{""0"":""?""},""packaging"":{""0"":""?""},""sizes"":{""0"":""?""},""id"":1}],""near_cities"":[0],""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}},""unloading"":{""dates"":{""0"":""?""},""near_cities"":[0],""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}},""way_points"":[{""type"":""loading"",""cargos"":[{""name"":""Автомобиль(ли)"",""weight"":{""0"":""?""},""volume"":{""0"":""?""},""packaging"":{""0"":""?""},""sizes"":{""0"":""?""},""id"":1}],""loading_date"":{""0"":""?""},""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}}],""is_round_trip"":true},""truck"":{""trucks_count"":1,""load_type"":""ftl"",""body_types"":[0],""body_loading"":{""0"":""?""},""body_unloading"":{""0"":""?""},""temperature"":{""0"":""?""},""documents"":{""0"":""?""},""requirements"":{""0"":""?""},""adr"":3,""belts_count"":4,""is_tracking"":true,""required_capacity"":20},""payment"":{""type"":""with-bargaining"",""auto_invites_settings"":{""0"":""?""},""currency_type"":1,""rate_with_vat"":50000,""rate_without_vat"":50000,""cash"":50000,""on_card"":true,""rates_with_vat"":[{""rate_with_vat"":50000,""vat_percent"":22}],""hide_counter_offers"":true,""direct_offer"":true,""prepayment"":{""0"":""?""},""payment_mode"":{""0"":""?""}},""documents"":[{""id"":""9c6cce94-c0e3-eb11-bb99-002590fdcfdb"",""file_id"":""6b35842b8386446c82a43726f139abe1""}],""boards"":[{""id"":""a0a0a0a0a0a0a0a0a0a0a0a0"",""publication_mode"":""now"",""publication_time"":""2024-01-15T10:30:00+00:00"",""cancel_publish_on_auction_bet"":true,""reservation_enabled"":true}],""paid_features"":{""priority_view"":{""0"":""?""},""stealth"":{""0"":""?""}},""note"":""Тестовый груз"",""contacts"":[0]}}");

Ответ

200 Заявка на груз успешно обновлена.

Модель

{...}

Ответ на обновление заявки на груз через Integration API.

cargo_application*:{...}

Контракт заявки груза, ожидаемый в ответах integration http методов работы с грузами

cargo_id: uuid

ID груза OBSOLETE используй поле CargoApplicationId

cargo_number: string

Номер груза, автоматически генерируемый ATI.SU OBSOLETE используй поле CargoApplicationNumber

source: int32

OBSOLETE используй поле OriginSource

contacts: [int32]

Контакты OBSOLETE используй поле ApplicationContacts

distance: int32

Дистанция, км

cargo_application_id*: uuid

Id груза

snapshot_id*: int64

Id состояния груза (меняется при каждом редактировании)

cargo_application_number*: string

Номер груза, автоматически генерируемый ATI.SU

department_id*: int32

Подразделение, которому принадлежит заявка.

persistent_user_id*: int32

Идентификатор пользователя, разместившего заявку

actor_contact_id: int32

Идентификатор контакта, разместившего заявку

external_id: null,string

Внешний номер груза или заказа

added_at*: date-time

Время добавления груза, UTC

updated_at*: date-time

Время последнего изменения груза, UTC

refreshed_at: date-time

Время последнего поднятия груза, UTC

origin_source*: string

Использованный api при создания груза: - web-cargos-api, - mobile-cargos-api, - public-cargos-api

route*:{...}

Маршрут

loading*:{...}

Основная точка загрузки — начало маршрута. Здесь даты загрузки и грузы, которые забирают в начале маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates*:{...}

Даты загрузки. Вид задаёт дискриминатор type.

type: enum

[from-date]

Тип даты — в промежутке дат (from-date).

from-datereadypermanentrate-request

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

is_available_tomorrow*: boolean

Готов к загрузке сегодня и завтра (TODO возможно убрать)

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

periodicity*: string

Периодичность постоянной загрузки: - everyday — "каждый день" - workdays — "по рабочим дням"

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

}

cargos*:[{...}]

Грузы заявки. cargo_id сквозной по всей заявке: по нему точки разгрузки указывают, что снимают.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

unloading*:{...}

Основная точка разгрузки — конец маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates:

Даты разгрузки. Могут быть не заданы.

ONE-OF

1:{...}

Даты разгрузки. Значима календарная дата, а не момент времени: день определяется по смещению в значении.

first_date: date-time

Первый день разгрузки.

last_date: date-time

Последний день разгрузки.

time:

Время разгрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

way_points:[{...}]

Промежуточные точки между загрузкой и разгрузкой, не больше 15, в порядке проезда.

type: enum

[loading]

Тип промежуточной точки — точка загрузки (loading).

loadingunloadingcustomsgo-through

cargos:[{...}]

Грузы, которые забирают в этой точке.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

loading_date:

Дата и время загрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

cargos:[{...}]

Грузы, которые снимают в этой точке.

packaging_quantity: int32

Снимаемое количество упаковок.

is_defined_by_ttn: null,boolean

Снимаемая часть груза будет определена в ТТН.

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

unloading_date:

Дата и время разгрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}]

is_round_trip: null,boolean

Кругорейс

}

truck*:{...}

Транспорт

trucks_count*: int32

Количество машин

load_type*: string

Загрузка: - ftl — отдельной машиной - dont-care — не важно

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

is_tracking*: boolean

Трекинг через АТИ Водитель

adr: int32

ADR

belts_count: int32

Количество ремней

required_capacity: double

Требуемая грузоподъемность в тоннах

body_loading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

body_unloading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

temperature:

Температура

ONE-OF

1:{...}

Температура.

from: int32

От

to: int32

До

}

null

documents:

Разрешения

ONE-OF

1:{...}

Разрешения транспорта.

tir*: boolean

TIR

cmr*: boolean

CMR

t1*: boolean

T1

medical_card*: boolean

Медкнижка

}

null

requirements:

Требования

ONE-OF

1:{...}

Требования к транспорту.

logging_truck*: boolean

Коники

road_train*: boolean

Сцепка

air_suspension*: boolean

Пневмоход

team_driving*: boolean

Для груза необходимы два водителя

}

null

}

payment*:{...}

Оплата

type: enum

[with-bargaining]

Тип оплаты — с возможностью торга (with-bargaining).

with-bargainingwithout-bargainingrate-requestauction

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

auction_id*: uuid

Id Торгов

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты из словаря валют

bid_step*: double

Шаг ставки Торгов

accept_bids_with_vat*: boolean

Принимать ставки с НДС

accept_bids_without_vat: null,boolean

Принимать ставки без НДС

vat_percents: int32

Размер НДС, в процентах

is_antisniper*: boolean

Опция Антиснайпер

time_to_provide_documents*: string

Время, за которое победитель обязан предоставить документы

winner_criteria*: string

Критерий выбора победителя: best-rate — по лучшей ставке matching-date — с учётом даты загрузки и лучшей ставки

winner_reselection_count: int32

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: null,string

Может быть null, если есть значение у поля FinishUntil. Длительность проведения Торгов: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов 1d — 1 день 2d — 2 дня 3d — 3 дня 4d — 4 дня 5d — 5 дней

count_from_first_bid*: boolean

Отсчитывать длительность Торгов с момента первой ставки

finish_until: date-time

Точные дата и время завершения Торгов

}

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type: enum

[archive]

Действие — переместить заявку в архив (archive).

archivepublish-with-ratepublish-rate-request

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

}

accept_counter_offers:

Параметры доступности встречных предложений во время проведения Торгов

ONE-OF

1:{...}

Параметры доступности встречных предложений во время Торгов.

acceptance_delay: null,string

Может быть null, в таком случае будем принимать встречные предложения сразу. Принимать встречные предложения через: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

until_first_bid*: boolean

Принимать встречные предложения до первой ставки по Торгам

}

null

auto_renew:

Параметры автопродления Торгов

ONE-OF

1:{...}

Параметры автопродления Торгов.

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

null

rate_rise:

Параметры повышения ставки Торгов при отсутствии ставок

ONE-OF

1:{...}

Параметры повышения ставки Торгов при отсутствии ставок.

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

null

auction_restart:

Параметры перезапуска Торгов в случае отсутствия ставок

ONE-OF

1:{...}

Параметры перезапуска Торгов при отсутствии ставок.

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов

rate_increase:

Параметры повышения начальной ставки после перезапуска торгов.

ONE-OF

1:{...}

Параметры повышения начальной ставки после перезапуска Торгов.

type: enum

[currency]

Тип повышения — абсолютное значение в валюте (currency).

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

null

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

}

boards*:[{...}]

Площадки груза

id*: string

Id площадки

publication_mode*: string

Опубликовать груз: now – сразу 15m – через 15 минут 30m – через 30 минут 1h – через час 3h – через 3 часа 6h – через 6 часов exact-time - в точное время

publication_time*: date-time

Точное время публикации груза, для publication_mode = 'exact-time'

cancel_publish_on_auction_bet*: boolean

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

publication_restriction: integer

Стратегия ограничений публикации груза на площадке

reservation_enabled*: boolean

Разрешить перевозчикам бронировать груз

is_published*: boolean

Груз опубликован на площадке

}]

documents:[{...}]

Фото груза и документов

id: string

Старый id документа OBSOLETE используй поле FileID

file_id*: string

Id документа в API Плюшкин (TODO ссылка)

name*: string

Название документа

link*: string

Ссылка на документ

}]

application_contacts*:[{...}]

Информация о контактах груза

id*: int32

Id контакта

}]

paid_features:

Платные услуги

ONE-OF

1:{...}

Платные услуги: приоритетный показ, стелс.

priority_view:

Приоритетный показ

ONE-OF

1:{...}

Приоритетный показ.

money_spent_per_day: double

Потрачено атисов за день OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

money_spent_per_order: double

Потрачено атисов на эту заявку OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

rate*: double

Ставка за просмотр

only_for_paid_users*: boolean

Показывать приоритетный груз только платным пользователям

limit: double

Лимит на заявку

daily_limit: double

Суточный лимит

}

null

stealth:

Стэлс

ONE-OF

1:{...}

Стелс.

list_id: uuid

Id списка фирм для скрытия

minimal_registration_date: date-time

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32

Минимальное количество звёзд фирм, которые будут видеть груз

}

null

}

null

note: null,string

Примечание к грузу

lot_id: uuid

Id Лота, к которому прикреплён данный груз

lot_number: int32

Номер Лота, к которому прикреплён данный груз

is_pass_through_copy: null,boolean

Является ли груз сквозной копией

is_archived: null,boolean

Отправлен ли груз в архив

archive_date: date-time

Время отправки груза в архив, UTC

true_price: int32

Истинная ставка на груз после жалоб "Озвученная ставка"

true_currency_id: int32

Истинная валюта ставки на груз после жалоб "Озвученная ставка"

client_application_id: null,string

Идентификатор интегратора (клиентского приложения), через которое был создан груз

}

}

Пример

{...}

"cargo_application":{...}

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"ABC1234",

"source":2,

"contacts":[...],

0

],

"distance":1794,

"cargo_application_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"snapshot_id":1000500,

"cargo_application_number":"ABC1234",

"department_id":7654321,

"persistent_user_id":1234567,

"actor_contact_id":0,

"external_id":"EXT-12345",

"added_at":"2024-01-15T10:30:00+00:00",

"updated_at":"2024-01-15T10:30:00+00:00",

"refreshed_at":"2024-01-15T10:30:00+00:00",

"origin_source":"public-cargos-api",

"route":{...},

"loading":{...},

"near_cities":[...],

0

],

"dates":{...},

"type":"from-date",

"time":{...},

"0":"?"

},

"first_date":"2024-08-27T00:00:00+03:00",

"last_date":"2024-08-29T00:00:00+03:00"

},

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"unloading":{...},

"near_cities":[...],

0

],

"dates":{...},

"0":"?"

},

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"way_points":[...],

{...}

"type":"loading",

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"loading_date":{...},

"0":"?"

},

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

}

],

"is_round_trip":true

},

"truck":{...},

"trucks_count":1,

"load_type":"ftl",

"body_types":[...],

0

],

"is_tracking":true,

"adr":3,

"belts_count":4,

"required_capacity":20,

"body_loading":{...},

"0":"?"

},

"body_unloading":{...},

"0":"?"

},

"temperature":{...},

"0":"?"

},

"documents":{...},

"0":"?"

},

"requirements":{...}

"0":"?"

}

},

"payment":{...},

"type":"with-bargaining",

"auto_invites_settings":{...},

"0":"?"

},

"currency_type":1,

"rate_with_vat":50000,

"rate_without_vat":50000,

"cash":50000,

"on_card":true,

"rates_with_vat":[...],

{...}

"rate_with_vat":50000,

"vat_percent":22

}

],

"hide_counter_offers":true,

"direct_offer":true,

"prepayment":{...},

"0":"?"

},

"payment_mode":{...}

"0":"?"

}

},

"boards":[...],

{...}

"id":"a0a0a0a0a0a0a0a0a0a0a0a0",

"publication_mode":"now",

"publication_time":"2024-01-15T10:30:00+00:00",

"cancel_publish_on_auction_bet":true,

"publication_restriction":0,

"reservation_enabled":true,

"is_published":true

}

],

"documents":[...],

{...}

"id":"9c6cce94-c0e3-eb11-bb99-002590fdcfdb",

"file_id":"6b35842b8386446c82a43726f139abe1",

"name":"Транспортная накладная.pdf",

"link":"https://api.ati.su/webapi/filestorage/files/6b35842b8386446c82a43726f139abe1"

}

],

"application_contacts":[...],

{...}

"id":0

}

],

"paid_features":{...},

"0":"?"

},

"note":"Тестовый груз",

"lot_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"lot_number":38,

"is_pass_through_copy":true,

"is_archived":true,

"archive_date":"2024-01-15T10:30:00+00:00",

"true_price":50000,

"true_currency_id":1,

"client_application_id":"ati"

}

}

400 Невалидные данные запроса или груз в лоте.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

402 Недостаточно средств на счёте для размещения.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

403 Кошелёк заблокирован.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

404 Заявка на груз не найдена.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

409 Обнаружен дубликат заявки.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

417 Изменилась цена размещения.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

423 Слишком рано для повторного редактирования.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

cargoApplicationId Идентификатор редактируемой заявки на груз.

{ "cargo_application": { "external_id": "EXT-12345", "route": { "loading": { "dates": { "type": "ready", "is_available_tomorrow": true, "time": { "0": "?" } }, "cargos": [ { "name": "Автомобиль(ли)", "weight": { "0": "?" }, "volume": { "0": "?" }, "packaging": { "0": "?" }, "sizes": { "0": "?" }, "id": 1 } ], "near_cities": [ 0 ], "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } }, "unloading": { "dates": { "0": "?" }, "near_cities": [ 0 ], "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } }, "way_points": [ { "type": "loading", "cargos": [ { "name": "Автомобиль(ли)", "weight": { "0": "?" }, "volume": { "0": "?" }, "packaging": { "0": "?" }, "sizes": { "0": "?" }, "id": 1 } ], "loading_date": { "0": "?" }, "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } } ], "is_round_trip": true }, "truck": { "trucks_count": 1, "load_type": "ftl", "body_types": [ 0 ], "body_loading": { "0": "?" }, "body_unloading": { "0": "?" }, "temperature": { "0": "?" }, "documents": { "0": "?" }, "requirements": { "0": "?" }, "adr": 3, "belts_count": 4, "is_tracking": true, "required_capacity": 20 }, "payment": { "type": "with-bargaining", "auto_invites_settings": { "0": "?" }, "currency_type": 1, "rate_with_vat": 50000, "rate_without_vat": 50000, "cash": 50000, "on_card": true, "rates_with_vat": [ { "rate_with_vat": 50000, "vat_percent": 22 } ], "hide_counter_offers": true, "direct_offer": true, "prepayment": { "0": "?" }, "payment_mode": { "0": "?" } }, "documents": [ { "id": "9c6cce94-c0e3-eb11-bb99-002590fdcfdb", "file_id": "6b35842b8386446c82a43726f139abe1" } ], "boards": [ { "id": "a0a0a0a0a0a0a0a0a0a0a0a0", "publication_mode": "now", "publication_time": "2024-01-15T10:30:00+00:00", "cancel_publish_on_auction_bet": true, "reservation_enabled": true } ], "paid_features": { "priority_view": { "0": "?" }, "stealth": { "0": "?" } }, "note": "Тестовый груз", "contacts": [ 0 ] } }

Редактировать опубликованную заявку на груз. API для интеграции. Редактирует опубликованную заявку от имени текущего пользователя.

Прежний адрес метода. Он продолжает работать, но для новых интеграций используйте актуальную версию.

put /v2/cargos/{cargoApplicationId}

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoApplicationId обязательный	string (uuid)	path	Идентификатор редактируемой заявки на груз. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Модель

{...}

Запрос на обновление заявки на груз через Integration API.

cargo_application*:{...}

Заявка груза

external_id: null,string

Внешний номер груза или заказа Поле не должно содержать emoji-символы и emoji-последовательности

route*:{...}

Маршрут

loading*:{...}

Основная точка загрузки — начало маршрута. Здесь задают даты загрузки и грузы, которые забирают в начале маршрута.

dates*:{...}

Даты загрузки. Обязательны, вид задаёт дискриминатор type.

type: enum

[ready]

Тип даты — готов к загрузке (ready).

readyfrom-datepermanentrate-request

is_available_tomorrow: null,boolean

Готов к загрузке сегодня и завтра

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

first_date: date-time

Первый день, когда груз можно забрать. Обязателен, отстоит от сегодняшнего дня не больше чем на 60 дней.

last_date: date-time

Последний день, когда груз можно забрать. Обязателен, не раньше first_date и не в прошлом.

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

periodicity*: string

Периодичность постоянной загрузки. Обязательна, другие значения отклоняются. - everyday — каждый день - workdays — по рабочим дням

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

cargos*:[{...}]

Грузы заявки, хотя бы один. id груза сквозной по всей заявке: по нему точки разгрузки указывают, что снимают.

name*: string

От (0 до 200 символов)

Наименование груза Поле не должно содержать emoji-символы и emoji-последовательности

weight*:

Вес груза. Можно не указывать, если задан объём.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume*:

Объём груза. Можно не указывать, если задан вес.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

near_cities: [int32]

Ближайшие крупные города — не больше 10, без повторов. Нельзя указывать, если сам город точки является региональным центром. dict: GET /v1.0/dictionaries/cities/{cityId}/near → id

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}

unloading*:{...}

Основная точка разгрузки — конец маршрута.

dates:

Даты разгрузки. Поле необязательное.

ONE-OF

1:{...}

Даты разгрузки. Значима календарная дата, а не момент времени: день определяется по смещению, которое прислал клиент. Даты в примерах условные: подставляйте актуальные, иначе запрос отклонят.

first_date: date-time

Первый день разгрузки. Не в прошлом. Обязателен, если задан last_date.

last_date: date-time

Последний день разгрузки. Не раньше first_date.

time:

Время разгрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

near_cities: [int32]

Ближайшие крупные города — не больше 10, без повторов. Нельзя указывать, если сам город точки является региональным центром. dict: GET /v1.0/dictionaries/cities/{cityId}/near → id

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}

way_points:[{...}]

Промежуточные точки между загрузкой и разгрузкой, не больше 15. Перечисляйте их в порядке проезда: по этому порядку сервис проверяет, что груз, снятый на промежуточной разгрузке, был загружен раньше.

type: enum

[loading]

Тип промежуточной точки — загрузка (loading).

loadingunloadingcustomsgo-through

cargos:[{...}]

Грузы, которые забирают в этой точке. id каждого груза уникален в пределах заявки.

name*: string

От (0 до 200 символов)

Наименование груза Поле не должно содержать emoji-символы и emoji-последовательности

weight*:

Вес груза. Можно не указывать, если задан объём.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume*:

Объём груза. Можно не указывать, если задан вес.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted: null,boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

loading_date:

Дата и время загрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

cargos:[{...}]

Грузы, которые снимают в этой точке. id ссылается на груз из route.loading.cargos либо из более ранней точки loading.

weight:

Снимаемая часть веса. Обязательна, если вес был задан при загрузке этого груза, и запрещена, если не был.

ONE-OF

1:{...}

Вес груза.

type: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество от 10 kilos до 9999 tons

}

null

volume:

Снимаемая часть объёма. Обязательна, если объём был задан при загрузке этого груза, и запрещена, если не был.

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

packaging_quantity: int32

Снимаемое количество упаковок.

is_defined_by_ttn: null,boolean

Снимаемая часть груза будет определена в ТТН.

id*: int32

Номер груза, сквозной по всей заявке. Обязателен. По нему точки разгрузки указывают, какой именно груз снимают.

}]

unloading_date:

Дата и время разгрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени задаётся полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с/по (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm. Принимаются только смещения, существующие в базе часовых поясов. Без start или end указывать нельзя.

}

null

}

null

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

Расположение точки: город с адресом либо адрес из справочника организаций.

type: enum

[manual]

Тип расположения точки — ручное (manual).

manualorganization

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

address: null,string

Адрес в населённом пункте, не длиннее 200 символов; в интеграторском API — не короче 5 символов. Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты точки. Должны лежать не дальше 80 км от центра города city_id.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса. Адрес должен принадлежать организации organization_id. dict: GET /v1.2/catalogs/organizations/addresses → id

}

}]

is_round_trip: null,boolean

Кругорейс

}

truck*:{...}

Транспорт

trucks_count: int32

Количество машин

load_type*: string

Загрузка: - ftl — отдельной машиной - ltl — догрузом - dont-care — отдельной машиной или догрузом

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

body_loading:

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

ONE-OF

1:{...}

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

types: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required: null,boolean

Обязательны все выбранные

}

null

body_unloading:

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

ONE-OF

1:{...}

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

types: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required: null,boolean

Обязательны все выбранные

}

null

temperature:

Температура

ONE-OF

1:{...}

Температура.

from: int32

От

to: int32

До

}

null

documents:

Разрешения

ONE-OF

1:{...}

Разрешения транспорта.

tir: null,boolean

TIR todo ссылка на фак

cmr: null,boolean

CMR todo ссылка на фак

t1: null,boolean

T1 todo ссылка на фак

medical_card: null,boolean

Медкнижка

}

null

requirements:

Требования

ONE-OF

1:{...}

Требования к транспорту.

logging_truck: null,boolean

Коники

road_train: null,boolean

Сцепка

air_suspension: null,boolean

Пневмоход

team_driving: null,boolean

Для груза необходимы два водителя

}

null

adr: int32

ADR

belts_count: int32

Количество ремней

is_tracking: null,boolean

Трекинг через АТИ Водитель

required_capacity: double

Требуемая грузоподъемность в тоннах

}

payment*:{...}

Оплата

type: enum

[with-bargaining]

Тип оплаты — возможен торг (with-bargaining).

with-bargainingwithout-bargainingrate-requestauction

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

rate_with_vat_available: null,boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available: null,boolean

Можно предлагать ставки безнал без НДС

cash_available: null,boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

accept_bids_with_vat*: null,boolean

Принимать ставки с НДС

accept_bids_without_vat: null,boolean

Принимать ставки без НДС

vat_percents: int32

Размер НДС, в процентах

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты, в которой будут вестись Торги. Значение из словаря валют

bid_step*: double

Шаг ставок

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: null,string

Длительность торгов: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов - 1d — 1 день - 2d — 2 дня - 3d — 3 дня - 4d — 4 дня - 5d — 5 дней

count_from_first_bid: null,boolean

Отсчитывать длительность Торгов с момента первой ставки

finish_until: date-time

Точные дата и время завершения Торгов

}

accept_counter_offers:

Параметры доступности встречных предложений во время проведения Торгов

ONE-OF

1:{...}

Параметры доступности встречных предложений во время Торгов.

acceptance_delay: null,string

Принимать встречные предложения через: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

until_first_bid: null,boolean

Принимать встречные предложения до первой ставки по Торгам

}

null

auto_renew:

Параметры автопродления Торгов

ONE-OF

1:{...}

Параметры автопродления Торгов.

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

null

is_antisniper: null,boolean

Опция Антиснайпер

rate_rise:

Параметры повышения ставки Торгов при отсутствии ставок

ONE-OF

1:{...}

Параметры повышения ставки Торгов при отсутствии ставок.

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

null

winner_criteria*: string

Критерий выбора победителя: - best-rate — по лучшей ставке - matching-date — с учётом даты загрузки и лучшей ставки

time_to_provide_documents*: null,string

Время, за которое победитель обязан предоставить документы

winner_reselection_count: int32

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_restart:

Параметры перезапуска Торгов в случае отсутствия ставок

ONE-OF

1:{...}

Параметры перезапуска Торгов при отсутствии ставок.

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

rate_increase:

Параметры повышения начальной ставки после перезапуска торгов.

ONE-OF

1:{...}

Параметры повышения начальной ставки после перезапуска Торгов.

type: enum

[currency]

Тип повышения — абсолютное значение в валюте (currency).

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

null

}

null

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type: enum

[archive]

Действие — переместить заявку в архив (archive).

archivepublish-with-ratepublish-rate-request

currency_type: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

rate_with_vat_available: null,boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available: null,boolean

Можно предлагать ставки безнал без НДС

cash_available: null,boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Автоматическое приглашение на лучшее встречное предложение.

invite_delay: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

need_archive_on_invite: boolean

Архивировать заявку при срабатывании автоматического приглашения

}

null

}

keep_rates: null,boolean

Сохранять ставки при редактировании груза

hide_counter_offers: null,boolean

Встречные предложения видны только вам

direct_offer: null,boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel: null,boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[on-unloading]

Тип режима оплаты — оплата на выгрузке (on-unloading).

on-unloadingdelayed-payment

payment_delay_days: int32

Количество банковских дней

}

null

}

documents:[{...}]

Фото груза и документов

id: string

Старый id документа

file_id: string

Новый id документа

}]

boards:[{...}]

Площадки груза

id*: string

Id площадки

publication_mode: string

Опубликовать груз - now – сразу - 15m – через 15 минут - 30m – через 30 минут - 1h – через час - 3h – через 3 часа - 6h – через 6 часов - exact-time - в точное время

publication_time: date-time

Точное время публикации груза, для publication_mode = 'exact-time'

cancel_publish_on_auction_bet: null,boolean

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

reservation_enabled: null,boolean

Разрешить перевозчикам бронировать груз

}]

paid_features:{...}

Платные услуги: приоритетный показ, стелс

priority_view:

Приоритетный показ

ONE-OF

1:{...}

Приоритетный показ.

rate*: double

Ставка за просмотр

limit: double

Лимит на заявку

daily_limit: double

Суточный лимит

only_for_paid_users: null,boolean

Показывать приоритетный груз только платным пользователям

}

null

stealth:

Стэлс

ONE-OF

1:{...}

Стелс.

list_id: uuid

Id списка фирм для скрытия

minimal_registration_date: date-time

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32

Минимальное количество звёзд фирм, которые будут видеть груз

}

null

}

note: null,string

Примечание к заявке Поле не должно содержать emoji-символы и emoji-последовательности

contacts*: [int32]

Id контактов заявки

}

}

Пример запроса

CURL

curl 'https://api.ati.su/v2/cargos/{cargoApplicationId}' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"cargo_application":{"external_id":"EXT-12345","route":{"loading":{"dates":{"type":"ready","is_available_tomorrow":true,"time":{"0":"?"}},"cargos":[{"name":"Автомобиль(ли)","weight":{"0":"?"},"volume":{"0":"?"},"packaging":{"0":"?"},"sizes":{"0":"?"},"id":1}],"near_cities":[0],"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}},"unloading":{"dates":{"0":"?"},"near_cities":[0],"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}},"way_points":[{"type":"loading","cargos":[{"name":"Автомобиль(ли)","weight":{"0":"?"},"volume":{"0":"?"},"packaging":{"0":"?"},"sizes":{"0":"?"},"id":1}],"loading_date":{"0":"?"},"city_id":3611,"address":"Набережная","coordinates":{"0":"?"},"location":{"type":"manual","city_id":3611,"address":"Набережная","coordinates":{"0":"?"}}}],"is_round_trip":true},"truck":{"trucks_count":1,"load_type":"ftl","body_types":[0],"body_loading":{"0":"?"},"body_unloading":{"0":"?"},"temperature":{"0":"?"},"documents":{"0":"?"},"requirements":{"0":"?"},"adr":3,"belts_count":4,"is_tracking":true,"required_capacity":20},"payment":{"type":"with-bargaining","auto_invites_settings":{"0":"?"},"currency_type":1,"rate_with_vat":50000,"rate_without_vat":50000,"cash":50000,"on_card":true,"rates_with_vat":[{"rate_with_vat":50000,"vat_percent":22}],"hide_counter_offers":true,"direct_offer":true,"prepayment":{"0":"?"},"payment_mode":{"0":"?"}},"documents":[{"id":"9c6cce94-c0e3-eb11-bb99-002590fdcfdb","file_id":"6b35842b8386446c82a43726f139abe1"}],"boards":[{"id":"a0a0a0a0a0a0a0a0a0a0a0a0","publication_mode":"now","publication_time":"2024-01-15T10:30:00+00:00","cancel_publish_on_auction_bet":true,"reservation_enabled":true}],"paid_features":{"priority_view":{"0":"?"},"stealth":{"0":"?"}},"note":"Тестовый груз","contacts":[0]}}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v2/cargos/{cargoApplicationId}", "{""cargo_application"":{""external_id"":""EXT-12345"",""route"":{""loading"":{""dates"":{""type"":""ready"",""is_available_tomorrow"":true,""time"":{""0"":""?""}},""cargos"":[{""name"":""Автомобиль(ли)"",""weight"":{""0"":""?""},""volume"":{""0"":""?""},""packaging"":{""0"":""?""},""sizes"":{""0"":""?""},""id"":1}],""near_cities"":[0],""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}},""unloading"":{""dates"":{""0"":""?""},""near_cities"":[0],""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}},""way_points"":[{""type"":""loading"",""cargos"":[{""name"":""Автомобиль(ли)"",""weight"":{""0"":""?""},""volume"":{""0"":""?""},""packaging"":{""0"":""?""},""sizes"":{""0"":""?""},""id"":1}],""loading_date"":{""0"":""?""},""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""},""location"":{""type"":""manual"",""city_id"":3611,""address"":""Набережная"",""coordinates"":{""0"":""?""}}}],""is_round_trip"":true},""truck"":{""trucks_count"":1,""load_type"":""ftl"",""body_types"":[0],""body_loading"":{""0"":""?""},""body_unloading"":{""0"":""?""},""temperature"":{""0"":""?""},""documents"":{""0"":""?""},""requirements"":{""0"":""?""},""adr"":3,""belts_count"":4,""is_tracking"":true,""required_capacity"":20},""payment"":{""type"":""with-bargaining"",""auto_invites_settings"":{""0"":""?""},""currency_type"":1,""rate_with_vat"":50000,""rate_without_vat"":50000,""cash"":50000,""on_card"":true,""rates_with_vat"":[{""rate_with_vat"":50000,""vat_percent"":22}],""hide_counter_offers"":true,""direct_offer"":true,""prepayment"":{""0"":""?""},""payment_mode"":{""0"":""?""}},""documents"":[{""id"":""9c6cce94-c0e3-eb11-bb99-002590fdcfdb"",""file_id"":""6b35842b8386446c82a43726f139abe1""}],""boards"":[{""id"":""a0a0a0a0a0a0a0a0a0a0a0a0"",""publication_mode"":""now"",""publication_time"":""2024-01-15T10:30:00+00:00"",""cancel_publish_on_auction_bet"":true,""reservation_enabled"":true}],""paid_features"":{""priority_view"":{""0"":""?""},""stealth"":{""0"":""?""}},""note"":""Тестовый груз"",""contacts"":[0]}}");

Ответ

200 Заявка на груз успешно обновлена.

Модель

{...}

Ответ на обновление заявки на груз через Integration API.

cargo_application*:{...}

Контракт заявки груза, ожидаемый в ответах integration http методов работы с грузами

cargo_id: uuid

ID груза OBSOLETE используй поле CargoApplicationId

cargo_number: string

Номер груза, автоматически генерируемый ATI.SU OBSOLETE используй поле CargoApplicationNumber

source: int32

OBSOLETE используй поле OriginSource

contacts: [int32]

Контакты OBSOLETE используй поле ApplicationContacts

distance: int32

Дистанция, км

cargo_application_id*: uuid

Id груза

snapshot_id*: int64

Id состояния груза (меняется при каждом редактировании)

cargo_application_number*: string

Номер груза, автоматически генерируемый ATI.SU

department_id*: int32

Подразделение, которому принадлежит заявка.

persistent_user_id*: int32

Идентификатор пользователя, разместившего заявку

actor_contact_id: int32

Идентификатор контакта, разместившего заявку

external_id: null,string

Внешний номер груза или заказа

added_at*: date-time

Время добавления груза, UTC

updated_at*: date-time

Время последнего изменения груза, UTC

refreshed_at: date-time

Время последнего поднятия груза, UTC

origin_source*: string

Использованный api при создания груза: - web-cargos-api, - mobile-cargos-api, - public-cargos-api

route*:{...}

Маршрут

loading*:{...}

Основная точка загрузки — начало маршрута. Здесь даты загрузки и грузы, которые забирают в начале маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates*:{...}

Даты загрузки. Вид задаёт дискриминатор type.

type: enum

[from-date]

Тип даты — в промежутке дат (from-date).

from-datereadypermanentrate-request

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

is_available_tomorrow*: boolean

Готов к загрузке сегодня и завтра (TODO возможно убрать)

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

periodicity*: string

Периодичность постоянной загрузки: - everyday — "каждый день" - workdays — "по рабочим дням"

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

}

cargos*:[{...}]

Грузы заявки. cargo_id сквозной по всей заявке: по нему точки разгрузки указывают, что снимают.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

unloading*:{...}

Основная точка разгрузки — конец маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates:

Даты разгрузки. Могут быть не заданы.

ONE-OF

1:{...}

Даты разгрузки. Значима календарная дата, а не момент времени: день определяется по смещению в значении.

first_date: date-time

Первый день разгрузки.

last_date: date-time

Последний день разгрузки.

time:

Время разгрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

way_points:[{...}]

Промежуточные точки между загрузкой и разгрузкой, не больше 15, в порядке проезда.

type: enum

[loading]

Тип промежуточной точки — точка загрузки (loading).

loadingunloadingcustomsgo-through

cargos:[{...}]

Грузы, которые забирают в этой точке.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

loading_date:

Дата и время загрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

cargos:[{...}]

Грузы, которые снимают в этой точке.

packaging_quantity: int32

Снимаемое количество упаковок.

is_defined_by_ttn: null,boolean

Снимаемая часть груза будет определена в ТТН.

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

unloading_date:

Дата и время разгрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}]

is_round_trip: null,boolean

Кругорейс

}

truck*:{...}

Транспорт

trucks_count*: int32

Количество машин

load_type*: string

Загрузка: - ftl — отдельной машиной - dont-care — не важно

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

is_tracking*: boolean

Трекинг через АТИ Водитель

adr: int32

ADR

belts_count: int32

Количество ремней

required_capacity: double

Требуемая грузоподъемность в тоннах

body_loading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

body_unloading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

temperature:

Температура

ONE-OF

1:{...}

Температура.

from: int32

От

to: int32

До

}

null

documents:

Разрешения

ONE-OF

1:{...}

Разрешения транспорта.

tir*: boolean

TIR

cmr*: boolean

CMR

t1*: boolean

T1

medical_card*: boolean

Медкнижка

}

null

requirements:

Требования

ONE-OF

1:{...}

Требования к транспорту.

logging_truck*: boolean

Коники

road_train*: boolean

Сцепка

air_suspension*: boolean

Пневмоход

team_driving*: boolean

Для груза необходимы два водителя

}

null

}

payment*:{...}

Оплата

type: enum

[with-bargaining]

Тип оплаты — с возможностью торга (with-bargaining).

with-bargainingwithout-bargainingrate-requestauction

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

auction_id*: uuid

Id Торгов

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты из словаря валют

bid_step*: double

Шаг ставки Торгов

accept_bids_with_vat*: boolean

Принимать ставки с НДС

accept_bids_without_vat: null,boolean

Принимать ставки без НДС

vat_percents: int32

Размер НДС, в процентах

is_antisniper*: boolean

Опция Антиснайпер

time_to_provide_documents*: string

Время, за которое победитель обязан предоставить документы

winner_criteria*: string

Критерий выбора победителя: best-rate — по лучшей ставке matching-date — с учётом даты загрузки и лучшей ставки

winner_reselection_count: int32

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: null,string

Может быть null, если есть значение у поля FinishUntil. Длительность проведения Торгов: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов 1d — 1 день 2d — 2 дня 3d — 3 дня 4d — 4 дня 5d — 5 дней

count_from_first_bid*: boolean

Отсчитывать длительность Торгов с момента первой ставки

finish_until: date-time

Точные дата и время завершения Торгов

}

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type: enum

[archive]

Действие — переместить заявку в архив (archive).

archivepublish-with-ratepublish-rate-request

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

}

accept_counter_offers:

Параметры доступности встречных предложений во время проведения Торгов

ONE-OF

1:{...}

Параметры доступности встречных предложений во время Торгов.

acceptance_delay: null,string

Может быть null, в таком случае будем принимать встречные предложения сразу. Принимать встречные предложения через: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

until_first_bid*: boolean

Принимать встречные предложения до первой ставки по Торгам

}

null

auto_renew:

Параметры автопродления Торгов

ONE-OF

1:{...}

Параметры автопродления Торгов.

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

null

rate_rise:

Параметры повышения ставки Торгов при отсутствии ставок

ONE-OF

1:{...}

Параметры повышения ставки Торгов при отсутствии ставок.

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

null

auction_restart:

Параметры перезапуска Торгов в случае отсутствия ставок

ONE-OF

1:{...}

Параметры перезапуска Торгов при отсутствии ставок.

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов

rate_increase:

Параметры повышения начальной ставки после перезапуска торгов.

ONE-OF

1:{...}

Параметры повышения начальной ставки после перезапуска Торгов.

type: enum

[currency]

Тип повышения — абсолютное значение в валюте (currency).

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

null

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

}

boards*:[{...}]

Площадки груза

id*: string

Id площадки

publication_mode*: string

Опубликовать груз: now – сразу 15m – через 15 минут 30m – через 30 минут 1h – через час 3h – через 3 часа 6h – через 6 часов exact-time - в точное время

publication_time*: date-time

Точное время публикации груза, для publication_mode = 'exact-time'

cancel_publish_on_auction_bet*: boolean

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

publication_restriction: integer

Стратегия ограничений публикации груза на площадке

reservation_enabled*: boolean

Разрешить перевозчикам бронировать груз

is_published*: boolean

Груз опубликован на площадке

}]

documents:[{...}]

Фото груза и документов

id: string

Старый id документа OBSOLETE используй поле FileID

file_id*: string

Id документа в API Плюшкин (TODO ссылка)

name*: string

Название документа

link*: string

Ссылка на документ

}]

application_contacts*:[{...}]

Информация о контактах груза

id*: int32

Id контакта

}]

paid_features:

Платные услуги

ONE-OF

1:{...}

Платные услуги: приоритетный показ, стелс.

priority_view:

Приоритетный показ

ONE-OF

1:{...}

Приоритетный показ.

money_spent_per_day: double

Потрачено атисов за день OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

money_spent_per_order: double

Потрачено атисов на эту заявку OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

rate*: double

Ставка за просмотр

only_for_paid_users*: boolean

Показывать приоритетный груз только платным пользователям

limit: double

Лимит на заявку

daily_limit: double

Суточный лимит

}

null

stealth:

Стэлс

ONE-OF

1:{...}

Стелс.

list_id: uuid

Id списка фирм для скрытия

minimal_registration_date: date-time

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32

Минимальное количество звёзд фирм, которые будут видеть груз

}

null

}

null

note: null,string

Примечание к грузу

lot_id: uuid

Id Лота, к которому прикреплён данный груз

lot_number: int32

Номер Лота, к которому прикреплён данный груз

is_pass_through_copy: null,boolean

Является ли груз сквозной копией

is_archived: null,boolean

Отправлен ли груз в архив

archive_date: date-time

Время отправки груза в архив, UTC

true_price: int32

Истинная ставка на груз после жалоб "Озвученная ставка"

true_currency_id: int32

Истинная валюта ставки на груз после жалоб "Озвученная ставка"

client_application_id: null,string

Идентификатор интегратора (клиентского приложения), через которое был создан груз

}

}

Пример

{...}

"cargo_application":{...}

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"ABC1234",

"source":2,

"contacts":[...],

0

],

"distance":1794,

"cargo_application_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"snapshot_id":1000500,

"cargo_application_number":"ABC1234",

"department_id":7654321,

"persistent_user_id":1234567,

"actor_contact_id":0,

"external_id":"EXT-12345",

"added_at":"2024-01-15T10:30:00+00:00",

"updated_at":"2024-01-15T10:30:00+00:00",

"refreshed_at":"2024-01-15T10:30:00+00:00",

"origin_source":"public-cargos-api",

"route":{...},

"loading":{...},

"near_cities":[...],

0

],

"dates":{...},

"type":"from-date",

"time":{...},

"0":"?"

},

"first_date":"2024-08-27T00:00:00+03:00",

"last_date":"2024-08-29T00:00:00+03:00"

},

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"unloading":{...},

"near_cities":[...],

0

],

"dates":{...},

"0":"?"

},

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"way_points":[...],

{...}

"type":"loading",

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"loading_date":{...},

"0":"?"

},

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

}

],

"is_round_trip":true

},

"truck":{...},

"trucks_count":1,

"load_type":"ftl",

"body_types":[...],

0

],

"is_tracking":true,

"adr":3,

"belts_count":4,

"required_capacity":20,

"body_loading":{...},

"0":"?"

},

"body_unloading":{...},

"0":"?"

},

"temperature":{...},

"0":"?"

},

"documents":{...},

"0":"?"

},

"requirements":{...}

"0":"?"

}

},

"payment":{...},

"type":"with-bargaining",

"auto_invites_settings":{...},

"0":"?"

},

"currency_type":1,

"rate_with_vat":50000,

"rate_without_vat":50000,

"cash":50000,

"on_card":true,

"rates_with_vat":[...],

{...}

"rate_with_vat":50000,

"vat_percent":22

}

],

"hide_counter_offers":true,

"direct_offer":true,

"prepayment":{...},

"0":"?"

},

"payment_mode":{...}

"0":"?"

}

},

"boards":[...],

{...}

"id":"a0a0a0a0a0a0a0a0a0a0a0a0",

"publication_mode":"now",

"publication_time":"2024-01-15T10:30:00+00:00",

"cancel_publish_on_auction_bet":true,

"publication_restriction":0,

"reservation_enabled":true,

"is_published":true

}

],

"documents":[...],

{...}

"id":"9c6cce94-c0e3-eb11-bb99-002590fdcfdb",

"file_id":"6b35842b8386446c82a43726f139abe1",

"name":"Транспортная накладная.pdf",

"link":"https://api.ati.su/webapi/filestorage/files/6b35842b8386446c82a43726f139abe1"

}

],

"application_contacts":[...],

{...}

"id":0

}

],

"paid_features":{...},

"0":"?"

},

"note":"Тестовый груз",

"lot_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"lot_number":38,

"is_pass_through_copy":true,

"is_archived":true,

"archive_date":"2024-01-15T10:30:00+00:00",

"true_price":50000,

"true_currency_id":1,

"client_application_id":"ati"

}

}

400 Невалидные данные запроса или груз в лоте.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

402 Недостаточно средств на счёте для размещения.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

403 Кошелёк заблокирован.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

404 Заявка на груз не найдена.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

409 Обнаружен дубликат заявки.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

417 Изменилась цена размещения.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

423 Слишком рано для повторного редактирования.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

cargoApplicationId Идентификатор редактируемой заявки на груз.

{ "cargo_application": { "external_id": "EXT-12345", "route": { "loading": { "dates": { "type": "ready", "is_available_tomorrow": true, "time": { "0": "?" } }, "cargos": [ { "name": "Автомобиль(ли)", "weight": { "0": "?" }, "volume": { "0": "?" }, "packaging": { "0": "?" }, "sizes": { "0": "?" }, "id": 1 } ], "near_cities": [ 0 ], "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } }, "unloading": { "dates": { "0": "?" }, "near_cities": [ 0 ], "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } }, "way_points": [ { "type": "loading", "cargos": [ { "name": "Автомобиль(ли)", "weight": { "0": "?" }, "volume": { "0": "?" }, "packaging": { "0": "?" }, "sizes": { "0": "?" }, "id": 1 } ], "loading_date": { "0": "?" }, "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" }, "location": { "type": "manual", "city_id": 3611, "address": "Набережная", "coordinates": { "0": "?" } } } ], "is_round_trip": true }, "truck": { "trucks_count": 1, "load_type": "ftl", "body_types": [ 0 ], "body_loading": { "0": "?" }, "body_unloading": { "0": "?" }, "temperature": { "0": "?" }, "documents": { "0": "?" }, "requirements": { "0": "?" }, "adr": 3, "belts_count": 4, "is_tracking": true, "required_capacity": 20 }, "payment": { "type": "with-bargaining", "auto_invites_settings": { "0": "?" }, "currency_type": 1, "rate_with_vat": 50000, "rate_without_vat": 50000, "cash": 50000, "on_card": true, "rates_with_vat": [ { "rate_with_vat": 50000, "vat_percent": 22 } ], "hide_counter_offers": true, "direct_offer": true, "prepayment": { "0": "?" }, "payment_mode": { "0": "?" } }, "documents": [ { "id": "9c6cce94-c0e3-eb11-bb99-002590fdcfdb", "file_id": "6b35842b8386446c82a43726f139abe1" } ], "boards": [ { "id": "a0a0a0a0a0a0a0a0a0a0a0a0", "publication_mode": "now", "publication_time": "2024-01-15T10:30:00+00:00", "cancel_publish_on_auction_bet": true, "reservation_enabled": true } ], "paid_features": { "priority_view": { "0": "?" }, "stealth": { "0": "?" } }, "note": "Тестовый груз", "contacts": [ 0 ] } }

Редактирование груза. API для интеграции. Тело задаёт итоговое состояние груза целиком, а не только изменённые поля.

Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

put /v1.0/loads/{loadId}

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Модель

{...}

Груз для редактирования.

LoadMeta:

Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией

ONE-OF

1:{...}

Метаданные публикации.

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные. Максимальная длина 1024 символа

}

ContactId1*: int32

Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id. Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами. Контакт должен быть виден для остальных участников АТИ

ContactId2: int32 (nullable)

Идентификатор второго выбранного контакта, если не выбрано, то null. Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу. Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC. Минимальное значение равно текущей дате. При значении параметра DateType равным 0, допустимое значение поля - текущая дата. При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед. При значении параметра DateType равным 2, допустимое значение поля - текущая дата. При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC. Минимальное значение равно значению параметра FirstDate. При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед. При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед. При значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется. При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Тип готовности груза к перевозке, по умолчанию 0

• 0 - Готов к загрузке
• 1 - в период с FirstDate по LastDate
• 2 - постоянно
• 3 - груза нет, запрос ставки

PeriodicityId: int32

Периодичность загрузки. Если параметр DateType не равен 2, PeriodicityId равен 0. Иначе PeriodicityId может принимать следующие значения:

• 1 - ежедневно
• 100 - по рабочим дням

OrderNumber: string

Номер заказа. Ограничение по длине: 250 символов

Krugoreis: boolean

Включён ли кругорейс

Loading*:

Точка погрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

ExtraPoints:[{...}]

Дополнительные пункты маршрута между погрузкой и выгрузкой.
Максимум 15 штук. Может иметь значение null

CityId*: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

PointType*: int32

Тип точки:

• 1 - загрузка
• 2 - разгрузка
• 3 - таможня
• 8 - проехать через

Latitude: decimal (nullable)

Широта точки. Допустимое значение от -90 до 90; указывается вместе с долготой

Longitude: decimal (nullable)

Долгота точки. Допустимое значение от -180 до 180; указывается вместе с широтой

Street: string

Улица или район. Максимальная длина 200 символов

OrganizationId: guid (nullable)

Организация, принимающая или отгружающая груз в этой точке. Указывается только вместе с AddressId

AddressId: guid (nullable)

Адрес точки. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

OrdinalId: int32

Порядок точки на маршруте. Если у всех точек 0, сервис нумерует их по порядку списка

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeStart: string (nullable)

Время начала загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeEnd: string (nullable)

Время окончания загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingCargos:[{...}]

Позиции груза, которые берут в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

UnloadingCargos:[{...}]

Позиции груза, которые оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза (CargoId из точки загрузки)

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

PackagingQuantity: int32 (nullable)

Количество выгружаемых мест

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

}]

Unloading*:

Точка выгрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

Cargo*:

Что везём: наименование, вес, объём, упаковка

ONE-OF

1:{...}

Описание груза: что и сколько везём.

Weight: double

Вес груза в тоннах. Обязательный параметр, если не задан параметр Volume. Допустимое значение 0 либо от 0,001 до 9999, не более 3 знаков после запятой

Volume: double

Объём груза в кубических метрах. Обязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа

ADR: int32

Класс опасности груза по ADR. Допустимое значение от 0 до 9, по умолчанию 0. Для CargoTypeId = 53 обязателен ненулевой

CargoTypeId*: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes

CargoType: string

Наименование груза текстом. Обязательный параметр: при CargoTypeId = 59 («другое») это и есть наименование груза. Максимальная длина названия - 200 символов. В этом поле запрещено указывать контактную информацию

PackType: int32

Идентификатор типа упаковки (навалом, коробки, россыпью), 0 — упаковка не указана. dict: GET /v1.0/dictionaries/packTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-packTypes

PalletCount: int32

Количество упаковок для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

• 1 - только отдельной машиной
• 2 - отдельной или догрузом
• 3 - только догрузом

SborGruz: boolean

Сборный груз

Size:

Параметры размера груза

ONE-OF

1:{...}

Габариты груза.

Length: double

Длина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

HeightHighlight: boolean

Выделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

}

}

Transport*:

Требования к транспорту: кузов, варианты загрузки и выгрузки

ONE-OF

1:{...}

Требования к транспорту.

CarType*: int64

Битовая маска типов кузова: идентификаторы из справочника — степени двойки, несколько кузовов складываются (1 + 4 = 5). dict: GET /v1.0/dictionaries/carTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes

CarTypeString: string

Та же битовая маска типов кузова строкой. Только в ответе: в запросе значение игнорируется

LoadingType: int32

Битовая маска вариантов загрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/loadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes

LoadingLogicalOperator: string

Тип условия загрузки:

• OR - необходимо, чтобы присутствовал один из способов загрузки
• AND - необходимо, чтобы присутствовали все выбранные типы загрузки

UnloadingType: int32

Битовая маска вариантов разгрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/unloadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-unloadingTypes

UnloadingLogicalOperator: string

Тип условия разгрузки:

• OR - необходимо, чтобы присутствовал один из способов разгрузки
• AND - необходимо, чтобы присутствовали все выбранные типы разгрузки

TrucksQuantity: int32

Количество машин. Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

Минимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

TemperatureTo: int32 (nullable)

Максимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

Stsepka: boolean

Нужна ли сцепка для груза

Pnevmohod: boolean

Нужен ли пневмоход для груза

Koniki: boolean

Нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

Документы на транспорт, необходимые для провоза этого груза: медкнижка

IsTracking: boolean

Трекинг через АТИ Водитель

RequiredCapacity: double (nullable)

Требуемая грузоподъемность в тоннах. Допустимое значение от 0,01 до 9999, не более 3 знаков после запятой

}

Payment*:

Условия оплаты и ставка

ONE-OF

1:{...}

Условия оплаты и ставка.

CurrencyId: int32

Идентификатор валюты. dict: GET /v1.0/dictionaries/currencyTypes → Id. По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

MoneyType: int32

Идентификатор варианта оплаты. dict: GET /v1.0/dictionaries/moneyTypes → Id. По умолчанию - 22. Должен принимать значение 22, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-moneyTypes

RateSum: decimal

Ставка для груза. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов

SumWithNDS: decimal

Ставка по безналичному расчёту с НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов. Если заданы обе безналичные ставки, SumWithNDS должна быть не меньше SumWithoutNDS. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0

SumWithoutNDS: decimal

Ставка по безналичному расчёту без НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Значение не меньше 0, максимальная длина 10 символов. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0

PrepayPercent: int32

Процент предоплаты. Допустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

Через сколько банковских дней оплата. Допустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false

PayDaysEnabled: boolean

Включена ли оплата через банковские дни. По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true

FixedRate: boolean

true, если ставка задана, false если запрос ставки. По умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1

Torg: boolean

Возможен ли торг. По умолчанию - false. Должен быть false, если параметр FixedRate равен false; при торгах с публикацией ставки — true

DirectContract: boolean

Прямой договор

InFuel: boolean

Предоплата топливом. Должен быть false, если параметр PrepayPercentEnabled равен false

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

Скрыть встречные предложения

AcceptPaymentTypes: int32

Битовая маска форм оплаты, которые вы готовы принять при запросе ставки: флаги складываются

• 1 - наличные
• 2 - безналичный расчёт с НДС
• 4 - безналичный расчёт без НДС

Пример: 7 — все три формы. При запросе ставки значение 0 сервис заменяет на 7; при фиксированной ставке поле не используется

}

InviteSettings:

Настройки автоприглашений

ONE-OF

1:{...}

Настройки автоприглашений по встречным предложениям.

InviteDelayInSeconds: int32

Время в секундах сбора встречных предложений: через него сервис создаёт приглашение по лучшему предложению. Обязателен и больше 0, если объект настроек передан

InviteDurationInSeconds: int32

Время в секундах действия приглашения. Обязателен и больше 0, если объект настроек передан

MaxPercentDeviation: int32 (nullable)

На сколько процентов встречное предложение может превышать вашу ставку, чтобы приглашение всё-таки ушло

NeedArchiveOnInvite: boolean

Архивировать груз при срабатывании автоматического приглашения

}

PriorityView:

Приоритетный показ

ONE-OF

1:{...}

Общие параметры приоритетного показа.

DailyLimit: decimal

Суточный лимит списания по услуге в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

Показывать груз в приоритете только платным пользователям

OrderLimit: decimal

Лимит списания на груз в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

Ставка за просмотр в атисах

• Кратна 0,5
• Не меньше минимальной ставки сервиса и не больше баланса фирмы
• Должна иметь длину не более 5 символов

}

Stealth:

Настройки показа груза

ONE-OF

1:{...}

Ограничения показа груза платной услугой «Стелс»: списания идут с баланса фирмы. Если объект передан, нужен хотя бы один параметр.

ListIdToHide: guid (nullable)

Идентификатор списка фирм, которым груз не показывается. dict: GET https://api.ati.su/scrolls/v1/firms → id. docs: https://ati.su/developers/api/catalogs/firm-lists/

FirmRegDateToHide: date-time (nullable)

Фирмам, зарегистрированным позже этой даты, груз не показывается

ScoreToHide: double (nullable)

Минимальное число звёзд фирмы: фирмам с меньшим числом груз не показывается. Целое от 1 до 5; при включённом бронировании на общей площадке — от 2 до 5

}

LoadFiles:[{...}]

Файлы к грузу.
Перед добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. API для хранения файлов)

Id: guid

Устаревший идентификатор файла, используйте FileId

deprecated

FileId: string

Идентификатор файла, который вернул API хранения файлов при загрузке. dict: POST https://api.ati.su/v1.0/filestorage/files → id. docs: https://ati.su/developers/api/filestorage/

FileType: int32

Тип загруженного файла. Всегда 1 — документ

Attributes: int32

Устаревшее поле, всегда 0

Name: string

Имя файла. Только в ответе: приходит из хранилища файлов, в запросе значение игнорируется

Link: string

Ссылка, по которой можно скачать файл. Сервис собирает её из идентификатора файла в хранилище

Size: int32

Устаревшее поле, всегда -1

}]

Deal:

Сделка, в рамках которой размещён груз

ONE-OF

1:{...}

Сделка по грузу.

Auction:

Параметры аукциона

ONE-OF

1:{...}

Параметры торгов по грузу.

StartRate*: decimal

Начальная ставка аукциона. Параметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.

Currency*: int32

Валюта аукциона. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

Step*: decimal

Минимальное изменение ставки по аукциону. Параметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.

PaymentType*:

Тип оплаты в торгах: допустимы только 24 и 25

ONE-OF

enum

[1, 22, 23, 24, 25]

Тип оплаты.

• 1 - Наличные
• 22 - Любая
• 23 - На карту
• 24 - Безналичный расчёт с НДС
• 25 - Безналичный расчёт без НДС

AcceptSecondPayType: boolean

Принимать ставки и со вторым типом оплаты: без НДС при PaymentType = 24, с НДС при PaymentType = 25

StartDate: date-time

Время начала аукциона в UTC. Должно быть позже времени начала публикации груза на площадке.

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Время окончания аукциона "завершить не позже". Если указанное время, меньше значения Duration - аукцион заканчивается по времени "завершить не позже", если нет автопродления. Время устанавливается в формате UTC.

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.

AutoRenew: boolean

Нужно ли продлевать торги, если ставка пришла незадолго до окончания

RenewTime: int32 (nullable)

Время в минутах, на которое сдвигается окончание аукциона при включённом AutoRenew

MaxRenewTime: int32 (nullable)

Максимально допустимое время в минутах, на которое можно сдвинуть окончание аукциона при включённом AutoRenew. Указывать, если AutoRenew = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

Максимально допустимая ставка по аукциону. Обязателен при RaiseBid = true. Не меньше суммы StartRate и Step, не больше 9999999999, не более 10 символов.

RaiseBidInterval: int32 (nullable)

Период увеличения ставки в минутах при отсутствии предложений. Обязателен при RaiseBid = true: от 1 минуты и меньше Duration. При StartSinceFirstBet = true верхнее ограничение не действует.

ResponseInMinutes: int32 (nullable)

Через сколько минут после начала торгов принимать встречные предложения:

• 0 - сразу
• N - через N минут; допустимо любое значение от 0 и меньше Duration
• null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

Длительность торгов в минутах: целое число больше 0. Окончание торгов не может быть позже времени актуальности груза LastDate. Если не указана, вычисляется как разница EndDate и StartDate, при этом StartSinceFirstBet игнорируется

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчёт до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:

Параметры перезапуска аукциона.
Если объект не передан, действуют значения по умолчанию: до 3 автоматических перевыборов победителя, после исчерпания груз публикуется со ставкой

ONE-OF

1:{...}

Параметры перезапуска торгов.

AuctionFinishAction:

Действие после исчерпания перезапусков

ONE-OF

enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны.

• 1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
• 2 - Опубликовать груз с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе.
• 3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно. Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно. В переданном объекте параметров по умолчанию 0; если сам объект не передан, действует значение 3

DurationAfterRestart: int32 (nullable)

Длительность торгов в минутах после перезапуска. Необязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным

RateIncrease: decimal (nullable)

Повышение ставки при перезапуске

RateIncreaseOption: int32 (nullable)

Единица повышения ставки при перезапуске:

• 1 - в валюте
• 2 - в процентах

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

Принимать встречные предложения только до первой ставки

WinnerCriterion:

Критерий выбора победителя торгов

ONE-OF

enum

[0, 1]

Критерий победы в аукционе.

• 0 - Выбор победителя происходит автоматически по лучшей ставке
• 1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

Source:

Площадка, на которой идут торги. Значение выставляет система: передавайте 0 или не передавайте поле

ONE-OF

enum

[0, 2]

Площадка, на которой идут торги по грузу.

• 0 - Торги в АТИ
• 2 - Торги в Atrucks

}

}

Boards:[{...}]

Площадки публикации. Если не переданы, груз публикуется на общей площадке

BoardId: string

Идентификатор площадки из 24 символов. Значение общей площадки — a0a0a0a0a0a0a0a0a0a0a0a0

PublicationTime: date-time (nullable)

Время публикации на площадке. Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

Разрешено ли бронирование груза на общей площадке. Учитывается только для Общей площадки, только при включённом Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC. Может иметь значение null. Минимальное значение равно текущей дате. Не указывается при значении параметра DateType равным 3

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null. Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate. Не указывается при значении параметра DateType равным 3

}

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"LoadMeta":{"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","MetaData":"import-2026-09"},"ContactId1":1234567,"ContactId2":1234568,"Note":"Погрузка с 9 до 18, пропуск заказывать заранее","FirstDate":"2026-09-08T00:00:00.000Z","LastDate":"2026-09-10T00:00:00.000Z","DateType":1,"PeriodicityId":0,"OrderNumber":"ЗК-2026-0917","Krugoreis":false,"Loading":{"CityId":1,"Latitude":59.939095,"Longitude":30.315868,"Street":"ул. Салова, 57","OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","TimeStart":"2026-09-08T09:00:00.000Z","TimeEnd":"2026-09-08T18:00:00.000Z","IsRoundTheClock":false,"LargeCities":[0],"LoadingCargos":[{"CargoId":1,"NameId":1,"Name":"Продукты питания","PackagingType":1,"PackagingQuantity":20,"Weight":20,"Volume":82,"Sizes":{"Length":13.6,"Width":2.45,"Height":2.7,"Diameter":1.2,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}}]},"ExtraPoints":[{"CityId":1,"PointType":2,"Latitude":59.939095,"Longitude":30.315868,"Street":"пр. Ленина, 10","OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","OrdinalId":1,"IsRoundTheClock":false,"LoadingDateStart":"2026-09-09T00:00:00.000Z","LoadingDateEnd":"2026-09-09T00:00:00.000Z","LoadingTimeStart":"09:00:00","LoadingTimeEnd":"18:00:00","LoadingCargos":[{"CargoId":1,"NameId":1,"Name":"Продукты питания","PackagingType":1,"PackagingQuantity":20,"Weight":20,"Volume":82,"Sizes":{"Length":13.6,"Width":2.45,"Height":2.7,"Diameter":1.2,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}}],"UnloadingCargos":[{"CargoId":1,"Weight":10,"Volume":40,"PackagingQuantity":10,"IsDefinedByTtn":false}]}],"Unloading":{"CityId":1,"Latitude":59.939095,"Longitude":30.315868,"Street":"ул. Салова, 57","OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","TimeStart":"2026-09-08T09:00:00.000Z","TimeEnd":"2026-09-08T18:00:00.000Z","IsRoundTheClock":false,"LargeCities":[0],"LoadingCargos":[{"CargoId":1,"NameId":1,"Name":"Продукты питания","PackagingType":1,"PackagingQuantity":20,"Weight":20,"Volume":82,"Sizes":{"Length":13.6,"Width":2.45,"Height":2.7,"Diameter":1.2,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}}]},"Cargo":{"Weight":20,"Volume":82,"ADR":0,"CargoTypeId":59,"CargoType":"Стройматериалы","PackType":1,"PalletCount":33,"BeltCount":0,"DogruzType":1,"SborGruz":false,"Size":{"Length":13.6,"Width":2.45,"Height":2.7,"Diameter":1.2,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}},"Transport":{"CarType":5,"CarTypeString":"5","LoadingType":3,"LoadingLogicalOperator":"OR","UnloadingType":3,"UnloadingLogicalOperator":"OR","TrucksQuantity":1,"TemperatureFrom":-18,"TemperatureTo":4,"Stsepka":false,"Pnevmohod":false,"Koniki":false,"TIR":false,"CMR":false,"T1":false,"SanPassport":false,"IsTracking":false,"RequiredCapacity":20},"Payment":{"CurrencyId":1,"MoneyType":22,"RateSum":85000,"SumWithNDS":102000,"SumWithoutNDS":85000,"PrepayPercent":30,"PrepayPercentEnabled":true,"PayDays":5,"PayDaysEnabled":true,"FixedRate":true,"Torg":false,"DirectContract":false,"InFuel":false,"OnUnloading":false,"HideResponses":false,"AcceptPaymentTypes":0},"InviteSettings":{"InviteDelayInSeconds":600,"InviteDurationInSeconds":3600,"MaxPercentDeviation":10,"NeedArchiveOnInvite":false},"PriorityView":{"DailyLimit":500,"IsForPayedOnly":false,"OrderLimit":100,"ViewRate":1.5},"Stealth":{"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6","FirmRegDateToHide":"2024-01-01T00:00:00.000Z","ScoreToHide":3},"LoadFiles":[{"FileId":"a1b2c3d4e5f6a7b8c9d0e1f2","FileType":1,"Attributes":0,"Name":"Договор.pdf","Link":"https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2","Size":-1}],"Deal":{"Auction":{"StartRate":50000,"Currency":1,"Step":500,"PaymentType":0,"AcceptSecondPayType":false,"StartDate":"2026-09-08T09:00:00.000Z","EndDate":"2026-09-08T12:00:00.000Z","EndDateBoundary":"2026-09-09T09:00:00.000Z","Nds":20,"TimeToProvideDocuments":4,"AutoRenew":true,"RenewTime":5,"MaxRenewTime":30,"RaiseBid":false,"MaxRate":60000,"RaiseBidInterval":30,"ResponseInMinutes":15,"Duration":180,"StartSinceFirstBet":false,"AuctionRestartParameters":{"AuctionFinishAction":0,"InitRestartCount":1,"InitChangeWinnerCount":1,"DurationAfterRestart":120,"RateIncrease":500,"RateIncreaseOption":1},"AcceptCounterOffersOnlyBeforeFirstBet":false,"WinnerCriterion":0,"Source":0}},"Boards":[{"BoardId":"a0a0a0a0a0a0a0a0a0a0a0a0","PublicationTime":"2026-09-08T12:00:00.000Z","IsReservationEnabled":false,"PublicationOption":0}],"UnloadFirstDate":"2026-09-11T00:00:00.000Z","UnloadLastDate":"2026-09-12T00:00:00.000Z"}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/{loadId}", "{""LoadMeta"":{""LoadMetaId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""MetaData"":""import-2026-09""},""ContactId1"":1234567,""ContactId2"":1234568,""Note"":""Погрузка с 9 до 18, пропуск заказывать заранее"",""FirstDate"":""2026-09-08T00:00:00.000Z"",""LastDate"":""2026-09-10T00:00:00.000Z"",""DateType"":1,""PeriodicityId"":0,""OrderNumber"":""ЗК-2026-0917"",""Krugoreis"":false,""Loading"":{""CityId"":1,""Latitude"":59.939095,""Longitude"":30.315868,""Street"":""ул. Салова, 57"",""OrganizationId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""AddressId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""TimeStart"":""2026-09-08T09:00:00.000Z"",""TimeEnd"":""2026-09-08T18:00:00.000Z"",""IsRoundTheClock"":false,""LargeCities"":[0],""LoadingCargos"":[{""CargoId"":1,""NameId"":1,""Name"":""Продукты питания"",""PackagingType"":1,""PackagingQuantity"":20,""Weight"":20,""Volume"":82,""Sizes"":{""Length"":13.6,""Width"":2.45,""Height"":2.7,""Diameter"":1.2,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}}]},""ExtraPoints"":[{""CityId"":1,""PointType"":2,""Latitude"":59.939095,""Longitude"":30.315868,""Street"":""пр. Ленина, 10"",""OrganizationId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""AddressId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""OrdinalId"":1,""IsRoundTheClock"":false,""LoadingDateStart"":""2026-09-09T00:00:00.000Z"",""LoadingDateEnd"":""2026-09-09T00:00:00.000Z"",""LoadingTimeStart"":""09:00:00"",""LoadingTimeEnd"":""18:00:00"",""LoadingCargos"":[{""CargoId"":1,""NameId"":1,""Name"":""Продукты питания"",""PackagingType"":1,""PackagingQuantity"":20,""Weight"":20,""Volume"":82,""Sizes"":{""Length"":13.6,""Width"":2.45,""Height"":2.7,""Diameter"":1.2,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}}],""UnloadingCargos"":[{""CargoId"":1,""Weight"":10,""Volume"":40,""PackagingQuantity"":10,""IsDefinedByTtn"":false}]}],""Unloading"":{""CityId"":1,""Latitude"":59.939095,""Longitude"":30.315868,""Street"":""ул. Салова, 57"",""OrganizationId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""AddressId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""TimeStart"":""2026-09-08T09:00:00.000Z"",""TimeEnd"":""2026-09-08T18:00:00.000Z"",""IsRoundTheClock"":false,""LargeCities"":[0],""LoadingCargos"":[{""CargoId"":1,""NameId"":1,""Name"":""Продукты питания"",""PackagingType"":1,""PackagingQuantity"":20,""Weight"":20,""Volume"":82,""Sizes"":{""Length"":13.6,""Width"":2.45,""Height"":2.7,""Diameter"":1.2,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}}]},""Cargo"":{""Weight"":20,""Volume"":82,""ADR"":0,""CargoTypeId"":59,""CargoType"":""Стройматериалы"",""PackType"":1,""PalletCount"":33,""BeltCount"":0,""DogruzType"":1,""SborGruz"":false,""Size"":{""Length"":13.6,""Width"":2.45,""Height"":2.7,""Diameter"":1.2,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}},""Transport"":{""CarType"":5,""CarTypeString"":""5"",""LoadingType"":3,""LoadingLogicalOperator"":""OR"",""UnloadingType"":3,""UnloadingLogicalOperator"":""OR"",""TrucksQuantity"":1,""TemperatureFrom"":-18,""TemperatureTo"":4,""Stsepka"":false,""Pnevmohod"":false,""Koniki"":false,""TIR"":false,""CMR"":false,""T1"":false,""SanPassport"":false,""IsTracking"":false,""RequiredCapacity"":20},""Payment"":{""CurrencyId"":1,""MoneyType"":22,""RateSum"":85000,""SumWithNDS"":102000,""SumWithoutNDS"":85000,""PrepayPercent"":30,""PrepayPercentEnabled"":true,""PayDays"":5,""PayDaysEnabled"":true,""FixedRate"":true,""Torg"":false,""DirectContract"":false,""InFuel"":false,""OnUnloading"":false,""HideResponses"":false,""AcceptPaymentTypes"":0},""InviteSettings"":{""InviteDelayInSeconds"":600,""InviteDurationInSeconds"":3600,""MaxPercentDeviation"":10,""NeedArchiveOnInvite"":false},""PriorityView"":{""DailyLimit"":500,""IsForPayedOnly"":false,""OrderLimit"":100,""ViewRate"":1.5},""Stealth"":{""ListIdToHide"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""FirmRegDateToHide"":""2024-01-01T00:00:00.000Z"",""ScoreToHide"":3},""LoadFiles"":[{""FileId"":""a1b2c3d4e5f6a7b8c9d0e1f2"",""FileType"":1,""Attributes"":0,""Name"":""Договор.pdf"",""Link"":""https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2"",""Size"":-1}],""Deal"":{""Auction"":{""StartRate"":50000,""Currency"":1,""Step"":500,""PaymentType"":0,""AcceptSecondPayType"":false,""StartDate"":""2026-09-08T09:00:00.000Z"",""EndDate"":""2026-09-08T12:00:00.000Z"",""EndDateBoundary"":""2026-09-09T09:00:00.000Z"",""Nds"":20,""TimeToProvideDocuments"":4,""AutoRenew"":true,""RenewTime"":5,""MaxRenewTime"":30,""RaiseBid"":false,""MaxRate"":60000,""RaiseBidInterval"":30,""ResponseInMinutes"":15,""Duration"":180,""StartSinceFirstBet"":false,""AuctionRestartParameters"":{""AuctionFinishAction"":0,""InitRestartCount"":1,""InitChangeWinnerCount"":1,""DurationAfterRestart"":120,""RateIncrease"":500,""RateIncreaseOption"":1},""AcceptCounterOffersOnlyBeforeFirstBet"":false,""WinnerCriterion"":0,""Source"":0}},""Boards"":[{""BoardId"":""a0a0a0a0a0a0a0a0a0a0a0a0"",""PublicationTime"":""2026-09-08T12:00:00.000Z"",""IsReservationEnabled"":false,""PublicationOption"":0}],""UnloadFirstDate"":""2026-09-11T00:00:00.000Z"",""UnloadLastDate"":""2026-09-12T00:00:00.000Z""}");

Ответ

200 Отредактированный груз.

Модель

{...}

Груз в ответе: поля публикации и вычисляемые сервисом.

LoadMeta:

Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией

ONE-OF

1:{...}

Метаданные публикации.

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные. Максимальная длина 1024 символа

}

ContactId1*: int32

Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id. Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами. Контакт должен быть виден для остальных участников АТИ

ContactId2: int32 (nullable)

Идентификатор второго выбранного контакта, если не выбрано, то null. Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу. Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC. Минимальное значение равно текущей дате. При значении параметра DateType равным 0, допустимое значение поля - текущая дата. При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед. При значении параметра DateType равным 2, допустимое значение поля - текущая дата. При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC. Минимальное значение равно значению параметра FirstDate. При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед. При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед. При значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется. При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Тип готовности груза к перевозке, по умолчанию 0

• 0 - Готов к загрузке
• 1 - в период с FirstDate по LastDate
• 2 - постоянно
• 3 - груза нет, запрос ставки

PeriodicityId: int32

Периодичность загрузки. Если параметр DateType не равен 2, PeriodicityId равен 0. Иначе PeriodicityId может принимать следующие значения:

• 1 - ежедневно
• 100 - по рабочим дням

OrderNumber: string

Номер заказа. Ограничение по длине: 250 символов

Krugoreis: boolean

Включён ли кругорейс

Loading*:

Точка погрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

ExtraPoints:[{...}]

Дополнительные пункты маршрута между погрузкой и выгрузкой.
Максимум 15 штук. Может иметь значение null

CityId*: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

PointType*: int32

Тип точки:

• 1 - загрузка
• 2 - разгрузка
• 3 - таможня
• 8 - проехать через

Latitude: decimal (nullable)

Широта точки. Допустимое значение от -90 до 90; указывается вместе с долготой

Longitude: decimal (nullable)

Долгота точки. Допустимое значение от -180 до 180; указывается вместе с широтой

Street: string

Улица или район. Максимальная длина 200 символов

OrganizationId: guid (nullable)

Организация, принимающая или отгружающая груз в этой точке. Указывается только вместе с AddressId

AddressId: guid (nullable)

Адрес точки. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

OrdinalId: int32

Порядок точки на маршруте. Если у всех точек 0, сервис нумерует их по порядку списка

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeStart: string (nullable)

Время начала загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeEnd: string (nullable)

Время окончания загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingCargos:[{...}]

Позиции груза, которые берут в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

UnloadingCargos:[{...}]

Позиции груза, которые оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза (CargoId из точки загрузки)

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

PackagingQuantity: int32 (nullable)

Количество выгружаемых мест

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

}]

Unloading*:

Точка выгрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

Cargo*:

Что везём: наименование, вес, объём, упаковка

ONE-OF

1:{...}

Описание груза: что и сколько везём.

Weight: double

Вес груза в тоннах. Обязательный параметр, если не задан параметр Volume. Допустимое значение 0 либо от 0,001 до 9999, не более 3 знаков после запятой

Volume: double

Объём груза в кубических метрах. Обязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа

ADR: int32

Класс опасности груза по ADR. Допустимое значение от 0 до 9, по умолчанию 0. Для CargoTypeId = 53 обязателен ненулевой

CargoTypeId*: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes

CargoType: string

Наименование груза текстом. Обязательный параметр: при CargoTypeId = 59 («другое») это и есть наименование груза. Максимальная длина названия - 200 символов. В этом поле запрещено указывать контактную информацию

PackType: int32

Идентификатор типа упаковки (навалом, коробки, россыпью), 0 — упаковка не указана. dict: GET /v1.0/dictionaries/packTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-packTypes

PalletCount: int32

Количество упаковок для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

• 1 - только отдельной машиной
• 2 - отдельной или догрузом
• 3 - только догрузом

SborGruz: boolean

Сборный груз

Size:

Параметры размера груза

ONE-OF

1:{...}

Габариты груза.

Length: double

Длина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

HeightHighlight: boolean

Выделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

}

}

Transport*:

Требования к транспорту: кузов, варианты загрузки и выгрузки

ONE-OF

1:{...}

Требования к транспорту.

CarType*: int64

Битовая маска типов кузова: идентификаторы из справочника — степени двойки, несколько кузовов складываются (1 + 4 = 5). dict: GET /v1.0/dictionaries/carTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes

CarTypeString: string

Та же битовая маска типов кузова строкой. Только в ответе: в запросе значение игнорируется

LoadingType: int32

Битовая маска вариантов загрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/loadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes

LoadingLogicalOperator: string

Тип условия загрузки:

• OR - необходимо, чтобы присутствовал один из способов загрузки
• AND - необходимо, чтобы присутствовали все выбранные типы загрузки

UnloadingType: int32

Битовая маска вариантов разгрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/unloadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-unloadingTypes

UnloadingLogicalOperator: string

Тип условия разгрузки:

• OR - необходимо, чтобы присутствовал один из способов разгрузки
• AND - необходимо, чтобы присутствовали все выбранные типы разгрузки

TrucksQuantity: int32

Количество машин. Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

Минимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

TemperatureTo: int32 (nullable)

Максимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

Stsepka: boolean

Нужна ли сцепка для груза

Pnevmohod: boolean

Нужен ли пневмоход для груза

Koniki: boolean

Нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

Документы на транспорт, необходимые для провоза этого груза: медкнижка

IsTracking: boolean

Трекинг через АТИ Водитель

RequiredCapacity: double (nullable)

Требуемая грузоподъемность в тоннах. Допустимое значение от 0,01 до 9999, не более 3 знаков после запятой

}

Payment*:

Условия оплаты и ставка

ONE-OF

1:{...}

Условия оплаты и ставка.

CurrencyId: int32

Идентификатор валюты. dict: GET /v1.0/dictionaries/currencyTypes → Id. По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

MoneyType: int32

Идентификатор варианта оплаты. dict: GET /v1.0/dictionaries/moneyTypes → Id. По умолчанию - 22. Должен принимать значение 22, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-moneyTypes

RateSum: decimal

Ставка для груза. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов

SumWithNDS: decimal

Ставка по безналичному расчёту с НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов. Если заданы обе безналичные ставки, SumWithNDS должна быть не меньше SumWithoutNDS. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0

SumWithoutNDS: decimal

Ставка по безналичному расчёту без НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Значение не меньше 0, максимальная длина 10 символов. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0

PrepayPercent: int32

Процент предоплаты. Допустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

Через сколько банковских дней оплата. Допустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false

PayDaysEnabled: boolean

Включена ли оплата через банковские дни. По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true

FixedRate: boolean

true, если ставка задана, false если запрос ставки. По умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1

Torg: boolean

Возможен ли торг. По умолчанию - false. Должен быть false, если параметр FixedRate равен false; при торгах с публикацией ставки — true

DirectContract: boolean

Прямой договор

InFuel: boolean

Предоплата топливом. Должен быть false, если параметр PrepayPercentEnabled равен false

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

Скрыть встречные предложения

AcceptPaymentTypes: int32

Битовая маска форм оплаты, которые вы готовы принять при запросе ставки: флаги складываются

• 1 - наличные
• 2 - безналичный расчёт с НДС
• 4 - безналичный расчёт без НДС

Пример: 7 — все три формы. При запросе ставки значение 0 сервис заменяет на 7; при фиксированной ставке поле не используется

}

InviteSettings:

Настройки автоприглашений

ONE-OF

1:{...}

Настройки автоприглашений по встречным предложениям.

InviteDelayInSeconds: int32

Время в секундах сбора встречных предложений: через него сервис создаёт приглашение по лучшему предложению. Обязателен и больше 0, если объект настроек передан

InviteDurationInSeconds: int32

Время в секундах действия приглашения. Обязателен и больше 0, если объект настроек передан

MaxPercentDeviation: int32 (nullable)

На сколько процентов встречное предложение может превышать вашу ставку, чтобы приглашение всё-таки ушло

NeedArchiveOnInvite: boolean

Архивировать груз при срабатывании автоматического приглашения

}

PriorityView:

Приоритетный показ

ONE-OF

1:{...}

Параметры приоритетного показа в ответе.

DailyLimit: decimal

Суточный лимит списания по услуге в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

Показывать груз в приоритете только платным пользователям

OrderLimit: decimal

Лимит списания на груз в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

Ставка за просмотр в атисах

• Кратна 0,5
• Не меньше минимальной ставки сервиса и не больше баланса фирмы
• Должна иметь длину не более 5 символов

MoneySpentPerDay: decimal

Сколько списано с баланса за груз в текущие сутки. Только для чтения

MoneySpentPerOrder: decimal

Сколько списано с баланса за груз за всё время. Только для чтения

}

Stealth:

Настройки показа груза

ONE-OF

1:{...}

Ограничения показа груза платной услугой «Стелс»: списания идут с баланса фирмы. Если объект передан, нужен хотя бы один параметр.

ListIdToHide: guid (nullable)

Идентификатор списка фирм, которым груз не показывается. dict: GET https://api.ati.su/scrolls/v1/firms → id. docs: https://ati.su/developers/api/catalogs/firm-lists/

FirmRegDateToHide: date-time (nullable)

Фирмам, зарегистрированным позже этой даты, груз не показывается

ScoreToHide: double (nullable)

Минимальное число звёзд фирмы: фирмам с меньшим числом груз не показывается. Целое от 1 до 5; при включённом бронировании на общей площадке — от 2 до 5

}

LoadFiles:[{...}]

Файлы к грузу.
Перед добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. API для хранения файлов)

Id: guid

Устаревший идентификатор файла, используйте FileId

deprecated

FileId: string

Идентификатор файла, который вернул API хранения файлов при загрузке. dict: POST https://api.ati.su/v1.0/filestorage/files → id. docs: https://ati.su/developers/api/filestorage/

FileType: int32

Тип загруженного файла. Всегда 1 — документ

Attributes: int32

Устаревшее поле, всегда 0

Name: string

Имя файла. Только в ответе: приходит из хранилища файлов, в запросе значение игнорируется

Link: string

Ссылка, по которой можно скачать файл. Сервис собирает её из идентификатора файла в хранилище

Size: int32

Устаревшее поле, всегда -1

}]

Deal:

Сделка, в рамках которой размещён груз

ONE-OF

1:{...}

Сделка по грузу в ответе.

Auction:

Параметры аукциона

ONE-OF

1:{...}

Торги по грузу в ответе.

StartRate*: decimal

Начальная ставка аукциона. Параметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.

Currency*: int32

Валюта аукциона. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

Step*: decimal

Минимальное изменение ставки по аукциону. Параметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.

PaymentType*:

Тип оплаты в торгах: допустимы только 24 и 25

ONE-OF

enum

[1, 22, 23, 24, 25]

Тип оплаты.

• 1 - Наличные
• 22 - Любая
• 23 - На карту
• 24 - Безналичный расчёт с НДС
• 25 - Безналичный расчёт без НДС

AcceptSecondPayType: boolean

Принимать ставки и со вторым типом оплаты: без НДС при PaymentType = 24, с НДС при PaymentType = 25

StartDate: date-time

Время начала аукциона в UTC. Должно быть позже времени начала публикации груза на площадке.

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Время окончания аукциона "завершить не позже". Если указанное время, меньше значения Duration - аукцион заканчивается по времени "завершить не позже", если нет автопродления. Время устанавливается в формате UTC.

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.

AutoRenew: boolean

Нужно ли продлевать торги, если ставка пришла незадолго до окончания

RenewTime: int32 (nullable)

Время в минутах, на которое сдвигается окончание аукциона при включённом AutoRenew

MaxRenewTime: int32 (nullable)

Максимально допустимое время в минутах, на которое можно сдвинуть окончание аукциона при включённом AutoRenew. Указывать, если AutoRenew = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

Максимально допустимая ставка по аукциону. Обязателен при RaiseBid = true. Не меньше суммы StartRate и Step, не больше 9999999999, не более 10 символов.

RaiseBidInterval: int32 (nullable)

Период увеличения ставки в минутах при отсутствии предложений. Обязателен при RaiseBid = true: от 1 минуты и меньше Duration. При StartSinceFirstBet = true верхнее ограничение не действует.

ResponseInMinutes: int32 (nullable)

Через сколько минут после начала торгов принимать встречные предложения:

• 0 - сразу
• N - через N минут; допустимо любое значение от 0 и меньше Duration
• null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

Длительность торгов в минутах: целое число больше 0. Окончание торгов не может быть позже времени актуальности груза LastDate. Если не указана, вычисляется как разница EndDate и StartDate, при этом StartSinceFirstBet игнорируется

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчёт до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:

Параметры перезапуска аукциона.
Если объект не передан, действуют значения по умолчанию: до 3 автоматических перевыборов победителя, после исчерпания груз публикуется со ставкой

ONE-OF

1:{...}

Параметры перезапуска торгов.

AuctionFinishAction:

Действие после исчерпания перезапусков

ONE-OF

enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны.

• 1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
• 2 - Опубликовать груз с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе.
• 3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно. Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно. В переданном объекте параметров по умолчанию 0; если сам объект не передан, действует значение 3

DurationAfterRestart: int32 (nullable)

Длительность торгов в минутах после перезапуска. Необязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным

RateIncrease: decimal (nullable)

Повышение ставки при перезапуске

RateIncreaseOption: int32 (nullable)

Единица повышения ставки при перезапуске:

• 1 - в валюте
• 2 - в процентах

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

Принимать встречные предложения только до первой ставки

WinnerCriterion:

Критерий выбора победителя торгов

ONE-OF

enum

[0, 1]

Критерий победы в аукционе.

• 0 - Выбор победителя происходит автоматически по лучшей ставке
• 1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

Source:

Площадка, на которой идут торги. Значение выставляет система: передавайте 0 или не передавайте поле

ONE-OF

enum

[0, 2]

Площадка, на которой идут торги по грузу.

• 0 - Торги в АТИ
• 2 - Торги в Atrucks

AuctionId: guid

Идентификатор аукциона

LoadId: guid

Идентификатор груза, для которого активен аукцион

ActiveDealId: guid (nullable)

Идентификатор сделки, привязанной к аукциону

State:

Статус аукциона

ONE-OF

enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона.

• -100 - Не удалось определить состояние аукциона
• -14 - Аукцион отменен руками грузовладельца
• -13 - Аукцион удален, т.к. расторгнут заказ
• -12 - Аукцион без ставок завершен
• -11 - Аукцион удален автоматически
• -10 - Аукцион удален т.к. сделка завершена
• -9 - Аукцион удален
• -8 - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет
• -7 - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель
• -6 - При включенном копировании грузов: торги завершены, экспедитор не является победителем
• -5 - Одна ставка лучшая по цене, другая по дате
• -4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
• -3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
• -2 - Закончился, ждем когда победитель возьмет груз
• -1 - Закончился, ставок нет
• 0 - Идет, ставок нет
• 1 - Идет (уже есть валидные ставки)

Finished: boolean

Завершён ли аукцион

WinDate: date-time (nullable)

Время, когда одна из ставок в AuctionRates стала победной

AuctionRates:[{...}]

Список ставок по аукциону

AuctionRateId: guid

Идентификатор ставки

AddedAt: date-time

Когда сделана ставка

RateFirm:

Фирма, сделавшая ставку

ONE-OF

1:{...}

Фирма-участник торгов: рейтинг, статус и контакт.

Score: double

Рейтинг фирмы в звёздах

Status:

Статус фирмы в АТИ. Коды описаны в FirmStatus

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7]

Статус фирмы по цвету звёзд.

• 0 - Серый
• 1 - Зелёный
• 2 - Жёлтый
• 3 - Красный
• 4 - Партнёр АТИ
• 5 - Сотрудник АТИ
• 6 - Гос. органы
• 7 - ОДКС

Name: string

Имя фирмы

ContactName: string

Имя контакта

AtiId: string

Идентификатор фирмы в АТИ

}

Rate: decimal

Ставка на груз, которую поставил пользователь

State:

Статус ставки. Коды описаны в AuctionRateState

ONE-OF

enum

[0, 1, -8, -7, -6, -5, -4, -3, -2, -1]

Статус ставки.

• -8 - Грузовладелец отклонил документ
• -7 - Победитель отклонил документ
• -6 - Победитель отменил сделку
• -5 - Грузовладелец отменил сделку
• -4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
• -3 - Бывший победитель
• -2 - Перевозчик отказался от участия
• -1 - Предложение отклонил грузовладелец/перевозчик
• 0 - Непобедная ставка при завершении торгов
• 1 - Победная ставка в аукционе

LoadingDate: date-time (nullable)

Ближайшая возможная для перевозчика дата загрузки. Используется только в аукционах с критерием победы по ставке и дате загрузки

FirmId: int32

Идентификатор фирмы, сделавшей ставку

ContactId: int32

Идентификатор контакта, сделавшего ставку

}]

}

}

Boards:[{...}]

Список площадок

BoardId: string

Идентификатор площадки из 24 символов. Значение общей площадки — a0a0a0a0a0a0a0a0a0a0a0a0

PublicationTime: date-time (nullable)

Время публикации на площадке. Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

Разрешено ли бронирование груза на общей площадке. Учитывается только для Общей площадки, только при включённом Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Является ли площадка общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC. Может иметь значение null. Минимальное значение равно текущей дате. Не указывается при значении параметра DateType равным 3

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null. Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate. Не указывается при значении параметра DateType равным 3

ArchiveDate: date-time (nullable)

Дата и время переноса в архив

ArchiveReason:

Причина переноса в архив

ONE-OF

(nullable)

enum

[Unknown, System, Manual, Complaints, UnwantedContent, DeleteCsvLoad, MergeLoadsAfterEdit, ContactDoesNotHaveAccessToVirtualPayments, VerticesLoadDelete, StealthStatisticError, CheckDuplicateComplaints, DeleteContact, DeleteFirm, CleanOldLoadsJob]

Причина, по которой груз оказался в архиве.

• VerticesLoadDelete - Снят при сквозной передаче груза
• StealthStatisticError - Снят из-за ошибки при подсчёте статистики Стелса
• CheckDuplicateComplaints - Снят при проверке дублирующих жалоб
• DeleteContact - Удалён контакт
• DeleteFirm - Удалена фирма
• CleanOldLoadsJob - Истёк срок актуальности
• Unknown - Причина не определена
• System - Снят системой
• Manual - Снят с публикации владельцем
• Complaints - Снят по жалобам
• UnwantedContent - Снят за недопустимое содержимое
• DeleteCsvLoad - Удалён вместе с CSV-загрузкой
• MergeLoadsAfterEdit - Объединён с другим грузом после редактирования
• ContactDoesNotHaveAccessToVirtualPayments - Снят: у контакта нет права оплачивать услугу со счёта фирмы

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

Идентификатор валюты озвученной ставки. dict: GET /v1.0/dictionaries/currencyTypes → Id

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Можно ли снять груз с публикации

HasPermissionsToLoad: boolean

Есть ли у текущего контакта доступ к грузу: контакт указан в грузе или имеет доступ к его подразделению

CanBeEdited: boolean

Можно ли редактировать груз

CanBeRenewed: boolean

Можно ли обновить груз

CanBeRestored: boolean

Можно ли восстановить груз из архива

EditRestriction:

Причина отказа в редактировании груза, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

DeleteRestriction:

Причина отказа в снятии груза с публикации, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RestoreRestriction:

Причина отказа в восстановлении груза из архива, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RenewRestriction: string

Причина отказа в обновлении груза. Пустая строка, если обновление доступно

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

UpdatedAt: date-time

Дата последнего изменения груза в UTC

AddedAt: date-time

Дата публикации груза в UTC

RefreshedAt: date-time

Дата последнего обновления груза в выдаче, в UTC

Distance: int32

Расстояние по дорогам в километрах

PlatonRoadsLength: int32

Протяжённость участков маршрута, за которые взимается плата по системе «Платон», в километрах

TollRoadsLength: int32

Протяжённость платных дорог на маршруте в километрах

TravelTime: string

Расчётное время в пути в формате [d.]hh:mm:ss

Zimnik: boolean

Учитывать ли зимники при построении маршрута

Ferries: boolean

Учитывать ли паромные переправы при построении маршрута

FirmId: string

Идентификатор фирмы

AuctionId: guid (nullable)

Идентификатор аукциона по грузу

}

Пример

{...}

"LoadMeta":{...},

"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"MetaData":"import-2026-09"

},

"ContactId1":1234567,

"ContactId2":1234568,

"Note":"Погрузка с 9 до 18, пропуск заказывать заранее",

"FirstDate":"2026-09-08T00:00:00.000Z",

"LastDate":"2026-09-10T00:00:00.000Z",

"DateType":1,

"PeriodicityId":0,

"OrderNumber":"ЗК-2026-0917",

"Krugoreis":false,

"Loading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"ExtraPoints":[...],

{...}

"CityId":1,

"PointType":2,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"пр. Ленина, 10",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"OrdinalId":1,

"IsRoundTheClock":false,

"LoadingDateStart":"2026-09-09T00:00:00.000Z",

"LoadingDateEnd":"2026-09-09T00:00:00.000Z",

"LoadingTimeStart":"09:00:00",

"LoadingTimeEnd":"18:00:00",

"LoadingCargos":[...],

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

],

"UnloadingCargos":[...]

{...}

"CargoId":1,

"Weight":10,

"Volume":40,

"PackagingQuantity":10,

"IsDefinedByTtn":false

}

]

}

],

"Unloading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"Cargo":{...},

"Weight":20,

"Volume":82,

"ADR":0,

"CargoTypeId":59,

"CargoType":"Стройматериалы",

"PackType":1,

"PalletCount":33,

"BeltCount":0,

"DogruzType":1,

"SborGruz":false,

"Size":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

},

"Transport":{...},

"CarType":5,

"CarTypeString":"5",

"LoadingType":3,

"LoadingLogicalOperator":"OR",

"UnloadingType":3,

"UnloadingLogicalOperator":"OR",

"TrucksQuantity":1,

"TemperatureFrom":-18,

"TemperatureTo":4,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false,

"RequiredCapacity":20

},

"Payment":{...},

"CurrencyId":1,

"MoneyType":22,

"RateSum":85000,

"SumWithNDS":102000,

"SumWithoutNDS":85000,

"PrepayPercent":30,

"PrepayPercentEnabled":true,

"PayDays":5,

"PayDaysEnabled":true,

"FixedRate":true,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

},

"InviteSettings":{...},

"InviteDelayInSeconds":600,

"InviteDurationInSeconds":3600,

"MaxPercentDeviation":10,

"NeedArchiveOnInvite":false

},

"PriorityView":{...},

"DailyLimit":500,

"IsForPayedOnly":false,

"OrderLimit":100,

"ViewRate":1.5,

"MoneySpentPerDay":12,

"MoneySpentPerOrder":45

},

"Stealth":{...},

"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"FirmRegDateToHide":"2024-01-01T00:00:00.000Z",

"ScoreToHide":3

},

"LoadFiles":[...],

{...}

"FileId":"a1b2c3d4e5f6a7b8c9d0e1f2",

"FileType":1,

"Attributes":0,

"Name":"Договор.pdf",

"Link":"https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2",

"Size":-1

}

],

"Deal":{...},

"Auction":{...}

"StartRate":50000,

"Currency":1,

"Step":500,

"PaymentType":0,

"AcceptSecondPayType":false,

"StartDate":"2026-09-08T09:00:00.000Z",

"EndDate":"2026-09-08T12:00:00.000Z",

"EndDateBoundary":"2026-09-09T09:00:00.000Z",

"Nds":20,

"TimeToProvideDocuments":4,

"AutoRenew":true,

"RenewTime":5,

"MaxRenewTime":30,

"RaiseBid":false,

"MaxRate":60000,

"RaiseBidInterval":30,

"ResponseInMinutes":15,

"Duration":180,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":1,

"InitChangeWinnerCount":1,

"DurationAfterRestart":120,

"RateIncrease":500,

"RateIncreaseOption":1

},

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

"Source":0,

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ActiveDealId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"State":0,

"Finished":false,

"WinDate":"2026-09-08T12:05:00.000Z",

"AuctionRates":[...]

{...}

"AuctionRateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddedAt":"2026-09-08T10:15:30.000Z",

"RateFirm":{...},

"Score":4.5,

"Status":0,

"Name":"ООО «Перевозчик»",

"ContactName":"Иван Петров",

"AtiId":"1234567"

},

"Rate":48000,

"State":0,

"LoadingDate":"2026-09-09T00:00:00.000Z",

"FirmId":7654321,

"ContactId":0

}

]

}

},

"Boards":[...],

{...}

"BoardId":"a0a0a0a0a0a0a0a0a0a0a0a0",

"PublicationTime":"2026-09-08T12:00:00.000Z",

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":true,

"IsCommonBoard":true

}

],

"UnloadFirstDate":"2026-09-11T00:00:00.000Z",

"UnloadLastDate":"2026-09-12T00:00:00.000Z",

"ArchiveDate":"2026-09-07T10:15:30.000Z",

"ArchiveReason":"Unknown",

"TruePrice":85000,

"TrueCurrencyId":1,

"ResponseCount":3,

"OfferCount":2,

"CanBeDeleted":true,

"HasPermissionsToLoad":true,

"CanBeEdited":true,

"CanBeRenewed":true,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"Груз можно обновить не ранее чем через 40 минут",

"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"12345678",

"UpdatedAt":"2026-09-07T10:15:30.000Z",

"AddedAt":"2026-09-05T08:00:00.000Z",

"RefreshedAt":"2026-09-07T09:00:00+00:00",

"Distance":712,

"PlatonRoadsLength":540,

"TollRoadsLength":120,

"TravelTime":"10:30:00",

"Zimnik":false,

"Ferries":false,

"FirmId":"1234567",

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

400 Тело запроса не разобрано или поля не прошли проверку.

Модель

{...}

Тело запроса не разобрано или не прошло проверку полей.

Error: string

Ключ ошибки: json_validation_error — поля не прошли проверку, deserialization_error — тело не разобрано

Reason: string

Причина ошибки для показа пользователю

ErrorsList:[{...}]

Ошибки по полям. Только при json_validation_error

property: string

Поле, не прошедшее проверку; вложенные поля через точку

reason: string

Причина ошибки для показа пользователю

error: string

Ключ нарушенного правила

context: {missing-type-info} (nullable)

Параметры нарушенного правила, если у него есть границы: например, Min и Max

}]

}

Пример

{...}

"Error":"json_validation_error",

"Reason":"Ошибка валидации json",

"ErrorsList":[...]

{...}

"property":"Cargo.Weight",

"reason":"Максимальная длина для параметра вес - 4 символа",

"error":"length_out_of_range",

"context":{...}

"Min":0,

"Max":4

}

}

]

}

402 Не хватает средств на платное размещение на выбранных площадках.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Недостаточно средств для платного размещения груза",

"Error":"low_balance_error"

}

403 Нет доступа к грузу; при повторном редактировании раньше разрешённого интервала — ключ `load_update_delay_not_elapsed` без кода причины.

Модель

{...}

Отказ в доступе к операции с грузом: ключ ошибки, пояснение и код причины.

Error: string

Ключ ошибки

Reason: string

Причина ошибки для показа пользователю

AccessDeniedReason:

Код причины отказа. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

ExceededLimit:

Какой лимит грузов исчерпан, если причина отказа — превышение лимита: 0 — общая площадка, 1 — персональные площадки. В остальных случаях null

ONE-OF

(nullable)

enum

[0, 1]

Лимит грузов, который исчерпан.

• 0 - Лимит грузов на общей площадке
• 1 - Лимит грузов на персональных площадках

}

Пример

{...}

"Error":"access_denied_error",

"Reason":"У вашего контакта недостаточно прав для работы с данным грузом",

"AccessDeniedReason":0,

"ExceededLimit":0

}

404 Груз не найден среди опубликованных грузов фирмы.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Груз не найден",

"Error":"load_not_found_error"

}

409 Среди опубликованных грузов фирмы уже есть такой же.

Модель

{...}

Отказ из-за дубликата: среди опубликованных грузов фирмы уже есть такой же.

Error: string

Ключ ошибки

Reason: string

Причина ошибки для показа пользователю

ConflictLoadId: guid

Идентификатор опубликованного груза, с которым найден дубликат

}

Пример

{...}

"Error":"load_conflict_error",

"Reason":"Найден дубликат в грузах",

"ConflictLoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

{ "LoadMeta": { "LoadMetaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "MetaData": "import-2026-09" }, "ContactId1": 1234567, "ContactId2": 1234568, "Note": "Погрузка с 9 до 18, пропуск заказывать заранее", "FirstDate": "2026-09-08T00:00:00.000Z", "LastDate": "2026-09-10T00:00:00.000Z", "DateType": 1, "PeriodicityId": 0, "OrderNumber": "ЗК-2026-0917", "Krugoreis": false, "Loading": { "CityId": 1, "Latitude": 59.939095, "Longitude": 30.315868, "Street": "ул. Салова, 57", "OrganizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "AddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "TimeStart": "2026-09-08T09:00:00.000Z", "TimeEnd": "2026-09-08T18:00:00.000Z", "IsRoundTheClock": false, "LargeCities": [ 0 ], "LoadingCargos": [ { "CargoId": 1, "NameId": 1, "Name": "Продукты питания", "PackagingType": 1, "PackagingQuantity": 20, "Weight": 20, "Volume": 82, "Sizes": { "Length": 13.6, "Width": 2.45, "Height": 2.7, "Diameter": 1.2, "LengthHighlight": false, "WidthHighlight": false, "HeightHighlight": false } } ] }, "ExtraPoints": [ { "CityId": 1, "PointType": 2, "Latitude": 59.939095, "Longitude": 30.315868, "Street": "пр. Ленина, 10", "OrganizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "AddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "OrdinalId": 1, "IsRoundTheClock": false, "LoadingDateStart": "2026-09-09T00:00:00.000Z", "LoadingDateEnd": "2026-09-09T00:00:00.000Z", "LoadingTimeStart": "09:00:00", "LoadingTimeEnd": "18:00:00", "LoadingCargos": [ { "CargoId": 1, "NameId": 1, "Name": "Продукты питания", "PackagingType": 1, "PackagingQuantity": 20, "Weight": 20, "Volume": 82, "Sizes": { "Length": 13.6, "Width": 2.45, "Height": 2.7, "Diameter": 1.2, "LengthHighlight": false, "WidthHighlight": false, "HeightHighlight": false } } ], "UnloadingCargos": [ { "CargoId": 1, "Weight": 10, "Volume": 40, "PackagingQuantity": 10, "IsDefinedByTtn": false } ] } ], "Unloading": { "CityId": 1, "Latitude": 59.939095, "Longitude": 30.315868, "Street": "ул. Салова, 57", "OrganizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "AddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "TimeStart": "2026-09-08T09:00:00.000Z", "TimeEnd": "2026-09-08T18:00:00.000Z", "IsRoundTheClock": false, "LargeCities": [ 0 ], "LoadingCargos": [ { "CargoId": 1, "NameId": 1, "Name": "Продукты питания", "PackagingType": 1, "PackagingQuantity": 20, "Weight": 20, "Volume": 82, "Sizes": { "Length": 13.6, "Width": 2.45, "Height": 2.7, "Diameter": 1.2, "LengthHighlight": false, "WidthHighlight": false, "HeightHighlight": false } } ] }, "Cargo": { "Weight": 20, "Volume": 82, "ADR": 0, "CargoTypeId": 59, "CargoType": "Стройматериалы", "PackType": 1, "PalletCount": 33, "BeltCount": 0, "DogruzType": 1, "SborGruz": false, "Size": { "Length": 13.6, "Width": 2.45, "Height": 2.7, "Diameter": 1.2, "LengthHighlight": false, "WidthHighlight": false, "HeightHighlight": false } }, "Transport": { "CarType": 5, "CarTypeString": "5", "LoadingType": 3, "LoadingLogicalOperator": "OR", "UnloadingType": 3, "UnloadingLogicalOperator": "OR", "TrucksQuantity": 1, "TemperatureFrom": -18, "TemperatureTo": 4, "Stsepka": false, "Pnevmohod": false, "Koniki": false, "TIR": false, "CMR": false, "T1": false, "SanPassport": false, "IsTracking": false, "RequiredCapacity": 20 }, "Payment": { "CurrencyId": 1, "MoneyType": 22, "RateSum": 85000, "SumWithNDS": 102000, "SumWithoutNDS": 85000, "PrepayPercent": 30, "PrepayPercentEnabled": true, "PayDays": 5, "PayDaysEnabled": true, "FixedRate": true, "Torg": false, "DirectContract": false, "InFuel": false, "OnUnloading": false, "HideResponses": false, "AcceptPaymentTypes": 0 }, "InviteSettings": { "InviteDelayInSeconds": 600, "InviteDurationInSeconds": 3600, "MaxPercentDeviation": 10, "NeedArchiveOnInvite": false }, "PriorityView": { "DailyLimit": 500, "IsForPayedOnly": false, "OrderLimit": 100, "ViewRate": 1.5 }, "Stealth": { "ListIdToHide": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "FirmRegDateToHide": "2024-01-01T00:00:00.000Z", "ScoreToHide": 3 }, "LoadFiles": [ { "FileId": "a1b2c3d4e5f6a7b8c9d0e1f2", "FileType": 1, "Attributes": 0, "Name": "Договор.pdf", "Link": "https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2", "Size": -1 } ], "Deal": { "Auction": { "StartRate": 50000, "Currency": 1, "Step": 500, "PaymentType": 0, "AcceptSecondPayType": false, "StartDate": "2026-09-08T09:00:00.000Z", "EndDate": "2026-09-08T12:00:00.000Z", "EndDateBoundary": "2026-09-09T09:00:00.000Z", "Nds": 20, "TimeToProvideDocuments": 4, "AutoRenew": true, "RenewTime": 5, "MaxRenewTime": 30, "RaiseBid": false, "MaxRate": 60000, "RaiseBidInterval": 30, "ResponseInMinutes": 15, "Duration": 180, "StartSinceFirstBet": false, "AuctionRestartParameters": { "AuctionFinishAction": 0, "InitRestartCount": 1, "InitChangeWinnerCount": 1, "DurationAfterRestart": 120, "RateIncrease": 500, "RateIncreaseOption": 1 }, "AcceptCounterOffersOnlyBeforeFirstBet": false, "WinnerCriterion": 0, "Source": 0 } }, "Boards": [ { "BoardId": "a0a0a0a0a0a0a0a0a0a0a0a0", "PublicationTime": "2026-09-08T12:00:00.000Z", "IsReservationEnabled": false, "PublicationOption": 0 } ], "UnloadFirstDate": "2026-09-11T00:00:00.000Z", "UnloadLastDate": "2026-09-12T00:00:00.000Z" }

Получение одного груза

Версия 2 2 (прежний адрес) 1.0

Получить опубликованную заявку на груз. API для интеграции. Возвращает опубликованную заявку на груз текущего пользователя.

get /gw/cargos_create_v2/integration/v2/cargos/{cargoApplicationId}

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoApplicationId обязательный	string (uuid)	path	Идентификатор заявки на груз. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargos_create_v2/integration/v2/cargos/{cargoApplicationId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargos_create_v2/integration/v2/cargos/{cargoApplicationId}");

Ответ

200 Заявка на груз найдена и возвращена.

Модель

{...}

Контракт заявки груза, ожидаемый в ответах integration http методов работы с грузами

cargo_id: uuid

ID груза OBSOLETE используй поле CargoApplicationId

cargo_number: string

Номер груза, автоматически генерируемый ATI.SU OBSOLETE используй поле CargoApplicationNumber

source: int32

OBSOLETE используй поле OriginSource

contacts: [int32]

Контакты OBSOLETE используй поле ApplicationContacts

distance: int32

Дистанция, км

cargo_application_id*: uuid

Id груза

snapshot_id*: int64

Id состояния груза (меняется при каждом редактировании)

cargo_application_number*: string

Номер груза, автоматически генерируемый ATI.SU

department_id*: int32

Подразделение, которому принадлежит заявка.

persistent_user_id*: int32

Идентификатор пользователя, разместившего заявку

actor_contact_id: int32

Идентификатор контакта, разместившего заявку

external_id: null,string

Внешний номер груза или заказа

added_at*: date-time

Время добавления груза, UTC

updated_at*: date-time

Время последнего изменения груза, UTC

refreshed_at: date-time

Время последнего поднятия груза, UTC

origin_source*: string

Использованный api при создания груза: - web-cargos-api, - mobile-cargos-api, - public-cargos-api

route*:{...}

Маршрут

loading*:{...}

Основная точка загрузки — начало маршрута. Здесь даты загрузки и грузы, которые забирают в начале маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates*:{...}

Даты загрузки. Вид задаёт дискриминатор type.

type: enum

[from-date]

Тип даты — в промежутке дат (from-date).

from-datereadypermanentrate-request

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

is_available_tomorrow*: boolean

Готов к загрузке сегодня и завтра (TODO возможно убрать)

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

periodicity*: string

Периодичность постоянной загрузки: - everyday — "каждый день" - workdays — "по рабочим дням"

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

}

cargos*:[{...}]

Грузы заявки. cargo_id сквозной по всей заявке: по нему точки разгрузки указывают, что снимают.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

unloading*:{...}

Основная точка разгрузки — конец маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates:

Даты разгрузки. Могут быть не заданы.

ONE-OF

1:{...}

Даты разгрузки. Значима календарная дата, а не момент времени: день определяется по смещению в значении.

first_date: date-time

Первый день разгрузки.

last_date: date-time

Последний день разгрузки.

time:

Время разгрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

way_points:[{...}]

Промежуточные точки между загрузкой и разгрузкой, не больше 15, в порядке проезда.

type: enum

[loading]

Тип промежуточной точки — точка загрузки (loading).

loadingunloadingcustomsgo-through

cargos:[{...}]

Грузы, которые забирают в этой точке.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

loading_date:

Дата и время загрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

cargos:[{...}]

Грузы, которые снимают в этой точке.

packaging_quantity: int32

Снимаемое количество упаковок.

is_defined_by_ttn: null,boolean

Снимаемая часть груза будет определена в ТТН.

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

unloading_date:

Дата и время разгрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}]

is_round_trip: null,boolean

Кругорейс

}

truck*:{...}

Транспорт

trucks_count*: int32

Количество машин

load_type*: string

Загрузка: - ftl — отдельной машиной - dont-care — не важно

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

is_tracking*: boolean

Трекинг через АТИ Водитель

adr: int32

ADR

belts_count: int32

Количество ремней

required_capacity: double

Требуемая грузоподъемность в тоннах

body_loading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

body_unloading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

temperature:

Температура

ONE-OF

1:{...}

Температура.

from: int32

От

to: int32

До

}

null

documents:

Разрешения

ONE-OF

1:{...}

Разрешения транспорта.

tir*: boolean

TIR

cmr*: boolean

CMR

t1*: boolean

T1

medical_card*: boolean

Медкнижка

}

null

requirements:

Требования

ONE-OF

1:{...}

Требования к транспорту.

logging_truck*: boolean

Коники

road_train*: boolean

Сцепка

air_suspension*: boolean

Пневмоход

team_driving*: boolean

Для груза необходимы два водителя

}

null

}

payment*:{...}

Оплата

type: enum

[with-bargaining]

Тип оплаты — с возможностью торга (with-bargaining).

with-bargainingwithout-bargainingrate-requestauction

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

auction_id*: uuid

Id Торгов

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты из словаря валют

bid_step*: double

Шаг ставки Торгов

accept_bids_with_vat*: boolean

Принимать ставки с НДС

accept_bids_without_vat: null,boolean

Принимать ставки без НДС

vat_percents: int32

Размер НДС, в процентах

is_antisniper*: boolean

Опция Антиснайпер

time_to_provide_documents*: string

Время, за которое победитель обязан предоставить документы

winner_criteria*: string

Критерий выбора победителя: best-rate — по лучшей ставке matching-date — с учётом даты загрузки и лучшей ставки

winner_reselection_count: int32

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: null,string

Может быть null, если есть значение у поля FinishUntil. Длительность проведения Торгов: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов 1d — 1 день 2d — 2 дня 3d — 3 дня 4d — 4 дня 5d — 5 дней

count_from_first_bid*: boolean

Отсчитывать длительность Торгов с момента первой ставки

finish_until: date-time

Точные дата и время завершения Торгов

}

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type: enum

[archive]

Действие — переместить заявку в архив (archive).

archivepublish-with-ratepublish-rate-request

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

}

accept_counter_offers:

Параметры доступности встречных предложений во время проведения Торгов

ONE-OF

1:{...}

Параметры доступности встречных предложений во время Торгов.

acceptance_delay: null,string

Может быть null, в таком случае будем принимать встречные предложения сразу. Принимать встречные предложения через: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

until_first_bid*: boolean

Принимать встречные предложения до первой ставки по Торгам

}

null

auto_renew:

Параметры автопродления Торгов

ONE-OF

1:{...}

Параметры автопродления Торгов.

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

null

rate_rise:

Параметры повышения ставки Торгов при отсутствии ставок

ONE-OF

1:{...}

Параметры повышения ставки Торгов при отсутствии ставок.

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

null

auction_restart:

Параметры перезапуска Торгов в случае отсутствия ставок

ONE-OF

1:{...}

Параметры перезапуска Торгов при отсутствии ставок.

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов

rate_increase:

Параметры повышения начальной ставки после перезапуска торгов.

ONE-OF

1:{...}

Параметры повышения начальной ставки после перезапуска Торгов.

type: enum

[currency]

Тип повышения — абсолютное значение в валюте (currency).

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

null

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

}

boards*:[{...}]

Площадки груза

id*: string

Id площадки

publication_mode*: string

Опубликовать груз: now – сразу 15m – через 15 минут 30m – через 30 минут 1h – через час 3h – через 3 часа 6h – через 6 часов exact-time - в точное время

publication_time*: date-time

Точное время публикации груза, для publication_mode = 'exact-time'

cancel_publish_on_auction_bet*: boolean

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

publication_restriction: integer

Стратегия ограничений публикации груза на площадке

reservation_enabled*: boolean

Разрешить перевозчикам бронировать груз

is_published*: boolean

Груз опубликован на площадке

}]

documents:[{...}]

Фото груза и документов

id: string

Старый id документа OBSOLETE используй поле FileID

file_id*: string

Id документа в API Плюшкин (TODO ссылка)

name*: string

Название документа

link*: string

Ссылка на документ

}]

application_contacts*:[{...}]

Информация о контактах груза

id*: int32

Id контакта

}]

paid_features:

Платные услуги

ONE-OF

1:{...}

Платные услуги: приоритетный показ, стелс.

priority_view:

Приоритетный показ

ONE-OF

1:{...}

Приоритетный показ.

money_spent_per_day: double

Потрачено атисов за день OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

money_spent_per_order: double

Потрачено атисов на эту заявку OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

rate*: double

Ставка за просмотр

only_for_paid_users*: boolean

Показывать приоритетный груз только платным пользователям

limit: double

Лимит на заявку

daily_limit: double

Суточный лимит

}

null

stealth:

Стэлс

ONE-OF

1:{...}

Стелс.

list_id: uuid

Id списка фирм для скрытия

minimal_registration_date: date-time

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32

Минимальное количество звёзд фирм, которые будут видеть груз

}

null

}

null

note: null,string

Примечание к грузу

lot_id: uuid

Id Лота, к которому прикреплён данный груз

lot_number: int32

Номер Лота, к которому прикреплён данный груз

is_pass_through_copy: null,boolean

Является ли груз сквозной копией

is_archived: null,boolean

Отправлен ли груз в архив

archive_date: date-time

Время отправки груза в архив, UTC

true_price: int32

Истинная ставка на груз после жалоб "Озвученная ставка"

true_currency_id: int32

Истинная валюта ставки на груз после жалоб "Озвученная ставка"

client_application_id: null,string

Идентификатор интегратора (клиентского приложения), через которое был создан груз

}

Пример

{...}

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"ABC1234",

"source":2,

"contacts":[...],

0

],

"distance":1794,

"cargo_application_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"snapshot_id":1000500,

"cargo_application_number":"ABC1234",

"department_id":7654321,

"persistent_user_id":1234567,

"actor_contact_id":0,

"external_id":"EXT-12345",

"added_at":"2024-01-15T10:30:00+00:00",

"updated_at":"2024-01-15T10:30:00+00:00",

"refreshed_at":"2024-01-15T10:30:00+00:00",

"origin_source":"public-cargos-api",

"route":{...},

"loading":{...},

"near_cities":[...],

0

],

"dates":{...},

"type":"from-date",

"time":{...},

"0":"?"

},

"first_date":"2024-08-27T00:00:00+03:00",

"last_date":"2024-08-29T00:00:00+03:00"

},

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"unloading":{...},

"near_cities":[...],

0

],

"dates":{...},

"0":"?"

},

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"way_points":[...],

{...}

"type":"loading",

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"loading_date":{...},

"0":"?"

},

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

}

],

"is_round_trip":true

},

"truck":{...},

"trucks_count":1,

"load_type":"ftl",

"body_types":[...],

0

],

"is_tracking":true,

"adr":3,

"belts_count":4,

"required_capacity":20,

"body_loading":{...},

"0":"?"

},

"body_unloading":{...},

"0":"?"

},

"temperature":{...},

"0":"?"

},

"documents":{...},

"0":"?"

},

"requirements":{...}

"0":"?"

}

},

"payment":{...},

"type":"with-bargaining",

"auto_invites_settings":{...},

"0":"?"

},

"currency_type":1,

"rate_with_vat":50000,

"rate_without_vat":50000,

"cash":50000,

"on_card":true,

"rates_with_vat":[...],

{...}

"rate_with_vat":50000,

"vat_percent":22

}

],

"hide_counter_offers":true,

"direct_offer":true,

"prepayment":{...},

"0":"?"

},

"payment_mode":{...}

"0":"?"

}

},

"boards":[...],

{...}

"id":"a0a0a0a0a0a0a0a0a0a0a0a0",

"publication_mode":"now",

"publication_time":"2024-01-15T10:30:00+00:00",

"cancel_publish_on_auction_bet":true,

"publication_restriction":0,

"reservation_enabled":true,

"is_published":true

}

],

"documents":[...],

{...}

"id":"9c6cce94-c0e3-eb11-bb99-002590fdcfdb",

"file_id":"6b35842b8386446c82a43726f139abe1",

"name":"Транспортная накладная.pdf",

"link":"https://api.ati.su/webapi/filestorage/files/6b35842b8386446c82a43726f139abe1"

}

],

"application_contacts":[...],

{...}

"id":0

}

],

"paid_features":{...},

"0":"?"

},

"note":"Тестовый груз",

"lot_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"lot_number":38,

"is_pass_through_copy":true,

"is_archived":true,

"archive_date":"2024-01-15T10:30:00+00:00",

"true_price":50000,

"true_currency_id":1,

"client_application_id":"ati"

}

404 Заявка на груз не найдена.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

cargoApplicationId Идентификатор заявки на груз.

Получить опубликованную заявку на груз. API для интеграции. Возвращает опубликованную заявку на груз текущего пользователя.

Прежний адрес метода. Он продолжает работать, но для новых интеграций используйте актуальную версию.

get /v2/cargos/{cargoApplicationId}

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoApplicationId обязательный	string (uuid)	path	Идентификатор заявки на груз. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v2/cargos/{cargoApplicationId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v2/cargos/{cargoApplicationId}");

Ответ

200 Заявка на груз найдена и возвращена.

Модель

{...}

Контракт заявки груза, ожидаемый в ответах integration http методов работы с грузами

cargo_id: uuid

ID груза OBSOLETE используй поле CargoApplicationId

cargo_number: string

Номер груза, автоматически генерируемый ATI.SU OBSOLETE используй поле CargoApplicationNumber

source: int32

OBSOLETE используй поле OriginSource

contacts: [int32]

Контакты OBSOLETE используй поле ApplicationContacts

distance: int32

Дистанция, км

cargo_application_id*: uuid

Id груза

snapshot_id*: int64

Id состояния груза (меняется при каждом редактировании)

cargo_application_number*: string

Номер груза, автоматически генерируемый ATI.SU

department_id*: int32

Подразделение, которому принадлежит заявка.

persistent_user_id*: int32

Идентификатор пользователя, разместившего заявку

actor_contact_id: int32

Идентификатор контакта, разместившего заявку

external_id: null,string

Внешний номер груза или заказа

added_at*: date-time

Время добавления груза, UTC

updated_at*: date-time

Время последнего изменения груза, UTC

refreshed_at: date-time

Время последнего поднятия груза, UTC

origin_source*: string

Использованный api при создания груза: - web-cargos-api, - mobile-cargos-api, - public-cargos-api

route*:{...}

Маршрут

loading*:{...}

Основная точка загрузки — начало маршрута. Здесь даты загрузки и грузы, которые забирают в начале маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates*:{...}

Даты загрузки. Вид задаёт дискриминатор type.

type: enum

[from-date]

Тип даты — в промежутке дат (from-date).

from-datereadypermanentrate-request

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

is_available_tomorrow*: boolean

Готов к загрузке сегодня и завтра (TODO возможно убрать)

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

periodicity*: string

Периодичность постоянной загрузки: - everyday — "каждый день" - workdays — "по рабочим дням"

time:

Время загрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

first_date*: date-time

Первый день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

last_date*: date-time

Последний день, когда груз можно забрать. Приходит при любом type, в том числе ready и permanent.

}

cargos*:[{...}]

Грузы заявки. cargo_id сквозной по всей заявке: по нему точки разгрузки указывают, что снимают.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

unloading*:{...}

Основная точка разгрузки — конец маршрута.

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates:

Даты разгрузки. Могут быть не заданы.

ONE-OF

1:{...}

Даты разгрузки. Значима календарная дата, а не момент времени: день определяется по смещению в значении.

first_date: date-time

Первый день разгрузки.

last_date: date-time

Последний день разгрузки.

time:

Время разгрузки в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

nearby_cities:[{...}]

Ближайшие крупные города, не больше 10.

id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

distance: double

Расстояние от точки маршрута до этого города, километры.

}]

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}

way_points:[{...}]

Промежуточные точки между загрузкой и разгрузкой, не больше 15, в порядке проезда.

type: enum

[loading]

Тип промежуточной точки — точка загрузки (loading).

loadingunloadingcustomsgo-through

cargos:[{...}]

Грузы, которые забирают в этой точке.

name_id*: int32

Id наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → id

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

Упаковка груза.

type*: int32

Id типа упаковки. dict: GET /v1.0/dictionaries/packTypes → id

quantity: int32

Количество

}

null

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

loading_date:

Дата и время загрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

cargos:[{...}]

Грузы, которые снимают в этой точке.

packaging_quantity: int32

Снимаемое количество упаковок.

is_defined_by_ttn: null,boolean

Снимаемая часть груза будет определена в ТТН.

cargo_id*: int32

Номер груза, сквозной по всей заявке. По нему точки разгрузки указывают, какой именно груз снимают.

weight:

Вес

ONE-OF

1:{...}

Вес груза.

type*: string

Тип: - tons — тонны - kilos — килограммы

quantity*: double

Количество

}

null

volume:

Объём

ONE-OF

1:{...}

Объём груза.

quantity*: double

Количество

}

null

sizes:

Габариты

ONE-OF

1:{...}

Габариты груза.

length:

Длина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

height:

Высота, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

width:

Ширина, метры

ONE-OF

1:{...}

Габаритный размер.

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

null

diameter: double

Диаметр, метры

}

null

}]

unloading_date:

Дата и время разгрузки в этой точке.

ONE-OF

1:{...}

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

first_date: date-time

Первый день, когда машина может приехать в точку.

last_date: date-time

Последний день, когда машина может приехать в точку.

time:

Время прибытия в пределах дня.

ONE-OF

1:{...}

Время в пределах дня. Вид задаёт дискриминатор type. Часовой пояс времени приходит полем offset и не связан со смещением в датах.

type: enum

[bounded]

Тип времени — с ограничением (bounded).

boundedround-the-clock

start: null,string

Начало интервала в формате HH:mm.

end: null,string

Конец интервала в формате HH:mm.

offset: null,string

Часовой пояс интервала в формате +HH:mm.

}

null

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

city*:{...}

Населённый пункт точки.

city_id*: int32

Id города. dict: GET /v1.0/dictionaries/cities → id

region_id: int32

Id региона. dict: GET /v1.0/dictionaries/regions → id

country_id: int32

Id страны. dict: GET /v1.0/dictionaries/countries → id

}

coordinates:

Координаты точки.

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

Адрес в населённом пункте.

organization:

Организация из справочника, если адрес точки был взят оттуда. Иначе не заполнена.

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель. Её адрес указан в точке маршрута.

organization_id*: uuid

Id организации. dict: GET /v1.2/catalogs/organizations → id

address_id*: uuid

Id адреса организации. dict: GET /v1.2/catalogs/organizations/addresses → id

}

null

}]

is_round_trip: null,boolean

Кругорейс

}

truck*:{...}

Транспорт

trucks_count*: int32

Количество машин

load_type*: string

Загрузка: - ftl — отдельной машиной - dont-care — не важно

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

is_tracking*: boolean

Трекинг через АТИ Водитель

adr: int32

ADR

belts_count: int32

Количество ремней

required_capacity: double

Требуемая грузоподъемность в тоннах

body_loading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

body_unloading:

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

ONE-OF

1:{...}

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

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

null

temperature:

Температура

ONE-OF

1:{...}

Температура.

from: int32

От

to: int32

До

}

null

documents:

Разрешения

ONE-OF

1:{...}

Разрешения транспорта.

tir*: boolean

TIR

cmr*: boolean

CMR

t1*: boolean

T1

medical_card*: boolean

Медкнижка

}

null

requirements:

Требования

ONE-OF

1:{...}

Требования к транспорту.

logging_truck*: boolean

Коники

road_train*: boolean

Сцепка

air_suspension*: boolean

Пневмоход

team_driving*: boolean

Для груза необходимы два водителя

}

null

}

payment*:{...}

Оплата

type: enum

[with-bargaining]

Тип оплаты — с возможностью торга (with-bargaining).

with-bargainingwithout-bargainingrate-requestauction

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Настройки автоматического приглашения на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

auction_id*: uuid

Id Торгов

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты из словаря валют

bid_step*: double

Шаг ставки Торгов

accept_bids_with_vat*: boolean

Принимать ставки с НДС

accept_bids_without_vat: null,boolean

Принимать ставки без НДС

vat_percents: int32

Размер НДС, в процентах

is_antisniper*: boolean

Опция Антиснайпер

time_to_provide_documents*: string

Время, за которое победитель обязан предоставить документы

winner_criteria*: string

Критерий выбора победителя: best-rate — по лучшей ставке matching-date — с учётом даты загрузки и лучшей ставки

winner_reselection_count: int32

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: null,string

Может быть null, если есть значение у поля FinishUntil. Длительность проведения Торгов: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов 1d — 1 день 2d — 2 дня 3d — 3 дня 4d — 4 дня 5d — 5 дней

count_from_first_bid*: boolean

Отсчитывать длительность Торгов с момента первой ставки

finish_until: date-time

Точные дата и время завершения Торгов

}

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type: enum

[archive]

Действие — переместить заявку в архив (archive).

archivepublish-with-ratepublish-rate-request

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double

Ставка безнал с НДС

rate_without_vat: double

Ставка безнал без НДС

cash: double

Ставка наличными

on_card: null,boolean

Возможность отправлять наличные на карту

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

rates_with_vat:[{...}]

Безналичные ставки с НДС — не больше одной на процент

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент. Допустимые значения задаёт словарь валют — атрибут vat_percents

}]

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:

Автоматическое приглашение на лучшее встречное предложение

ONE-OF

1:{...}

Настройки автоматического приглашения на встречные предложения.

invite_delay*: string

Период приема встречного предложения до автоматического приглашения (в формате 30m, 1h, 2d).

invite_duration*: string

Период действия автоматического приглашения (в формате 30m, 1h, 2d).

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

null

}

accept_counter_offers:

Параметры доступности встречных предложений во время проведения Торгов

ONE-OF

1:{...}

Параметры доступности встречных предложений во время Торгов.

acceptance_delay: null,string

Может быть null, в таком случае будем принимать встречные предложения сразу. Принимать встречные предложения через: - 30m — 30 минут - 1h — 1 час - 2h — 2 часа - 3h — 3 часа - 4h — 4 часа - 6h — 6 часов - 12h — 12 часов

until_first_bid*: boolean

Принимать встречные предложения до первой ставки по Торгам

}

null

auto_renew:

Параметры автопродления Торгов

ONE-OF

1:{...}

Параметры автопродления Торгов.

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

null

rate_rise:

Параметры повышения ставки Торгов при отсутствии ставок

ONE-OF

1:{...}

Параметры повышения ставки Торгов при отсутствии ставок.

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

null

auction_restart:

Параметры перезапуска Торгов в случае отсутствия ставок

ONE-OF

1:{...}

Параметры перезапуска Торгов при отсутствии ставок.

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов

rate_increase:

Параметры повышения начальной ставки после перезапуска торгов.

ONE-OF

1:{...}

Параметры повышения начальной ставки после перезапуска Торгов.

type: enum

[currency]

Тип повышения — абсолютное значение в валюте (currency).

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

null

}

null

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

null

payment_mode:

Режим оплаты

ONE-OF

1:{...}

Режим оплаты.

type: enum

[delayed-payment]

Тип режима оплаты — через несколько дней (delayed-payment).

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

null

}

boards*:[{...}]

Площадки груза

id*: string

Id площадки

publication_mode*: string

Опубликовать груз: now – сразу 15m – через 15 минут 30m – через 30 минут 1h – через час 3h – через 3 часа 6h – через 6 часов exact-time - в точное время

publication_time*: date-time

Точное время публикации груза, для publication_mode = 'exact-time'

cancel_publish_on_auction_bet*: boolean

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

publication_restriction: integer

Стратегия ограничений публикации груза на площадке

reservation_enabled*: boolean

Разрешить перевозчикам бронировать груз

is_published*: boolean

Груз опубликован на площадке

}]

documents:[{...}]

Фото груза и документов

id: string

Старый id документа OBSOLETE используй поле FileID

file_id*: string

Id документа в API Плюшкин (TODO ссылка)

name*: string

Название документа

link*: string

Ссылка на документ

}]

application_contacts*:[{...}]

Информация о контактах груза

id*: int32

Id контакта

}]

paid_features:

Платные услуги

ONE-OF

1:{...}

Платные услуги: приоритетный показ, стелс.

priority_view:

Приоритетный показ

ONE-OF

1:{...}

Приоритетный показ.

money_spent_per_day: double

Потрачено атисов за день OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

money_spent_per_order: double

Потрачено атисов на эту заявку OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

rate*: double

Ставка за просмотр

only_for_paid_users*: boolean

Показывать приоритетный груз только платным пользователям

limit: double

Лимит на заявку

daily_limit: double

Суточный лимит

}

null

stealth:

Стэлс

ONE-OF

1:{...}

Стелс.

list_id: uuid

Id списка фирм для скрытия

minimal_registration_date: date-time

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32

Минимальное количество звёзд фирм, которые будут видеть груз

}

null

}

null

note: null,string

Примечание к грузу

lot_id: uuid

Id Лота, к которому прикреплён данный груз

lot_number: int32

Номер Лота, к которому прикреплён данный груз

is_pass_through_copy: null,boolean

Является ли груз сквозной копией

is_archived: null,boolean

Отправлен ли груз в архив

archive_date: date-time

Время отправки груза в архив, UTC

true_price: int32

Истинная ставка на груз после жалоб "Озвученная ставка"

true_currency_id: int32

Истинная валюта ставки на груз после жалоб "Озвученная ставка"

client_application_id: null,string

Идентификатор интегратора (клиентского приложения), через которое был создан груз

}

Пример

{...}

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"ABC1234",

"source":2,

"contacts":[...],

0

],

"distance":1794,

"cargo_application_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"snapshot_id":1000500,

"cargo_application_number":"ABC1234",

"department_id":7654321,

"persistent_user_id":1234567,

"actor_contact_id":0,

"external_id":"EXT-12345",

"added_at":"2024-01-15T10:30:00+00:00",

"updated_at":"2024-01-15T10:30:00+00:00",

"refreshed_at":"2024-01-15T10:30:00+00:00",

"origin_source":"public-cargos-api",

"route":{...},

"loading":{...},

"near_cities":[...],

0

],

"dates":{...},

"type":"from-date",

"time":{...},

"0":"?"

},

"first_date":"2024-08-27T00:00:00+03:00",

"last_date":"2024-08-29T00:00:00+03:00"

},

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"unloading":{...},

"near_cities":[...],

0

],

"dates":{...},

"0":"?"

},

"nearby_cities":[...],

{...}

"id":3611,

"distance":25

}

],

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

},

"way_points":[...],

{...}

"type":"loading",

"cargos":[...],

{...}

"name_id":112,

"name":"Автомобиль(ли)",

"packaging":{...},

"0":"?"

},

"cargo_id":1,

"weight":{...},

"0":"?"

},

"volume":{...},

"0":"?"

},

"sizes":{...}

"0":"?"

}

}

],

"loading_date":{...},

"0":"?"

},

"city_id":3611,

"city":{...},

"city_id":3611,

"region_id":21,

"country_id":1

},

"coordinates":{...},

"0":"?"

},

"address":"ул. Набережная, д. 12",

"organization":{...}

"0":"?"

}

}

],

"is_round_trip":true

},

"truck":{...},

"trucks_count":1,

"load_type":"ftl",

"body_types":[...],

0

],

"is_tracking":true,

"adr":3,

"belts_count":4,

"required_capacity":20,

"body_loading":{...},

"0":"?"

},

"body_unloading":{...},

"0":"?"

},

"temperature":{...},

"0":"?"

},

"documents":{...},

"0":"?"

},

"requirements":{...}

"0":"?"

}

},

"payment":{...},

"type":"with-bargaining",

"auto_invites_settings":{...},

"0":"?"

},

"currency_type":1,

"rate_with_vat":50000,

"rate_without_vat":50000,

"cash":50000,

"on_card":true,

"rates_with_vat":[...],

{...}

"rate_with_vat":50000,

"vat_percent":22

}

],

"hide_counter_offers":true,

"direct_offer":true,

"prepayment":{...},

"0":"?"

},

"payment_mode":{...}

"0":"?"

}

},

"boards":[...],

{...}

"id":"a0a0a0a0a0a0a0a0a0a0a0a0",

"publication_mode":"now",

"publication_time":"2024-01-15T10:30:00+00:00",

"cancel_publish_on_auction_bet":true,

"publication_restriction":0,

"reservation_enabled":true,

"is_published":true

}

],

"documents":[...],

{...}

"id":"9c6cce94-c0e3-eb11-bb99-002590fdcfdb",

"file_id":"6b35842b8386446c82a43726f139abe1",

"name":"Транспортная накладная.pdf",

"link":"https://api.ati.su/webapi/filestorage/files/6b35842b8386446c82a43726f139abe1"

}

],

"application_contacts":[...],

{...}

"id":0

}

],

"paid_features":{...},

"0":"?"

},

"note":"Тестовый груз",

"lot_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"lot_number":38,

"is_pass_through_copy":true,

"is_archived":true,

"archive_date":"2024-01-15T10:30:00+00:00",

"true_price":50000,

"true_currency_id":1,

"client_application_id":"ati"

}

404 Заявка на груз не найдена.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

cargoApplicationId Идентификатор заявки на груз.

Получение груза по идентификатору. API для интеграции. Отдаётся только опубликованный груз вашей фирмы; чужой или архивный груз отвечает 404.

Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

get /v1.0/loads/{loadId}

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/{loadId}");

Ответ

200 Груз.

Модель

{...}

Груз в ответе: поля публикации и вычисляемые сервисом.

LoadMeta:

Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией

ONE-OF

1:{...}

Метаданные публикации.

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные. Максимальная длина 1024 символа

}

ContactId1*: int32

Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id. Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами. Контакт должен быть виден для остальных участников АТИ

ContactId2: int32 (nullable)

Идентификатор второго выбранного контакта, если не выбрано, то null. Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу. Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC. Минимальное значение равно текущей дате. При значении параметра DateType равным 0, допустимое значение поля - текущая дата. При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед. При значении параметра DateType равным 2, допустимое значение поля - текущая дата. При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC. Минимальное значение равно значению параметра FirstDate. При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед. При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед. При значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется. При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Тип готовности груза к перевозке, по умолчанию 0

• 0 - Готов к загрузке
• 1 - в период с FirstDate по LastDate
• 2 - постоянно
• 3 - груза нет, запрос ставки

PeriodicityId: int32

Периодичность загрузки. Если параметр DateType не равен 2, PeriodicityId равен 0. Иначе PeriodicityId может принимать следующие значения:

• 1 - ежедневно
• 100 - по рабочим дням

OrderNumber: string

Номер заказа. Ограничение по длине: 250 символов

Krugoreis: boolean

Включён ли кругорейс

Loading*:

Точка погрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

ExtraPoints:[{...}]

Дополнительные пункты маршрута между погрузкой и выгрузкой.
Максимум 15 штук. Может иметь значение null

CityId*: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

PointType*: int32

Тип точки:

• 1 - загрузка
• 2 - разгрузка
• 3 - таможня
• 8 - проехать через

Latitude: decimal (nullable)

Широта точки. Допустимое значение от -90 до 90; указывается вместе с долготой

Longitude: decimal (nullable)

Долгота точки. Допустимое значение от -180 до 180; указывается вместе с широтой

Street: string

Улица или район. Максимальная длина 200 символов

OrganizationId: guid (nullable)

Организация, принимающая или отгружающая груз в этой точке. Указывается только вместе с AddressId

AddressId: guid (nullable)

Адрес точки. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

OrdinalId: int32

Порядок точки на маршруте. Если у всех точек 0, сервис нумерует их по порядку списка

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeStart: string (nullable)

Время начала загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeEnd: string (nullable)

Время окончания загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingCargos:[{...}]

Позиции груза, которые берут в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

UnloadingCargos:[{...}]

Позиции груза, которые оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза (CargoId из точки загрузки)

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

PackagingQuantity: int32 (nullable)

Количество выгружаемых мест

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

}]

Unloading*:

Точка выгрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

Cargo*:

Что везём: наименование, вес, объём, упаковка

ONE-OF

1:{...}

Описание груза: что и сколько везём.

Weight: double

Вес груза в тоннах. Обязательный параметр, если не задан параметр Volume. Допустимое значение 0 либо от 0,001 до 9999, не более 3 знаков после запятой

Volume: double

Объём груза в кубических метрах. Обязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа

ADR: int32

Класс опасности груза по ADR. Допустимое значение от 0 до 9, по умолчанию 0. Для CargoTypeId = 53 обязателен ненулевой

CargoTypeId*: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes

CargoType: string

Наименование груза текстом. Обязательный параметр: при CargoTypeId = 59 («другое») это и есть наименование груза. Максимальная длина названия - 200 символов. В этом поле запрещено указывать контактную информацию

PackType: int32

Идентификатор типа упаковки (навалом, коробки, россыпью), 0 — упаковка не указана. dict: GET /v1.0/dictionaries/packTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-packTypes

PalletCount: int32

Количество упаковок для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

• 1 - только отдельной машиной
• 2 - отдельной или догрузом
• 3 - только догрузом

SborGruz: boolean

Сборный груз

Size:

Параметры размера груза

ONE-OF

1:{...}

Габариты груза.

Length: double

Длина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

HeightHighlight: boolean

Выделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

}

}

Transport*:

Требования к транспорту: кузов, варианты загрузки и выгрузки

ONE-OF

1:{...}

Требования к транспорту.

CarType*: int64

Битовая маска типов кузова: идентификаторы из справочника — степени двойки, несколько кузовов складываются (1 + 4 = 5). dict: GET /v1.0/dictionaries/carTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes

CarTypeString: string

Та же битовая маска типов кузова строкой. Только в ответе: в запросе значение игнорируется

LoadingType: int32

Битовая маска вариантов загрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/loadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes

LoadingLogicalOperator: string

Тип условия загрузки:

• OR - необходимо, чтобы присутствовал один из способов загрузки
• AND - необходимо, чтобы присутствовали все выбранные типы загрузки

UnloadingType: int32

Битовая маска вариантов разгрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/unloadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-unloadingTypes

UnloadingLogicalOperator: string

Тип условия разгрузки:

• OR - необходимо, чтобы присутствовал один из способов разгрузки
• AND - необходимо, чтобы присутствовали все выбранные типы разгрузки

TrucksQuantity: int32

Количество машин. Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

Минимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

TemperatureTo: int32 (nullable)

Максимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

Stsepka: boolean

Нужна ли сцепка для груза

Pnevmohod: boolean

Нужен ли пневмоход для груза

Koniki: boolean

Нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

Документы на транспорт, необходимые для провоза этого груза: медкнижка

IsTracking: boolean

Трекинг через АТИ Водитель

RequiredCapacity: double (nullable)

Требуемая грузоподъемность в тоннах. Допустимое значение от 0,01 до 9999, не более 3 знаков после запятой

}

Payment*:

Условия оплаты и ставка

ONE-OF

1:{...}

Условия оплаты и ставка.

CurrencyId: int32

Идентификатор валюты. dict: GET /v1.0/dictionaries/currencyTypes → Id. По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

MoneyType: int32

Идентификатор варианта оплаты. dict: GET /v1.0/dictionaries/moneyTypes → Id. По умолчанию - 22. Должен принимать значение 22, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-moneyTypes

RateSum: decimal

Ставка для груза. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов

SumWithNDS: decimal

Ставка по безналичному расчёту с НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов. Если заданы обе безналичные ставки, SumWithNDS должна быть не меньше SumWithoutNDS. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0

SumWithoutNDS: decimal

Ставка по безналичному расчёту без НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Значение не меньше 0, максимальная длина 10 символов. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0

PrepayPercent: int32

Процент предоплаты. Допустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

Через сколько банковских дней оплата. Допустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false

PayDaysEnabled: boolean

Включена ли оплата через банковские дни. По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true

FixedRate: boolean

true, если ставка задана, false если запрос ставки. По умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1

Torg: boolean

Возможен ли торг. По умолчанию - false. Должен быть false, если параметр FixedRate равен false; при торгах с публикацией ставки — true

DirectContract: boolean

Прямой договор

InFuel: boolean

Предоплата топливом. Должен быть false, если параметр PrepayPercentEnabled равен false

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

Скрыть встречные предложения

AcceptPaymentTypes: int32

Битовая маска форм оплаты, которые вы готовы принять при запросе ставки: флаги складываются

• 1 - наличные
• 2 - безналичный расчёт с НДС
• 4 - безналичный расчёт без НДС

Пример: 7 — все три формы. При запросе ставки значение 0 сервис заменяет на 7; при фиксированной ставке поле не используется

}

InviteSettings:

Настройки автоприглашений

ONE-OF

1:{...}

Настройки автоприглашений по встречным предложениям.

InviteDelayInSeconds: int32

Время в секундах сбора встречных предложений: через него сервис создаёт приглашение по лучшему предложению. Обязателен и больше 0, если объект настроек передан

InviteDurationInSeconds: int32

Время в секундах действия приглашения. Обязателен и больше 0, если объект настроек передан

MaxPercentDeviation: int32 (nullable)

На сколько процентов встречное предложение может превышать вашу ставку, чтобы приглашение всё-таки ушло

NeedArchiveOnInvite: boolean

Архивировать груз при срабатывании автоматического приглашения

}

PriorityView:

Приоритетный показ

ONE-OF

1:{...}

Параметры приоритетного показа в ответе.

DailyLimit: decimal

Суточный лимит списания по услуге в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

Показывать груз в приоритете только платным пользователям

OrderLimit: decimal

Лимит списания на груз в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

Ставка за просмотр в атисах

• Кратна 0,5
• Не меньше минимальной ставки сервиса и не больше баланса фирмы
• Должна иметь длину не более 5 символов

MoneySpentPerDay: decimal

Сколько списано с баланса за груз в текущие сутки. Только для чтения

MoneySpentPerOrder: decimal

Сколько списано с баланса за груз за всё время. Только для чтения

}

Stealth:

Настройки показа груза

ONE-OF

1:{...}

Ограничения показа груза платной услугой «Стелс»: списания идут с баланса фирмы. Если объект передан, нужен хотя бы один параметр.

ListIdToHide: guid (nullable)

Идентификатор списка фирм, которым груз не показывается. dict: GET https://api.ati.su/scrolls/v1/firms → id. docs: https://ati.su/developers/api/catalogs/firm-lists/

FirmRegDateToHide: date-time (nullable)

Фирмам, зарегистрированным позже этой даты, груз не показывается

ScoreToHide: double (nullable)

Минимальное число звёзд фирмы: фирмам с меньшим числом груз не показывается. Целое от 1 до 5; при включённом бронировании на общей площадке — от 2 до 5

}

LoadFiles:[{...}]

Файлы к грузу.
Перед добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. API для хранения файлов)

Id: guid

Устаревший идентификатор файла, используйте FileId

deprecated

FileId: string

Идентификатор файла, который вернул API хранения файлов при загрузке. dict: POST https://api.ati.su/v1.0/filestorage/files → id. docs: https://ati.su/developers/api/filestorage/

FileType: int32

Тип загруженного файла. Всегда 1 — документ

Attributes: int32

Устаревшее поле, всегда 0

Name: string

Имя файла. Только в ответе: приходит из хранилища файлов, в запросе значение игнорируется

Link: string

Ссылка, по которой можно скачать файл. Сервис собирает её из идентификатора файла в хранилище

Size: int32

Устаревшее поле, всегда -1

}]

Deal:

Сделка, в рамках которой размещён груз

ONE-OF

1:{...}

Сделка по грузу в ответе.

Auction:

Параметры аукциона

ONE-OF

1:{...}

Торги по грузу в ответе.

StartRate*: decimal

Начальная ставка аукциона. Параметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.

Currency*: int32

Валюта аукциона. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

Step*: decimal

Минимальное изменение ставки по аукциону. Параметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.

PaymentType*:

Тип оплаты в торгах: допустимы только 24 и 25

ONE-OF

enum

[1, 22, 23, 24, 25]

Тип оплаты.

• 1 - Наличные
• 22 - Любая
• 23 - На карту
• 24 - Безналичный расчёт с НДС
• 25 - Безналичный расчёт без НДС

AcceptSecondPayType: boolean

Принимать ставки и со вторым типом оплаты: без НДС при PaymentType = 24, с НДС при PaymentType = 25

StartDate: date-time

Время начала аукциона в UTC. Должно быть позже времени начала публикации груза на площадке.

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Время окончания аукциона "завершить не позже". Если указанное время, меньше значения Duration - аукцион заканчивается по времени "завершить не позже", если нет автопродления. Время устанавливается в формате UTC.

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.

AutoRenew: boolean

Нужно ли продлевать торги, если ставка пришла незадолго до окончания

RenewTime: int32 (nullable)

Время в минутах, на которое сдвигается окончание аукциона при включённом AutoRenew

MaxRenewTime: int32 (nullable)

Максимально допустимое время в минутах, на которое можно сдвинуть окончание аукциона при включённом AutoRenew. Указывать, если AutoRenew = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

Максимально допустимая ставка по аукциону. Обязателен при RaiseBid = true. Не меньше суммы StartRate и Step, не больше 9999999999, не более 10 символов.

RaiseBidInterval: int32 (nullable)

Период увеличения ставки в минутах при отсутствии предложений. Обязателен при RaiseBid = true: от 1 минуты и меньше Duration. При StartSinceFirstBet = true верхнее ограничение не действует.

ResponseInMinutes: int32 (nullable)

Через сколько минут после начала торгов принимать встречные предложения:

• 0 - сразу
• N - через N минут; допустимо любое значение от 0 и меньше Duration
• null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

Длительность торгов в минутах: целое число больше 0. Окончание торгов не может быть позже времени актуальности груза LastDate. Если не указана, вычисляется как разница EndDate и StartDate, при этом StartSinceFirstBet игнорируется

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчёт до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:

Параметры перезапуска аукциона.
Если объект не передан, действуют значения по умолчанию: до 3 автоматических перевыборов победителя, после исчерпания груз публикуется со ставкой

ONE-OF

1:{...}

Параметры перезапуска торгов.

AuctionFinishAction:

Действие после исчерпания перезапусков

ONE-OF

enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны.

• 1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
• 2 - Опубликовать груз с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе.
• 3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно. Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно. В переданном объекте параметров по умолчанию 0; если сам объект не передан, действует значение 3

DurationAfterRestart: int32 (nullable)

Длительность торгов в минутах после перезапуска. Необязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным

RateIncrease: decimal (nullable)

Повышение ставки при перезапуске

RateIncreaseOption: int32 (nullable)

Единица повышения ставки при перезапуске:

• 1 - в валюте
• 2 - в процентах

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

Принимать встречные предложения только до первой ставки

WinnerCriterion:

Критерий выбора победителя торгов

ONE-OF

enum

[0, 1]

Критерий победы в аукционе.

• 0 - Выбор победителя происходит автоматически по лучшей ставке
• 1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

Source:

Площадка, на которой идут торги. Значение выставляет система: передавайте 0 или не передавайте поле

ONE-OF

enum

[0, 2]

Площадка, на которой идут торги по грузу.

• 0 - Торги в АТИ
• 2 - Торги в Atrucks

AuctionId: guid

Идентификатор аукциона

LoadId: guid

Идентификатор груза, для которого активен аукцион

ActiveDealId: guid (nullable)

Идентификатор сделки, привязанной к аукциону

State:

Статус аукциона

ONE-OF

enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона.

• -100 - Не удалось определить состояние аукциона
• -14 - Аукцион отменен руками грузовладельца
• -13 - Аукцион удален, т.к. расторгнут заказ
• -12 - Аукцион без ставок завершен
• -11 - Аукцион удален автоматически
• -10 - Аукцион удален т.к. сделка завершена
• -9 - Аукцион удален
• -8 - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет
• -7 - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель
• -6 - При включенном копировании грузов: торги завершены, экспедитор не является победителем
• -5 - Одна ставка лучшая по цене, другая по дате
• -4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
• -3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
• -2 - Закончился, ждем когда победитель возьмет груз
• -1 - Закончился, ставок нет
• 0 - Идет, ставок нет
• 1 - Идет (уже есть валидные ставки)

Finished: boolean

Завершён ли аукцион

WinDate: date-time (nullable)

Время, когда одна из ставок в AuctionRates стала победной

AuctionRates:[{...}]

Список ставок по аукциону

AuctionRateId: guid

Идентификатор ставки

AddedAt: date-time

Когда сделана ставка

RateFirm:

Фирма, сделавшая ставку

ONE-OF

1:{...}

Фирма-участник торгов: рейтинг, статус и контакт.

Score: double

Рейтинг фирмы в звёздах

Status:

Статус фирмы в АТИ. Коды описаны в FirmStatus

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7]

Статус фирмы по цвету звёзд.

• 0 - Серый
• 1 - Зелёный
• 2 - Жёлтый
• 3 - Красный
• 4 - Партнёр АТИ
• 5 - Сотрудник АТИ
• 6 - Гос. органы
• 7 - ОДКС

Name: string

Имя фирмы

ContactName: string

Имя контакта

AtiId: string

Идентификатор фирмы в АТИ

}

Rate: decimal

Ставка на груз, которую поставил пользователь

State:

Статус ставки. Коды описаны в AuctionRateState

ONE-OF

enum

[0, 1, -8, -7, -6, -5, -4, -3, -2, -1]

Статус ставки.

• -8 - Грузовладелец отклонил документ
• -7 - Победитель отклонил документ
• -6 - Победитель отменил сделку
• -5 - Грузовладелец отменил сделку
• -4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
• -3 - Бывший победитель
• -2 - Перевозчик отказался от участия
• -1 - Предложение отклонил грузовладелец/перевозчик
• 0 - Непобедная ставка при завершении торгов
• 1 - Победная ставка в аукционе

LoadingDate: date-time (nullable)

Ближайшая возможная для перевозчика дата загрузки. Используется только в аукционах с критерием победы по ставке и дате загрузки

FirmId: int32

Идентификатор фирмы, сделавшей ставку

ContactId: int32

Идентификатор контакта, сделавшего ставку

}]

}

}

Boards:[{...}]

Список площадок

BoardId: string

Идентификатор площадки из 24 символов. Значение общей площадки — a0a0a0a0a0a0a0a0a0a0a0a0

PublicationTime: date-time (nullable)

Время публикации на площадке. Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

Разрешено ли бронирование груза на общей площадке. Учитывается только для Общей площадки, только при включённом Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Является ли площадка общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC. Может иметь значение null. Минимальное значение равно текущей дате. Не указывается при значении параметра DateType равным 3

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null. Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate. Не указывается при значении параметра DateType равным 3

ArchiveDate: date-time (nullable)

Дата и время переноса в архив

ArchiveReason:

Причина переноса в архив

ONE-OF

(nullable)

enum

[Unknown, System, Manual, Complaints, UnwantedContent, DeleteCsvLoad, MergeLoadsAfterEdit, ContactDoesNotHaveAccessToVirtualPayments, VerticesLoadDelete, StealthStatisticError, CheckDuplicateComplaints, DeleteContact, DeleteFirm, CleanOldLoadsJob]

Причина, по которой груз оказался в архиве.

• VerticesLoadDelete - Снят при сквозной передаче груза
• StealthStatisticError - Снят из-за ошибки при подсчёте статистики Стелса
• CheckDuplicateComplaints - Снят при проверке дублирующих жалоб
• DeleteContact - Удалён контакт
• DeleteFirm - Удалена фирма
• CleanOldLoadsJob - Истёк срок актуальности
• Unknown - Причина не определена
• System - Снят системой
• Manual - Снят с публикации владельцем
• Complaints - Снят по жалобам
• UnwantedContent - Снят за недопустимое содержимое
• DeleteCsvLoad - Удалён вместе с CSV-загрузкой
• MergeLoadsAfterEdit - Объединён с другим грузом после редактирования
• ContactDoesNotHaveAccessToVirtualPayments - Снят: у контакта нет права оплачивать услугу со счёта фирмы

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

Идентификатор валюты озвученной ставки. dict: GET /v1.0/dictionaries/currencyTypes → Id

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Можно ли снять груз с публикации

HasPermissionsToLoad: boolean

Есть ли у текущего контакта доступ к грузу: контакт указан в грузе или имеет доступ к его подразделению

CanBeEdited: boolean

Можно ли редактировать груз

CanBeRenewed: boolean

Можно ли обновить груз

CanBeRestored: boolean

Можно ли восстановить груз из архива

EditRestriction:

Причина отказа в редактировании груза, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

DeleteRestriction:

Причина отказа в снятии груза с публикации, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RestoreRestriction:

Причина отказа в восстановлении груза из архива, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RenewRestriction: string

Причина отказа в обновлении груза. Пустая строка, если обновление доступно

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

UpdatedAt: date-time

Дата последнего изменения груза в UTC

AddedAt: date-time

Дата публикации груза в UTC

RefreshedAt: date-time

Дата последнего обновления груза в выдаче, в UTC

Distance: int32

Расстояние по дорогам в километрах

PlatonRoadsLength: int32

Протяжённость участков маршрута, за которые взимается плата по системе «Платон», в километрах

TollRoadsLength: int32

Протяжённость платных дорог на маршруте в километрах

TravelTime: string

Расчётное время в пути в формате [d.]hh:mm:ss

Zimnik: boolean

Учитывать ли зимники при построении маршрута

Ferries: boolean

Учитывать ли паромные переправы при построении маршрута

FirmId: string

Идентификатор фирмы

AuctionId: guid (nullable)

Идентификатор аукциона по грузу

}

Пример

{...}

"LoadMeta":{...},

"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"MetaData":"import-2026-09"

},

"ContactId1":1234567,

"ContactId2":1234568,

"Note":"Погрузка с 9 до 18, пропуск заказывать заранее",

"FirstDate":"2026-09-08T00:00:00.000Z",

"LastDate":"2026-09-10T00:00:00.000Z",

"DateType":1,

"PeriodicityId":0,

"OrderNumber":"ЗК-2026-0917",

"Krugoreis":false,

"Loading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"ExtraPoints":[...],

{...}

"CityId":1,

"PointType":2,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"пр. Ленина, 10",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"OrdinalId":1,

"IsRoundTheClock":false,

"LoadingDateStart":"2026-09-09T00:00:00.000Z",

"LoadingDateEnd":"2026-09-09T00:00:00.000Z",

"LoadingTimeStart":"09:00:00",

"LoadingTimeEnd":"18:00:00",

"LoadingCargos":[...],

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

],

"UnloadingCargos":[...]

{...}

"CargoId":1,

"Weight":10,

"Volume":40,

"PackagingQuantity":10,

"IsDefinedByTtn":false

}

]

}

],

"Unloading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"Cargo":{...},

"Weight":20,

"Volume":82,

"ADR":0,

"CargoTypeId":59,

"CargoType":"Стройматериалы",

"PackType":1,

"PalletCount":33,

"BeltCount":0,

"DogruzType":1,

"SborGruz":false,

"Size":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

},

"Transport":{...},

"CarType":5,

"CarTypeString":"5",

"LoadingType":3,

"LoadingLogicalOperator":"OR",

"UnloadingType":3,

"UnloadingLogicalOperator":"OR",

"TrucksQuantity":1,

"TemperatureFrom":-18,

"TemperatureTo":4,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false,

"RequiredCapacity":20

},

"Payment":{...},

"CurrencyId":1,

"MoneyType":22,

"RateSum":85000,

"SumWithNDS":102000,

"SumWithoutNDS":85000,

"PrepayPercent":30,

"PrepayPercentEnabled":true,

"PayDays":5,

"PayDaysEnabled":true,

"FixedRate":true,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

},

"InviteSettings":{...},

"InviteDelayInSeconds":600,

"InviteDurationInSeconds":3600,

"MaxPercentDeviation":10,

"NeedArchiveOnInvite":false

},

"PriorityView":{...},

"DailyLimit":500,

"IsForPayedOnly":false,

"OrderLimit":100,

"ViewRate":1.5,

"MoneySpentPerDay":12,

"MoneySpentPerOrder":45

},

"Stealth":{...},

"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"FirmRegDateToHide":"2024-01-01T00:00:00.000Z",

"ScoreToHide":3

},

"LoadFiles":[...],

{...}

"FileId":"a1b2c3d4e5f6a7b8c9d0e1f2",

"FileType":1,

"Attributes":0,

"Name":"Договор.pdf",

"Link":"https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2",

"Size":-1

}

],

"Deal":{...},

"Auction":{...}

"StartRate":50000,

"Currency":1,

"Step":500,

"PaymentType":0,

"AcceptSecondPayType":false,

"StartDate":"2026-09-08T09:00:00.000Z",

"EndDate":"2026-09-08T12:00:00.000Z",

"EndDateBoundary":"2026-09-09T09:00:00.000Z",

"Nds":20,

"TimeToProvideDocuments":4,

"AutoRenew":true,

"RenewTime":5,

"MaxRenewTime":30,

"RaiseBid":false,

"MaxRate":60000,

"RaiseBidInterval":30,

"ResponseInMinutes":15,

"Duration":180,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":1,

"InitChangeWinnerCount":1,

"DurationAfterRestart":120,

"RateIncrease":500,

"RateIncreaseOption":1

},

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

"Source":0,

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ActiveDealId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"State":0,

"Finished":false,

"WinDate":"2026-09-08T12:05:00.000Z",

"AuctionRates":[...]

{...}

"AuctionRateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddedAt":"2026-09-08T10:15:30.000Z",

"RateFirm":{...},

"Score":4.5,

"Status":0,

"Name":"ООО «Перевозчик»",

"ContactName":"Иван Петров",

"AtiId":"1234567"

},

"Rate":48000,

"State":0,

"LoadingDate":"2026-09-09T00:00:00.000Z",

"FirmId":7654321,

"ContactId":0

}

]

}

},

"Boards":[...],

{...}

"BoardId":"a0a0a0a0a0a0a0a0a0a0a0a0",

"PublicationTime":"2026-09-08T12:00:00.000Z",

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":true,

"IsCommonBoard":true

}

],

"UnloadFirstDate":"2026-09-11T00:00:00.000Z",

"UnloadLastDate":"2026-09-12T00:00:00.000Z",

"ArchiveDate":"2026-09-07T10:15:30.000Z",

"ArchiveReason":"Unknown",

"TruePrice":85000,

"TrueCurrencyId":1,

"ResponseCount":3,

"OfferCount":2,

"CanBeDeleted":true,

"HasPermissionsToLoad":true,

"CanBeEdited":true,

"CanBeRenewed":true,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"Груз можно обновить не ранее чем через 40 минут",

"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"12345678",

"UpdatedAt":"2026-09-07T10:15:30.000Z",

"AddedAt":"2026-09-05T08:00:00.000Z",

"RefreshedAt":"2026-09-07T09:00:00+00:00",

"Distance":712,

"PlatonRoadsLength":540,

"TollRoadsLength":120,

"TravelTime":"10:30:00",

"Zimnik":false,

"Ferries":false,

"FirmId":"1234567",

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

404 Груз не найден среди опубликованных грузов фирмы.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Груз не найден",

"Error":"load_not_found_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

Получение всех своих грузов

Доступен фильтр по контакту. При передаче значения в contactId будут получены только те грузы, у которых ContactId1 == contactId либо ContactId2 == contactId.
Получать этим методом чужие грузы с общей площадки нельзя. Метод предназначен для работы со своими грузами.

Получение всех грузов фирмы. API для интеграции. Отдаются только опубликованные грузы фирмы, от имени которой выпущен токен; архивные лежат в unpublished-loads. Без contactId возвращаются грузы всех контактов фирмы.

get /v1.0/loads

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
contactId	integer (int32)	query	Идентификатор контакта. Пример: 0

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads");

Ответ

200 Грузы фирмы.

Модель

[{...}]

Груз в ответе: поля публикации и вычисляемые сервисом.

LoadMeta:

Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией

ONE-OF

1:{...}

Метаданные публикации.

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные. Максимальная длина 1024 символа

}

ContactId1*: int32

Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id. Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами. Контакт должен быть виден для остальных участников АТИ

ContactId2: int32 (nullable)

Идентификатор второго выбранного контакта, если не выбрано, то null. Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу. Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC. Минимальное значение равно текущей дате. При значении параметра DateType равным 0, допустимое значение поля - текущая дата. При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед. При значении параметра DateType равным 2, допустимое значение поля - текущая дата. При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC. Минимальное значение равно значению параметра FirstDate. При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед. При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед. При значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется. При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Тип готовности груза к перевозке, по умолчанию 0

• 0 - Готов к загрузке
• 1 - в период с FirstDate по LastDate
• 2 - постоянно
• 3 - груза нет, запрос ставки

PeriodicityId: int32

Периодичность загрузки. Если параметр DateType не равен 2, PeriodicityId равен 0. Иначе PeriodicityId может принимать следующие значения:

• 1 - ежедневно
• 100 - по рабочим дням

OrderNumber: string

Номер заказа. Ограничение по длине: 250 символов

Krugoreis: boolean

Включён ли кругорейс

Loading*:

Точка погрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

ExtraPoints:[{...}]

Дополнительные пункты маршрута между погрузкой и выгрузкой.
Максимум 15 штук. Может иметь значение null

CityId*: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

PointType*: int32

Тип точки:

• 1 - загрузка
• 2 - разгрузка
• 3 - таможня
• 8 - проехать через

Latitude: decimal (nullable)

Широта точки. Допустимое значение от -90 до 90; указывается вместе с долготой

Longitude: decimal (nullable)

Долгота точки. Допустимое значение от -180 до 180; указывается вместе с широтой

Street: string

Улица или район. Максимальная длина 200 символов

OrganizationId: guid (nullable)

Организация, принимающая или отгружающая груз в этой точке. Указывается только вместе с AddressId

AddressId: guid (nullable)

Адрес точки. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

OrdinalId: int32

Порядок точки на маршруте. Если у всех точек 0, сервис нумерует их по порядку списка

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeStart: string (nullable)

Время начала загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeEnd: string (nullable)

Время окончания загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingCargos:[{...}]

Позиции груза, которые берут в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

UnloadingCargos:[{...}]

Позиции груза, которые оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза (CargoId из точки загрузки)

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

PackagingQuantity: int32 (nullable)

Количество выгружаемых мест

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

}]

Unloading*:

Точка выгрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

Cargo*:

Что везём: наименование, вес, объём, упаковка

ONE-OF

1:{...}

Описание груза: что и сколько везём.

Weight: double

Вес груза в тоннах. Обязательный параметр, если не задан параметр Volume. Допустимое значение 0 либо от 0,001 до 9999, не более 3 знаков после запятой

Volume: double

Объём груза в кубических метрах. Обязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа

ADR: int32

Класс опасности груза по ADR. Допустимое значение от 0 до 9, по умолчанию 0. Для CargoTypeId = 53 обязателен ненулевой

CargoTypeId*: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes

CargoType: string

Наименование груза текстом. Обязательный параметр: при CargoTypeId = 59 («другое») это и есть наименование груза. Максимальная длина названия - 200 символов. В этом поле запрещено указывать контактную информацию

PackType: int32

Идентификатор типа упаковки (навалом, коробки, россыпью), 0 — упаковка не указана. dict: GET /v1.0/dictionaries/packTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-packTypes

PalletCount: int32

Количество упаковок для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

• 1 - только отдельной машиной
• 2 - отдельной или догрузом
• 3 - только догрузом

SborGruz: boolean

Сборный груз

Size:

Параметры размера груза

ONE-OF

1:{...}

Габариты груза.

Length: double

Длина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

HeightHighlight: boolean

Выделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

}

}

Transport*:

Требования к транспорту: кузов, варианты загрузки и выгрузки

ONE-OF

1:{...}

Требования к транспорту.

CarType*: int64

Битовая маска типов кузова: идентификаторы из справочника — степени двойки, несколько кузовов складываются (1 + 4 = 5). dict: GET /v1.0/dictionaries/carTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes

CarTypeString: string

Та же битовая маска типов кузова строкой. Только в ответе: в запросе значение игнорируется

LoadingType: int32

Битовая маска вариантов загрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/loadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes

LoadingLogicalOperator: string

Тип условия загрузки:

• OR - необходимо, чтобы присутствовал один из способов загрузки
• AND - необходимо, чтобы присутствовали все выбранные типы загрузки

UnloadingType: int32

Битовая маска вариантов разгрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/unloadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-unloadingTypes

UnloadingLogicalOperator: string

Тип условия разгрузки:

• OR - необходимо, чтобы присутствовал один из способов разгрузки
• AND - необходимо, чтобы присутствовали все выбранные типы разгрузки

TrucksQuantity: int32

Количество машин. Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

Минимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

TemperatureTo: int32 (nullable)

Максимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

Stsepka: boolean

Нужна ли сцепка для груза

Pnevmohod: boolean

Нужен ли пневмоход для груза

Koniki: boolean

Нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

Документы на транспорт, необходимые для провоза этого груза: медкнижка

IsTracking: boolean

Трекинг через АТИ Водитель

RequiredCapacity: double (nullable)

Требуемая грузоподъемность в тоннах. Допустимое значение от 0,01 до 9999, не более 3 знаков после запятой

}

Payment*:

Условия оплаты и ставка

ONE-OF

1:{...}

Условия оплаты и ставка.

CurrencyId: int32

Идентификатор валюты. dict: GET /v1.0/dictionaries/currencyTypes → Id. По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

MoneyType: int32

Идентификатор варианта оплаты. dict: GET /v1.0/dictionaries/moneyTypes → Id. По умолчанию - 22. Должен принимать значение 22, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-moneyTypes

RateSum: decimal

Ставка для груза. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов

SumWithNDS: decimal

Ставка по безналичному расчёту с НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов. Если заданы обе безналичные ставки, SumWithNDS должна быть не меньше SumWithoutNDS. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0

SumWithoutNDS: decimal

Ставка по безналичному расчёту без НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Значение не меньше 0, максимальная длина 10 символов. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0

PrepayPercent: int32

Процент предоплаты. Допустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

Через сколько банковских дней оплата. Допустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false

PayDaysEnabled: boolean

Включена ли оплата через банковские дни. По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true

FixedRate: boolean

true, если ставка задана, false если запрос ставки. По умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1

Torg: boolean

Возможен ли торг. По умолчанию - false. Должен быть false, если параметр FixedRate равен false; при торгах с публикацией ставки — true

DirectContract: boolean

Прямой договор

InFuel: boolean

Предоплата топливом. Должен быть false, если параметр PrepayPercentEnabled равен false

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

Скрыть встречные предложения

AcceptPaymentTypes: int32

Битовая маска форм оплаты, которые вы готовы принять при запросе ставки: флаги складываются

• 1 - наличные
• 2 - безналичный расчёт с НДС
• 4 - безналичный расчёт без НДС

Пример: 7 — все три формы. При запросе ставки значение 0 сервис заменяет на 7; при фиксированной ставке поле не используется

}

InviteSettings:

Настройки автоприглашений

ONE-OF

1:{...}

Настройки автоприглашений по встречным предложениям.

InviteDelayInSeconds: int32

Время в секундах сбора встречных предложений: через него сервис создаёт приглашение по лучшему предложению. Обязателен и больше 0, если объект настроек передан

InviteDurationInSeconds: int32

Время в секундах действия приглашения. Обязателен и больше 0, если объект настроек передан

MaxPercentDeviation: int32 (nullable)

На сколько процентов встречное предложение может превышать вашу ставку, чтобы приглашение всё-таки ушло

NeedArchiveOnInvite: boolean

Архивировать груз при срабатывании автоматического приглашения

}

PriorityView:

Приоритетный показ

ONE-OF

1:{...}

Параметры приоритетного показа в ответе.

DailyLimit: decimal

Суточный лимит списания по услуге в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

Показывать груз в приоритете только платным пользователям

OrderLimit: decimal

Лимит списания на груз в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

Ставка за просмотр в атисах

• Кратна 0,5
• Не меньше минимальной ставки сервиса и не больше баланса фирмы
• Должна иметь длину не более 5 символов

MoneySpentPerDay: decimal

Сколько списано с баланса за груз в текущие сутки. Только для чтения

MoneySpentPerOrder: decimal

Сколько списано с баланса за груз за всё время. Только для чтения

}

Stealth:

Настройки показа груза

ONE-OF

1:{...}

Ограничения показа груза платной услугой «Стелс»: списания идут с баланса фирмы. Если объект передан, нужен хотя бы один параметр.

ListIdToHide: guid (nullable)

Идентификатор списка фирм, которым груз не показывается. dict: GET https://api.ati.su/scrolls/v1/firms → id. docs: https://ati.su/developers/api/catalogs/firm-lists/

FirmRegDateToHide: date-time (nullable)

Фирмам, зарегистрированным позже этой даты, груз не показывается

ScoreToHide: double (nullable)

Минимальное число звёзд фирмы: фирмам с меньшим числом груз не показывается. Целое от 1 до 5; при включённом бронировании на общей площадке — от 2 до 5

}

LoadFiles:[{...}]

Файлы к грузу.
Перед добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. API для хранения файлов)

Id: guid

Устаревший идентификатор файла, используйте FileId

deprecated

FileId: string

Идентификатор файла, который вернул API хранения файлов при загрузке. dict: POST https://api.ati.su/v1.0/filestorage/files → id. docs: https://ati.su/developers/api/filestorage/

FileType: int32

Тип загруженного файла. Всегда 1 — документ

Attributes: int32

Устаревшее поле, всегда 0

Name: string

Имя файла. Только в ответе: приходит из хранилища файлов, в запросе значение игнорируется

Link: string

Ссылка, по которой можно скачать файл. Сервис собирает её из идентификатора файла в хранилище

Size: int32

Устаревшее поле, всегда -1

}]

Deal:

Сделка, в рамках которой размещён груз

ONE-OF

1:{...}

Сделка по грузу в ответе.

Auction:

Параметры аукциона

ONE-OF

1:{...}

Торги по грузу в ответе.

StartRate*: decimal

Начальная ставка аукциона. Параметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.

Currency*: int32

Валюта аукциона. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

Step*: decimal

Минимальное изменение ставки по аукциону. Параметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.

PaymentType*:

Тип оплаты в торгах: допустимы только 24 и 25

ONE-OF

enum

[1, 22, 23, 24, 25]

Тип оплаты.

• 1 - Наличные
• 22 - Любая
• 23 - На карту
• 24 - Безналичный расчёт с НДС
• 25 - Безналичный расчёт без НДС

AcceptSecondPayType: boolean

Принимать ставки и со вторым типом оплаты: без НДС при PaymentType = 24, с НДС при PaymentType = 25

StartDate: date-time

Время начала аукциона в UTC. Должно быть позже времени начала публикации груза на площадке.

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Время окончания аукциона "завершить не позже". Если указанное время, меньше значения Duration - аукцион заканчивается по времени "завершить не позже", если нет автопродления. Время устанавливается в формате UTC.

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.

AutoRenew: boolean

Нужно ли продлевать торги, если ставка пришла незадолго до окончания

RenewTime: int32 (nullable)

Время в минутах, на которое сдвигается окончание аукциона при включённом AutoRenew

MaxRenewTime: int32 (nullable)

Максимально допустимое время в минутах, на которое можно сдвинуть окончание аукциона при включённом AutoRenew. Указывать, если AutoRenew = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

Максимально допустимая ставка по аукциону. Обязателен при RaiseBid = true. Не меньше суммы StartRate и Step, не больше 9999999999, не более 10 символов.

RaiseBidInterval: int32 (nullable)

Период увеличения ставки в минутах при отсутствии предложений. Обязателен при RaiseBid = true: от 1 минуты и меньше Duration. При StartSinceFirstBet = true верхнее ограничение не действует.

ResponseInMinutes: int32 (nullable)

Через сколько минут после начала торгов принимать встречные предложения:

• 0 - сразу
• N - через N минут; допустимо любое значение от 0 и меньше Duration
• null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

Длительность торгов в минутах: целое число больше 0. Окончание торгов не может быть позже времени актуальности груза LastDate. Если не указана, вычисляется как разница EndDate и StartDate, при этом StartSinceFirstBet игнорируется

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчёт до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:

Параметры перезапуска аукциона.
Если объект не передан, действуют значения по умолчанию: до 3 автоматических перевыборов победителя, после исчерпания груз публикуется со ставкой

ONE-OF

1:{...}

Параметры перезапуска торгов.

AuctionFinishAction:

Действие после исчерпания перезапусков

ONE-OF

enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны.

• 1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
• 2 - Опубликовать груз с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе.
• 3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно. Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно. В переданном объекте параметров по умолчанию 0; если сам объект не передан, действует значение 3

DurationAfterRestart: int32 (nullable)

Длительность торгов в минутах после перезапуска. Необязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным

RateIncrease: decimal (nullable)

Повышение ставки при перезапуске

RateIncreaseOption: int32 (nullable)

Единица повышения ставки при перезапуске:

• 1 - в валюте
• 2 - в процентах

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

Принимать встречные предложения только до первой ставки

WinnerCriterion:

Критерий выбора победителя торгов

ONE-OF

enum

[0, 1]

Критерий победы в аукционе.

• 0 - Выбор победителя происходит автоматически по лучшей ставке
• 1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

Source:

Площадка, на которой идут торги. Значение выставляет система: передавайте 0 или не передавайте поле

ONE-OF

enum

[0, 2]

Площадка, на которой идут торги по грузу.

• 0 - Торги в АТИ
• 2 - Торги в Atrucks

AuctionId: guid

Идентификатор аукциона

LoadId: guid

Идентификатор груза, для которого активен аукцион

ActiveDealId: guid (nullable)

Идентификатор сделки, привязанной к аукциону

State:

Статус аукциона

ONE-OF

enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона.

• -100 - Не удалось определить состояние аукциона
• -14 - Аукцион отменен руками грузовладельца
• -13 - Аукцион удален, т.к. расторгнут заказ
• -12 - Аукцион без ставок завершен
• -11 - Аукцион удален автоматически
• -10 - Аукцион удален т.к. сделка завершена
• -9 - Аукцион удален
• -8 - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет
• -7 - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель
• -6 - При включенном копировании грузов: торги завершены, экспедитор не является победителем
• -5 - Одна ставка лучшая по цене, другая по дате
• -4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
• -3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
• -2 - Закончился, ждем когда победитель возьмет груз
• -1 - Закончился, ставок нет
• 0 - Идет, ставок нет
• 1 - Идет (уже есть валидные ставки)

Finished: boolean

Завершён ли аукцион

WinDate: date-time (nullable)

Время, когда одна из ставок в AuctionRates стала победной

AuctionRates:[{...}]

Список ставок по аукциону

AuctionRateId: guid

Идентификатор ставки

AddedAt: date-time

Когда сделана ставка

RateFirm:

Фирма, сделавшая ставку

ONE-OF

1:{...}

Фирма-участник торгов: рейтинг, статус и контакт.

Score: double

Рейтинг фирмы в звёздах

Status:

Статус фирмы в АТИ. Коды описаны в FirmStatus

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7]

Статус фирмы по цвету звёзд.

• 0 - Серый
• 1 - Зелёный
• 2 - Жёлтый
• 3 - Красный
• 4 - Партнёр АТИ
• 5 - Сотрудник АТИ
• 6 - Гос. органы
• 7 - ОДКС

Name: string

Имя фирмы

ContactName: string

Имя контакта

AtiId: string

Идентификатор фирмы в АТИ

}

Rate: decimal

Ставка на груз, которую поставил пользователь

State:

Статус ставки. Коды описаны в AuctionRateState

ONE-OF

enum

[0, 1, -8, -7, -6, -5, -4, -3, -2, -1]

Статус ставки.

• -8 - Грузовладелец отклонил документ
• -7 - Победитель отклонил документ
• -6 - Победитель отменил сделку
• -5 - Грузовладелец отменил сделку
• -4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
• -3 - Бывший победитель
• -2 - Перевозчик отказался от участия
• -1 - Предложение отклонил грузовладелец/перевозчик
• 0 - Непобедная ставка при завершении торгов
• 1 - Победная ставка в аукционе

LoadingDate: date-time (nullable)

Ближайшая возможная для перевозчика дата загрузки. Используется только в аукционах с критерием победы по ставке и дате загрузки

FirmId: int32

Идентификатор фирмы, сделавшей ставку

ContactId: int32

Идентификатор контакта, сделавшего ставку

}]

}

}

Boards:[{...}]

Список площадок

BoardId: string

Идентификатор площадки из 24 символов. Значение общей площадки — a0a0a0a0a0a0a0a0a0a0a0a0

PublicationTime: date-time (nullable)

Время публикации на площадке. Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

Разрешено ли бронирование груза на общей площадке. Учитывается только для Общей площадки, только при включённом Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Является ли площадка общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC. Может иметь значение null. Минимальное значение равно текущей дате. Не указывается при значении параметра DateType равным 3

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null. Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate. Не указывается при значении параметра DateType равным 3

ArchiveDate: date-time (nullable)

Дата и время переноса в архив

ArchiveReason:

Причина переноса в архив

ONE-OF

(nullable)

enum

[Unknown, System, Manual, Complaints, UnwantedContent, DeleteCsvLoad, MergeLoadsAfterEdit, ContactDoesNotHaveAccessToVirtualPayments, VerticesLoadDelete, StealthStatisticError, CheckDuplicateComplaints, DeleteContact, DeleteFirm, CleanOldLoadsJob]

Причина, по которой груз оказался в архиве.

• VerticesLoadDelete - Снят при сквозной передаче груза
• StealthStatisticError - Снят из-за ошибки при подсчёте статистики Стелса
• CheckDuplicateComplaints - Снят при проверке дублирующих жалоб
• DeleteContact - Удалён контакт
• DeleteFirm - Удалена фирма
• CleanOldLoadsJob - Истёк срок актуальности
• Unknown - Причина не определена
• System - Снят системой
• Manual - Снят с публикации владельцем
• Complaints - Снят по жалобам
• UnwantedContent - Снят за недопустимое содержимое
• DeleteCsvLoad - Удалён вместе с CSV-загрузкой
• MergeLoadsAfterEdit - Объединён с другим грузом после редактирования
• ContactDoesNotHaveAccessToVirtualPayments - Снят: у контакта нет права оплачивать услугу со счёта фирмы

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

Идентификатор валюты озвученной ставки. dict: GET /v1.0/dictionaries/currencyTypes → Id

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Можно ли снять груз с публикации

HasPermissionsToLoad: boolean

Есть ли у текущего контакта доступ к грузу: контакт указан в грузе или имеет доступ к его подразделению

CanBeEdited: boolean

Можно ли редактировать груз

CanBeRenewed: boolean

Можно ли обновить груз

CanBeRestored: boolean

Можно ли восстановить груз из архива

EditRestriction:

Причина отказа в редактировании груза, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

DeleteRestriction:

Причина отказа в снятии груза с публикации, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RestoreRestriction:

Причина отказа в восстановлении груза из архива, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RenewRestriction: string

Причина отказа в обновлении груза. Пустая строка, если обновление доступно

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

UpdatedAt: date-time

Дата последнего изменения груза в UTC

AddedAt: date-time

Дата публикации груза в UTC

RefreshedAt: date-time

Дата последнего обновления груза в выдаче, в UTC

Distance: int32

Расстояние по дорогам в километрах

PlatonRoadsLength: int32

Протяжённость участков маршрута, за которые взимается плата по системе «Платон», в километрах

TollRoadsLength: int32

Протяжённость платных дорог на маршруте в километрах

TravelTime: string

Расчётное время в пути в формате [d.]hh:mm:ss

Zimnik: boolean

Учитывать ли зимники при построении маршрута

Ferries: boolean

Учитывать ли паромные переправы при построении маршрута

FirmId: string

Идентификатор фирмы

AuctionId: guid (nullable)

Идентификатор аукциона по грузу

}]

Пример

[...]

{...}

"LoadMeta":{...},

"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"MetaData":"import-2026-09"

},

"ContactId1":1234567,

"ContactId2":1234568,

"Note":"Погрузка с 9 до 18, пропуск заказывать заранее",

"FirstDate":"2026-09-08T00:00:00.000Z",

"LastDate":"2026-09-10T00:00:00.000Z",

"DateType":1,

"PeriodicityId":0,

"OrderNumber":"ЗК-2026-0917",

"Krugoreis":false,

"Loading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"ExtraPoints":[...],

{...}

"CityId":1,

"PointType":2,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"пр. Ленина, 10",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"OrdinalId":1,

"IsRoundTheClock":false,

"LoadingDateStart":"2026-09-09T00:00:00.000Z",

"LoadingDateEnd":"2026-09-09T00:00:00.000Z",

"LoadingTimeStart":"09:00:00",

"LoadingTimeEnd":"18:00:00",

"LoadingCargos":[...],

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

],

"UnloadingCargos":[...]

{...}

"CargoId":1,

"Weight":10,

"Volume":40,

"PackagingQuantity":10,

"IsDefinedByTtn":false

}

]

}

],

"Unloading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"Cargo":{...},

"Weight":20,

"Volume":82,

"ADR":0,

"CargoTypeId":59,

"CargoType":"Стройматериалы",

"PackType":1,

"PalletCount":33,

"BeltCount":0,

"DogruzType":1,

"SborGruz":false,

"Size":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

},

"Transport":{...},

"CarType":5,

"CarTypeString":"5",

"LoadingType":3,

"LoadingLogicalOperator":"OR",

"UnloadingType":3,

"UnloadingLogicalOperator":"OR",

"TrucksQuantity":1,

"TemperatureFrom":-18,

"TemperatureTo":4,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false,

"RequiredCapacity":20

},

"Payment":{...},

"CurrencyId":1,

"MoneyType":22,

"RateSum":85000,

"SumWithNDS":102000,

"SumWithoutNDS":85000,

"PrepayPercent":30,

"PrepayPercentEnabled":true,

"PayDays":5,

"PayDaysEnabled":true,

"FixedRate":true,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

},

"InviteSettings":{...},

"InviteDelayInSeconds":600,

"InviteDurationInSeconds":3600,

"MaxPercentDeviation":10,

"NeedArchiveOnInvite":false

},

"PriorityView":{...},

"DailyLimit":500,

"IsForPayedOnly":false,

"OrderLimit":100,

"ViewRate":1.5,

"MoneySpentPerDay":12,

"MoneySpentPerOrder":45

},

"Stealth":{...},

"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"FirmRegDateToHide":"2024-01-01T00:00:00.000Z",

"ScoreToHide":3

},

"LoadFiles":[...],

{...}

"FileId":"a1b2c3d4e5f6a7b8c9d0e1f2",

"FileType":1,

"Attributes":0,

"Name":"Договор.pdf",

"Link":"https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2",

"Size":-1

}

],

"Deal":{...},

"Auction":{...}

"StartRate":50000,

"Currency":1,

"Step":500,

"PaymentType":0,

"AcceptSecondPayType":false,

"StartDate":"2026-09-08T09:00:00.000Z",

"EndDate":"2026-09-08T12:00:00.000Z",

"EndDateBoundary":"2026-09-09T09:00:00.000Z",

"Nds":20,

"TimeToProvideDocuments":4,

"AutoRenew":true,

"RenewTime":5,

"MaxRenewTime":30,

"RaiseBid":false,

"MaxRate":60000,

"RaiseBidInterval":30,

"ResponseInMinutes":15,

"Duration":180,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":1,

"InitChangeWinnerCount":1,

"DurationAfterRestart":120,

"RateIncrease":500,

"RateIncreaseOption":1

},

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

"Source":0,

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ActiveDealId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"State":0,

"Finished":false,

"WinDate":"2026-09-08T12:05:00.000Z",

"AuctionRates":[...]

{...}

"AuctionRateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddedAt":"2026-09-08T10:15:30.000Z",

"RateFirm":{...},

"Score":4.5,

"Status":0,

"Name":"ООО «Перевозчик»",

"ContactName":"Иван Петров",

"AtiId":"1234567"

},

"Rate":48000,

"State":0,

"LoadingDate":"2026-09-09T00:00:00.000Z",

"FirmId":7654321,

"ContactId":0

}

]

}

},

"Boards":[...],

{...}

"BoardId":"a0a0a0a0a0a0a0a0a0a0a0a0",

"PublicationTime":"2026-09-08T12:00:00.000Z",

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":true,

"IsCommonBoard":true

}

],

"UnloadFirstDate":"2026-09-11T00:00:00.000Z",

"UnloadLastDate":"2026-09-12T00:00:00.000Z",

"ArchiveDate":"2026-09-07T10:15:30.000Z",

"ArchiveReason":"Unknown",

"TruePrice":85000,

"TrueCurrencyId":1,

"ResponseCount":3,

"OfferCount":2,

"CanBeDeleted":true,

"HasPermissionsToLoad":true,

"CanBeEdited":true,

"CanBeRenewed":true,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"Груз можно обновить не ранее чем через 40 минут",

"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"12345678",

"UpdatedAt":"2026-09-07T10:15:30.000Z",

"AddedAt":"2026-09-05T08:00:00.000Z",

"RefreshedAt":"2026-09-07T09:00:00+00:00",

"Distance":712,

"PlatonRoadsLength":540,

"TollRoadsLength":120,

"TravelTime":"10:30:00",

"Zimnik":false,

"Ferries":false,

"FirmId":"1234567",

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

404 Контакт не найден в фирме.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Контакт не существует",

"Error":"contact_not_found_error"

}

Консоль

Отправить

Параметры

contactId Идентификатор контакта.

Обновление одного груза

Важно

Обновление груза доступно не чаще одного раза в 60 минут. При более частом вызове метод возвращает ошибку c HTTP статусом 403 и кодом cargo_application_delay_not_ellapsed.

Версия 2 2 (прежний адрес) 1

Обновить заявку на груз. API для интеграции. Поднимает в поисковой выдаче одну опубликованную заявку.

put /gw/cargos_create_v2/integration/v2/cargos/{requestedCargoApplicationId}/refresh

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
requestedCargoApplicationId обязательный	string (uuid)	path	Идентификатор обновляемой заявки на груз. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargos_create_v2/integration/v2/cargos/{requestedCargoApplicationId}/refresh' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/gw/cargos_create_v2/integration/v2/cargos/{requestedCargoApplicationId}/refresh");

Ответ

200 Заявка на груз успешно обновлена.

Успешный ответ

403 Нет прав на обновление заявки.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

404 Заявка на груз не найдена.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

423 Слишком рано для повторного обновления.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

requestedCargoApplicationId Идентификатор обновляемой заявки на груз.

Обновить заявку на груз. API для интеграции. Поднимает в поисковой выдаче одну опубликованную заявку.

Прежний адрес метода. Он продолжает работать, но для новых интеграций используйте актуальную версию.

put /v2/cargos/{requestedCargoApplicationId}/refresh

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
requestedCargoApplicationId обязательный	string (uuid)	path	Идентификатор обновляемой заявки на груз. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v2/cargos/{requestedCargoApplicationId}/refresh' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v2/cargos/{requestedCargoApplicationId}/refresh");

Ответ

200 Заявка на груз успешно обновлена.

Успешный ответ

403 Нет прав на обновление заявки.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

404 Заявка на груз не найдена.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

423 Слишком рано для повторного обновления.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

requestedCargoApplicationId Идентификатор обновляемой заявки на груз.

Обновление груза, чтобы он поднялся в выдаче. API для интеграции. Повторное обновление раньше разрешённого интервала отклоняется статусом операции по грузу, а не ошибкой запроса.

Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

put /v1.0/loads/{loadId}/renew

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/renew' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/{loadId}/renew");

Ответ

200 Статус операции по грузу. Ключ — идентификатор груза.

Модель

{...}

any-key:{...}

Статус операции по грузу или отзыву.

Status: int32

Статус операции.

• 0 - Успех
• 1 - Груз не найден
• 2 - Груз обновляли или восстанавливали слишком недавно
• 3 - Нет доступа; для обновления груза сюда же попадает повтор раньше разрешённого интервала
• 5 - Найден дубликат среди опубликованных грузов
• 7 - Груз не прошёл проверку полей
• 8 - Внутренняя ошибка при обработке груза
• 9 - Отзыв не найден
• 10 - Не хватает средств на платное размещение
• 11 - Кошелёк для платного размещения заблокирован
• -1 - Незапланированная ошибка

Message: string

Пояснение к статусу для показа пользователю

}

}

Пример

{...}

"3fa85f64-5717-4562-b3fc-2c963f66afa6":{...}

"Status":0,

"Message":"Успешная операция"

}

}

400 Идентификатор груза пуст.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Ошибка валидации: Массив ids не должен быть пуст",

"Error":"validation_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

Обновление нескольких грузов

Важно

Обновление выполняется только для тех грузов, у которых с прошлого обновления прошло более 60 минут. Для грузов, по которым 60-минутная пауза еще не истекла, в ответе возвращается ошибка по конкретному грузу с кодом cargo_application_delay_not_ellapsed. Максимальное количество передаваемых грузов — 100, иначе вернется ошибка с кодом max_cargos_count_exceeded. HTTP-статус метода будет 200 OK даже если часть грузов не была обновлена.

Версия 2 2 (прежний адрес) 1

Обновить несколько заявок на груз. API для интеграции. Поднимает в поисковой выдаче указанные опубликованные заявки. Максимум — 100 идентификаторов за один запрос.

put /gw/cargos_create_v2/integration/v2/cargos/refresh

Модель и примеры

Параметры

Параметров нет

Запрос

Модель

[uuid]

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargos_create_v2/integration/v2/cargos/refresh' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '["3fa85f64-5717-4562-b3fc-2c963f66afa6"]'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/gw/cargos_create_v2/integration/v2/cargos/refresh", "[""3fa85f64-5717-4562-b3fc-2c963f66afa6""]");

Ответ

200 Результат обновления по каждой заявке.

Модель

{...}

Ответ на обновление (refresh) заявок на груз через Integration API.

refresh_operation_responses*: null,object

Результаты обновления грузов. Ключ — id заявки, значение — результат операции.

}

Пример

{...}

"refresh_operation_responses":{...}

"any-key":{...}

"type":"success",

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

}

}

400 Превышен лимит количества грузов в запросе.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

403 Нет прав на обновление одной или нескольких заявок.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

404 Одна или несколько заявок не найдены.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

423 Слишком рано для повторного обновления.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

Нет параметров

[ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ]

Обновить несколько заявок на груз. API для интеграции. Поднимает в поисковой выдаче указанные опубликованные заявки. Максимум — 100 идентификаторов за один запрос.

Прежний адрес метода. Он продолжает работать, но для новых интеграций используйте актуальную версию.

put /v2/cargos/refresh

Модель и примеры

Параметры

Параметров нет

Запрос

Модель

[uuid]

Пример запроса

CURL

curl 'https://api.ati.su/v2/cargos/refresh' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '["3fa85f64-5717-4562-b3fc-2c963f66afa6"]'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v2/cargos/refresh", "[""3fa85f64-5717-4562-b3fc-2c963f66afa6""]");

Ответ

200 Результат обновления по каждой заявке.

Модель

{...}

Ответ на обновление (refresh) заявок на груз через Integration API.

refresh_operation_responses*: null,object

Результаты обновления грузов. Ключ — id заявки, значение — результат операции.

}

Пример

{...}

"refresh_operation_responses":{...}

"any-key":{...}

"type":"success",

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

}

}

400 Превышен лимит количества грузов в запросе.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

403 Нет прав на обновление одной или нескольких заявок.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

404 Одна или несколько заявок не найдены.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

423 Слишком рано для повторного обновления.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

Нет параметров

[ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ]

Обновление нескольких грузов, чтобы они поднялись в выдаче. API для интеграции. Грузы обрабатываются по отдельности: отказ по одному не отменяет обновление остальных.

Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

put /v1.0/loads/renew

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
ids	string (guid)[]	query	Идентификаторы грузов. Пример: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"]

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/renew' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/renew");

Ответ

200 Статусы операций по грузам. Ключ — идентификатор груза.

Модель

{...}

any-key:{...}

Статус операции по грузу или отзыву.

Status: int32

Статус операции.

• 0 - Успех
• 1 - Груз не найден
• 2 - Груз обновляли или восстанавливали слишком недавно
• 3 - Нет доступа; для обновления груза сюда же попадает повтор раньше разрешённого интервала
• 5 - Найден дубликат среди опубликованных грузов
• 7 - Груз не прошёл проверку полей
• 8 - Внутренняя ошибка при обработке груза
• 9 - Отзыв не найден
• 10 - Не хватает средств на платное размещение
• 11 - Кошелёк для платного размещения заблокирован
• -1 - Незапланированная ошибка

Message: string

Пояснение к статусу для показа пользователю

}

}

Пример

{...}

"3fa85f64-5717-4562-b3fc-2c963f66afa6":{...}

"Status":0,

"Message":"Успех"

}

}

400 Список идентификаторов пуст или содержит неверный guid.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Ошибка валидации: Массив ids не должен быть пуст",

"Error":"validation_error"

}

Консоль

Отправить

Параметры

ids Идентификаторы грузов.

Архивация одного груза

В API v2 для архивации одного груза передайте его идентификатор в массиве cargo_application_ids.

Версия 2 1.0

Отправить несколько заявок на груз в архив. API для интеграции. Снимает опубликованные заявки с площадок и переводит их в архив. Максимум — 100 идентификаторов за один запрос.

put /gw/cargos_create_v2/integration/v2/cargos/archive

Модель и примеры

Параметры

Параметров нет

Запрос

Модель

{...}

Запрос на архивацию нескольких заявок на груз через Integration API.

cargo_application_ids*: [uuid]

Идентификаторы заявок на груз для архивации.

}

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargos_create_v2/integration/v2/cargos/archive' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"cargo_application_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/gw/cargos_create_v2/integration/v2/cargos/archive", "{""cargo_application_ids"":[""3fa85f64-5717-4562-b3fc-2c963f66afa6""]}");

Ответ

200 Результат архивации по каждой заявке.

Модель

{...}

Ответ на архивацию заявок на груз через Integration API.

cargo_application_ids*: null,object

Результаты архивации грузов. Ключ — id заявки, значение — результат операции.

}

Пример

{...}

"cargo_application_ids":{...}

"any-key":{...}

"type":"success",

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

}

}

400 Пустой массив id или превышен лимит количества грузов в запросе.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

403 Нет прав на архивацию одной или нескольких заявок.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

404 Одна или несколько заявок не найдены.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

Нет параметров

{ "cargo_application_ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] }

Снятие груза с публикации. API для интеграции. Груз снимается с публикации и переносится в архив, откуда его можно восстановить методами unpublished-loads.

Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

delete /v1.0/loads/{loadId}

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.0/loads/{loadId}");

Ответ

200 Статус операции по грузу. Ключ — идентификатор груза.

Модель

{...}

any-key:{...}

Статус операции по грузу или отзыву.

Status: int32

Статус операции.

• 0 - Успех
• 1 - Груз не найден
• 2 - Груз обновляли или восстанавливали слишком недавно
• 3 - Нет доступа; для обновления груза сюда же попадает повтор раньше разрешённого интервала
• 5 - Найден дубликат среди опубликованных грузов
• 7 - Груз не прошёл проверку полей
• 8 - Внутренняя ошибка при обработке груза
• 9 - Отзыв не найден
• 10 - Не хватает средств на платное размещение
• 11 - Кошелёк для платного размещения заблокирован
• -1 - Незапланированная ошибка

Message: string

Пояснение к статусу для показа пользователю

}

}

Пример

{...}

"3fa85f64-5717-4562-b3fc-2c963f66afa6":{...}

"Status":0,

"Message":"Успешная операция"

}

}

400 Идентификатор груза пуст.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Ошибка валидации: Массив ids не должен быть пуст",

"Error":"validation_error"

}

403 Нет доступа к грузу.

Модель

{...}

Отказ в доступе к операции с грузом: ключ ошибки, пояснение и код причины.

Error: string

Ключ ошибки

Reason: string

Причина ошибки для показа пользователю

AccessDeniedReason:

Код причины отказа. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

ExceededLimit:

Какой лимит грузов исчерпан, если причина отказа — превышение лимита: 0 — общая площадка, 1 — персональные площадки. В остальных случаях null

ONE-OF

(nullable)

enum

[0, 1]

Лимит грузов, который исчерпан.

• 0 - Лимит грузов на общей площадке
• 1 - Лимит грузов на персональных площадках

}

Пример

{...}

"Error":"access_denied_error",

"Reason":"У вашего контакта недостаточно прав для работы с данным грузом",

"AccessDeniedReason":0,

"ExceededLimit":0

}

404 Груз не найден среди опубликованных грузов фирмы.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Груз не найден",

"Error":"load_not_found_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

Архивация нескольких грузов

Важно

Максимальное количество передаваемых грузов — 100, иначе вернётся ошибка с кодом max_cargos_count_exceeded. HTTP-статус метода будет 200 OK даже если часть грузов не была заархивирована — результат по каждому грузу возвращается отдельно.

Версия 2 1.0

Отправить несколько заявок на груз в архив. API для интеграции. Снимает опубликованные заявки с площадок и переводит их в архив. Максимум — 100 идентификаторов за один запрос.

put /gw/cargos_create_v2/integration/v2/cargos/archive

Модель и примеры

Параметры

Параметров нет

Запрос

Модель

{...}

Запрос на архивацию нескольких заявок на груз через Integration API.

cargo_application_ids*: [uuid]

Идентификаторы заявок на груз для архивации.

}

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargos_create_v2/integration/v2/cargos/archive' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"cargo_application_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/gw/cargos_create_v2/integration/v2/cargos/archive", "{""cargo_application_ids"":[""3fa85f64-5717-4562-b3fc-2c963f66afa6""]}");

Ответ

200 Результат архивации по каждой заявке.

Модель

{...}

Ответ на архивацию заявок на груз через Integration API.

cargo_application_ids*: null,object

Результаты архивации грузов. Ключ — id заявки, значение — результат операции.

}

Пример

{...}

"cargo_application_ids":{...}

"any-key":{...}

"type":"success",

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

}

}

400 Пустой массив id или превышен лимит количества грузов в запросе.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

403 Нет прав на архивацию одной или нескольких заявок.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

404 Одна или несколько заявок не найдены.

Модель

{...}

Ответ об ошибке при выполнении операции.

error_code*: null,string

Код ошибки.

reason*: null,string

Сообщение об ошибке.

details: {missing-type-info}

Дополнительные детали ошибки.

error_list:[{}]

Список ошибок валидации.

}

Пример

{...}

"error_code":"validation_error",

"reason":"Передан невалидный объект",

"details":"?",

"error_list":[...]

{}

]

}

Консоль

Отправить

Параметры

Нет параметров

{ "cargo_application_ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] }

Снятие нескольких грузов с публикации. API для интеграции. Грузы обрабатываются по отдельности: отказ по одному не отменяет удаление остальных.

Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

delete /v1.0/loads

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
ids	string (guid)[]	query	Идентификаторы грузов. Пример: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"]

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.0/loads");

Ответ

200 Статусы операций по грузам. Ключ — идентификатор груза; при отказе статус несёт ключ и причину ошибки.

Модель

{...}

any-key:{...}

Статус групповой операции по грузу с описанием отказа.

Status: int32

Статус операции.

• 0 - Успех
• 1 - Груз не найден
• 2 - Груз обновляли или восстанавливали слишком недавно
• 3 - Нет доступа; для обновления груза сюда же попадает повтор раньше разрешённого интервала
• 5 - Найден дубликат среди опубликованных грузов
• 7 - Груз не прошёл проверку полей
• 8 - Внутренняя ошибка при обработке груза
• 9 - Отзыв не найден
• 10 - Не хватает средств на платное размещение
• 11 - Кошелёк для платного размещения заблокирован
• -1 - Незапланированная ошибка

Message: string

Пояснение к статусу для показа пользователю

Error: string (nullable)

Ключ ошибки. Только при Status, отличном от 0

Reason: string (nullable)

Причина ошибки для показа пользователю. Только при Status, отличном от 0

Paid: boolean (nullable)

Груз восстановлен с платным размещением на площадках. Только у такого восстановления

PlacementPrice: decimal (nullable)

Списанная стоимость платного размещения. Только при Paid = true

}

}

Пример

{...}

"3fa85f64-5717-4562-b3fc-2c963f66afa6":{...}

"Status":0,

"Message":"Успех"

}

}

400 Список идентификаторов пуст.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Ошибка валидации: Массив ids не должен быть пуст",

"Error":"validation_error"

}

Консоль

Отправить

Параметры

ids Идентификаторы грузов.

Изменение приоритетного показа

Версия 1.0 2

Изменение параметров приоритетного показа у груза. API для интеграции. Приоритетный показ платный: списания идут с виртуального баланса фирмы. Пустое тело или нулевая ставка ничего не меняют: отключает приоритетный показ только DELETE.

Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

put /v1.0/loads/{loadId}/priority

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Модель

{...}

Параметры приоритетного показа в запросе.

DailyLimit: decimal

Суточный лимит списания по услуге в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

Показывать груз в приоритете только платным пользователям

OrderLimit: decimal

Лимит списания на груз в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate: decimal

Ставка за просмотр в атисах

• Кратна 0,5
• Не меньше минимальной ставки сервиса и не больше баланса фирмы
• Должна иметь длину не более 5 символов

MoneySpentPerDay: decimal

Сколько списано с баланса за груз в текущие сутки. Только для чтения

MoneySpentPerOrder: decimal

Сколько списано с баланса за груз за всё время. Только для чтения

}

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/priority' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"DailyLimit":500,"IsForPayedOnly":false,"OrderLimit":100,"ViewRate":1.5,"MoneySpentPerDay":12,"MoneySpentPerOrder":45}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/{loadId}/priority", "{""DailyLimit"":500,""IsForPayedOnly"":false,""OrderLimit"":100,""ViewRate"":1.5,""MoneySpentPerDay"":12,""MoneySpentPerOrder"":45}");

Ответ

200 Груз после изменения приоритетного показа.

Модель

{...}

Груз в ответе: поля публикации и вычисляемые сервисом.

LoadMeta:

Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией

ONE-OF

1:{...}

Метаданные публикации.

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные. Максимальная длина 1024 символа

}

ContactId1*: int32

Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id. Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами. Контакт должен быть виден для остальных участников АТИ

ContactId2: int32 (nullable)

Идентификатор второго выбранного контакта, если не выбрано, то null. Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу. Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC. Минимальное значение равно текущей дате. При значении параметра DateType равным 0, допустимое значение поля - текущая дата. При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед. При значении параметра DateType равным 2, допустимое значение поля - текущая дата. При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC. Минимальное значение равно значению параметра FirstDate. При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед. При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед. При значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется. При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Тип готовности груза к перевозке, по умолчанию 0

• 0 - Готов к загрузке
• 1 - в период с FirstDate по LastDate
• 2 - постоянно
• 3 - груза нет, запрос ставки

PeriodicityId: int32

Периодичность загрузки. Если параметр DateType не равен 2, PeriodicityId равен 0. Иначе PeriodicityId может принимать следующие значения:

• 1 - ежедневно
• 100 - по рабочим дням

OrderNumber: string

Номер заказа. Ограничение по длине: 250 символов

Krugoreis: boolean

Включён ли кругорейс

Loading*:

Точка погрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

ExtraPoints:[{...}]

Дополнительные пункты маршрута между погрузкой и выгрузкой.
Максимум 15 штук. Может иметь значение null

CityId*: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

PointType*: int32

Тип точки:

• 1 - загрузка
• 2 - разгрузка
• 3 - таможня
• 8 - проехать через

Latitude: decimal (nullable)

Широта точки. Допустимое значение от -90 до 90; указывается вместе с долготой

Longitude: decimal (nullable)

Долгота точки. Допустимое значение от -180 до 180; указывается вместе с широтой

Street: string

Улица или район. Максимальная длина 200 символов

OrganizationId: guid (nullable)

Организация, принимающая или отгружающая груз в этой точке. Указывается только вместе с AddressId

AddressId: guid (nullable)

Адрес точки. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

OrdinalId: int32

Порядок точки на маршруте. Если у всех точек 0, сервис нумерует их по порядку списка

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeStart: string (nullable)

Время начала загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeEnd: string (nullable)

Время окончания загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingCargos:[{...}]

Позиции груза, которые берут в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

UnloadingCargos:[{...}]

Позиции груза, которые оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза (CargoId из точки загрузки)

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

PackagingQuantity: int32 (nullable)

Количество выгружаемых мест

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

}]

Unloading*:

Точка выгрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

Cargo*:

Что везём: наименование, вес, объём, упаковка

ONE-OF

1:{...}

Описание груза: что и сколько везём.

Weight: double

Вес груза в тоннах. Обязательный параметр, если не задан параметр Volume. Допустимое значение 0 либо от 0,001 до 9999, не более 3 знаков после запятой

Volume: double

Объём груза в кубических метрах. Обязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа

ADR: int32

Класс опасности груза по ADR. Допустимое значение от 0 до 9, по умолчанию 0. Для CargoTypeId = 53 обязателен ненулевой

CargoTypeId*: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes

CargoType: string

Наименование груза текстом. Обязательный параметр: при CargoTypeId = 59 («другое») это и есть наименование груза. Максимальная длина названия - 200 символов. В этом поле запрещено указывать контактную информацию

PackType: int32

Идентификатор типа упаковки (навалом, коробки, россыпью), 0 — упаковка не указана. dict: GET /v1.0/dictionaries/packTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-packTypes

PalletCount: int32

Количество упаковок для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

• 1 - только отдельной машиной
• 2 - отдельной или догрузом
• 3 - только догрузом

SborGruz: boolean

Сборный груз

Size:

Параметры размера груза

ONE-OF

1:{...}

Габариты груза.

Length: double

Длина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

HeightHighlight: boolean

Выделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

}

}

Transport*:

Требования к транспорту: кузов, варианты загрузки и выгрузки

ONE-OF

1:{...}

Требования к транспорту.

CarType*: int64

Битовая маска типов кузова: идентификаторы из справочника — степени двойки, несколько кузовов складываются (1 + 4 = 5). dict: GET /v1.0/dictionaries/carTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes

CarTypeString: string

Та же битовая маска типов кузова строкой. Только в ответе: в запросе значение игнорируется

LoadingType: int32

Битовая маска вариантов загрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/loadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes

LoadingLogicalOperator: string

Тип условия загрузки:

• OR - необходимо, чтобы присутствовал один из способов загрузки
• AND - необходимо, чтобы присутствовали все выбранные типы загрузки

UnloadingType: int32

Битовая маска вариантов разгрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/unloadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-unloadingTypes

UnloadingLogicalOperator: string

Тип условия разгрузки:

• OR - необходимо, чтобы присутствовал один из способов разгрузки
• AND - необходимо, чтобы присутствовали все выбранные типы разгрузки

TrucksQuantity: int32

Количество машин. Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

Минимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

TemperatureTo: int32 (nullable)

Максимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

Stsepka: boolean

Нужна ли сцепка для груза

Pnevmohod: boolean

Нужен ли пневмоход для груза

Koniki: boolean

Нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

Документы на транспорт, необходимые для провоза этого груза: медкнижка

IsTracking: boolean

Трекинг через АТИ Водитель

RequiredCapacity: double (nullable)

Требуемая грузоподъемность в тоннах. Допустимое значение от 0,01 до 9999, не более 3 знаков после запятой

}

Payment*:

Условия оплаты и ставка

ONE-OF

1:{...}

Условия оплаты и ставка.

CurrencyId: int32

Идентификатор валюты. dict: GET /v1.0/dictionaries/currencyTypes → Id. По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

MoneyType: int32

Идентификатор варианта оплаты. dict: GET /v1.0/dictionaries/moneyTypes → Id. По умолчанию - 22. Должен принимать значение 22, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-moneyTypes

RateSum: decimal

Ставка для груза. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов

SumWithNDS: decimal

Ставка по безналичному расчёту с НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов. Если заданы обе безналичные ставки, SumWithNDS должна быть не меньше SumWithoutNDS. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0

SumWithoutNDS: decimal

Ставка по безналичному расчёту без НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Значение не меньше 0, максимальная длина 10 символов. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0

PrepayPercent: int32

Процент предоплаты. Допустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

Через сколько банковских дней оплата. Допустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false

PayDaysEnabled: boolean

Включена ли оплата через банковские дни. По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true

FixedRate: boolean

true, если ставка задана, false если запрос ставки. По умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1

Torg: boolean

Возможен ли торг. По умолчанию - false. Должен быть false, если параметр FixedRate равен false; при торгах с публикацией ставки — true

DirectContract: boolean

Прямой договор

InFuel: boolean

Предоплата топливом. Должен быть false, если параметр PrepayPercentEnabled равен false

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

Скрыть встречные предложения

AcceptPaymentTypes: int32

Битовая маска форм оплаты, которые вы готовы принять при запросе ставки: флаги складываются

• 1 - наличные
• 2 - безналичный расчёт с НДС
• 4 - безналичный расчёт без НДС

Пример: 7 — все три формы. При запросе ставки значение 0 сервис заменяет на 7; при фиксированной ставке поле не используется

}

InviteSettings:

Настройки автоприглашений

ONE-OF

1:{...}

Настройки автоприглашений по встречным предложениям.

InviteDelayInSeconds: int32

Время в секундах сбора встречных предложений: через него сервис создаёт приглашение по лучшему предложению. Обязателен и больше 0, если объект настроек передан

InviteDurationInSeconds: int32

Время в секундах действия приглашения. Обязателен и больше 0, если объект настроек передан

MaxPercentDeviation: int32 (nullable)

На сколько процентов встречное предложение может превышать вашу ставку, чтобы приглашение всё-таки ушло

NeedArchiveOnInvite: boolean

Архивировать груз при срабатывании автоматического приглашения

}

PriorityView:

Приоритетный показ

ONE-OF

1:{...}

Параметры приоритетного показа в ответе.

DailyLimit: decimal

Суточный лимит списания по услуге в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

Показывать груз в приоритете только платным пользователям

OrderLimit: decimal

Лимит списания на груз в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

Ставка за просмотр в атисах

• Кратна 0,5
• Не меньше минимальной ставки сервиса и не больше баланса фирмы
• Должна иметь длину не более 5 символов

MoneySpentPerDay: decimal

Сколько списано с баланса за груз в текущие сутки. Только для чтения

MoneySpentPerOrder: decimal

Сколько списано с баланса за груз за всё время. Только для чтения

}

Stealth:

Настройки показа груза

ONE-OF

1:{...}

Ограничения показа груза платной услугой «Стелс»: списания идут с баланса фирмы. Если объект передан, нужен хотя бы один параметр.

ListIdToHide: guid (nullable)

Идентификатор списка фирм, которым груз не показывается. dict: GET https://api.ati.su/scrolls/v1/firms → id. docs: https://ati.su/developers/api/catalogs/firm-lists/

FirmRegDateToHide: date-time (nullable)

Фирмам, зарегистрированным позже этой даты, груз не показывается

ScoreToHide: double (nullable)

Минимальное число звёзд фирмы: фирмам с меньшим числом груз не показывается. Целое от 1 до 5; при включённом бронировании на общей площадке — от 2 до 5

}

LoadFiles:[{...}]

Файлы к грузу.
Перед добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. API для хранения файлов)

Id: guid

Устаревший идентификатор файла, используйте FileId

deprecated

FileId: string

Идентификатор файла, который вернул API хранения файлов при загрузке. dict: POST https://api.ati.su/v1.0/filestorage/files → id. docs: https://ati.su/developers/api/filestorage/

FileType: int32

Тип загруженного файла. Всегда 1 — документ

Attributes: int32

Устаревшее поле, всегда 0

Name: string

Имя файла. Только в ответе: приходит из хранилища файлов, в запросе значение игнорируется

Link: string

Ссылка, по которой можно скачать файл. Сервис собирает её из идентификатора файла в хранилище

Size: int32

Устаревшее поле, всегда -1

}]

Deal:

Сделка, в рамках которой размещён груз

ONE-OF

1:{...}

Сделка по грузу в ответе.

Auction:

Параметры аукциона

ONE-OF

1:{...}

Торги по грузу в ответе.

StartRate*: decimal

Начальная ставка аукциона. Параметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.

Currency*: int32

Валюта аукциона. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

Step*: decimal

Минимальное изменение ставки по аукциону. Параметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.

PaymentType*:

Тип оплаты в торгах: допустимы только 24 и 25

ONE-OF

enum

[1, 22, 23, 24, 25]

Тип оплаты.

• 1 - Наличные
• 22 - Любая
• 23 - На карту
• 24 - Безналичный расчёт с НДС
• 25 - Безналичный расчёт без НДС

AcceptSecondPayType: boolean

Принимать ставки и со вторым типом оплаты: без НДС при PaymentType = 24, с НДС при PaymentType = 25

StartDate: date-time

Время начала аукциона в UTC. Должно быть позже времени начала публикации груза на площадке.

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Время окончания аукциона "завершить не позже". Если указанное время, меньше значения Duration - аукцион заканчивается по времени "завершить не позже", если нет автопродления. Время устанавливается в формате UTC.

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.

AutoRenew: boolean

Нужно ли продлевать торги, если ставка пришла незадолго до окончания

RenewTime: int32 (nullable)

Время в минутах, на которое сдвигается окончание аукциона при включённом AutoRenew

MaxRenewTime: int32 (nullable)

Максимально допустимое время в минутах, на которое можно сдвинуть окончание аукциона при включённом AutoRenew. Указывать, если AutoRenew = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

Максимально допустимая ставка по аукциону. Обязателен при RaiseBid = true. Не меньше суммы StartRate и Step, не больше 9999999999, не более 10 символов.

RaiseBidInterval: int32 (nullable)

Период увеличения ставки в минутах при отсутствии предложений. Обязателен при RaiseBid = true: от 1 минуты и меньше Duration. При StartSinceFirstBet = true верхнее ограничение не действует.

ResponseInMinutes: int32 (nullable)

Через сколько минут после начала торгов принимать встречные предложения:

• 0 - сразу
• N - через N минут; допустимо любое значение от 0 и меньше Duration
• null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

Длительность торгов в минутах: целое число больше 0. Окончание торгов не может быть позже времени актуальности груза LastDate. Если не указана, вычисляется как разница EndDate и StartDate, при этом StartSinceFirstBet игнорируется

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчёт до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:

Параметры перезапуска аукциона.
Если объект не передан, действуют значения по умолчанию: до 3 автоматических перевыборов победителя, после исчерпания груз публикуется со ставкой

ONE-OF

1:{...}

Параметры перезапуска торгов.

AuctionFinishAction:

Действие после исчерпания перезапусков

ONE-OF

enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны.

• 1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
• 2 - Опубликовать груз с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе.
• 3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно. Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно. В переданном объекте параметров по умолчанию 0; если сам объект не передан, действует значение 3

DurationAfterRestart: int32 (nullable)

Длительность торгов в минутах после перезапуска. Необязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным

RateIncrease: decimal (nullable)

Повышение ставки при перезапуске

RateIncreaseOption: int32 (nullable)

Единица повышения ставки при перезапуске:

• 1 - в валюте
• 2 - в процентах

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

Принимать встречные предложения только до первой ставки

WinnerCriterion:

Критерий выбора победителя торгов

ONE-OF

enum

[0, 1]

Критерий победы в аукционе.

• 0 - Выбор победителя происходит автоматически по лучшей ставке
• 1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

Source:

Площадка, на которой идут торги. Значение выставляет система: передавайте 0 или не передавайте поле

ONE-OF

enum

[0, 2]

Площадка, на которой идут торги по грузу.

• 0 - Торги в АТИ
• 2 - Торги в Atrucks

AuctionId: guid

Идентификатор аукциона

LoadId: guid

Идентификатор груза, для которого активен аукцион

ActiveDealId: guid (nullable)

Идентификатор сделки, привязанной к аукциону

State:

Статус аукциона

ONE-OF

enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона.

• -100 - Не удалось определить состояние аукциона
• -14 - Аукцион отменен руками грузовладельца
• -13 - Аукцион удален, т.к. расторгнут заказ
• -12 - Аукцион без ставок завершен
• -11 - Аукцион удален автоматически
• -10 - Аукцион удален т.к. сделка завершена
• -9 - Аукцион удален
• -8 - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет
• -7 - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель
• -6 - При включенном копировании грузов: торги завершены, экспедитор не является победителем
• -5 - Одна ставка лучшая по цене, другая по дате
• -4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
• -3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
• -2 - Закончился, ждем когда победитель возьмет груз
• -1 - Закончился, ставок нет
• 0 - Идет, ставок нет
• 1 - Идет (уже есть валидные ставки)

Finished: boolean

Завершён ли аукцион

WinDate: date-time (nullable)

Время, когда одна из ставок в AuctionRates стала победной

AuctionRates:[{...}]

Список ставок по аукциону

AuctionRateId: guid

Идентификатор ставки

AddedAt: date-time

Когда сделана ставка

RateFirm:

Фирма, сделавшая ставку

ONE-OF

1:{...}

Фирма-участник торгов: рейтинг, статус и контакт.

Score: double

Рейтинг фирмы в звёздах

Status:

Статус фирмы в АТИ. Коды описаны в FirmStatus

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7]

Статус фирмы по цвету звёзд.

• 0 - Серый
• 1 - Зелёный
• 2 - Жёлтый
• 3 - Красный
• 4 - Партнёр АТИ
• 5 - Сотрудник АТИ
• 6 - Гос. органы
• 7 - ОДКС

Name: string

Имя фирмы

ContactName: string

Имя контакта

AtiId: string

Идентификатор фирмы в АТИ

}

Rate: decimal

Ставка на груз, которую поставил пользователь

State:

Статус ставки. Коды описаны в AuctionRateState

ONE-OF

enum

[0, 1, -8, -7, -6, -5, -4, -3, -2, -1]

Статус ставки.

• -8 - Грузовладелец отклонил документ
• -7 - Победитель отклонил документ
• -6 - Победитель отменил сделку
• -5 - Грузовладелец отменил сделку
• -4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
• -3 - Бывший победитель
• -2 - Перевозчик отказался от участия
• -1 - Предложение отклонил грузовладелец/перевозчик
• 0 - Непобедная ставка при завершении торгов
• 1 - Победная ставка в аукционе

LoadingDate: date-time (nullable)

Ближайшая возможная для перевозчика дата загрузки. Используется только в аукционах с критерием победы по ставке и дате загрузки

FirmId: int32

Идентификатор фирмы, сделавшей ставку

ContactId: int32

Идентификатор контакта, сделавшего ставку

}]

}

}

Boards:[{...}]

Список площадок

BoardId: string

Идентификатор площадки из 24 символов. Значение общей площадки — a0a0a0a0a0a0a0a0a0a0a0a0

PublicationTime: date-time (nullable)

Время публикации на площадке. Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

Разрешено ли бронирование груза на общей площадке. Учитывается только для Общей площадки, только при включённом Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Является ли площадка общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC. Может иметь значение null. Минимальное значение равно текущей дате. Не указывается при значении параметра DateType равным 3

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null. Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate. Не указывается при значении параметра DateType равным 3

ArchiveDate: date-time (nullable)

Дата и время переноса в архив

ArchiveReason:

Причина переноса в архив

ONE-OF

(nullable)

enum

[Unknown, System, Manual, Complaints, UnwantedContent, DeleteCsvLoad, MergeLoadsAfterEdit, ContactDoesNotHaveAccessToVirtualPayments, VerticesLoadDelete, StealthStatisticError, CheckDuplicateComplaints, DeleteContact, DeleteFirm, CleanOldLoadsJob]

Причина, по которой груз оказался в архиве.

• VerticesLoadDelete - Снят при сквозной передаче груза
• StealthStatisticError - Снят из-за ошибки при подсчёте статистики Стелса
• CheckDuplicateComplaints - Снят при проверке дублирующих жалоб
• DeleteContact - Удалён контакт
• DeleteFirm - Удалена фирма
• CleanOldLoadsJob - Истёк срок актуальности
• Unknown - Причина не определена
• System - Снят системой
• Manual - Снят с публикации владельцем
• Complaints - Снят по жалобам
• UnwantedContent - Снят за недопустимое содержимое
• DeleteCsvLoad - Удалён вместе с CSV-загрузкой
• MergeLoadsAfterEdit - Объединён с другим грузом после редактирования
• ContactDoesNotHaveAccessToVirtualPayments - Снят: у контакта нет права оплачивать услугу со счёта фирмы

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

Идентификатор валюты озвученной ставки. dict: GET /v1.0/dictionaries/currencyTypes → Id

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Можно ли снять груз с публикации

HasPermissionsToLoad: boolean

Есть ли у текущего контакта доступ к грузу: контакт указан в грузе или имеет доступ к его подразделению

CanBeEdited: boolean

Можно ли редактировать груз

CanBeRenewed: boolean

Можно ли обновить груз

CanBeRestored: boolean

Можно ли восстановить груз из архива

EditRestriction:

Причина отказа в редактировании груза, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

DeleteRestriction:

Причина отказа в снятии груза с публикации, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RestoreRestriction:

Причина отказа в восстановлении груза из архива, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RenewRestriction: string

Причина отказа в обновлении груза. Пустая строка, если обновление доступно

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

UpdatedAt: date-time

Дата последнего изменения груза в UTC

AddedAt: date-time

Дата публикации груза в UTC

RefreshedAt: date-time

Дата последнего обновления груза в выдаче, в UTC

Distance: int32

Расстояние по дорогам в километрах

PlatonRoadsLength: int32

Протяжённость участков маршрута, за которые взимается плата по системе «Платон», в километрах

TollRoadsLength: int32

Протяжённость платных дорог на маршруте в километрах

TravelTime: string

Расчётное время в пути в формате [d.]hh:mm:ss

Zimnik: boolean

Учитывать ли зимники при построении маршрута

Ferries: boolean

Учитывать ли паромные переправы при построении маршрута

FirmId: string

Идентификатор фирмы

AuctionId: guid (nullable)

Идентификатор аукциона по грузу

}

Пример

{...}

"LoadMeta":{...},

"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"MetaData":"import-2026-09"

},

"ContactId1":1234567,

"ContactId2":1234568,

"Note":"Погрузка с 9 до 18, пропуск заказывать заранее",

"FirstDate":"2026-09-08T00:00:00.000Z",

"LastDate":"2026-09-10T00:00:00.000Z",

"DateType":1,

"PeriodicityId":0,

"OrderNumber":"ЗК-2026-0917",

"Krugoreis":false,

"Loading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"ExtraPoints":[...],

{...}

"CityId":1,

"PointType":2,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"пр. Ленина, 10",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"OrdinalId":1,

"IsRoundTheClock":false,

"LoadingDateStart":"2026-09-09T00:00:00.000Z",

"LoadingDateEnd":"2026-09-09T00:00:00.000Z",

"LoadingTimeStart":"09:00:00",

"LoadingTimeEnd":"18:00:00",

"LoadingCargos":[...],

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

],

"UnloadingCargos":[...]

{...}

"CargoId":1,

"Weight":10,

"Volume":40,

"PackagingQuantity":10,

"IsDefinedByTtn":false

}

]

}

],

"Unloading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"Cargo":{...},

"Weight":20,

"Volume":82,

"ADR":0,

"CargoTypeId":59,

"CargoType":"Стройматериалы",

"PackType":1,

"PalletCount":33,

"BeltCount":0,

"DogruzType":1,

"SborGruz":false,

"Size":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

},

"Transport":{...},

"CarType":5,

"CarTypeString":"5",

"LoadingType":3,

"LoadingLogicalOperator":"OR",

"UnloadingType":3,

"UnloadingLogicalOperator":"OR",

"TrucksQuantity":1,

"TemperatureFrom":-18,

"TemperatureTo":4,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false,

"RequiredCapacity":20

},

"Payment":{...},

"CurrencyId":1,

"MoneyType":22,

"RateSum":85000,

"SumWithNDS":102000,

"SumWithoutNDS":85000,

"PrepayPercent":30,

"PrepayPercentEnabled":true,

"PayDays":5,

"PayDaysEnabled":true,

"FixedRate":true,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

},

"InviteSettings":{...},

"InviteDelayInSeconds":600,

"InviteDurationInSeconds":3600,

"MaxPercentDeviation":10,

"NeedArchiveOnInvite":false

},

"PriorityView":{...},

"DailyLimit":500,

"IsForPayedOnly":false,

"OrderLimit":100,

"ViewRate":1.5,

"MoneySpentPerDay":12,

"MoneySpentPerOrder":45

},

"Stealth":{...},

"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"FirmRegDateToHide":"2024-01-01T00:00:00.000Z",

"ScoreToHide":3

},

"LoadFiles":[...],

{...}

"FileId":"a1b2c3d4e5f6a7b8c9d0e1f2",

"FileType":1,

"Attributes":0,

"Name":"Договор.pdf",

"Link":"https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2",

"Size":-1

}

],

"Deal":{...},

"Auction":{...}

"StartRate":50000,

"Currency":1,

"Step":500,

"PaymentType":0,

"AcceptSecondPayType":false,

"StartDate":"2026-09-08T09:00:00.000Z",

"EndDate":"2026-09-08T12:00:00.000Z",

"EndDateBoundary":"2026-09-09T09:00:00.000Z",

"Nds":20,

"TimeToProvideDocuments":4,

"AutoRenew":true,

"RenewTime":5,

"MaxRenewTime":30,

"RaiseBid":false,

"MaxRate":60000,

"RaiseBidInterval":30,

"ResponseInMinutes":15,

"Duration":180,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":1,

"InitChangeWinnerCount":1,

"DurationAfterRestart":120,

"RateIncrease":500,

"RateIncreaseOption":1

},

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

"Source":0,

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ActiveDealId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"State":0,

"Finished":false,

"WinDate":"2026-09-08T12:05:00.000Z",

"AuctionRates":[...]

{...}

"AuctionRateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddedAt":"2026-09-08T10:15:30.000Z",

"RateFirm":{...},

"Score":4.5,

"Status":0,

"Name":"ООО «Перевозчик»",

"ContactName":"Иван Петров",

"AtiId":"1234567"

},

"Rate":48000,

"State":0,

"LoadingDate":"2026-09-09T00:00:00.000Z",

"FirmId":7654321,

"ContactId":0

}

]

}

},

"Boards":[...],

{...}

"BoardId":"a0a0a0a0a0a0a0a0a0a0a0a0",

"PublicationTime":"2026-09-08T12:00:00.000Z",

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":true,

"IsCommonBoard":true

}

],

"UnloadFirstDate":"2026-09-11T00:00:00.000Z",

"UnloadLastDate":"2026-09-12T00:00:00.000Z",

"ArchiveDate":"2026-09-07T10:15:30.000Z",

"ArchiveReason":"Unknown",

"TruePrice":85000,

"TrueCurrencyId":1,

"ResponseCount":3,

"OfferCount":2,

"CanBeDeleted":true,

"HasPermissionsToLoad":true,

"CanBeEdited":true,

"CanBeRenewed":true,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"Груз можно обновить не ранее чем через 40 минут",

"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"12345678",

"UpdatedAt":"2026-09-07T10:15:30.000Z",

"AddedAt":"2026-09-05T08:00:00.000Z",

"RefreshedAt":"2026-09-07T09:00:00+00:00",

"Distance":712,

"PlatonRoadsLength":540,

"TollRoadsLength":120,

"TravelTime":"10:30:00",

"Zimnik":false,

"Ferries":false,

"FirmId":"1234567",

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

400 Параметры не прошли проверку.

Модель

{...}

Тело запроса не разобрано или не прошло проверку полей.

Error: string

Ключ ошибки: json_validation_error — поля не прошли проверку, deserialization_error — тело не разобрано

Reason: string

Причина ошибки для показа пользователю

ErrorsList:[{...}]

Ошибки по полям. Только при json_validation_error

property: string

Поле, не прошедшее проверку; вложенные поля через точку

reason: string

Причина ошибки для показа пользователю

error: string

Ключ нарушенного правила

context: {missing-type-info} (nullable)

Параметры нарушенного правила, если у него есть границы: например, Min и Max

}]

}

Пример

{...}

"Error":"json_validation_error",

"Reason":"Ошибка валидации json",

"ErrorsList":[...]

{...}

"property":"Cargo.Weight",

"reason":"Максимальная длина для параметра вес - 4 символа",

"error":"length_out_of_range",

"context":{...}

"Min":0,

"Max":4

}

}

]

}

403 Нет доступа к грузу.

Модель

{...}

Отказ в доступе к операции с грузом: ключ ошибки, пояснение и код причины.

Error: string

Ключ ошибки

Reason: string

Причина ошибки для показа пользователю

AccessDeniedReason:

Код причины отказа. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

ExceededLimit:

Какой лимит грузов исчерпан, если причина отказа — превышение лимита: 0 — общая площадка, 1 — персональные площадки. В остальных случаях null

ONE-OF

(nullable)

enum

[0, 1]

Лимит грузов, который исчерпан.

• 0 - Лимит грузов на общей площадке
• 1 - Лимит грузов на персональных площадках

}

Пример

{...}

"Error":"access_denied_error",

"Reason":"У вашего контакта недостаточно прав для работы с данным грузом",

"AccessDeniedReason":0,

"ExceededLimit":0

}

404 Груз не найден среди опубликованных грузов фирмы.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Груз не найден",

"Error":"load_not_found_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

{ "DailyLimit": 500, "IsForPayedOnly": false, "OrderLimit": 100, "ViewRate": 1.5, "MoneySpentPerDay": 12, "MoneySpentPerOrder": 45 }

Сохранение или обновление настроек приоритетного показа на груз

put /gw/cargos-priority-view-api/v2/cargos/{cargoApplicationId}/priority-view

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoApplicationId обязательный	string (uuid)	path	Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Модель

{...}

priority_view:{...}

Конфигурация приоритетного показа

view_rate: double (nullable)

Ставка за просмотр

daily_limit: double (nullable)

Суточный лимит списания по услуге

• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

order_limit: double (nullable)

Лимит на заявку

• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

is_for_paid_only: boolean (nullable)

Показывать приоритетный показ только платным пользователям

}

}

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargos-priority-view-api/v2/cargos/{cargoApplicationId}/priority-view' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"priority_view":{"view_rate":0.5,"daily_limit":0.5,"order_limit":0.5,"is_for_paid_only":false}}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/gw/cargos-priority-view-api/v2/cargos/{cargoApplicationId}/priority-view", "{""priority_view"":{""view_rate"":0.5,""daily_limit"":0.5,""order_limit"":0.5,""is_for_paid_only"":false}}");

Ответ

200 Success

Успешный ответ

Консоль

Отправить

Параметры

cargoApplicationId

{ "priority_view": { "view_rate": 0.5, "daily_limit": 0.5, "order_limit": 0.5, "is_for_paid_only": false } }

Удаление приоритетного показа

Версия 1.0 2

Обнуление параметров приоритетного показа у груза. API для интеграции. Отключает приоритетный показ; сам груз остаётся опубликованным.

Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

delete /v1.0/loads/{loadId}/priority

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/priority' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.0/loads/{loadId}/priority");

Ответ

200 Груз после отключения приоритетного показа.

Модель

{...}

Груз в ответе: поля публикации и вычисляемые сервисом.

LoadMeta:

Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией

ONE-OF

1:{...}

Метаданные публикации.

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные. Максимальная длина 1024 символа

}

ContactId1*: int32

Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id. Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами. Контакт должен быть виден для остальных участников АТИ

ContactId2: int32 (nullable)

Идентификатор второго выбранного контакта, если не выбрано, то null. Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу. Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC. Минимальное значение равно текущей дате. При значении параметра DateType равным 0, допустимое значение поля - текущая дата. При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед. При значении параметра DateType равным 2, допустимое значение поля - текущая дата. При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC. Минимальное значение равно значению параметра FirstDate. При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед. При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед. При значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется. При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Тип готовности груза к перевозке, по умолчанию 0

• 0 - Готов к загрузке
• 1 - в период с FirstDate по LastDate
• 2 - постоянно
• 3 - груза нет, запрос ставки

PeriodicityId: int32

Периодичность загрузки. Если параметр DateType не равен 2, PeriodicityId равен 0. Иначе PeriodicityId может принимать следующие значения:

• 1 - ежедневно
• 100 - по рабочим дням

OrderNumber: string

Номер заказа. Ограничение по длине: 250 символов

Krugoreis: boolean

Включён ли кругорейс

Loading*:

Точка погрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

ExtraPoints:[{...}]

Дополнительные пункты маршрута между погрузкой и выгрузкой.
Максимум 15 штук. Может иметь значение null

CityId*: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

PointType*: int32

Тип точки:

• 1 - загрузка
• 2 - разгрузка
• 3 - таможня
• 8 - проехать через

Latitude: decimal (nullable)

Широта точки. Допустимое значение от -90 до 90; указывается вместе с долготой

Longitude: decimal (nullable)

Долгота точки. Допустимое значение от -180 до 180; указывается вместе с широтой

Street: string

Улица или район. Максимальная длина 200 символов

OrganizationId: guid (nullable)

Организация, принимающая или отгружающая груз в этой точке. Указывается только вместе с AddressId

AddressId: guid (nullable)

Адрес точки. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

OrdinalId: int32

Порядок точки на маршруте. Если у всех точек 0, сервис нумерует их по порядку списка

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeStart: string (nullable)

Время начала загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeEnd: string (nullable)

Время окончания загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingCargos:[{...}]

Позиции груза, которые берут в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

UnloadingCargos:[{...}]

Позиции груза, которые оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза (CargoId из точки загрузки)

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

PackagingQuantity: int32 (nullable)

Количество выгружаемых мест

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

}]

Unloading*:

Точка выгрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

Cargo*:

Что везём: наименование, вес, объём, упаковка

ONE-OF

1:{...}

Описание груза: что и сколько везём.

Weight: double

Вес груза в тоннах. Обязательный параметр, если не задан параметр Volume. Допустимое значение 0 либо от 0,001 до 9999, не более 3 знаков после запятой

Volume: double

Объём груза в кубических метрах. Обязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа

ADR: int32

Класс опасности груза по ADR. Допустимое значение от 0 до 9, по умолчанию 0. Для CargoTypeId = 53 обязателен ненулевой

CargoTypeId*: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes

CargoType: string

Наименование груза текстом. Обязательный параметр: при CargoTypeId = 59 («другое») это и есть наименование груза. Максимальная длина названия - 200 символов. В этом поле запрещено указывать контактную информацию

PackType: int32

Идентификатор типа упаковки (навалом, коробки, россыпью), 0 — упаковка не указана. dict: GET /v1.0/dictionaries/packTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-packTypes

PalletCount: int32

Количество упаковок для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

• 1 - только отдельной машиной
• 2 - отдельной или догрузом
• 3 - только догрузом

SborGruz: boolean

Сборный груз

Size:

Параметры размера груза

ONE-OF

1:{...}

Габариты груза.

Length: double

Длина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

HeightHighlight: boolean

Выделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

}

}

Transport*:

Требования к транспорту: кузов, варианты загрузки и выгрузки

ONE-OF

1:{...}

Требования к транспорту.

CarType*: int64

Битовая маска типов кузова: идентификаторы из справочника — степени двойки, несколько кузовов складываются (1 + 4 = 5). dict: GET /v1.0/dictionaries/carTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes

CarTypeString: string

Та же битовая маска типов кузова строкой. Только в ответе: в запросе значение игнорируется

LoadingType: int32

Битовая маска вариантов загрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/loadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes

LoadingLogicalOperator: string

Тип условия загрузки:

• OR - необходимо, чтобы присутствовал один из способов загрузки
• AND - необходимо, чтобы присутствовали все выбранные типы загрузки

UnloadingType: int32

Битовая маска вариантов разгрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/unloadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-unloadingTypes

UnloadingLogicalOperator: string

Тип условия разгрузки:

• OR - необходимо, чтобы присутствовал один из способов разгрузки
• AND - необходимо, чтобы присутствовали все выбранные типы разгрузки

TrucksQuantity: int32

Количество машин. Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

Минимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

TemperatureTo: int32 (nullable)

Максимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

Stsepka: boolean

Нужна ли сцепка для груза

Pnevmohod: boolean

Нужен ли пневмоход для груза

Koniki: boolean

Нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

Документы на транспорт, необходимые для провоза этого груза: медкнижка

IsTracking: boolean

Трекинг через АТИ Водитель

RequiredCapacity: double (nullable)

Требуемая грузоподъемность в тоннах. Допустимое значение от 0,01 до 9999, не более 3 знаков после запятой

}

Payment*:

Условия оплаты и ставка

ONE-OF

1:{...}

Условия оплаты и ставка.

CurrencyId: int32

Идентификатор валюты. dict: GET /v1.0/dictionaries/currencyTypes → Id. По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

MoneyType: int32

Идентификатор варианта оплаты. dict: GET /v1.0/dictionaries/moneyTypes → Id. По умолчанию - 22. Должен принимать значение 22, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-moneyTypes

RateSum: decimal

Ставка для груза. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов

SumWithNDS: decimal

Ставка по безналичному расчёту с НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов. Если заданы обе безналичные ставки, SumWithNDS должна быть не меньше SumWithoutNDS. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0

SumWithoutNDS: decimal

Ставка по безналичному расчёту без НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Значение не меньше 0, максимальная длина 10 символов. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0

PrepayPercent: int32

Процент предоплаты. Допустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

Через сколько банковских дней оплата. Допустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false

PayDaysEnabled: boolean

Включена ли оплата через банковские дни. По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true

FixedRate: boolean

true, если ставка задана, false если запрос ставки. По умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1

Torg: boolean

Возможен ли торг. По умолчанию - false. Должен быть false, если параметр FixedRate равен false; при торгах с публикацией ставки — true

DirectContract: boolean

Прямой договор

InFuel: boolean

Предоплата топливом. Должен быть false, если параметр PrepayPercentEnabled равен false

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

Скрыть встречные предложения

AcceptPaymentTypes: int32

Битовая маска форм оплаты, которые вы готовы принять при запросе ставки: флаги складываются

• 1 - наличные
• 2 - безналичный расчёт с НДС
• 4 - безналичный расчёт без НДС

Пример: 7 — все три формы. При запросе ставки значение 0 сервис заменяет на 7; при фиксированной ставке поле не используется

}

InviteSettings:

Настройки автоприглашений

ONE-OF

1:{...}

Настройки автоприглашений по встречным предложениям.

InviteDelayInSeconds: int32

Время в секундах сбора встречных предложений: через него сервис создаёт приглашение по лучшему предложению. Обязателен и больше 0, если объект настроек передан

InviteDurationInSeconds: int32

Время в секундах действия приглашения. Обязателен и больше 0, если объект настроек передан

MaxPercentDeviation: int32 (nullable)

На сколько процентов встречное предложение может превышать вашу ставку, чтобы приглашение всё-таки ушло

NeedArchiveOnInvite: boolean

Архивировать груз при срабатывании автоматического приглашения

}

PriorityView:

Приоритетный показ

ONE-OF

1:{...}

Параметры приоритетного показа в ответе.

DailyLimit: decimal

Суточный лимит списания по услуге в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

Показывать груз в приоритете только платным пользователям

OrderLimit: decimal

Лимит списания на груз в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

Ставка за просмотр в атисах

• Кратна 0,5
• Не меньше минимальной ставки сервиса и не больше баланса фирмы
• Должна иметь длину не более 5 символов

MoneySpentPerDay: decimal

Сколько списано с баланса за груз в текущие сутки. Только для чтения

MoneySpentPerOrder: decimal

Сколько списано с баланса за груз за всё время. Только для чтения

}

Stealth:

Настройки показа груза

ONE-OF

1:{...}

Ограничения показа груза платной услугой «Стелс»: списания идут с баланса фирмы. Если объект передан, нужен хотя бы один параметр.

ListIdToHide: guid (nullable)

Идентификатор списка фирм, которым груз не показывается. dict: GET https://api.ati.su/scrolls/v1/firms → id. docs: https://ati.su/developers/api/catalogs/firm-lists/

FirmRegDateToHide: date-time (nullable)

Фирмам, зарегистрированным позже этой даты, груз не показывается

ScoreToHide: double (nullable)

Минимальное число звёзд фирмы: фирмам с меньшим числом груз не показывается. Целое от 1 до 5; при включённом бронировании на общей площадке — от 2 до 5

}

LoadFiles:[{...}]

Файлы к грузу.
Перед добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. API для хранения файлов)

Id: guid

Устаревший идентификатор файла, используйте FileId

deprecated

FileId: string

Идентификатор файла, который вернул API хранения файлов при загрузке. dict: POST https://api.ati.su/v1.0/filestorage/files → id. docs: https://ati.su/developers/api/filestorage/

FileType: int32

Тип загруженного файла. Всегда 1 — документ

Attributes: int32

Устаревшее поле, всегда 0

Name: string

Имя файла. Только в ответе: приходит из хранилища файлов, в запросе значение игнорируется

Link: string

Ссылка, по которой можно скачать файл. Сервис собирает её из идентификатора файла в хранилище

Size: int32

Устаревшее поле, всегда -1

}]

Deal:

Сделка, в рамках которой размещён груз

ONE-OF

1:{...}

Сделка по грузу в ответе.

Auction:

Параметры аукциона

ONE-OF

1:{...}

Торги по грузу в ответе.

StartRate*: decimal

Начальная ставка аукциона. Параметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.

Currency*: int32

Валюта аукциона. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

Step*: decimal

Минимальное изменение ставки по аукциону. Параметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.

PaymentType*:

Тип оплаты в торгах: допустимы только 24 и 25

ONE-OF

enum

[1, 22, 23, 24, 25]

Тип оплаты.

• 1 - Наличные
• 22 - Любая
• 23 - На карту
• 24 - Безналичный расчёт с НДС
• 25 - Безналичный расчёт без НДС

AcceptSecondPayType: boolean

Принимать ставки и со вторым типом оплаты: без НДС при PaymentType = 24, с НДС при PaymentType = 25

StartDate: date-time

Время начала аукциона в UTC. Должно быть позже времени начала публикации груза на площадке.

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Время окончания аукциона "завершить не позже". Если указанное время, меньше значения Duration - аукцион заканчивается по времени "завершить не позже", если нет автопродления. Время устанавливается в формате UTC.

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.

AutoRenew: boolean

Нужно ли продлевать торги, если ставка пришла незадолго до окончания

RenewTime: int32 (nullable)

Время в минутах, на которое сдвигается окончание аукциона при включённом AutoRenew

MaxRenewTime: int32 (nullable)

Максимально допустимое время в минутах, на которое можно сдвинуть окончание аукциона при включённом AutoRenew. Указывать, если AutoRenew = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

Максимально допустимая ставка по аукциону. Обязателен при RaiseBid = true. Не меньше суммы StartRate и Step, не больше 9999999999, не более 10 символов.

RaiseBidInterval: int32 (nullable)

Период увеличения ставки в минутах при отсутствии предложений. Обязателен при RaiseBid = true: от 1 минуты и меньше Duration. При StartSinceFirstBet = true верхнее ограничение не действует.

ResponseInMinutes: int32 (nullable)

Через сколько минут после начала торгов принимать встречные предложения:

• 0 - сразу
• N - через N минут; допустимо любое значение от 0 и меньше Duration
• null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

Длительность торгов в минутах: целое число больше 0. Окончание торгов не может быть позже времени актуальности груза LastDate. Если не указана, вычисляется как разница EndDate и StartDate, при этом StartSinceFirstBet игнорируется

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчёт до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:

Параметры перезапуска аукциона.
Если объект не передан, действуют значения по умолчанию: до 3 автоматических перевыборов победителя, после исчерпания груз публикуется со ставкой

ONE-OF

1:{...}

Параметры перезапуска торгов.

AuctionFinishAction:

Действие после исчерпания перезапусков

ONE-OF

enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны.

• 1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
• 2 - Опубликовать груз с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе.
• 3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно. Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно. В переданном объекте параметров по умолчанию 0; если сам объект не передан, действует значение 3

DurationAfterRestart: int32 (nullable)

Длительность торгов в минутах после перезапуска. Необязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным

RateIncrease: decimal (nullable)

Повышение ставки при перезапуске

RateIncreaseOption: int32 (nullable)

Единица повышения ставки при перезапуске:

• 1 - в валюте
• 2 - в процентах

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

Принимать встречные предложения только до первой ставки

WinnerCriterion:

Критерий выбора победителя торгов

ONE-OF

enum

[0, 1]

Критерий победы в аукционе.

• 0 - Выбор победителя происходит автоматически по лучшей ставке
• 1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

Source:

Площадка, на которой идут торги. Значение выставляет система: передавайте 0 или не передавайте поле

ONE-OF

enum

[0, 2]

Площадка, на которой идут торги по грузу.

• 0 - Торги в АТИ
• 2 - Торги в Atrucks

AuctionId: guid

Идентификатор аукциона

LoadId: guid

Идентификатор груза, для которого активен аукцион

ActiveDealId: guid (nullable)

Идентификатор сделки, привязанной к аукциону

State:

Статус аукциона

ONE-OF

enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона.

• -100 - Не удалось определить состояние аукциона
• -14 - Аукцион отменен руками грузовладельца
• -13 - Аукцион удален, т.к. расторгнут заказ
• -12 - Аукцион без ставок завершен
• -11 - Аукцион удален автоматически
• -10 - Аукцион удален т.к. сделка завершена
• -9 - Аукцион удален
• -8 - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет
• -7 - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель
• -6 - При включенном копировании грузов: торги завершены, экспедитор не является победителем
• -5 - Одна ставка лучшая по цене, другая по дате
• -4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
• -3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
• -2 - Закончился, ждем когда победитель возьмет груз
• -1 - Закончился, ставок нет
• 0 - Идет, ставок нет
• 1 - Идет (уже есть валидные ставки)

Finished: boolean

Завершён ли аукцион

WinDate: date-time (nullable)

Время, когда одна из ставок в AuctionRates стала победной

AuctionRates:[{...}]

Список ставок по аукциону

AuctionRateId: guid

Идентификатор ставки

AddedAt: date-time

Когда сделана ставка

RateFirm:

Фирма, сделавшая ставку

ONE-OF

1:{...}

Фирма-участник торгов: рейтинг, статус и контакт.

Score: double

Рейтинг фирмы в звёздах

Status:

Статус фирмы в АТИ. Коды описаны в FirmStatus

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7]

Статус фирмы по цвету звёзд.

• 0 - Серый
• 1 - Зелёный
• 2 - Жёлтый
• 3 - Красный
• 4 - Партнёр АТИ
• 5 - Сотрудник АТИ
• 6 - Гос. органы
• 7 - ОДКС

Name: string

Имя фирмы

ContactName: string

Имя контакта

AtiId: string

Идентификатор фирмы в АТИ

}

Rate: decimal

Ставка на груз, которую поставил пользователь

State:

Статус ставки. Коды описаны в AuctionRateState

ONE-OF

enum

[0, 1, -8, -7, -6, -5, -4, -3, -2, -1]

Статус ставки.

• -8 - Грузовладелец отклонил документ
• -7 - Победитель отклонил документ
• -6 - Победитель отменил сделку
• -5 - Грузовладелец отменил сделку
• -4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
• -3 - Бывший победитель
• -2 - Перевозчик отказался от участия
• -1 - Предложение отклонил грузовладелец/перевозчик
• 0 - Непобедная ставка при завершении торгов
• 1 - Победная ставка в аукционе

LoadingDate: date-time (nullable)

Ближайшая возможная для перевозчика дата загрузки. Используется только в аукционах с критерием победы по ставке и дате загрузки

FirmId: int32

Идентификатор фирмы, сделавшей ставку

ContactId: int32

Идентификатор контакта, сделавшего ставку

}]

}

}

Boards:[{...}]

Список площадок

BoardId: string

Идентификатор площадки из 24 символов. Значение общей площадки — a0a0a0a0a0a0a0a0a0a0a0a0

PublicationTime: date-time (nullable)

Время публикации на площадке. Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

Разрешено ли бронирование груза на общей площадке. Учитывается только для Общей площадки, только при включённом Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Является ли площадка общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC. Может иметь значение null. Минимальное значение равно текущей дате. Не указывается при значении параметра DateType равным 3

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null. Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate. Не указывается при значении параметра DateType равным 3

ArchiveDate: date-time (nullable)

Дата и время переноса в архив

ArchiveReason:

Причина переноса в архив

ONE-OF

(nullable)

enum

[Unknown, System, Manual, Complaints, UnwantedContent, DeleteCsvLoad, MergeLoadsAfterEdit, ContactDoesNotHaveAccessToVirtualPayments, VerticesLoadDelete, StealthStatisticError, CheckDuplicateComplaints, DeleteContact, DeleteFirm, CleanOldLoadsJob]

Причина, по которой груз оказался в архиве.

• VerticesLoadDelete - Снят при сквозной передаче груза
• StealthStatisticError - Снят из-за ошибки при подсчёте статистики Стелса
• CheckDuplicateComplaints - Снят при проверке дублирующих жалоб
• DeleteContact - Удалён контакт
• DeleteFirm - Удалена фирма
• CleanOldLoadsJob - Истёк срок актуальности
• Unknown - Причина не определена
• System - Снят системой
• Manual - Снят с публикации владельцем
• Complaints - Снят по жалобам
• UnwantedContent - Снят за недопустимое содержимое
• DeleteCsvLoad - Удалён вместе с CSV-загрузкой
• MergeLoadsAfterEdit - Объединён с другим грузом после редактирования
• ContactDoesNotHaveAccessToVirtualPayments - Снят: у контакта нет права оплачивать услугу со счёта фирмы

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

Идентификатор валюты озвученной ставки. dict: GET /v1.0/dictionaries/currencyTypes → Id

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Можно ли снять груз с публикации

HasPermissionsToLoad: boolean

Есть ли у текущего контакта доступ к грузу: контакт указан в грузе или имеет доступ к его подразделению

CanBeEdited: boolean

Можно ли редактировать груз

CanBeRenewed: boolean

Можно ли обновить груз

CanBeRestored: boolean

Можно ли восстановить груз из архива

EditRestriction:

Причина отказа в редактировании груза, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

DeleteRestriction:

Причина отказа в снятии груза с публикации, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RestoreRestriction:

Причина отказа в восстановлении груза из архива, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RenewRestriction: string

Причина отказа в обновлении груза. Пустая строка, если обновление доступно

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

UpdatedAt: date-time

Дата последнего изменения груза в UTC

AddedAt: date-time

Дата публикации груза в UTC

RefreshedAt: date-time

Дата последнего обновления груза в выдаче, в UTC

Distance: int32

Расстояние по дорогам в километрах

PlatonRoadsLength: int32

Протяжённость участков маршрута, за которые взимается плата по системе «Платон», в километрах

TollRoadsLength: int32

Протяжённость платных дорог на маршруте в километрах

TravelTime: string

Расчётное время в пути в формате [d.]hh:mm:ss

Zimnik: boolean

Учитывать ли зимники при построении маршрута

Ferries: boolean

Учитывать ли паромные переправы при построении маршрута

FirmId: string

Идентификатор фирмы

AuctionId: guid (nullable)

Идентификатор аукциона по грузу

}

Пример

{...}

"LoadMeta":{...},

"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"MetaData":"import-2026-09"

},

"ContactId1":1234567,

"ContactId2":1234568,

"Note":"Погрузка с 9 до 18, пропуск заказывать заранее",

"FirstDate":"2026-09-08T00:00:00.000Z",

"LastDate":"2026-09-10T00:00:00.000Z",

"DateType":1,

"PeriodicityId":0,

"OrderNumber":"ЗК-2026-0917",

"Krugoreis":false,

"Loading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"ExtraPoints":[...],

{...}

"CityId":1,

"PointType":2,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"пр. Ленина, 10",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"OrdinalId":1,

"IsRoundTheClock":false,

"LoadingDateStart":"2026-09-09T00:00:00.000Z",

"LoadingDateEnd":"2026-09-09T00:00:00.000Z",

"LoadingTimeStart":"09:00:00",

"LoadingTimeEnd":"18:00:00",

"LoadingCargos":[...],

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

],

"UnloadingCargos":[...]

{...}

"CargoId":1,

"Weight":10,

"Volume":40,

"PackagingQuantity":10,

"IsDefinedByTtn":false

}

]

}

],

"Unloading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"Cargo":{...},

"Weight":20,

"Volume":82,

"ADR":0,

"CargoTypeId":59,

"CargoType":"Стройматериалы",

"PackType":1,

"PalletCount":33,

"BeltCount":0,

"DogruzType":1,

"SborGruz":false,

"Size":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

},

"Transport":{...},

"CarType":5,

"CarTypeString":"5",

"LoadingType":3,

"LoadingLogicalOperator":"OR",

"UnloadingType":3,

"UnloadingLogicalOperator":"OR",

"TrucksQuantity":1,

"TemperatureFrom":-18,

"TemperatureTo":4,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false,

"RequiredCapacity":20

},

"Payment":{...},

"CurrencyId":1,

"MoneyType":22,

"RateSum":85000,

"SumWithNDS":102000,

"SumWithoutNDS":85000,

"PrepayPercent":30,

"PrepayPercentEnabled":true,

"PayDays":5,

"PayDaysEnabled":true,

"FixedRate":true,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

},

"InviteSettings":{...},

"InviteDelayInSeconds":600,

"InviteDurationInSeconds":3600,

"MaxPercentDeviation":10,

"NeedArchiveOnInvite":false

},

"PriorityView":{...},

"DailyLimit":500,

"IsForPayedOnly":false,

"OrderLimit":100,

"ViewRate":1.5,

"MoneySpentPerDay":12,

"MoneySpentPerOrder":45

},

"Stealth":{...},

"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"FirmRegDateToHide":"2024-01-01T00:00:00.000Z",

"ScoreToHide":3

},

"LoadFiles":[...],

{...}

"FileId":"a1b2c3d4e5f6a7b8c9d0e1f2",

"FileType":1,

"Attributes":0,

"Name":"Договор.pdf",

"Link":"https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2",

"Size":-1

}

],

"Deal":{...},

"Auction":{...}

"StartRate":50000,

"Currency":1,

"Step":500,

"PaymentType":0,

"AcceptSecondPayType":false,

"StartDate":"2026-09-08T09:00:00.000Z",

"EndDate":"2026-09-08T12:00:00.000Z",

"EndDateBoundary":"2026-09-09T09:00:00.000Z",

"Nds":20,

"TimeToProvideDocuments":4,

"AutoRenew":true,

"RenewTime":5,

"MaxRenewTime":30,

"RaiseBid":false,

"MaxRate":60000,

"RaiseBidInterval":30,

"ResponseInMinutes":15,

"Duration":180,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":1,

"InitChangeWinnerCount":1,

"DurationAfterRestart":120,

"RateIncrease":500,

"RateIncreaseOption":1

},

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

"Source":0,

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ActiveDealId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"State":0,

"Finished":false,

"WinDate":"2026-09-08T12:05:00.000Z",

"AuctionRates":[...]

{...}

"AuctionRateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddedAt":"2026-09-08T10:15:30.000Z",

"RateFirm":{...},

"Score":4.5,

"Status":0,

"Name":"ООО «Перевозчик»",

"ContactName":"Иван Петров",

"AtiId":"1234567"

},

"Rate":48000,

"State":0,

"LoadingDate":"2026-09-09T00:00:00.000Z",

"FirmId":7654321,

"ContactId":0

}

]

}

},

"Boards":[...],

{...}

"BoardId":"a0a0a0a0a0a0a0a0a0a0a0a0",

"PublicationTime":"2026-09-08T12:00:00.000Z",

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":true,

"IsCommonBoard":true

}

],

"UnloadFirstDate":"2026-09-11T00:00:00.000Z",

"UnloadLastDate":"2026-09-12T00:00:00.000Z",

"ArchiveDate":"2026-09-07T10:15:30.000Z",

"ArchiveReason":"Unknown",

"TruePrice":85000,

"TrueCurrencyId":1,

"ResponseCount":3,

"OfferCount":2,

"CanBeDeleted":true,

"HasPermissionsToLoad":true,

"CanBeEdited":true,

"CanBeRenewed":true,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"Груз можно обновить не ранее чем через 40 минут",

"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"12345678",

"UpdatedAt":"2026-09-07T10:15:30.000Z",

"AddedAt":"2026-09-05T08:00:00.000Z",

"RefreshedAt":"2026-09-07T09:00:00+00:00",

"Distance":712,

"PlatonRoadsLength":540,

"TollRoadsLength":120,

"TravelTime":"10:30:00",

"Zimnik":false,

"Ferries":false,

"FirmId":"1234567",

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

403 Нет доступа к грузу.

Модель

{...}

Отказ в доступе к операции с грузом: ключ ошибки, пояснение и код причины.

Error: string

Ключ ошибки

Reason: string

Причина ошибки для показа пользователю

AccessDeniedReason:

Код причины отказа. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

ExceededLimit:

Какой лимит грузов исчерпан, если причина отказа — превышение лимита: 0 — общая площадка, 1 — персональные площадки. В остальных случаях null

ONE-OF

(nullable)

enum

[0, 1]

Лимит грузов, который исчерпан.

• 0 - Лимит грузов на общей площадке
• 1 - Лимит грузов на персональных площадках

}

Пример

{...}

"Error":"access_denied_error",

"Reason":"У вашего контакта недостаточно прав для работы с данным грузом",

"AccessDeniedReason":0,

"ExceededLimit":0

}

404 Груз не найден среди опубликованных грузов фирмы.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Груз не найден",

"Error":"load_not_found_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

Удаление настроек приоритетного показа с груза

delete /gw/cargos-priority-view-api/v2/cargos/{cargoApplicationId}/priority-view

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoApplicationId обязательный	string (uuid)	path	Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargos-priority-view-api/v2/cargos/{cargoApplicationId}/priority-view' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/gw/cargos-priority-view-api/v2/cargos/{cargoApplicationId}/priority-view");

Ответ

200 Success

Успешный ответ

Консоль

Отправить

Параметры

cargoApplicationId

Методы для работы с комментариями к грузам

Получение всех комментариев ко всем грузам для текущей фирмы

Ответ будет представлен в виде словаря, где ключ - это id груза, а значение - массив структуры “комментарий”.

Получение всех комментариев фирмы ко всем грузам. API для интеграции. Возвращаются комментарии вашей фирмы ко всем её опубликованным грузам.

get /v1.0/loads/comments

Модель и примеры

Параметры

Параметров нет

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/comments' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/comments");

Ответ

200 Комментарии фирмы по грузам. Ключ — идентификатор груза.

Модель

{...}

any-key:[{...}]

Комментарий фирмы к грузу.

CommentId: guid

Идентификатор комментария

LoadId: guid

Идентификатор груза, к которому оставлен комментарий

Message: string

Текст комментария

ContactId: int32

Идентификатор контакта фирмы, оставившего комментарий

CommentDateTime: date-time

Время, когда комментарий был оставлен. Дата в UTC

}]

}

Пример

{...}

"3fa85f64-5717-4562-b3fc-2c963f66afa6":[]

}

Консоль

Отправить

Параметры

Нет параметров

Получение всех комментариев к грузу для текущей фирмы

Получение комментариев фирмы к грузу. API для интеграции. Комментарий виден только фирме, которая его оставила: чужие комментарии к тому же грузу не возвращаются.

get /v1.0/loads/{loadId}/comments

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/comments' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/{loadId}/comments");

Ответ

200 Комментарии фирмы к грузу.

Модель

[{...}]

Комментарий фирмы к грузу.

CommentId: guid

Идентификатор комментария

LoadId: guid

Идентификатор груза, к которому оставлен комментарий

Message: string

Текст комментария

ContactId: int32

Идентификатор контакта фирмы, оставившего комментарий

CommentDateTime: date-time

Время, когда комментарий был оставлен. Дата в UTC

}]

Пример

[...]

{...}

"CommentId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Message":"Договорились на понедельник",

"ContactId":0,

"CommentDateTime":"2026-09-07T10:15:30.000Z"

}

]

404 Груз не найден среди опубликованных грузов фирмы.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Груз не найден",

"Error":"load_not_found_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

Добавление либо редактирование комментария к грузу

При редактировании комментария у изменённого комментария поменяется CommentId.

Требования к комментарию

• комментарий не может быть пустым
• длина комментария не более 128 символов
• если для фирмы включен режим раздельного доступа, то количество комментариев к одному грузу ограничено одним комментарием на контакт, иначе – одним комментарием на фирму

Добавление либо редактирование комментария к грузу. API для интеграции. Повторный вызов заменяет комментарий фирмы к этому грузу, а не добавляет ещё один.

put /v1.0/loads/{loadId}/comments

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Модель

string

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/comments' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '"Договорились на понедельник"'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/{loadId}/comments", """Договорились на понедельник""");

Ответ

200 Сохранённый комментарий.

Модель

{...}

Комментарий фирмы к грузу.

CommentId: guid

Идентификатор комментария

LoadId: guid

Идентификатор груза, к которому оставлен комментарий

Message: string

Текст комментария

ContactId: int32

Идентификатор контакта фирмы, оставившего комментарий

CommentDateTime: date-time

Время, когда комментарий был оставлен. Дата в UTC

}

Пример

{...}

"CommentId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Message":"Договорились на понедельник",

"ContactId":0,

"CommentDateTime":"2026-09-07T10:15:30.000Z"

}

400 Комментарий пустой или длиннее 128 символов.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Ошибка валидации: Массив ids не должен быть пуст",

"Error":"validation_error"

}

404 Груз не найден среди опубликованных грузов фирмы.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Груз не найден",

"Error":"load_not_found_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

"Договорились на понедельник"

Удаление комментария у груза

Удаление комментария у груза. API для интеграции. Удаляется комментарий вашей фирмы; на сам груз и на чужие комментарии вызов не влияет.

delete /v1.0/loads/{loadId}/comments

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/comments' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.0/loads/{loadId}/comments");

Ответ

200 Комментарий удалён.

Модель

string

Пример

"string"

404 Груз или комментарий фирмы к нему не найден.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Груз не найден",

"Error":"load_not_found_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

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

Отзыв может быть “Встречным предложением” с одной или несколькими ставками, “Груза нет”, “Озвученная ставка”.

Требования к дате, передаваемой в dateFrom при отправке запросов на получение отзывов:

• Дата в UTC, начиная с которой необходимо показывать отзывы. Если ничего не передано, значит показываем абсолютно все отзывы
• Формат даты: yyyy-mm-ddThh:mm:ss<timezone_specifier>, где timezone_specifier обозначает спецификатор часового пояса, например:
  • Z - дата в формате UTC. Пример, 2016-04-28T20:01:57Z;
  • -hh:mm - часовой пояс UTC-hh:mm. Пример UTC-1: 2016-04-28T20:01:57-01:00;
  • %2Bhh:mm - часовой пояс UTC+hh:mm. Пример UTC+1: 2016-04-28T20:01:57%2B01:00;
• Если модификатора часового пояса нет, дата отправляется в формате UTC±00:00

Методы API для работы со встречными предложениями по грузам

Создание встречного предложения

Метод используется для первичной отправки встречного предложения по грузу cargoId. После успешного вызова сохраните Id встречного предложения из ответа: он потребуется для изменения и удаления.

Создание встречного предложения

post /gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoId обязательный	string (guid)	path	ID груза Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Модель

{...}

contact_id*: int32

Контакт, от лица которого выставить встречное предложение

price: decimal

Предложенная ставка встречного предложения не б/нал.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_percent: int32 (nullable)

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

note: string (nullable)

Примечание к встречному предложению

prepay_percent: int32

Процент предоплаты
Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней\

loading_date: date (nullable)

Дата загрузки

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

}

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"contact_id":1,"price":100.5,"currency_id":1,"nds_price":100.5,"nds_percent":22,"nds_currency_id":1,"not_nds_price":100.5,"not_nds_currency_id":1,"note":"Примечание","prepay_percent":10,"pay_after_max_bank_days":0,"loading_date":"2024-01-15","pay_attributes":64}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers", "{""contact_id"":1,""price"":100.5,""currency_id"":1,""nds_price"":100.5,""nds_percent"":22,""nds_currency_id"":1,""not_nds_price"":100.5,""not_nds_currency_id"":1,""note"":""Примечание"",""prepay_percent"":10,""pay_after_max_bank_days"":0,""loading_date"":""2024-01-15"",""pay_attributes"":64}");

Ответ

200

Модель

{...}

Встречное предложение

id: guid

Id встречного предложения

cargo_id: guid

Id груза, на который оставлено встречное предложение

cargo_number: string

Минимальное количество символов: 1

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная цена встречного предложения

currency_id: int32

Валюта встречного предложения
Значение из словаря валют АТИ

nds_price: decimal

Предложенная цена встречного предложения с НДС

nds_percent: int32

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная цена встречного предложения без НДС

not_nds_currency_id: int32

Валюта встречного предложения без НДС

counter_offer_source: int32

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string

Минимальное количество символов: 1

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты

pay_after_max_bank_days: int32

Оплата через ... банковских дней

loading_date: date

Дата загрузки

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\

is_cargo_published: boolean

Относится ли встречное предложение к опубликованному грузу

firm_info:

Информация о фирме, оставившей встречное предложение на груз

ONE-OF

1:{...}

Информация о фирме

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

full_firm_name: string

Минимальное количество символов: 1

Полное название фирмы

contact:

Информация о контакте фирмы

ONE-OF

1:{...}

Информация о контакте

id: int32

Id контакта в фирме

name: string

Минимальное количество символов: 1

Имя контакта

telephone: string

Минимальное количество символов: 1

Телефон

email: string

Минимальное количество символов: 1

Электронная почта

mobile: string

Минимальное количество символов: 1

Телефон(мобильный)

mobile_operator: string

Минимальное количество символов: 1

Мобильный оператор

location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Информация о городе

city_id: int32

ID города

region_id: int32

ID региона

country_id: int32

ID страны

full_name: string

Минимальное количество символов: 1

Полное название

short_name: string

Минимальное количество символов: 1

Краткое название

is_regional_center: boolean

Является ли региональным центром

fias_id: guid

Id в базе ФИАС

city_name: string

Минимальное количество символов: 1

Название города

region_name: string

Минимальное количество символов: 1

Название региона

country_name: string

Минимальное количество символов: 1

Название страны

country_code: string

Минимальное количество символов: 1

Код страны

}

}

inn: string

Минимальное количество символов: 1

ИНН

}

}

Пример

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"CES23786",

"cargo_firm_id":1234,

"firm_id":1234,

"added_at":"2024-01-15T10:30:00+03:00",

"updated_at":"2024-01-15T10:30:00+03:00",

"price":100.5,

"currency_id":1,

"nds_price":100.5,

"nds_percent":22,

"nds_currency_id":1,

"not_nds_price":100.5,

"not_nds_currency_id":1,

"counter_offer_source":2,

"note":"Тестовое примечание",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2024-01-15",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.5,

"status":3,

"full_firm_name":"ООО Тест",

"contact":{...},

"id":1,

"name":"Иванов Иван",

"telephone":"+74951234567",

"email":"test@test.ru",

"mobile":"+79001234567",

"mobile_operator":"МТС",

"location":{...}

"city_id":1,

"region_id":1,

"country_id":1,

"full_name":"Москва, Россия",

"short_name":"Москва",

"is_regional_center":true,

"fias_id":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",

"city_name":"Москва",

"region_name":"Московская область",

"country_name":"Россия",

"country_code":"RU"

}

},

"inn":1234567890

}

}

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId ID груза

{ "contact_id": 1, "price": 100.5, "currency_id": 1, "nds_price": 100.5, "nds_percent": 22, "nds_currency_id": 1, "not_nds_price": 100.5, "not_nds_currency_id": 1, "note": "Примечание", "prepay_percent": 10, "pay_after_max_bank_days": 0, "loading_date": "2024-01-15", "pay_attributes": 64 }

Изменение встречного предложения

Метод изменяет уже отправленное встречное предложение по id. Используйте его, когда меняются ставка, условия оплаты или комментарий, чтобы не создавать дублирующие предложения.

Обновление встречного предложения

put /gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/{id}

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoId обязательный	string (guid)	path	ID груза Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6
id обязательный	string (guid)	path	ID встречного предложения Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Модель

{...}

contact_id*: int32

Контакт, от лица которого выставить встречное предложение

price: decimal

Предложенная ставка встречного предложения не б/нал.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_percent: int32 (nullable)

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

note: string (nullable)

Примечание к встречному предложению

prepay_percent: int32

Процент предоплаты
Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней\

loading_date: date (nullable)

Дата загрузки

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

}

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/{id}' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"contact_id":1,"price":100.5,"currency_id":1,"nds_price":100.5,"nds_percent":22,"nds_currency_id":1,"not_nds_price":100.5,"not_nds_currency_id":1,"note":"Примечание","prepay_percent":10,"pay_after_max_bank_days":0,"loading_date":"2024-01-15","pay_attributes":64}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/{id}", "{""contact_id"":1,""price"":100.5,""currency_id"":1,""nds_price"":100.5,""nds_percent"":22,""nds_currency_id"":1,""not_nds_price"":100.5,""not_nds_currency_id"":1,""note"":""Примечание"",""prepay_percent"":10,""pay_after_max_bank_days"":0,""loading_date"":""2024-01-15"",""pay_attributes"":64}");

Ответ

200

Модель

{...}

Встречное предложение

id: guid

Id встречного предложения

cargo_id: guid

Id груза, на который оставлено встречное предложение

cargo_number: string

Минимальное количество символов: 1

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная цена встречного предложения

currency_id: int32

Валюта встречного предложения
Значение из словаря валют АТИ

nds_price: decimal

Предложенная цена встречного предложения с НДС

nds_percent: int32

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная цена встречного предложения без НДС

not_nds_currency_id: int32

Валюта встречного предложения без НДС

counter_offer_source: int32

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string

Минимальное количество символов: 1

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты

pay_after_max_bank_days: int32

Оплата через ... банковских дней

loading_date: date

Дата загрузки

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\

is_cargo_published: boolean

Относится ли встречное предложение к опубликованному грузу

firm_info:

Информация о фирме, оставившей встречное предложение на груз

ONE-OF

1:{...}

Информация о фирме

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

full_firm_name: string

Минимальное количество символов: 1

Полное название фирмы

contact:

Информация о контакте фирмы

ONE-OF

1:{...}

Информация о контакте

id: int32

Id контакта в фирме

name: string

Минимальное количество символов: 1

Имя контакта

telephone: string

Минимальное количество символов: 1

Телефон

email: string

Минимальное количество символов: 1

Электронная почта

mobile: string

Минимальное количество символов: 1

Телефон(мобильный)

mobile_operator: string

Минимальное количество символов: 1

Мобильный оператор

location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Информация о городе

city_id: int32

ID города

region_id: int32

ID региона

country_id: int32

ID страны

full_name: string

Минимальное количество символов: 1

Полное название

short_name: string

Минимальное количество символов: 1

Краткое название

is_regional_center: boolean

Является ли региональным центром

fias_id: guid

Id в базе ФИАС

city_name: string

Минимальное количество символов: 1

Название города

region_name: string

Минимальное количество символов: 1

Название региона

country_name: string

Минимальное количество символов: 1

Название страны

country_code: string

Минимальное количество символов: 1

Код страны

}

}

inn: string

Минимальное количество символов: 1

ИНН

}

}

Пример

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"CES23786",

"cargo_firm_id":1234,

"firm_id":1234,

"added_at":"2024-01-15T10:30:00+03:00",

"updated_at":"2024-01-15T10:30:00+03:00",

"price":100.5,

"currency_id":1,

"nds_price":100.5,

"nds_percent":22,

"nds_currency_id":1,

"not_nds_price":100.5,

"not_nds_currency_id":1,

"counter_offer_source":2,

"note":"Тестовое примечание",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2024-01-15",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.5,

"status":3,

"full_firm_name":"ООО Тест",

"contact":{...},

"id":1,

"name":"Иванов Иван",

"telephone":"+74951234567",

"email":"test@test.ru",

"mobile":"+79001234567",

"mobile_operator":"МТС",

"location":{...}

"city_id":1,

"region_id":1,

"country_id":1,

"full_name":"Москва, Россия",

"short_name":"Москва",

"is_regional_center":true,

"fias_id":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",

"city_name":"Москва",

"region_name":"Московская область",

"country_name":"Россия",

"country_code":"RU"

}

},

"inn":1234567890

}

}

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId ID груза

id ID встречного предложения

{ "contact_id": 1, "price": 100.5, "currency_id": 1, "nds_price": 100.5, "nds_percent": 22, "nds_currency_id": 1, "not_nds_price": 100.5, "not_nds_currency_id": 1, "note": "Примечание", "prepay_percent": 10, "pay_after_max_bank_days": 0, "loading_date": "2024-01-15", "pay_attributes": 64 }

Удаление своих встречных предложений для чужого опубликованного груза

Метод позволяет снять свои встречные предложения с чужого опубликованного груза. Используйте его, когда нужно отозвать участие в торге без влияния на предложения других участников.

Удаление своих встречных предложений для чужого опубликованного груза

delete /gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/my

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoId обязательный	string (guid)	path	ID груза Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/my' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/my");

Ответ

204

Успешный ответ

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId ID груза

Удаление чужих встречных предложений для своего груза

Метод используется владельцем груза для удаления выбранных входящих предложений. Передавайте в body массив counterOfferIds, чтобы удалить только нужные предложения.

Удаление чужих встречных предложений для своего груза

delete /gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoId обязательный	string (guid)	path	ID груза Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Модель

[guid]

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '["3fa85f64-5717-4562-b3fc-2c963f66afa6"]'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers", "[""3fa85f64-5717-4562-b3fc-2c963f66afa6""]");

Ответ

200

Модель

{...}

any-key:{...}

Статус выполнения операции

message: string (nullable)

Сообщение о результате операции

error: string (nullable)

Описание ошибки

result:

Результат операции

ONE-OF

(nullable)

1:{...}

Встречное предложение

id: guid

Id встречного предложения

cargo_id: guid

Id груза, на который оставлено встречное предложение

cargo_number: string

Минимальное количество символов: 1

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная цена встречного предложения

currency_id: int32

Валюта встречного предложения
Значение из словаря валют АТИ

nds_price: decimal

Предложенная цена встречного предложения с НДС

nds_percent: int32

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная цена встречного предложения без НДС

not_nds_currency_id: int32

Валюта встречного предложения без НДС

counter_offer_source: int32

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string

Минимальное количество символов: 1

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты

pay_after_max_bank_days: int32

Оплата через ... банковских дней

loading_date: date

Дата загрузки

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\

is_cargo_published: boolean

Относится ли встречное предложение к опубликованному грузу

firm_info:

Информация о фирме, оставившей встречное предложение на груз

ONE-OF

1:{...}

Информация о фирме

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

full_firm_name: string

Минимальное количество символов: 1

Полное название фирмы

contact:

Информация о контакте фирмы

ONE-OF

1:{...}

Информация о контакте

id: int32

Id контакта в фирме

name: string

Минимальное количество символов: 1

Имя контакта

telephone: string

Минимальное количество символов: 1

Телефон

email: string

Минимальное количество символов: 1

Электронная почта

mobile: string

Минимальное количество символов: 1

Телефон(мобильный)

mobile_operator: string

Минимальное количество символов: 1

Мобильный оператор

location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Информация о городе

city_id: int32

ID города

region_id: int32

ID региона

country_id: int32

ID страны

full_name: string

Минимальное количество символов: 1

Полное название

short_name: string

Минимальное количество символов: 1

Краткое название

is_regional_center: boolean

Является ли региональным центром

fias_id: guid

Id в базе ФИАС

city_name: string

Минимальное количество символов: 1

Название города

region_name: string

Минимальное количество символов: 1

Название региона

country_name: string

Минимальное количество символов: 1

Название страны

country_code: string

Минимальное количество символов: 1

Код страны

}

}

inn: string

Минимальное количество символов: 1

ИНН

}

}

}

}

Пример

{...}

"any-key":{...}

"message":"OK",

"error":null,

"result":{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"CES23786",

"cargo_firm_id":1234,

"firm_id":1234,

"added_at":"2024-01-15T10:30:00+03:00",

"updated_at":"2024-01-15T10:30:00+03:00",

"price":100.5,

"currency_id":1,

"nds_price":100.5,

"nds_percent":22,

"nds_currency_id":1,

"not_nds_price":100.5,

"not_nds_currency_id":1,

"counter_offer_source":2,

"note":"Тестовое примечание",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2024-01-15",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.5,

"status":3,

"full_firm_name":"ООО Тест",

"contact":{...},

"id":1,

"name":"Иванов Иван",

"telephone":"+74951234567",

"email":"test@test.ru",

"mobile":"+79001234567",

"mobile_operator":"МТС",

"location":{...}

"city_id":1,

"region_id":1,

"country_id":1,

"full_name":"Москва, Россия",

"short_name":"Москва",

"is_regional_center":true,

"fias_id":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",

"city_name":"Москва",

"region_name":"Московская область",

"country_name":"Россия",

"country_code":"RU"

}

},

"inn":1234567890

}

}

}

}

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId ID груза

[ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ]

Получение встречных предложений для опубликованного груза

Метод возвращает предложения по конкретному опубликованному грузу. Чтобы получать встречные предложения, которые были созданы или изменились с определенного момента времени, используйте параметр fromDate.

Получение встречных предложений для опубликованного груза

get /gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoId обязательный	string (guid)	path	ID груза Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6
fromDate	string (date-time)	query	Дата с которой вернуть встречные предложения Пример: 2024-01-01T00:00:00+00:00

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers");

Ответ

200

Модель

[{...}]

Встречное предложение

id: guid

Id встречного предложения

cargo_id: guid

Id груза, на который оставлено встречное предложение

cargo_number: string

Минимальное количество символов: 1

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная цена встречного предложения

currency_id: int32

Валюта встречного предложения
Значение из словаря валют АТИ

nds_price: decimal

Предложенная цена встречного предложения с НДС

nds_percent: int32

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная цена встречного предложения без НДС

not_nds_currency_id: int32

Валюта встречного предложения без НДС

counter_offer_source: int32

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string

Минимальное количество символов: 1

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты

pay_after_max_bank_days: int32

Оплата через ... банковских дней

loading_date: date

Дата загрузки

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\

is_cargo_published: boolean

Относится ли встречное предложение к опубликованному грузу

firm_info:

Информация о фирме, оставившей встречное предложение на груз

ONE-OF

1:{...}

Информация о фирме

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

full_firm_name: string

Минимальное количество символов: 1

Полное название фирмы

contact:

Информация о контакте фирмы

ONE-OF

1:{...}

Информация о контакте

id: int32

Id контакта в фирме

name: string

Минимальное количество символов: 1

Имя контакта

telephone: string

Минимальное количество символов: 1

Телефон

email: string

Минимальное количество символов: 1

Электронная почта

mobile: string

Минимальное количество символов: 1

Телефон(мобильный)

mobile_operator: string

Минимальное количество символов: 1

Мобильный оператор

location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Информация о городе

city_id: int32

ID города

region_id: int32

ID региона

country_id: int32

ID страны

full_name: string

Минимальное количество символов: 1

Полное название

short_name: string

Минимальное количество символов: 1

Краткое название

is_regional_center: boolean

Является ли региональным центром

fias_id: guid

Id в базе ФИАС

city_name: string

Минимальное количество символов: 1

Название города

region_name: string

Минимальное количество символов: 1

Название региона

country_name: string

Минимальное количество символов: 1

Название страны

country_code: string

Минимальное количество символов: 1

Код страны

}

}

inn: string

Минимальное количество символов: 1

ИНН

}

}]

Пример

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"CES23786",

"cargo_firm_id":1234,

"firm_id":1234,

"added_at":"2024-01-15T10:30:00+03:00",

"updated_at":"2024-01-15T10:30:00+03:00",

"price":100.5,

"currency_id":1,

"nds_price":100.5,

"nds_percent":22,

"nds_currency_id":1,

"not_nds_price":100.5,

"not_nds_currency_id":1,

"counter_offer_source":2,

"note":"Тестовое примечание",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2024-01-15",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.5,

"status":3,

"full_firm_name":"ООО Тест",

"contact":{...},

"id":1,

"name":"Иванов Иван",

"telephone":"+74951234567",

"email":"test@test.ru",

"mobile":"+79001234567",

"mobile_operator":"МТС",

"location":{...}

"city_id":1,

"region_id":1,

"country_id":1,

"full_name":"Москва, Россия",

"short_name":"Москва",

"is_regional_center":true,

"fias_id":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",

"city_name":"Москва",

"region_name":"Московская область",

"country_name":"Россия",

"country_code":"RU"

}

},

"inn":1234567890

}

}

]

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId ID груза

fromDate Дата с которой вернуть встречные предложения

Получение встречных предложений для всех опубликованных грузов

Метод возвращает предложения по всем опубликованным грузам фирмы. Обычно используется в фоновой синхронизации с fromDate, чтобы не загружать полный список при каждом опросе.

Получение встречных предложений для всех опубликованных грузов

get /gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
fromDate	string (date-time)	query	Дата с которой вернуть встречные предложения Пример: 2024-01-01T00:00:00+00:00

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers");

Ответ

200

Модель

[{...}]

Встречное предложение

id: guid

Id встречного предложения

cargo_id: guid

Id груза, на который оставлено встречное предложение

cargo_number: string

Минимальное количество символов: 1

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная цена встречного предложения

currency_id: int32

Валюта встречного предложения
Значение из словаря валют АТИ

nds_price: decimal

Предложенная цена встречного предложения с НДС

nds_percent: int32

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная цена встречного предложения без НДС

not_nds_currency_id: int32

Валюта встречного предложения без НДС

counter_offer_source: int32

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string

Минимальное количество символов: 1

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты

pay_after_max_bank_days: int32

Оплата через ... банковских дней

loading_date: date

Дата загрузки

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\

is_cargo_published: boolean

Относится ли встречное предложение к опубликованному грузу

firm_info:

Информация о фирме, оставившей встречное предложение на груз

ONE-OF

1:{...}

Информация о фирме

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

full_firm_name: string

Минимальное количество символов: 1

Полное название фирмы

contact:

Информация о контакте фирмы

ONE-OF

1:{...}

Информация о контакте

id: int32

Id контакта в фирме

name: string

Минимальное количество символов: 1

Имя контакта

telephone: string

Минимальное количество символов: 1

Телефон

email: string

Минимальное количество символов: 1

Электронная почта

mobile: string

Минимальное количество символов: 1

Телефон(мобильный)

mobile_operator: string

Минимальное количество символов: 1

Мобильный оператор

location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Информация о городе

city_id: int32

ID города

region_id: int32

ID региона

country_id: int32

ID страны

full_name: string

Минимальное количество символов: 1

Полное название

short_name: string

Минимальное количество символов: 1

Краткое название

is_regional_center: boolean

Является ли региональным центром

fias_id: guid

Id в базе ФИАС

city_name: string

Минимальное количество символов: 1

Название города

region_name: string

Минимальное количество символов: 1

Название региона

country_name: string

Минимальное количество символов: 1

Название страны

country_code: string

Минимальное количество символов: 1

Код страны

}

}

inn: string

Минимальное количество символов: 1

ИНН

}

}]

Пример

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"CES23786",

"cargo_firm_id":1234,

"firm_id":1234,

"added_at":"2024-01-15T10:30:00+03:00",

"updated_at":"2024-01-15T10:30:00+03:00",

"price":100.5,

"currency_id":1,

"nds_price":100.5,

"nds_percent":22,

"nds_currency_id":1,

"not_nds_price":100.5,

"not_nds_currency_id":1,

"counter_offer_source":2,

"note":"Тестовое примечание",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2024-01-15",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.5,

"status":3,

"full_firm_name":"ООО Тест",

"contact":{...},

"id":1,

"name":"Иванов Иван",

"telephone":"+74951234567",

"email":"test@test.ru",

"mobile":"+79001234567",

"mobile_operator":"МТС",

"location":{...}

"city_id":1,

"region_id":1,

"country_id":1,

"full_name":"Москва, Россия",

"short_name":"Москва",

"is_regional_center":true,

"fias_id":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",

"city_name":"Москва",

"region_name":"Московская область",

"country_name":"Россия",

"country_code":"RU"

}

},

"inn":1234567890

}

}

]

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

fromDate Дата с которой вернуть встречные предложения

Получение встречных предложений для опубликованных грузов по их ID

Ответ будет представлен в виде словаря, где ключ - id груза, а значение - структура со статусом и списком встречных предложений, содержащий:

• Result, представляющий набор встречных предложений для данного груза;
• Status, представляющий статус груза: если груз с таким id не найден, то статус равен 1, иначе статус равен 0. Если у груза статус равен 1, то массив встречных предложений всегда пуст.

Список ключей словаря полностью совпадает со списком грузов, для которых были запрошены встречные предложения. Параметр onlyActual используйте, если в интеграции нужно работать только с актуальными предложениями.

Получение встречных предложений для опубликованных грузов по их ID

get /gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/by-cargo-ids

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
dateFrom	string (date-time)	query	Дата с которой вернуть встречные предложения Пример: 2024-01-01T00:00:00+00:00
onlyActual	boolean	query	Только актуальные встречные предложения Пример: false
cargoIds	string (guid)[]	query	ID грузов Пример: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"]

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/by-cargo-ids' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/by-cargo-ids");

Ответ

200

Модель

{...}

any-key:{...}

Статус выполнения операции

message: string (nullable)

Сообщение о результате операции

error: string (nullable)

Описание ошибки

result:[{...}]

Результат операции

id: guid

Id встречного предложения

cargo_id: guid

Id груза, на который оставлено встречное предложение

cargo_number: string

Минимальное количество символов: 1

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная цена встречного предложения

currency_id: int32

Валюта встречного предложения
Значение из словаря валют АТИ

nds_price: decimal

Предложенная цена встречного предложения с НДС

nds_percent: int32

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная цена встречного предложения без НДС

not_nds_currency_id: int32

Валюта встречного предложения без НДС

counter_offer_source: int32

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string

Минимальное количество символов: 1

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты

pay_after_max_bank_days: int32

Оплата через ... банковских дней

loading_date: date

Дата загрузки

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\

is_cargo_published: boolean

Относится ли встречное предложение к опубликованному грузу

firm_info:

Информация о фирме, оставившей встречное предложение на груз

ONE-OF

1:{...}

Информация о фирме

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

full_firm_name: string

Минимальное количество символов: 1

Полное название фирмы

contact:

Информация о контакте фирмы

ONE-OF

1:{...}

Информация о контакте

id: int32

Id контакта в фирме

name: string

Минимальное количество символов: 1

Имя контакта

telephone: string

Минимальное количество символов: 1

Телефон

email: string

Минимальное количество символов: 1

Электронная почта

mobile: string

Минимальное количество символов: 1

Телефон(мобильный)

mobile_operator: string

Минимальное количество символов: 1

Мобильный оператор

location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Информация о городе

city_id: int32

ID города

region_id: int32

ID региона

country_id: int32

ID страны

full_name: string

Минимальное количество символов: 1

Полное название

short_name: string

Минимальное количество символов: 1

Краткое название

is_regional_center: boolean

Является ли региональным центром

fias_id: guid

Id в базе ФИАС

city_name: string

Минимальное количество символов: 1

Название города

region_name: string

Минимальное количество символов: 1

Название региона

country_name: string

Минимальное количество символов: 1

Название страны

country_code: string

Минимальное количество символов: 1

Код страны

}

}

inn: string

Минимальное количество символов: 1

ИНН

}

}]

}

}

Пример

{...}

"any-key":{...}

"message":"OK",

"error":null,

"result":[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"CES23786",

"cargo_firm_id":1234,

"firm_id":1234,

"added_at":"2024-01-15T10:30:00+03:00",

"updated_at":"2024-01-15T10:30:00+03:00",

"price":100.5,

"currency_id":1,

"nds_price":100.5,

"nds_percent":22,

"nds_currency_id":1,

"not_nds_price":100.5,

"not_nds_currency_id":1,

"counter_offer_source":2,

"note":"Тестовое примечание",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2024-01-15",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.5,

"status":3,

"full_firm_name":"ООО Тест",

"contact":{...},

"id":1,

"name":"Иванов Иван",

"telephone":"+74951234567",

"email":"test@test.ru",

"mobile":"+79001234567",

"mobile_operator":"МТС",

"location":{...}

"city_id":1,

"region_id":1,

"country_id":1,

"full_name":"Москва, Россия",

"short_name":"Москва",

"is_regional_center":true,

"fias_id":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",

"city_name":"Москва",

"region_name":"Московская область",

"country_name":"Россия",

"country_code":"RU"

}

},

"inn":1234567890

}

}

]

}

}

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

dateFrom Дата с которой вернуть встречные предложения

onlyActual true false Только актуальные встречные предложения

cargoIds ID грузов

Получение статусов своих встречных предложений на чужие грузы

Метод возвращает статусы ваших предложений по чужим грузам. Удобен как быстрый предварительный шаг перед детальной загрузкой самих предложений.

Получение статусов своих встречных предложений на чужие грузы

get /gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/statuses

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
dateFrom	string (date-time)	query	Дата с которой вернуть статусы Пример: 2024-01-01T00:00:00+00:00

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/statuses' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/statuses");

Ответ

200

Модель

[{...}]

Статус встречного предложения для груза

cargo_id: guid

ID груза

has_active: boolean

Есть ли активное встречное предложение

}]

Пример

[...]

{...}

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"has_active":true

}

]

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

dateFrom Дата с которой вернуть статусы

Получение встречного предложения по его ID

Метод возвращает одно конкретное предложение по id. Используйте его, когда нужно открыть карточку предложения напрямую, без загрузки общих списков.

Получение встречного предложения по его ID

get /gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/{id}

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
id обязательный	string (guid)	path	ID встречного предложения Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/{id}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/{id}");

Ответ

200

Модель

{...}

Встречное предложение

id: guid

Id встречного предложения

cargo_id: guid

Id груза, на который оставлено встречное предложение

cargo_number: string

Минимальное количество символов: 1

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная цена встречного предложения

currency_id: int32

Валюта встречного предложения
Значение из словаря валют АТИ

nds_price: decimal

Предложенная цена встречного предложения с НДС

nds_percent: int32

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная цена встречного предложения без НДС

not_nds_currency_id: int32

Валюта встречного предложения без НДС

counter_offer_source: int32

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string

Минимальное количество символов: 1

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты

pay_after_max_bank_days: int32

Оплата через ... банковских дней

loading_date: date

Дата загрузки

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\

is_cargo_published: boolean

Относится ли встречное предложение к опубликованному грузу

firm_info:

Информация о фирме, оставившей встречное предложение на груз

ONE-OF

1:{...}

Информация о фирме

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

full_firm_name: string

Минимальное количество символов: 1

Полное название фирмы

contact:

Информация о контакте фирмы

ONE-OF

1:{...}

Информация о контакте

id: int32

Id контакта в фирме

name: string

Минимальное количество символов: 1

Имя контакта

telephone: string

Минимальное количество символов: 1

Телефон

email: string

Минимальное количество символов: 1

Электронная почта

mobile: string

Минимальное количество символов: 1

Телефон(мобильный)

mobile_operator: string

Минимальное количество символов: 1

Мобильный оператор

location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Информация о городе

city_id: int32

ID города

region_id: int32

ID региона

country_id: int32

ID страны

full_name: string

Минимальное количество символов: 1

Полное название

short_name: string

Минимальное количество символов: 1

Краткое название

is_regional_center: boolean

Является ли региональным центром

fias_id: guid

Id в базе ФИАС

city_name: string

Минимальное количество символов: 1

Название города

region_name: string

Минимальное количество символов: 1

Название региона

country_name: string

Минимальное количество символов: 1

Название страны

country_code: string

Минимальное количество символов: 1

Код страны

}

}

inn: string

Минимальное количество символов: 1

ИНН

}

}

Пример

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"CES23786",

"cargo_firm_id":1234,

"firm_id":1234,

"added_at":"2024-01-15T10:30:00+03:00",

"updated_at":"2024-01-15T10:30:00+03:00",

"price":100.5,

"currency_id":1,

"nds_price":100.5,

"nds_percent":22,

"nds_currency_id":1,

"not_nds_price":100.5,

"not_nds_currency_id":1,

"counter_offer_source":2,

"note":"Тестовое примечание",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2024-01-15",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.5,

"status":3,

"full_firm_name":"ООО Тест",

"contact":{...},

"id":1,

"name":"Иванов Иван",

"telephone":"+74951234567",

"email":"test@test.ru",

"mobile":"+79001234567",

"mobile_operator":"МТС",

"location":{...}

"city_id":1,

"region_id":1,

"country_id":1,

"full_name":"Москва, Россия",

"short_name":"Москва",

"is_regional_center":true,

"fias_id":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",

"city_name":"Москва",

"region_name":"Московская область",

"country_name":"Россия",

"country_code":"RU"

}

},

"inn":1234567890

}

}

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

id ID встречного предложения

Получение встречных предложений для неопубликованных грузов

Метод возвращает предложения по всем неопубликованным грузам фирмы. Для получения только изменений передавайте fromDate.

Получение встречных предложений для неопубликованных грузов

get /gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
fromDate	string (date-time)	query	Дата с которой вернуть встречные предложения Пример: 2024-01-01T00:00:00+00:00

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers");

Ответ

200

Модель

[{...}]

Встречное предложение

id: guid

Id встречного предложения

cargo_id: guid

Id груза, на который оставлено встречное предложение

cargo_number: string

Минимальное количество символов: 1

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная цена встречного предложения

currency_id: int32

Валюта встречного предложения
Значение из словаря валют АТИ

nds_price: decimal

Предложенная цена встречного предложения с НДС

nds_percent: int32

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная цена встречного предложения без НДС

not_nds_currency_id: int32

Валюта встречного предложения без НДС

counter_offer_source: int32

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string

Минимальное количество символов: 1

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты

pay_after_max_bank_days: int32

Оплата через ... банковских дней

loading_date: date

Дата загрузки

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\

is_cargo_published: boolean

Относится ли встречное предложение к опубликованному грузу

firm_info:

Информация о фирме, оставившей встречное предложение на груз

ONE-OF

1:{...}

Информация о фирме

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

full_firm_name: string

Минимальное количество символов: 1

Полное название фирмы

contact:

Информация о контакте фирмы

ONE-OF

1:{...}

Информация о контакте

id: int32

Id контакта в фирме

name: string

Минимальное количество символов: 1

Имя контакта

telephone: string

Минимальное количество символов: 1

Телефон

email: string

Минимальное количество символов: 1

Электронная почта

mobile: string

Минимальное количество символов: 1

Телефон(мобильный)

mobile_operator: string

Минимальное количество символов: 1

Мобильный оператор

location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Информация о городе

city_id: int32

ID города

region_id: int32

ID региона

country_id: int32

ID страны

full_name: string

Минимальное количество символов: 1

Полное название

short_name: string

Минимальное количество символов: 1

Краткое название

is_regional_center: boolean

Является ли региональным центром

fias_id: guid

Id в базе ФИАС

city_name: string

Минимальное количество символов: 1

Название города

region_name: string

Минимальное количество символов: 1

Название региона

country_name: string

Минимальное количество символов: 1

Название страны

country_code: string

Минимальное количество символов: 1

Код страны

}

}

inn: string

Минимальное количество символов: 1

ИНН

}

}]

Пример

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"CES23786",

"cargo_firm_id":1234,

"firm_id":1234,

"added_at":"2024-01-15T10:30:00+03:00",

"updated_at":"2024-01-15T10:30:00+03:00",

"price":100.5,

"currency_id":1,

"nds_price":100.5,

"nds_percent":22,

"nds_currency_id":1,

"not_nds_price":100.5,

"not_nds_currency_id":1,

"counter_offer_source":2,

"note":"Тестовое примечание",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2024-01-15",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.5,

"status":3,

"full_firm_name":"ООО Тест",

"contact":{...},

"id":1,

"name":"Иванов Иван",

"telephone":"+74951234567",

"email":"test@test.ru",

"mobile":"+79001234567",

"mobile_operator":"МТС",

"location":{...}

"city_id":1,

"region_id":1,

"country_id":1,

"full_name":"Москва, Россия",

"short_name":"Москва",

"is_regional_center":true,

"fias_id":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",

"city_name":"Москва",

"region_name":"Московская область",

"country_name":"Россия",

"country_code":"RU"

}

},

"inn":1234567890

}

}

]

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

fromDate Дата с которой вернуть встречные предложения

Получение встречных предложений для неопубликованного груза по его ID

Метод возвращает предложения по конкретному неопубликованному грузу. Подходит для карточки груза и получения только изменений с использованием fromDate.

Получение встречных предложений для неопубликованного груза по его ID

get /gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoId обязательный	string (guid)	path	ID груза Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6
fromDate	string (date-time)	query	Дата с которой вернуть встречные предложения Пример: 2024-01-01T00:00:00+00:00

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers");

Ответ

200

Модель

[{...}]

Встречное предложение

id: guid

Id встречного предложения

cargo_id: guid

Id груза, на который оставлено встречное предложение

cargo_number: string

Минимальное количество символов: 1

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная цена встречного предложения

currency_id: int32

Валюта встречного предложения
Значение из словаря валют АТИ

nds_price: decimal

Предложенная цена встречного предложения с НДС

nds_percent: int32

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная цена встречного предложения без НДС

not_nds_currency_id: int32

Валюта встречного предложения без НДС

counter_offer_source: int32

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string

Минимальное количество символов: 1

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты

pay_after_max_bank_days: int32

Оплата через ... банковских дней

loading_date: date

Дата загрузки

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\

is_cargo_published: boolean

Относится ли встречное предложение к опубликованному грузу

firm_info:

Информация о фирме, оставившей встречное предложение на груз

ONE-OF

1:{...}

Информация о фирме

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

full_firm_name: string

Минимальное количество символов: 1

Полное название фирмы

contact:

Информация о контакте фирмы

ONE-OF

1:{...}

Информация о контакте

id: int32

Id контакта в фирме

name: string

Минимальное количество символов: 1

Имя контакта

telephone: string

Минимальное количество символов: 1

Телефон

email: string

Минимальное количество символов: 1

Электронная почта

mobile: string

Минимальное количество символов: 1

Телефон(мобильный)

mobile_operator: string

Минимальное количество символов: 1

Мобильный оператор

location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Информация о городе

city_id: int32

ID города

region_id: int32

ID региона

country_id: int32

ID страны

full_name: string

Минимальное количество символов: 1

Полное название

short_name: string

Минимальное количество символов: 1

Краткое название

is_regional_center: boolean

Является ли региональным центром

fias_id: guid

Id в базе ФИАС

city_name: string

Минимальное количество символов: 1

Название города

region_name: string

Минимальное количество символов: 1

Название региона

country_name: string

Минимальное количество символов: 1

Название страны

country_code: string

Минимальное количество символов: 1

Код страны

}

}

inn: string

Минимальное количество символов: 1

ИНН

}

}]

Пример

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"CES23786",

"cargo_firm_id":1234,

"firm_id":1234,

"added_at":"2024-01-15T10:30:00+03:00",

"updated_at":"2024-01-15T10:30:00+03:00",

"price":100.5,

"currency_id":1,

"nds_price":100.5,

"nds_percent":22,

"nds_currency_id":1,

"not_nds_price":100.5,

"not_nds_currency_id":1,

"counter_offer_source":2,

"note":"Тестовое примечание",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2024-01-15",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.5,

"status":3,

"full_firm_name":"ООО Тест",

"contact":{...},

"id":1,

"name":"Иванов Иван",

"telephone":"+74951234567",

"email":"test@test.ru",

"mobile":"+79001234567",

"mobile_operator":"МТС",

"location":{...}

"city_id":1,

"region_id":1,

"country_id":1,

"full_name":"Москва, Россия",

"short_name":"Москва",

"is_regional_center":true,

"fias_id":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",

"city_name":"Москва",

"region_name":"Московская область",

"country_name":"Россия",

"country_code":"RU"

}

},

"inn":1234567890

}

}

]

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId ID груза

fromDate Дата с которой вернуть встречные предложения

Получение встречных предложений для неопубликованных грузов по их ID

Ответ будет представлен в виде словаря, где ключ - id груза, а значение - структура со статусом и списком встречных предложений, содержащий:

• Result, представляющий набор встречных предложений для данного груза;
• Status, представляющий статус груза: если груз с таким id не найден, то статус равен 1, иначе статус равен 0. Если у груза статус равен 1, то массив встречных предложений всегда пуст.

Список ключей словаря полностью совпадает со списком грузов, для которых были запрошены встречные предложения.

Получение встречных предложений для неопубликованных грузов по их ID

get /gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers/by-cargo-ids

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoIds	string (guid)[]	query	ID грузов Пример: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"]
fromDate	string (date-time)	query	Дата с которой вернуть встречные предложения Пример: 2024-01-01T00:00:00+00:00

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers/by-cargo-ids' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers/by-cargo-ids");

Ответ

200

Модель

{...}

any-key:{...}

Статус выполнения операции

message: string (nullable)

Сообщение о результате операции

error: string (nullable)

Описание ошибки

result:[{...}]

Результат операции

id: guid

Id встречного предложения

cargo_id: guid

Id груза, на который оставлено встречное предложение

cargo_number: string

Минимальное количество символов: 1

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная цена встречного предложения

currency_id: int32

Валюта встречного предложения
Значение из словаря валют АТИ

nds_price: decimal

Предложенная цена встречного предложения с НДС

nds_percent: int32

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная цена встречного предложения без НДС

not_nds_currency_id: int32

Валюта встречного предложения без НДС

counter_offer_source: int32

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string

Минимальное количество символов: 1

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты

pay_after_max_bank_days: int32

Оплата через ... банковских дней

loading_date: date

Дата загрузки

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\

is_cargo_published: boolean

Относится ли встречное предложение к опубликованному грузу

firm_info:

Информация о фирме, оставившей встречное предложение на груз

ONE-OF

1:{...}

Информация о фирме

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

full_firm_name: string

Минимальное количество символов: 1

Полное название фирмы

contact:

Информация о контакте фирмы

ONE-OF

1:{...}

Информация о контакте

id: int32

Id контакта в фирме

name: string

Минимальное количество символов: 1

Имя контакта

telephone: string

Минимальное количество символов: 1

Телефон

email: string

Минимальное количество символов: 1

Электронная почта

mobile: string

Минимальное количество символов: 1

Телефон(мобильный)

mobile_operator: string

Минимальное количество символов: 1

Мобильный оператор

location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Информация о городе

city_id: int32

ID города

region_id: int32

ID региона

country_id: int32

ID страны

full_name: string

Минимальное количество символов: 1

Полное название

short_name: string

Минимальное количество символов: 1

Краткое название

is_regional_center: boolean

Является ли региональным центром

fias_id: guid

Id в базе ФИАС

city_name: string

Минимальное количество символов: 1

Название города

region_name: string

Минимальное количество символов: 1

Название региона

country_name: string

Минимальное количество символов: 1

Название страны

country_code: string

Минимальное количество символов: 1

Код страны

}

}

inn: string

Минимальное количество символов: 1

ИНН

}

}]

}

}

Пример

{...}

"any-key":{...}

"message":"OK",

"error":null,

"result":[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"CES23786",

"cargo_firm_id":1234,

"firm_id":1234,

"added_at":"2024-01-15T10:30:00+03:00",

"updated_at":"2024-01-15T10:30:00+03:00",

"price":100.5,

"currency_id":1,

"nds_price":100.5,

"nds_percent":22,

"nds_currency_id":1,

"not_nds_price":100.5,

"not_nds_currency_id":1,

"counter_offer_source":2,

"note":"Тестовое примечание",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2024-01-15",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.5,

"status":3,

"full_firm_name":"ООО Тест",

"contact":{...},

"id":1,

"name":"Иванов Иван",

"telephone":"+74951234567",

"email":"test@test.ru",

"mobile":"+79001234567",

"mobile_operator":"МТС",

"location":{...}

"city_id":1,

"region_id":1,

"country_id":1,

"full_name":"Москва, Россия",

"short_name":"Москва",

"is_regional_center":true,

"fias_id":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",

"city_name":"Москва",

"region_name":"Московская область",

"country_name":"Россия",

"country_code":"RU"

}

},

"inn":1234567890

}

}

]

}

}

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

cargoIds ID грузов

fromDate Дата с которой вернуть встречные предложения

Удаление встречных предложений для неопубликованного груза

Метод удаляет выбранные предложения по неопубликованному грузу. Список counterOfferIds передается в query.

Удаление встречных предложений для неопубликованного груза

delete /gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
cargoId обязательный	string (guid)	path	ID груза Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6
counterOfferIds	string (guid)[]	query	ID встречных предложений Пример: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"]

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers");

Ответ

200

Модель

{...}

any-key:{...}

Статус выполнения операции

message: string (nullable)

Сообщение о результате операции

error: string (nullable)

Описание ошибки

result:

Результат операции

ONE-OF

(nullable)

1:{...}

Встречное предложение

id: guid

Id встречного предложения

cargo_id: guid

Id груза, на который оставлено встречное предложение

cargo_number: string

Минимальное количество символов: 1

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная цена встречного предложения

currency_id: int32

Валюта встречного предложения
Значение из словаря валют АТИ

nds_price: decimal

Предложенная цена встречного предложения с НДС

nds_percent: int32

Процент НДС ставки встречного предложения

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная цена встречного предложения без НДС

not_nds_currency_id: int32

Валюта встречного предложения без НДС

counter_offer_source: int32

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string

Минимальное количество символов: 1

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты

pay_after_max_bank_days: int32

Оплата через ... банковских дней

loading_date: date

Дата загрузки

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\

is_cargo_published: boolean

Относится ли встречное предложение к опубликованному грузу

firm_info:

Информация о фирме, оставившей встречное предложение на груз

ONE-OF

1:{...}

Информация о фирме

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

full_firm_name: string

Минимальное количество символов: 1

Полное название фирмы

contact:

Информация о контакте фирмы

ONE-OF

1:{...}

Информация о контакте

id: int32

Id контакта в фирме

name: string

Минимальное количество символов: 1

Имя контакта

telephone: string

Минимальное количество символов: 1

Телефон

email: string

Минимальное количество символов: 1

Электронная почта

mobile: string

Минимальное количество символов: 1

Телефон(мобильный)

mobile_operator: string

Минимальное количество символов: 1

Мобильный оператор

location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Информация о городе

city_id: int32

ID города

region_id: int32

ID региона

country_id: int32

ID страны

full_name: string

Минимальное количество символов: 1

Полное название

short_name: string

Минимальное количество символов: 1

Краткое название

is_regional_center: boolean

Является ли региональным центром

fias_id: guid

Id в базе ФИАС

city_name: string

Минимальное количество символов: 1

Название города

region_name: string

Минимальное количество символов: 1

Название региона

country_name: string

Минимальное количество символов: 1

Название страны

country_code: string

Минимальное количество символов: 1

Код страны

}

}

inn: string

Минимальное количество символов: 1

ИНН

}

}

}

}

Пример

{...}

"any-key":{...}

"message":"OK",

"error":null,

"result":{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"CES23786",

"cargo_firm_id":1234,

"firm_id":1234,

"added_at":"2024-01-15T10:30:00+03:00",

"updated_at":"2024-01-15T10:30:00+03:00",

"price":100.5,

"currency_id":1,

"nds_price":100.5,

"nds_percent":22,

"nds_currency_id":1,

"not_nds_price":100.5,

"not_nds_currency_id":1,

"counter_offer_source":2,

"note":"Тестовое примечание",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2024-01-15",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.5,

"status":3,

"full_firm_name":"ООО Тест",

"contact":{...},

"id":1,

"name":"Иванов Иван",

"telephone":"+74951234567",

"email":"test@test.ru",

"mobile":"+79001234567",

"mobile_operator":"МТС",

"location":{...}

"city_id":1,

"region_id":1,

"country_id":1,

"full_name":"Москва, Россия",

"short_name":"Москва",

"is_regional_center":true,

"fias_id":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",

"city_name":"Москва",

"region_name":"Московская область",

"country_name":"Россия",

"country_code":"RU"

}

},

"inn":1234567890

}

}

}

}

4XX Ошибка запроса

Модель

{...}

error: string

Код ошибки

reason: string (nullable)

Причина ошибки

details:[{...}]

Детали ошибки

property: string

Свойство модели с ошибкой

error: string

Ошибка

reason: string

Причина ошибки

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"error":"string",

"reason":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId ID груза

counterOfferIds ID встречных предложений

Получение встречных предложений на грузы фирмы с одной или несколькими ставками

Получение всех отзывов по всем грузам фирмы. API для интеграции. Отдаются отзывы на опубликованные грузы фирмы, для которой выпущен токен. Возвращаются отзывы всех типов: встречные предложения, жалобы, озвученные ставки и «груза нет».

get /v1.0/loads/new/responses

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
dateFrom	string (date-time)	query	Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3). Пример: 2026-09-01T00:00:00.000Z

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/new/responses' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/new/responses");

Ответ

200 Отзывы на грузы фирмы.

Модель

[{...}]

Отзыв на груз в новой структуре.

ResponseId: guid

Идентификатор отзыва

LoadId: guid

Идентификатор груза, на который оставлен отзыв

LoadNumber: string

Номер груза

LoadFirmId: int32

Идентификатор фирмы, которой принадлежит груз

FirmId: int32

Идентификатор фирмы, оставившей отзыв

FirmName: string

Название фирмы, оставившей отзыв

ContactId: int32

Идентификатор контакта, оставившего отзыв. -1 — контакт скрыт: чужой отзыв на чужом грузе

AddedAt: date-time

Дата добавления отзыва

UpdatedAt: date-time

Дата изменения отзыва

Price: decimal

Ставка встречного предложения наличными

CurrencyId: int32

Валюта встречного предложения. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

NdsPrice: decimal

Предложенная ставка по безналичному расчёту с НДС

NdsCurrencyId: int32

Валюта ставки встречного предложения по безналичному расчёту с НДС. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

NotNdsPrice: decimal

Предложенная ставка по безналичному расчёту без НДС

NotNdsCurrencyId: int32

Идентификатор валюты ставки по безналичному расчёту без НДС. dict: GET /v1.0/dictionaries/currencyTypes → Id

NdsPercent: int32 (nullable)

Процент НДС в ставке

CounterOfferSource:

Откуда пришло встречное предложение

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6]

Откуда пришло встречное предложение.

• 0 - Неизвестный источник
• 1 - Встречное предложение из мобильного приложения
• 2 - Встречное предложение оставил интегратор по Id груза
• 3 - Встречное предложение оставил интегратор из перехвата грузов
• 4 - Встречное предложение оставили с поиска грузов
• 5 - Встречное предложение оставили из перехвата машин
• 6 - Сквозное встречное предложение, добавлено автоматически

Note: string

Примечание к встречному предложению. null — отзыв не является встречным предложением, пустая строка — примечание чужого отзыва скрыто

PayAttributes: int32

Атрибуты оплаты. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному расчёту
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - оплата через N банковских дней (см. PayAfterMaxBankDays)

PrepayPercent: int32

Процент предоплаты. Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

PayAfterMaxBankDays: int32

Оплата через ... банковских дней. Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включёна оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

LoadingDate: date-time (nullable)

Дата, на которую перевозчик готов забрать груз

IsOutdated: boolean

Отзыв помечен просроченным: груз после него отредактировали или сняли с публикации

IsLoadPublished: boolean

Относится ли отзыв к опубликованному грузу, а не к архивному

IsNoLoad: boolean

Отзыв означает жалобу «груза нет»

AnnouncedCurrencyId: int32

Валюта "Озвученной ставки". dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

AnnouncedRate: int32

Озвученная ставка

FirmInfo:

Фирма, оставившая отзыв. Контакт скрыт у чужого отзыва на чужом грузе

ONE-OF

1:{...}

Фирма, оставившая отзыв.

TotalScore: double

Рейтинг фирмы в звёздах

Status:

Статус фирмы в АТИ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7]

Статус фирмы по цвету звёзд.

• 0 - Серый
• 1 - Зелёный
• 2 - Жёлтый
• 3 - Красный
• 4 - Партнёр АТИ
• 5 - Сотрудник АТИ
• 6 - Гос. органы
• 7 - ОДКС

FullFirmName: string

Полное название фирмы

Contact:

Контакт фирмы, оставившей отзыв. null — чужой отзыв на чужом грузе.
Если контакт скрыт настройками фирмы, приходит общий контакт фирмы с идентификатором 0

ONE-OF

(nullable)

1:{...}

Контакт фирмы, оставившей отзыв.

Id: int32

Идентификатор контакта в фирме

Name: string

Имя контакта

Telephone: string

Телефон

Email: string

Электронная почта

Icq: string

Аккаунт ICQ

Mobile: string

Мобильный телефон

MobileOperator: string

Мобильный оператор

SkypeName: string

Аккаунт Skype

CityId: int32 (nullable)

Идентификатор города контакта. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Город местонахождения фирмы.

CityId: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

RegionId: int32 (nullable)

Идентификатор региона. dict: GET /v1.0/dictionaries/regions → Id. docs: https://ati.su/developers/api/dictionaries/geo/

CountryId: int32 (nullable)

Идентификатор страны. dict: GET /v1.0/dictionaries/countries → Id. docs: https://ati.su/developers/api/dictionaries/geo/

FullName: string

Город, регион и страна через запятую

ShortName: string

Город, регион (если город не областной центр) и код страны (если не Россия)

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

• 0 - не определён
• 1 - до 10 000
• 2 - от 10 000 до 50 000
• 3 - от 50 000 до 100 000
• 4 - от 100 000 до 500 000
• 5 - от 500 000 до 1 000 000
• 6 - свыше 1 000 000

FiasId: guid (nullable)

Идентификатор города в базе ФИАС

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CountryCodeName: string

Трёхбуквенный код страны, как InterShortName в справочнике стран

}

}

Inn: string

ИНН фирмы

}

}]

Пример

[...]

{...}

"ResponseId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"12345678",

"LoadFirmId":1234567,

"FirmId":7654321,

"FirmName":"ООО «Перевозчик»",

"ContactId":0,

"AddedAt":"2026-09-07T10:15:30.000Z",

"UpdatedAt":"2026-09-07T11:20:00.000Z",

"Price":85000,

"CurrencyId":1,

"NdsPrice":102000,

"NdsCurrencyId":1,

"NotNdsPrice":85000,

"NotNdsCurrencyId":1,

"NdsPercent":20,

"CounterOfferSource":0,

"Note":"Готовы забрать завтра утром",

"PayAttributes":91,

"PrepayPercent":30,

"PayAfterMaxBankDays":5,

"LoadingDate":"2026-09-08T00:00:00.000Z",

"IsOutdated":false,

"IsLoadPublished":true,

"IsNoLoad":false,

"AnnouncedCurrencyId":1,

"AnnouncedRate":90000,

"FirmInfo":{...}

"TotalScore":4.5,

"Status":0,

"FullFirmName":"ООО «Перевозчик»",

"Contact":{...},

"Id":1,

"Name":"Иван Петров",

"Telephone":"+7 812 123-45-67",

"Email":"ivan@example.com",

"Icq":"123456789",

"Mobile":"+7 911 123-45-67",

"MobileOperator":"МТС",

"SkypeName":"ivan.petrov",

"CityId":1,

"Location":{...}

"CityId":1,

"RegionId":153,

"CountryId":1,

"FullName":"Санкт-Петербург, Санкт-Петербург (регион), Россия",

"ShortName":"Санкт-Петербург",

"IsRegionalCenter":true,

"CitySize":6,

"FiasId":"c2deb16a-0330-4f05-821f-1d09c93331e6",

"CityName":"Санкт-Петербург",

"RegionName":"Санкт-Петербург (регион)",

"CountryName":"Россия",

"CountryCodeName":"RUS"

}

},

"Inn":"7801234567"

}

}

]

403 Фирме закрыт доступ к отзывам.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Отказано в доступе: У вашей фирмы нет доступа к работе с отзывами",

"Error":"access_denied_error"

}

Консоль

Отправить

Параметры

dateFrom Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3).

Получение отзывов на любой груз по ID

Если груз принадлежит вашей фирме, то вернутся все отзывы на ваш груз с полной информацией. Если груз принадлежит чужой фирме, то вернутся все отзывы на этот груз, но при этом все отзывы, кроме вашего, будут иметь в поле FirmInfo.Contact значение null.

Получение отзывов на конкретный груз фирмы. API для интеграции. По грузу вашей фирмы возвращаются все отзывы целиком. Возвращаются отзывы всех типов: встречные предложения, жалобы, озвученные ставки и «груза нет». По чужому грузу видны только актуальные отзывы, и только если владелец их не скрыл; контакты и примечания чужих отзывов скрыты, ваш отзыв — целиком.

get /v1.0/loads/new/{loadId}/responses

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6
dateFrom	string (date-time)	query	Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3). Пример: 2026-09-01T00:00:00.000Z

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/new/{loadId}/responses' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/new/{loadId}/responses");

Ответ

200 Отзывы на груз.

Модель

[{...}]

Отзыв на груз в новой структуре.

ResponseId: guid

Идентификатор отзыва

LoadId: guid

Идентификатор груза, на который оставлен отзыв

LoadNumber: string

Номер груза

LoadFirmId: int32

Идентификатор фирмы, которой принадлежит груз

FirmId: int32

Идентификатор фирмы, оставившей отзыв

FirmName: string

Название фирмы, оставившей отзыв

ContactId: int32

Идентификатор контакта, оставившего отзыв. -1 — контакт скрыт: чужой отзыв на чужом грузе

AddedAt: date-time

Дата добавления отзыва

UpdatedAt: date-time

Дата изменения отзыва

Price: decimal

Ставка встречного предложения наличными

CurrencyId: int32

Валюта встречного предложения. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

NdsPrice: decimal

Предложенная ставка по безналичному расчёту с НДС

NdsCurrencyId: int32

Валюта ставки встречного предложения по безналичному расчёту с НДС. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

NotNdsPrice: decimal

Предложенная ставка по безналичному расчёту без НДС

NotNdsCurrencyId: int32

Идентификатор валюты ставки по безналичному расчёту без НДС. dict: GET /v1.0/dictionaries/currencyTypes → Id

NdsPercent: int32 (nullable)

Процент НДС в ставке

CounterOfferSource:

Откуда пришло встречное предложение

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6]

Откуда пришло встречное предложение.

• 0 - Неизвестный источник
• 1 - Встречное предложение из мобильного приложения
• 2 - Встречное предложение оставил интегратор по Id груза
• 3 - Встречное предложение оставил интегратор из перехвата грузов
• 4 - Встречное предложение оставили с поиска грузов
• 5 - Встречное предложение оставили из перехвата машин
• 6 - Сквозное встречное предложение, добавлено автоматически

Note: string

Примечание к встречному предложению. null — отзыв не является встречным предложением, пустая строка — примечание чужого отзыва скрыто

PayAttributes: int32

Атрибуты оплаты. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному расчёту
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - оплата через N банковских дней (см. PayAfterMaxBankDays)

PrepayPercent: int32

Процент предоплаты. Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

PayAfterMaxBankDays: int32

Оплата через ... банковских дней. Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включёна оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

LoadingDate: date-time (nullable)

Дата, на которую перевозчик готов забрать груз

IsOutdated: boolean

Отзыв помечен просроченным: груз после него отредактировали или сняли с публикации

IsLoadPublished: boolean

Относится ли отзыв к опубликованному грузу, а не к архивному

IsNoLoad: boolean

Отзыв означает жалобу «груза нет»

AnnouncedCurrencyId: int32

Валюта "Озвученной ставки". dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

AnnouncedRate: int32

Озвученная ставка

FirmInfo:

Фирма, оставившая отзыв. Контакт скрыт у чужого отзыва на чужом грузе

ONE-OF

1:{...}

Фирма, оставившая отзыв.

TotalScore: double

Рейтинг фирмы в звёздах

Status:

Статус фирмы в АТИ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7]

Статус фирмы по цвету звёзд.

• 0 - Серый
• 1 - Зелёный
• 2 - Жёлтый
• 3 - Красный
• 4 - Партнёр АТИ
• 5 - Сотрудник АТИ
• 6 - Гос. органы
• 7 - ОДКС

FullFirmName: string

Полное название фирмы

Contact:

Контакт фирмы, оставившей отзыв. null — чужой отзыв на чужом грузе.
Если контакт скрыт настройками фирмы, приходит общий контакт фирмы с идентификатором 0

ONE-OF

(nullable)

1:{...}

Контакт фирмы, оставившей отзыв.

Id: int32

Идентификатор контакта в фирме

Name: string

Имя контакта

Telephone: string

Телефон

Email: string

Электронная почта

Icq: string

Аккаунт ICQ

Mobile: string

Мобильный телефон

MobileOperator: string

Мобильный оператор

SkypeName: string

Аккаунт Skype

CityId: int32 (nullable)

Идентификатор города контакта. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Город местонахождения фирмы.

CityId: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

RegionId: int32 (nullable)

Идентификатор региона. dict: GET /v1.0/dictionaries/regions → Id. docs: https://ati.su/developers/api/dictionaries/geo/

CountryId: int32 (nullable)

Идентификатор страны. dict: GET /v1.0/dictionaries/countries → Id. docs: https://ati.su/developers/api/dictionaries/geo/

FullName: string

Город, регион и страна через запятую

ShortName: string

Город, регион (если город не областной центр) и код страны (если не Россия)

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

• 0 - не определён
• 1 - до 10 000
• 2 - от 10 000 до 50 000
• 3 - от 50 000 до 100 000
• 4 - от 100 000 до 500 000
• 5 - от 500 000 до 1 000 000
• 6 - свыше 1 000 000

FiasId: guid (nullable)

Идентификатор города в базе ФИАС

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CountryCodeName: string

Трёхбуквенный код страны, как InterShortName в справочнике стран

}

}

Inn: string

ИНН фирмы

}

}]

Пример

[...]

{...}

"ResponseId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"12345678",

"LoadFirmId":1234567,

"FirmId":7654321,

"FirmName":"ООО «Перевозчик»",

"ContactId":0,

"AddedAt":"2026-09-07T10:15:30.000Z",

"UpdatedAt":"2026-09-07T11:20:00.000Z",

"Price":85000,

"CurrencyId":1,

"NdsPrice":102000,

"NdsCurrencyId":1,

"NotNdsPrice":85000,

"NotNdsCurrencyId":1,

"NdsPercent":20,

"CounterOfferSource":0,

"Note":"Готовы забрать завтра утром",

"PayAttributes":91,

"PrepayPercent":30,

"PayAfterMaxBankDays":5,

"LoadingDate":"2026-09-08T00:00:00.000Z",

"IsOutdated":false,

"IsLoadPublished":true,

"IsNoLoad":false,

"AnnouncedCurrencyId":1,

"AnnouncedRate":90000,

"FirmInfo":{...}

"TotalScore":4.5,

"Status":0,

"FullFirmName":"ООО «Перевозчик»",

"Contact":{...},

"Id":1,

"Name":"Иван Петров",

"Telephone":"+7 812 123-45-67",

"Email":"ivan@example.com",

"Icq":"123456789",

"Mobile":"+7 911 123-45-67",

"MobileOperator":"МТС",

"SkypeName":"ivan.petrov",

"CityId":1,

"Location":{...}

"CityId":1,

"RegionId":153,

"CountryId":1,

"FullName":"Санкт-Петербург, Санкт-Петербург (регион), Россия",

"ShortName":"Санкт-Петербург",

"IsRegionalCenter":true,

"CitySize":6,

"FiasId":"c2deb16a-0330-4f05-821f-1d09c93331e6",

"CityName":"Санкт-Петербург",

"RegionName":"Санкт-Петербург (регион)",

"CountryName":"Россия",

"CountryCodeName":"RUS"

}

},

"Inn":"7801234567"

}

}

]

403 Фирме закрыт доступ к отзывам или чужой груз ей не виден.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Отказано в доступе: У вашей фирмы нет доступа к работе с отзывами",

"Error":"access_denied_error"

}

404 Груз не найден.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Груз не найден",

"Error":"load_not_found_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

dateFrom Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3).

Получение отзывов на заданные грузы фирмы в виде словаря

Ответ будет представлен в виде словаря, где ключ – id груза, а значение - массив структур “отзыв на груз”, содержащий:

• Result, представляющий набор отзывов для данного груза;
• Status, представляющий статус груза: если груз с таким id не найден у вашей фирмы, статус равен 1, иначе статус равен 0. Если у груза статус равен 1, то массив отзывов всегда пуст.

Список ключей словаря полностью совпадает со списком грузов, для которых были запрошены отзывы.

Получение отзывов на заданные грузы фирмы в виде словаря. API для интеграции. Повторы в списке грузов схлопываются. У груза с доступом к отзывам статус 0 и список отзывов всех типов; у чужих отзывов контакт и примечание скрыты. Без доступа или для несуществующего груза вместо списка приходит статус ошибки.

get /v1.0/loads/new/responses/by-ids

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
dateFrom	string (date-time)	query	Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3). Пример: 2026-09-01T00:00:00.000Z
onlyActual	boolean	query	Возвращать только актуальные отзывы. Пример: true
loadIds	string (guid)[]	query	Идентификаторы грузов, по которым нужны отзывы. Пример: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"]

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/new/responses/by-ids' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/new/responses/by-ids");

Ответ

200 Отзывы по запрошенным грузам. Ключ — идентификатор груза.

Модель

{...}

any-key:{...}

Результат операции над отзывами со списком отзывов.

Status: int32

Статус операции.

• 0 - Успех
• 1 - Груз не найден
• 2 - Груз обновляли или восстанавливали слишком недавно
• 3 - Нет доступа; для обновления груза сюда же попадает повтор раньше разрешённого интервала
• 5 - Найден дубликат среди опубликованных грузов
• 7 - Груз не прошёл проверку полей
• 8 - Внутренняя ошибка при обработке груза
• 9 - Отзыв не найден
• 10 - Не хватает средств на платное размещение
• 11 - Кошелёк для платного размещения заблокирован
• -1 - Незапланированная ошибка

Message: string

Пояснение к статусу для показа пользователю

Result:[{...}]

Отзывы на груз всех типов. Только при Status, равном 0

ResponseId: guid

Идентификатор отзыва

LoadId: guid

Идентификатор груза, на который оставлен отзыв

LoadNumber: string

Номер груза

LoadFirmId: int32

Идентификатор фирмы, которой принадлежит груз

FirmId: int32

Идентификатор фирмы, оставившей отзыв

FirmName: string

Название фирмы, оставившей отзыв

ContactId: int32

Идентификатор контакта, оставившего отзыв. -1 — контакт скрыт: чужой отзыв на чужом грузе

AddedAt: date-time

Дата добавления отзыва

UpdatedAt: date-time

Дата изменения отзыва

Price: decimal

Ставка встречного предложения наличными

CurrencyId: int32

Валюта встречного предложения. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

NdsPrice: decimal

Предложенная ставка по безналичному расчёту с НДС

NdsCurrencyId: int32

Валюта ставки встречного предложения по безналичному расчёту с НДС. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

NotNdsPrice: decimal

Предложенная ставка по безналичному расчёту без НДС

NotNdsCurrencyId: int32

Идентификатор валюты ставки по безналичному расчёту без НДС. dict: GET /v1.0/dictionaries/currencyTypes → Id

NdsPercent: int32 (nullable)

Процент НДС в ставке

CounterOfferSource:

Откуда пришло встречное предложение

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6]

Откуда пришло встречное предложение.

• 0 - Неизвестный источник
• 1 - Встречное предложение из мобильного приложения
• 2 - Встречное предложение оставил интегратор по Id груза
• 3 - Встречное предложение оставил интегратор из перехвата грузов
• 4 - Встречное предложение оставили с поиска грузов
• 5 - Встречное предложение оставили из перехвата машин
• 6 - Сквозное встречное предложение, добавлено автоматически

Note: string

Примечание к встречному предложению. null — отзыв не является встречным предложением, пустая строка — примечание чужого отзыва скрыто

PayAttributes: int32

Атрибуты оплаты. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному расчёту
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - оплата через N банковских дней (см. PayAfterMaxBankDays)

PrepayPercent: int32

Процент предоплаты. Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

PayAfterMaxBankDays: int32

Оплата через ... банковских дней. Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включёна оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

LoadingDate: date-time (nullable)

Дата, на которую перевозчик готов забрать груз

IsOutdated: boolean

Отзыв помечен просроченным: груз после него отредактировали или сняли с публикации

IsLoadPublished: boolean

Относится ли отзыв к опубликованному грузу, а не к архивному

IsNoLoad: boolean

Отзыв означает жалобу «груза нет»

AnnouncedCurrencyId: int32

Валюта "Озвученной ставки". dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

AnnouncedRate: int32

Озвученная ставка

FirmInfo:

Фирма, оставившая отзыв. Контакт скрыт у чужого отзыва на чужом грузе

ONE-OF

1:{...}

Фирма, оставившая отзыв.

TotalScore: double

Рейтинг фирмы в звёздах

Status:

Статус фирмы в АТИ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7]

Статус фирмы по цвету звёзд.

• 0 - Серый
• 1 - Зелёный
• 2 - Жёлтый
• 3 - Красный
• 4 - Партнёр АТИ
• 5 - Сотрудник АТИ
• 6 - Гос. органы
• 7 - ОДКС

FullFirmName: string

Полное название фирмы

Contact:

Контакт фирмы, оставившей отзыв. null — чужой отзыв на чужом грузе.
Если контакт скрыт настройками фирмы, приходит общий контакт фирмы с идентификатором 0

ONE-OF

(nullable)

1:{...}

Контакт фирмы, оставившей отзыв.

Id: int32

Идентификатор контакта в фирме

Name: string

Имя контакта

Telephone: string

Телефон

Email: string

Электронная почта

Icq: string

Аккаунт ICQ

Mobile: string

Мобильный телефон

MobileOperator: string

Мобильный оператор

SkypeName: string

Аккаунт Skype

CityId: int32 (nullable)

Идентификатор города контакта. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Город местонахождения фирмы.

CityId: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

RegionId: int32 (nullable)

Идентификатор региона. dict: GET /v1.0/dictionaries/regions → Id. docs: https://ati.su/developers/api/dictionaries/geo/

CountryId: int32 (nullable)

Идентификатор страны. dict: GET /v1.0/dictionaries/countries → Id. docs: https://ati.su/developers/api/dictionaries/geo/

FullName: string

Город, регион и страна через запятую

ShortName: string

Город, регион (если город не областной центр) и код страны (если не Россия)

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

• 0 - не определён
• 1 - до 10 000
• 2 - от 10 000 до 50 000
• 3 - от 50 000 до 100 000
• 4 - от 100 000 до 500 000
• 5 - от 500 000 до 1 000 000
• 6 - свыше 1 000 000

FiasId: guid (nullable)

Идентификатор города в базе ФИАС

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CountryCodeName: string

Трёхбуквенный код страны, как InterShortName в справочнике стран

}

}

Inn: string

ИНН фирмы

}

}]

Error: string (nullable)

Ключ ошибки. Только при Status, отличном от 0

Reason: string (nullable)

Причина ошибки. Только при Status, отличном от 0

}

}

Пример

{...}

"3fa85f64-5717-4562-b3fc-2c963f66afa6":{...}

"Status":0,

"Message":"Ок",

"Result":[]

}

}

400 Список идентификаторов пуст или содержит неверный guid.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Ошибка валидации: Массив ids не должен быть пуст",

"Error":"validation_error"

}

403 Фирме закрыт доступ к отзывам.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Отказано в доступе: У вашей фирмы нет доступа к работе с отзывами",

"Error":"access_denied_error"

}

Консоль

Отправить

Параметры

dateFrom Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3).

onlyActual true false Возвращать только актуальные отзывы.

loadIds Идентификаторы грузов, по которым нужны отзывы.

Добавление либо редактирование отзыва на чужой груз

Добавление либо редактирование отзыва на чужой груз. API для интеграции. У фирмы один отзыв на груз: повторный вызов заменяет предыдущий. Фирма берётся из токена, груз — из адреса; одноимённые поля запроса игнорируются. Контакт передаётся в теле.

put /v1.0/loads/new/{loadId}/responses

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Запрос

Модель

{...}

Встречное предложение на груз.

CounterOfferSource:

Откуда пришло встречное предложение

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6]

Откуда пришло встречное предложение.

• 0 - Неизвестный источник
• 1 - Встречное предложение из мобильного приложения
• 2 - Встречное предложение оставил интегратор по Id груза
• 3 - Встречное предложение оставил интегратор из перехвата грузов
• 4 - Встречное предложение оставили с поиска грузов
• 5 - Встречное предложение оставили из перехвата машин
• 6 - Сквозное встречное предложение, добавлено автоматически

LoadId: guid

Идентификатор груза, на который оставлен отзыв. Заполняется сервисом из адреса запроса, переданное значение игнорируется

FirmId: int32

Идентификатор фирмы, оставившей отзыв. Заполняется сервисом из токена, переданное значение игнорируется

ContactId: int32

Идентификатор контакта, сделавшего встречное предложение

Price: decimal

Предложенная ставка наличными. Параметр должен быть равен одной из ставок груза: RateSum, SumWithNDS или SumWithoutNDS, если у груза, которому выставляется встречное предложение, параметр FixedRate равен True И параметр Torg равен False. Значение 0 допустимо, если ставка задана в NdsPrice или NotNdsPrice; хотя бы одна из трёх ставок больше 0. Не более 10 символов.

CurrencyId: int32

Валюта встречного предложения. Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

NdsPrice: decimal

Предложенная ставка по безналичному расчёту с НДС

NdsCurrencyId: int32

Валюта ставки встречного предложения по безналичному расчёту с НДС. Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

NotNdsPrice: decimal

Предложенная ставка по безналичному расчёту без НДС

NotNdsCurrencyId: int32

Идентификатор валюты ставки по безналичному расчёту без НДС. Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

Note: string

Примечание к встречному предложению. Максимальная длина - 512 символов

PayAttributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному расчёту
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - оплата через N банковских дней (см. PayAfterMaxBankDays)

PrepayPercent: int32

Процент предоплаты. Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

PayAfterMaxBankDays: int32

Оплата через ... банковских дней. Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включёна оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

LoadingDate: date-time (nullable)

Дата, на которую перевозчик готов забрать груз

NdsPercent: int32 (nullable)

Процент НДС в ставке

}

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/new/{loadId}/responses' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"CounterOfferSource":0,"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","FirmId":7654321,"ContactId":0,"Price":85000,"CurrencyId":1,"NdsPrice":102000,"NdsCurrencyId":1,"NotNdsPrice":85000,"NotNdsCurrencyId":1,"Note":"Готовы забрать завтра утром","PayAttributes":10,"PrepayPercent":30,"PayAfterMaxBankDays":5,"LoadingDate":"2026-09-08T00:00:00.000Z","NdsPercent":20}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/new/{loadId}/responses", "{""CounterOfferSource"":0,""LoadId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""FirmId"":7654321,""ContactId"":0,""Price"":85000,""CurrencyId"":1,""NdsPrice"":102000,""NdsCurrencyId"":1,""NotNdsPrice"":85000,""NotNdsCurrencyId"":1,""Note"":""Готовы забрать завтра утром"",""PayAttributes"":10,""PrepayPercent"":30,""PayAfterMaxBankDays"":5,""LoadingDate"":""2026-09-08T00:00:00.000Z"",""NdsPercent"":20}");

Ответ

200 Сохранённый отзыв.

Модель

{...}

Отзыв на груз в новой структуре.

ResponseId: guid

Идентификатор отзыва

LoadId: guid

Идентификатор груза, на который оставлен отзыв

LoadNumber: string

Номер груза

LoadFirmId: int32

Идентификатор фирмы, которой принадлежит груз

FirmId: int32

Идентификатор фирмы, оставившей отзыв

FirmName: string

Название фирмы, оставившей отзыв

ContactId: int32

Идентификатор контакта, оставившего отзыв. -1 — контакт скрыт: чужой отзыв на чужом грузе

AddedAt: date-time

Дата добавления отзыва

UpdatedAt: date-time

Дата изменения отзыва

Price: decimal

Ставка встречного предложения наличными

CurrencyId: int32

Валюта встречного предложения. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

NdsPrice: decimal

Предложенная ставка по безналичному расчёту с НДС

NdsCurrencyId: int32

Валюта ставки встречного предложения по безналичному расчёту с НДС. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

NotNdsPrice: decimal

Предложенная ставка по безналичному расчёту без НДС

NotNdsCurrencyId: int32

Идентификатор валюты ставки по безналичному расчёту без НДС. dict: GET /v1.0/dictionaries/currencyTypes → Id

NdsPercent: int32 (nullable)

Процент НДС в ставке

CounterOfferSource:

Откуда пришло встречное предложение

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6]

Откуда пришло встречное предложение.

• 0 - Неизвестный источник
• 1 - Встречное предложение из мобильного приложения
• 2 - Встречное предложение оставил интегратор по Id груза
• 3 - Встречное предложение оставил интегратор из перехвата грузов
• 4 - Встречное предложение оставили с поиска грузов
• 5 - Встречное предложение оставили из перехвата машин
• 6 - Сквозное встречное предложение, добавлено автоматически

Note: string

Примечание к встречному предложению. null — отзыв не является встречным предложением, пустая строка — примечание чужого отзыва скрыто

PayAttributes: int32

Атрибуты оплаты. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному расчёту
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - оплата через N банковских дней (см. PayAfterMaxBankDays)

PrepayPercent: int32

Процент предоплаты. Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

PayAfterMaxBankDays: int32

Оплата через ... банковских дней. Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включёна оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

LoadingDate: date-time (nullable)

Дата, на которую перевозчик готов забрать груз

IsOutdated: boolean

Отзыв помечен просроченным: груз после него отредактировали или сняли с публикации

IsLoadPublished: boolean

Относится ли отзыв к опубликованному грузу, а не к архивному

IsNoLoad: boolean

Отзыв означает жалобу «груза нет»

AnnouncedCurrencyId: int32

Валюта "Озвученной ставки". dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

AnnouncedRate: int32

Озвученная ставка

FirmInfo:

Фирма, оставившая отзыв. Контакт скрыт у чужого отзыва на чужом грузе

ONE-OF

1:{...}

Фирма, оставившая отзыв.

TotalScore: double

Рейтинг фирмы в звёздах

Status:

Статус фирмы в АТИ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7]

Статус фирмы по цвету звёзд.

• 0 - Серый
• 1 - Зелёный
• 2 - Жёлтый
• 3 - Красный
• 4 - Партнёр АТИ
• 5 - Сотрудник АТИ
• 6 - Гос. органы
• 7 - ОДКС

FullFirmName: string

Полное название фирмы

Contact:

Контакт фирмы, оставившей отзыв. null — чужой отзыв на чужом грузе.
Если контакт скрыт настройками фирмы, приходит общий контакт фирмы с идентификатором 0

ONE-OF

(nullable)

1:{...}

Контакт фирмы, оставившей отзыв.

Id: int32

Идентификатор контакта в фирме

Name: string

Имя контакта

Telephone: string

Телефон

Email: string

Электронная почта

Icq: string

Аккаунт ICQ

Mobile: string

Мобильный телефон

MobileOperator: string

Мобильный оператор

SkypeName: string

Аккаунт Skype

CityId: int32 (nullable)

Идентификатор города контакта. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Location:

Информация о местоположении фирмы

ONE-OF

1:{...}

Город местонахождения фирмы.

CityId: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

RegionId: int32 (nullable)

Идентификатор региона. dict: GET /v1.0/dictionaries/regions → Id. docs: https://ati.su/developers/api/dictionaries/geo/

CountryId: int32 (nullable)

Идентификатор страны. dict: GET /v1.0/dictionaries/countries → Id. docs: https://ati.su/developers/api/dictionaries/geo/

FullName: string

Город, регион и страна через запятую

ShortName: string

Город, регион (если город не областной центр) и код страны (если не Россия)

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

• 0 - не определён
• 1 - до 10 000
• 2 - от 10 000 до 50 000
• 3 - от 50 000 до 100 000
• 4 - от 100 000 до 500 000
• 5 - от 500 000 до 1 000 000
• 6 - свыше 1 000 000

FiasId: guid (nullable)

Идентификатор города в базе ФИАС

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CountryCodeName: string

Трёхбуквенный код страны, как InterShortName в справочнике стран

}

}

Inn: string

ИНН фирмы

}

}

Пример

{...}

"ResponseId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"12345678",

"LoadFirmId":1234567,

"FirmId":7654321,

"FirmName":"ООО «Перевозчик»",

"ContactId":0,

"AddedAt":"2026-09-07T10:15:30.000Z",

"UpdatedAt":"2026-09-07T11:20:00.000Z",

"Price":85000,

"CurrencyId":1,

"NdsPrice":102000,

"NdsCurrencyId":1,

"NotNdsPrice":85000,

"NotNdsCurrencyId":1,

"NdsPercent":20,

"CounterOfferSource":0,

"Note":"Готовы забрать завтра утром",

"PayAttributes":91,

"PrepayPercent":30,

"PayAfterMaxBankDays":5,

"LoadingDate":"2026-09-08T00:00:00.000Z",

"IsOutdated":false,

"IsLoadPublished":true,

"IsNoLoad":false,

"AnnouncedCurrencyId":1,

"AnnouncedRate":90000,

"FirmInfo":{...}

"TotalScore":4.5,

"Status":0,

"FullFirmName":"ООО «Перевозчик»",

"Contact":{...},

"Id":1,

"Name":"Иван Петров",

"Telephone":"+7 812 123-45-67",

"Email":"ivan@example.com",

"Icq":"123456789",

"Mobile":"+7 911 123-45-67",

"MobileOperator":"МТС",

"SkypeName":"ivan.petrov",

"CityId":1,

"Location":{...}

"CityId":1,

"RegionId":153,

"CountryId":1,

"FullName":"Санкт-Петербург, Санкт-Петербург (регион), Россия",

"ShortName":"Санкт-Петербург",

"IsRegionalCenter":true,

"CitySize":6,

"FiasId":"c2deb16a-0330-4f05-821f-1d09c93331e6",

"CityName":"Санкт-Петербург",

"RegionName":"Санкт-Петербург (регион)",

"CountryName":"Россия",

"CountryCodeName":"RUS"

}

},

"Inn":"7801234567"

}

}

400 Тело запроса не разобрано или поля не прошли проверку: например, ставка не совпадает с фиксированной ставкой груза.

Модель

{...}

Тело запроса не разобрано или не прошло проверку полей.

Error: string

Ключ ошибки: json_validation_error — поля не прошли проверку, deserialization_error — тело не разобрано

Reason: string

Причина ошибки для показа пользователю

ErrorsList:[{...}]

Ошибки по полям. Только при json_validation_error

property: string

Поле, не прошедшее проверку; вложенные поля через точку

reason: string

Причина ошибки для показа пользователю

error: string

Ключ нарушенного правила

context: {missing-type-info} (nullable)

Параметры нарушенного правила, если у него есть границы: например, Min и Max

}]

}

Пример

{...}

"Error":"json_validation_error",

"Reason":"Ошибка валидации json",

"ErrorsList":[...]

{...}

"property":"Cargo.Weight",

"reason":"Максимальная длина для параметра вес - 4 символа",

"error":"length_out_of_range",

"context":{...}

"Min":0,

"Max":4

}

}

]

}

403 Фирме закрыт доступ к отзывам, груз ей не виден или это её собственный груз.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Отказано в доступе: У вашей фирмы нет доступа к работе с отзывами",

"Error":"access_denied_error"

}

404 Груз не найден.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Груз не найден",

"Error":"load_not_found_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

{ "CounterOfferSource": 0, "LoadId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "FirmId": 7654321, "ContactId": 0, "Price": 85000, "CurrencyId": 1, "NdsPrice": 102000, "NdsCurrencyId": 1, "NotNdsPrice": 85000, "NotNdsCurrencyId": 1, "Note": "Готовы забрать завтра утром", "PayAttributes": 10, "PrepayPercent": 30, "PayAfterMaxBankDays": 5, "LoadingDate": "2026-09-08T00:00:00.000Z", "NdsPercent": 20 }

Удаление отзыва на груз

При удалении встречного предложения у своего груза, необходимо заполнить как loadId, так и ids.
При удалении отзыва на чужой груз, необходимо передать loadId.

Удаление встречных предложений на своём грузе или своего отзыва на чужом. API для интеграции. Без списка идентификаторов удаляется отзыв вашей фирмы на чужой груз; со списком — перечисленные встречные предложения на вашем грузе.

delete /v1.0/loads/new/{loadId}/responses

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6
ids	string (guid)[]	query	Идентификаторы встречных предложений на вашем грузе. Без них удаляется ваш отзыв на чужом грузе. Пример: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"]

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/new/{loadId}/responses' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.0/loads/new/{loadId}/responses");

Ответ

200 Статусы операций по отзывам. Ключ — идентификатор отзыва. Без списка идентификаторов тело — только сообщение об удалении вашего отзыва.

Модель

{...}

any-key:{...}

Результат удаления отзыва.

Status: int32

Статус операции

• 0 - Успех
• -1 - Незапланированная ошибка

Message: string

Сообщение о результате

Error: string

Ключ ошибки, если Status не равен 0

Reason: string

Причина ошибки, если Status не равен 0

}

}

Пример

{...}

"3fa85f64-5717-4562-b3fc-2c963f66afa6":{...}

"Status":0,

"Message":"Успех"

}

}

403 Фирме закрыт доступ к отзывам или груз не ваш.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Отказано в доступе: У вашей фирмы нет доступа к работе с отзывами",

"Error":"access_denied_error"

}

404 Груз или отзыв не найден.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Отзыв не найден",

"Error":"response_not_found_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

ids Идентификаторы встречных предложений на вашем грузе. Без них удаляется ваш отзыв на чужом грузе.

Методы для поиска грузов

Поиск грузов на площадках

В теле ответа находится массив грузов, которые опубликованы на выбранных площадках. В грузах будут указаны только те площадки, в которых дата публикации меньше текущей.
Если массив boardIds пуст, будут получены грузы со всех возможных площадок.

Поиск грузов, размещённых на указанных площадках. API для интеграции. Площадка — закрытый список фирм, которым виден груз; в выдачу попадают и ваши грузы, и чужие. Искать можно только по площадкам, доступным вашей фирме; общая площадка исключена.

get /v1.0/loads/search/byboards

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
boardIds	string[]	query	Идентификаторы закрытых площадок, по 24 символа. Пустой список — поиск по всем площадкам, доступным фирме. Пример: ["5f1e2d3c4b5a69788796a5b4"]

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/search/byboards' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/search/byboards");

Ответ

200 Грузы, опубликованные на выбранных площадках.

Модель

[{...}]

Груз в ответе: поля публикации и вычисляемые сервисом.

LoadMeta:

Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией

ONE-OF

1:{...}

Метаданные публикации.

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные. Максимальная длина 1024 символа

}

ContactId1*: int32

Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id. Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами. Контакт должен быть виден для остальных участников АТИ

ContactId2: int32 (nullable)

Идентификатор второго выбранного контакта, если не выбрано, то null. Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу. Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC. Минимальное значение равно текущей дате. При значении параметра DateType равным 0, допустимое значение поля - текущая дата. При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед. При значении параметра DateType равным 2, допустимое значение поля - текущая дата. При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC. Минимальное значение равно значению параметра FirstDate. При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед. При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед. При значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется. При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Тип готовности груза к перевозке, по умолчанию 0

• 0 - Готов к загрузке
• 1 - в период с FirstDate по LastDate
• 2 - постоянно
• 3 - груза нет, запрос ставки

PeriodicityId: int32

Периодичность загрузки. Если параметр DateType не равен 2, PeriodicityId равен 0. Иначе PeriodicityId может принимать следующие значения:

• 1 - ежедневно
• 100 - по рабочим дням

OrderNumber: string

Номер заказа. Ограничение по длине: 250 символов

Krugoreis: boolean

Включён ли кругорейс

Loading*:

Точка погрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

ExtraPoints:[{...}]

Дополнительные пункты маршрута между погрузкой и выгрузкой.
Максимум 15 штук. Может иметь значение null

CityId*: int32

Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

PointType*: int32

Тип точки:

• 1 - загрузка
• 2 - разгрузка
• 3 - таможня
• 8 - проехать через

Latitude: decimal (nullable)

Широта точки. Допустимое значение от -90 до 90; указывается вместе с долготой

Longitude: decimal (nullable)

Долгота точки. Допустимое значение от -180 до 180; указывается вместе с широтой

Street: string

Улица или район. Максимальная длина 200 символов

OrganizationId: guid (nullable)

Организация, принимающая или отгружающая груз в этой точке. Указывается только вместе с AddressId

AddressId: guid (nullable)

Адрес точки. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

OrdinalId: int32

Порядок точки на маршруте. Если у всех точек 0, сервис нумерует их по порядку списка

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeStart: string (nullable)

Время начала загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingTimeEnd: string (nullable)

Время окончания загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется

LoadingCargos:[{...}]

Позиции груза, которые берут в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

UnloadingCargos:[{...}]

Позиции груза, которые оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза (CargoId из точки загрузки)

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

PackagingQuantity: int32 (nullable)

Количество выгружаемых мест

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

}]

Unloading*:

Точка выгрузки

ONE-OF

1:{...}

Точка погрузки или выгрузки.

CityId*: int32

Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/

Latitude: decimal (nullable)

Широта города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр. Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки. Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр. Допустимое значение от -180 до 180.

Street: string

Улица или район города загрузки/разгрузки. Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если улица указана, её длина от 5 до 200 символов.

OrganizationId: guid (nullable)

Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId

AddressId: guid (nullable)

Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная. Не указывается при значении параметра DateType равным 3. Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Круглосуточная загрузка/разгрузка. По умолчанию - false. Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId. docs: https://ati.su/developers/api/dictionaries/geo/. Максимальное количество - 10 штук

LoadingCargos:[{...}]

Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется

CargoId: int32

Идентификатор позиции груза в точке маршрута

NameId: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id

Name: string

Название груза

PackagingType: int32 (nullable)

Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id

PackagingQuantity: int32 (nullable)

Количество мест упаковки

Weight: double (nullable)

Вес в тоннах

Volume: double (nullable)

Объём в кубических метрах

Sizes:

Габариты

ONE-OF

1:{...}

Габариты позиции груза.

Length: double

Длина в метрах

Width: double

Ширина в метрах

Height: double

Высота в метрах

Diameter: double

Диаметр в метрах, если груз круглого сечения

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Подсвечивать ли ширину в интерфейсе

HeightHighlight: boolean

Подсвечивать ли высоту в интерфейсе

}

}]

}

Cargo*:

Что везём: наименование, вес, объём, упаковка

ONE-OF

1:{...}

Описание груза: что и сколько везём.

Weight: double

Вес груза в тоннах. Обязательный параметр, если не задан параметр Volume. Допустимое значение 0 либо от 0,001 до 9999, не более 3 знаков после запятой

Volume: double

Объём груза в кубических метрах. Обязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа

ADR: int32

Класс опасности груза по ADR. Допустимое значение от 0 до 9, по умолчанию 0. Для CargoTypeId = 53 обязателен ненулевой

CargoTypeId*: int32

Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes

CargoType: string

Наименование груза текстом. Обязательный параметр: при CargoTypeId = 59 («другое») это и есть наименование груза. Максимальная длина названия - 200 символов. В этом поле запрещено указывать контактную информацию

PackType: int32

Идентификатор типа упаковки (навалом, коробки, россыпью), 0 — упаковка не указана. dict: GET /v1.0/dictionaries/packTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-packTypes

PalletCount: int32

Количество упаковок для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза. Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

• 1 - только отдельной машиной
• 2 - отдельной или догрузом
• 3 - только догрузом

SborGruz: boolean

Сборный груз

Size:

Параметры размера груза

ONE-OF

1:{...}

Габариты груза.

Length: double

Длина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах. Допустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

Подсвечивать длину как нестандартную

WidthHighlight: boolean

Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

HeightHighlight: boolean

Выделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

}

}

Transport*:

Требования к транспорту: кузов, варианты загрузки и выгрузки

ONE-OF

1:{...}

Требования к транспорту.

CarType*: int64

Битовая маска типов кузова: идентификаторы из справочника — степени двойки, несколько кузовов складываются (1 + 4 = 5). dict: GET /v1.0/dictionaries/carTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes

CarTypeString: string

Та же битовая маска типов кузова строкой. Только в ответе: в запросе значение игнорируется

LoadingType: int32

Битовая маска вариантов загрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/loadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes

LoadingLogicalOperator: string

Тип условия загрузки:

• OR - необходимо, чтобы присутствовал один из способов загрузки
• AND - необходимо, чтобы присутствовали все выбранные типы загрузки

UnloadingType: int32

Битовая маска вариантов разгрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/unloadingTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-unloadingTypes

UnloadingLogicalOperator: string

Тип условия разгрузки:

• OR - необходимо, чтобы присутствовал один из способов разгрузки
• AND - необходимо, чтобы присутствовали все выбранные типы разгрузки

TrucksQuantity: int32

Количество машин. Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

Минимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

TemperatureTo: int32 (nullable)

Максимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный". Допустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0

Stsepka: boolean

Нужна ли сцепка для груза

Pnevmohod: boolean

Нужен ли пневмоход для груза

Koniki: boolean

Нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

Документы на транспорт, необходимые для провоза этого груза: медкнижка

IsTracking: boolean

Трекинг через АТИ Водитель

RequiredCapacity: double (nullable)

Требуемая грузоподъемность в тоннах. Допустимое значение от 0,01 до 9999, не более 3 знаков после запятой

}

Payment*:

Условия оплаты и ставка

ONE-OF

1:{...}

Условия оплаты и ставка.

CurrencyId: int32

Идентификатор валюты. dict: GET /v1.0/dictionaries/currencyTypes → Id. По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

MoneyType: int32

Идентификатор варианта оплаты. dict: GET /v1.0/dictionaries/moneyTypes → Id. По умолчанию - 22. Должен принимать значение 22, если параметр FixedRate равен false. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-moneyTypes

RateSum: decimal

Ставка для груза. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов

SumWithNDS: decimal

Ставка по безналичному расчёту с НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Значение не меньше 0, максимальная длина 10 символов. Если заданы обе безналичные ставки, SumWithNDS должна быть не меньше SumWithoutNDS. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0

SumWithoutNDS: decimal

Ставка по безналичному расчёту без НДС. Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Значение не меньше 0, максимальная длина 10 символов. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0

PrepayPercent: int32

Процент предоплаты. Допустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

Через сколько банковских дней оплата. Допустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false

PayDaysEnabled: boolean

Включена ли оплата через банковские дни. По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true

FixedRate: boolean

true, если ставка задана, false если запрос ставки. По умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1

Torg: boolean

Возможен ли торг. По умолчанию - false. Должен быть false, если параметр FixedRate равен false; при торгах с публикацией ставки — true

DirectContract: boolean

Прямой договор

InFuel: boolean

Предоплата топливом. Должен быть false, если параметр PrepayPercentEnabled равен false

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

Скрыть встречные предложения

AcceptPaymentTypes: int32

Битовая маска форм оплаты, которые вы готовы принять при запросе ставки: флаги складываются

• 1 - наличные
• 2 - безналичный расчёт с НДС
• 4 - безналичный расчёт без НДС

Пример: 7 — все три формы. При запросе ставки значение 0 сервис заменяет на 7; при фиксированной ставке поле не используется

}

InviteSettings:

Настройки автоприглашений

ONE-OF

1:{...}

Настройки автоприглашений по встречным предложениям.

InviteDelayInSeconds: int32

Время в секундах сбора встречных предложений: через него сервис создаёт приглашение по лучшему предложению. Обязателен и больше 0, если объект настроек передан

InviteDurationInSeconds: int32

Время в секундах действия приглашения. Обязателен и больше 0, если объект настроек передан

MaxPercentDeviation: int32 (nullable)

На сколько процентов встречное предложение может превышать вашу ставку, чтобы приглашение всё-таки ушло

NeedArchiveOnInvite: boolean

Архивировать груз при срабатывании автоматического приглашения

}

PriorityView:

Приоритетный показ

ONE-OF

1:{...}

Параметры приоритетного показа в ответе.

DailyLimit: decimal

Суточный лимит списания по услуге в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

Показывать груз в приоритете только платным пользователям

OrderLimit: decimal

Лимит списания на груз в атисах

• Должен иметь длину не более 5 символов
• Не более 2 символов после запятой
• Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
• Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

Ставка за просмотр в атисах

• Кратна 0,5
• Не меньше минимальной ставки сервиса и не больше баланса фирмы
• Должна иметь длину не более 5 символов

MoneySpentPerDay: decimal

Сколько списано с баланса за груз в текущие сутки. Только для чтения

MoneySpentPerOrder: decimal

Сколько списано с баланса за груз за всё время. Только для чтения

}

Stealth:

Настройки показа груза

ONE-OF

1:{...}

Ограничения показа груза платной услугой «Стелс»: списания идут с баланса фирмы. Если объект передан, нужен хотя бы один параметр.

ListIdToHide: guid (nullable)

Идентификатор списка фирм, которым груз не показывается. dict: GET https://api.ati.su/scrolls/v1/firms → id. docs: https://ati.su/developers/api/catalogs/firm-lists/

FirmRegDateToHide: date-time (nullable)

Фирмам, зарегистрированным позже этой даты, груз не показывается

ScoreToHide: double (nullable)

Минимальное число звёзд фирмы: фирмам с меньшим числом груз не показывается. Целое от 1 до 5; при включённом бронировании на общей площадке — от 2 до 5

}

LoadFiles:[{...}]

Файлы к грузу.
Перед добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. API для хранения файлов)

Id: guid

Устаревший идентификатор файла, используйте FileId

deprecated

FileId: string

Идентификатор файла, который вернул API хранения файлов при загрузке. dict: POST https://api.ati.su/v1.0/filestorage/files → id. docs: https://ati.su/developers/api/filestorage/

FileType: int32

Тип загруженного файла. Всегда 1 — документ

Attributes: int32

Устаревшее поле, всегда 0

Name: string

Имя файла. Только в ответе: приходит из хранилища файлов, в запросе значение игнорируется

Link: string

Ссылка, по которой можно скачать файл. Сервис собирает её из идентификатора файла в хранилище

Size: int32

Устаревшее поле, всегда -1

}]

Deal:

Сделка, в рамках которой размещён груз

ONE-OF

1:{...}

Сделка по грузу в ответе.

Auction:

Параметры аукциона

ONE-OF

1:{...}

Торги по грузу в ответе.

StartRate*: decimal

Начальная ставка аукциона. Параметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.

Currency*: int32

Валюта аукциона. dict: GET /v1.0/dictionaries/currencyTypes → Id. docs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes

Step*: decimal

Минимальное изменение ставки по аукциону. Параметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.

PaymentType*:

Тип оплаты в торгах: допустимы только 24 и 25

ONE-OF

enum

[1, 22, 23, 24, 25]

Тип оплаты.

• 1 - Наличные
• 22 - Любая
• 23 - На карту
• 24 - Безналичный расчёт с НДС
• 25 - Безналичный расчёт без НДС

AcceptSecondPayType: boolean

Принимать ставки и со вторым типом оплаты: без НДС при PaymentType = 24, с НДС при PaymentType = 25

StartDate: date-time

Время начала аукциона в UTC. Должно быть позже времени начала публикации груза на площадке.

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Время окончания аукциона "завершить не позже". Если указанное время, меньше значения Duration - аукцион заканчивается по времени "завершить не позже", если нет автопродления. Время устанавливается в формате UTC.

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.

AutoRenew: boolean

Нужно ли продлевать торги, если ставка пришла незадолго до окончания

RenewTime: int32 (nullable)

Время в минутах, на которое сдвигается окончание аукциона при включённом AutoRenew

MaxRenewTime: int32 (nullable)

Максимально допустимое время в минутах, на которое можно сдвинуть окончание аукциона при включённом AutoRenew. Указывать, если AutoRenew = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

Максимально допустимая ставка по аукциону. Обязателен при RaiseBid = true. Не меньше суммы StartRate и Step, не больше 9999999999, не более 10 символов.

RaiseBidInterval: int32 (nullable)

Период увеличения ставки в минутах при отсутствии предложений. Обязателен при RaiseBid = true: от 1 минуты и меньше Duration. При StartSinceFirstBet = true верхнее ограничение не действует.

ResponseInMinutes: int32 (nullable)

Через сколько минут после начала торгов принимать встречные предложения:

• 0 - сразу
• N - через N минут; допустимо любое значение от 0 и меньше Duration
• null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

Длительность торгов в минутах: целое число больше 0. Окончание торгов не может быть позже времени актуальности груза LastDate. Если не указана, вычисляется как разница EndDate и StartDate, при этом StartSinceFirstBet игнорируется

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчёт до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:

Параметры перезапуска аукциона.
Если объект не передан, действуют значения по умолчанию: до 3 автоматических перевыборов победителя, после исчерпания груз публикуется со ставкой

ONE-OF

1:{...}

Параметры перезапуска торгов.

AuctionFinishAction:

Действие после исчерпания перезапусков

ONE-OF

enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны.

• 1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
• 2 - Опубликовать груз с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе.
• 3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно. Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно. В переданном объекте параметров по умолчанию 0; если сам объект не передан, действует значение 3

DurationAfterRestart: int32 (nullable)

Длительность торгов в минутах после перезапуска. Необязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным

RateIncrease: decimal (nullable)

Повышение ставки при перезапуске

RateIncreaseOption: int32 (nullable)

Единица повышения ставки при перезапуске:

• 1 - в валюте
• 2 - в процентах

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

Принимать встречные предложения только до первой ставки

WinnerCriterion:

Критерий выбора победителя торгов

ONE-OF

enum

[0, 1]

Критерий победы в аукционе.

• 0 - Выбор победителя происходит автоматически по лучшей ставке
• 1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

Source:

Площадка, на которой идут торги. Значение выставляет система: передавайте 0 или не передавайте поле

ONE-OF

enum

[0, 2]

Площадка, на которой идут торги по грузу.

• 0 - Торги в АТИ
• 2 - Торги в Atrucks

AuctionId: guid

Идентификатор аукциона

LoadId: guid

Идентификатор груза, для которого активен аукцион

ActiveDealId: guid (nullable)

Идентификатор сделки, привязанной к аукциону

State:

Статус аукциона

ONE-OF

enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона.

• -100 - Не удалось определить состояние аукциона
• -14 - Аукцион отменен руками грузовладельца
• -13 - Аукцион удален, т.к. расторгнут заказ
• -12 - Аукцион без ставок завершен
• -11 - Аукцион удален автоматически
• -10 - Аукцион удален т.к. сделка завершена
• -9 - Аукцион удален
• -8 - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет
• -7 - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель
• -6 - При включенном копировании грузов: торги завершены, экспедитор не является победителем
• -5 - Одна ставка лучшая по цене, другая по дате
• -4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
• -3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
• -2 - Закончился, ждем когда победитель возьмет груз
• -1 - Закончился, ставок нет
• 0 - Идет, ставок нет
• 1 - Идет (уже есть валидные ставки)

Finished: boolean

Завершён ли аукцион

WinDate: date-time (nullable)

Время, когда одна из ставок в AuctionRates стала победной

AuctionRates:[{...}]

Список ставок по аукциону

AuctionRateId: guid

Идентификатор ставки

AddedAt: date-time

Когда сделана ставка

RateFirm:

Фирма, сделавшая ставку

ONE-OF

1:{...}

Фирма-участник торгов: рейтинг, статус и контакт.

Score: double

Рейтинг фирмы в звёздах

Status:

Статус фирмы в АТИ. Коды описаны в FirmStatus

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7]

Статус фирмы по цвету звёзд.

• 0 - Серый
• 1 - Зелёный
• 2 - Жёлтый
• 3 - Красный
• 4 - Партнёр АТИ
• 5 - Сотрудник АТИ
• 6 - Гос. органы
• 7 - ОДКС

Name: string

Имя фирмы

ContactName: string

Имя контакта

AtiId: string

Идентификатор фирмы в АТИ

}

Rate: decimal

Ставка на груз, которую поставил пользователь

State:

Статус ставки. Коды описаны в AuctionRateState

ONE-OF

enum

[0, 1, -8, -7, -6, -5, -4, -3, -2, -1]

Статус ставки.

• -8 - Грузовладелец отклонил документ
• -7 - Победитель отклонил документ
• -6 - Победитель отменил сделку
• -5 - Грузовладелец отменил сделку
• -4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
• -3 - Бывший победитель
• -2 - Перевозчик отказался от участия
• -1 - Предложение отклонил грузовладелец/перевозчик
• 0 - Непобедная ставка при завершении торгов
• 1 - Победная ставка в аукционе

LoadingDate: date-time (nullable)

Ближайшая возможная для перевозчика дата загрузки. Используется только в аукционах с критерием победы по ставке и дате загрузки

FirmId: int32

Идентификатор фирмы, сделавшей ставку

ContactId: int32

Идентификатор контакта, сделавшего ставку

}]

}

}

Boards:[{...}]

Список площадок

BoardId: string

Идентификатор площадки из 24 символов. Значение общей площадки — a0a0a0a0a0a0a0a0a0a0a0a0

PublicationTime: date-time (nullable)

Время публикации на площадке. Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

Разрешено ли бронирование груза на общей площадке. Учитывается только для Общей площадки, только при включённом Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Является ли площадка общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC. Может иметь значение null. Минимальное значение равно текущей дате. Не указывается при значении параметра DateType равным 3

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null. Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate. Не указывается при значении параметра DateType равным 3

ArchiveDate: date-time (nullable)

Дата и время переноса в архив

ArchiveReason:

Причина переноса в архив

ONE-OF

(nullable)

enum

[Unknown, System, Manual, Complaints, UnwantedContent, DeleteCsvLoad, MergeLoadsAfterEdit, ContactDoesNotHaveAccessToVirtualPayments, VerticesLoadDelete, StealthStatisticError, CheckDuplicateComplaints, DeleteContact, DeleteFirm, CleanOldLoadsJob]

Причина, по которой груз оказался в архиве.

• VerticesLoadDelete - Снят при сквозной передаче груза
• StealthStatisticError - Снят из-за ошибки при подсчёте статистики Стелса
• CheckDuplicateComplaints - Снят при проверке дублирующих жалоб
• DeleteContact - Удалён контакт
• DeleteFirm - Удалена фирма
• CleanOldLoadsJob - Истёк срок актуальности
• Unknown - Причина не определена
• System - Снят системой
• Manual - Снят с публикации владельцем
• Complaints - Снят по жалобам
• UnwantedContent - Снят за недопустимое содержимое
• DeleteCsvLoad - Удалён вместе с CSV-загрузкой
• MergeLoadsAfterEdit - Объединён с другим грузом после редактирования
• ContactDoesNotHaveAccessToVirtualPayments - Снят: у контакта нет права оплачивать услугу со счёта фирмы

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

Идентификатор валюты озвученной ставки. dict: GET /v1.0/dictionaries/currencyTypes → Id

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Можно ли снять груз с публикации

HasPermissionsToLoad: boolean

Есть ли у текущего контакта доступ к грузу: контакт указан в грузе или имеет доступ к его подразделению

CanBeEdited: boolean

Можно ли редактировать груз

CanBeRenewed: boolean

Можно ли обновить груз

CanBeRestored: boolean

Можно ли восстановить груз из архива

EditRestriction:

Причина отказа в редактировании груза, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

DeleteRestriction:

Причина отказа в снятии груза с публикации, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RestoreRestriction:

Причина отказа в восстановлении груза из архива, 0 — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

Причина отказа в доступе к грузу.

• 0 - Вы имеете доступ к работе с грузом
• 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
• 2 - Груз зарезервирован или взят, операции с грузом запрещены
• 3 - Превышен лимит актуальных грузов
• 4 - Вы пытаетесь работать с грузами под общим пользователем, недостаточно прав
• 5 - У вашего контакта недостаточно прав для работы с данным грузом
• 6 - Груз имеет завершённые торги, операции с грузом запрещены
• 7 - Сервис сделок временно недоступен
• 8 - Нельзя изменять или удалять груз из сквозных торгов
• 9 - У вашего контакта недостаточно прав для создания грузов
• 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
• 11 - У вашего контакта недостаточно прав для работы с грузами на общей площадке
• 12 - У вашего контакта недостаточно прав для работы с грузами на персональных площадках
• 13 - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе
• 14 - У вашего контакта нет доступа к подразделению груза
• 15 - Ваш контакт должен быть указан первым в грузе
• 16 - Груз не опубликован ни на одной площадке

RenewRestriction: string

Причина отказа в обновлении груза. Пустая строка, если обновление доступно

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

UpdatedAt: date-time

Дата последнего изменения груза в UTC

AddedAt: date-time

Дата публикации груза в UTC

RefreshedAt: date-time

Дата последнего обновления груза в выдаче, в UTC

Distance: int32

Расстояние по дорогам в километрах

PlatonRoadsLength: int32

Протяжённость участков маршрута, за которые взимается плата по системе «Платон», в километрах

TollRoadsLength: int32

Протяжённость платных дорог на маршруте в километрах

TravelTime: string

Расчётное время в пути в формате [d.]hh:mm:ss

Zimnik: boolean

Учитывать ли зимники при построении маршрута

Ferries: boolean

Учитывать ли паромные переправы при построении маршрута

FirmId: string

Идентификатор фирмы

AuctionId: guid (nullable)

Идентификатор аукциона по грузу

}]

Пример

[...]

{...}

"LoadMeta":{...},

"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"MetaData":"import-2026-09"

},

"ContactId1":1234567,

"ContactId2":1234568,

"Note":"Погрузка с 9 до 18, пропуск заказывать заранее",

"FirstDate":"2026-09-08T00:00:00.000Z",

"LastDate":"2026-09-10T00:00:00.000Z",

"DateType":1,

"PeriodicityId":0,

"OrderNumber":"ЗК-2026-0917",

"Krugoreis":false,

"Loading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"ExtraPoints":[...],

{...}

"CityId":1,

"PointType":2,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"пр. Ленина, 10",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"OrdinalId":1,

"IsRoundTheClock":false,

"LoadingDateStart":"2026-09-09T00:00:00.000Z",

"LoadingDateEnd":"2026-09-09T00:00:00.000Z",

"LoadingTimeStart":"09:00:00",

"LoadingTimeEnd":"18:00:00",

"LoadingCargos":[...],

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

],

"UnloadingCargos":[...]

{...}

"CargoId":1,

"Weight":10,

"Volume":40,

"PackagingQuantity":10,

"IsDefinedByTtn":false

}

]

}

],

"Unloading":{...},

"CityId":1,

"Latitude":59.939095,

"Longitude":30.315868,

"Street":"ул. Салова, 57",

"OrganizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddressId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"TimeStart":"2026-09-08T09:00:00.000Z",

"TimeEnd":"2026-09-08T18:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

0

],

"LoadingCargos":[...]

{...}

"CargoId":1,

"NameId":1,

"Name":"Продукты питания",

"PackagingType":1,

"PackagingQuantity":20,

"Weight":20,

"Volume":82,

"Sizes":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

}

]

},

"Cargo":{...},

"Weight":20,

"Volume":82,

"ADR":0,

"CargoTypeId":59,

"CargoType":"Стройматериалы",

"PackType":1,

"PalletCount":33,

"BeltCount":0,

"DogruzType":1,

"SborGruz":false,

"Size":{...}

"Length":13.6,

"Width":2.45,

"Height":2.7,

"Diameter":1.2,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

},

"Transport":{...},

"CarType":5,

"CarTypeString":"5",

"LoadingType":3,

"LoadingLogicalOperator":"OR",

"UnloadingType":3,

"UnloadingLogicalOperator":"OR",

"TrucksQuantity":1,

"TemperatureFrom":-18,

"TemperatureTo":4,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false,

"RequiredCapacity":20

},

"Payment":{...},

"CurrencyId":1,

"MoneyType":22,

"RateSum":85000,

"SumWithNDS":102000,

"SumWithoutNDS":85000,

"PrepayPercent":30,

"PrepayPercentEnabled":true,

"PayDays":5,

"PayDaysEnabled":true,

"FixedRate":true,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

},

"InviteSettings":{...},

"InviteDelayInSeconds":600,

"InviteDurationInSeconds":3600,

"MaxPercentDeviation":10,

"NeedArchiveOnInvite":false

},

"PriorityView":{...},

"DailyLimit":500,

"IsForPayedOnly":false,

"OrderLimit":100,

"ViewRate":1.5,

"MoneySpentPerDay":12,

"MoneySpentPerOrder":45

},

"Stealth":{...},

"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"FirmRegDateToHide":"2024-01-01T00:00:00.000Z",

"ScoreToHide":3

},

"LoadFiles":[...],

{...}

"FileId":"a1b2c3d4e5f6a7b8c9d0e1f2",

"FileType":1,

"Attributes":0,

"Name":"Договор.pdf",

"Link":"https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2",

"Size":-1

}

],

"Deal":{...},

"Auction":{...}

"StartRate":50000,

"Currency":1,

"Step":500,

"PaymentType":0,

"AcceptSecondPayType":false,

"StartDate":"2026-09-08T09:00:00.000Z",

"EndDate":"2026-09-08T12:00:00.000Z",

"EndDateBoundary":"2026-09-09T09:00:00.000Z",

"Nds":20,

"TimeToProvideDocuments":4,

"AutoRenew":true,

"RenewTime":5,

"MaxRenewTime":30,

"RaiseBid":false,

"MaxRate":60000,

"RaiseBidInterval":30,

"ResponseInMinutes":15,

"Duration":180,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":1,

"InitChangeWinnerCount":1,

"DurationAfterRestart":120,

"RateIncrease":500,

"RateIncreaseOption":1

},

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

"Source":0,

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ActiveDealId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"State":0,

"Finished":false,

"WinDate":"2026-09-08T12:05:00.000Z",

"AuctionRates":[...]

{...}

"AuctionRateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddedAt":"2026-09-08T10:15:30.000Z",

"RateFirm":{...},

"Score":4.5,

"Status":0,

"Name":"ООО «Перевозчик»",

"ContactName":"Иван Петров",

"AtiId":"1234567"

},

"Rate":48000,

"State":0,

"LoadingDate":"2026-09-09T00:00:00.000Z",

"FirmId":7654321,

"ContactId":0

}

]

}

},

"Boards":[...],

{...}

"BoardId":"a0a0a0a0a0a0a0a0a0a0a0a0",

"PublicationTime":"2026-09-08T12:00:00.000Z",

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":true,

"IsCommonBoard":true

}

],

"UnloadFirstDate":"2026-09-11T00:00:00.000Z",

"UnloadLastDate":"2026-09-12T00:00:00.000Z",

"ArchiveDate":"2026-09-07T10:15:30.000Z",

"ArchiveReason":"Unknown",

"TruePrice":85000,

"TrueCurrencyId":1,

"ResponseCount":3,

"OfferCount":2,

"CanBeDeleted":true,

"HasPermissionsToLoad":true,

"CanBeEdited":true,

"CanBeRenewed":true,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"Груз можно обновить не ранее чем через 40 минут",

"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"12345678",

"UpdatedAt":"2026-09-07T10:15:30.000Z",

"AddedAt":"2026-09-05T08:00:00.000Z",

"RefreshedAt":"2026-09-07T09:00:00+00:00",

"Distance":712,

"PlatonRoadsLength":540,

"TollRoadsLength":120,

"TravelTime":"10:30:00",

"Zimnik":false,

"Ferries":false,

"FirmId":"1234567",

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

400 Идентификатор площадки не из 24 символов.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Ошибка валидации: Массив ids не должен быть пуст",

"Error":"validation_error"

}

403 Среди площадок есть недоступная фирме, в том числе общая.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Следующие площадки не существуют или вы не имеете доступа к ним: 5f1e2d3c4b5a69788796a5b4",

"Error":"boards_access_denied_error"

}

Консоль

Отправить

Параметры

boardIds Идентификаторы закрытых площадок, по 24 символа. Пустой список — поиск по всем площадкам, доступным фирме.

Методы для добавления документа к грузу

Создание документа в АТИ-Доках на груз

Данный метод позволяет создавать следующие типы документов:

• заказ
• заказ (табличный вид)
• заявка (к договору)
• заявка к договору (табличный вид)
• поручение экспедитору

Тип создаваемого документа должен быть передан в documentType в том же виде, как он указан выше.

Создание документа на груз в ATI.Docs. API для интеграции. Допустимые значения типа документа отдаёт справочник documenttypes.

post /v1.0/loads/{loadId}/atidocs/{documentType}

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
loadId обязательный	string (guid)	path	Идентификатор груза. Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6
documentType обязательный	string	path	Тип документа из справочника documenttypes. Пример: заказ
templateId	string	query	Идентификатор шаблона документа. Пример: 12345

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/atidocs/{documentType}' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v1.0/loads/{loadId}/atidocs/{documentType}");

Ответ

200 Созданный документ.

Модель

{...}

Документ, созданный в ATI.Docs.

Id: string

Идентификатор созданного документа

Url: string

Ссылка на документ в АТИ-Доках

}

Пример

{...}

"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Url":"https://d.ati.su/documents/3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

400 Идентификатор груза пуст или тип документа не указан.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Ошибка валидации: Массив ids не должен быть пуст",

"Error":"validation_error"

}

404 Груз не найден.

Модель

{...}

Ошибка вместо результата: машинный ключ и пояснение для пользователя.

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"Груз не найден",

"Error":"load_not_found_error"

}

Консоль

Отправить

Параметры

loadId Идентификатор груза.

documentType Тип документа из справочника documenttypes.

templateId Идентификатор шаблона документа.