Как добавить груз с нужными параметрами

Для того, чтобы найти перевозчика на Бирже грузоперевозок ATI.SU, для начала необходимо добавить груз.

Создать заявку на груз. 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).

is_available_tomorrow: null,boolean

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

time:

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

ONE-OF

1:{...}

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

type: enum

[bounded]

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

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: enum

[bounded]

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

start: null,string

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

end: null,string

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

offset: null,string

}

null

periodicity*: string

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

time:

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

ONE-OF

1:{...}

type: enum

[bounded]

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

start: null,string

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

end: null,string

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

offset: null,string

}

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).

city_id*: int32

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

address: null,string

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: enum

[bounded]

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

start: null,string

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

end: null,string

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

offset: null,string

}

null

}

null

near_cities: [int32]

city_id*: int32

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

address: null,string

coordinates:

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

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

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

type: enum

[manual]

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

city_id*: int32

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

address: null,string

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).

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: enum

[bounded]

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

start: null,string

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

end: null,string

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

offset: null,string

}

null

}

null

city_id*: int32

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

address: null,string

coordinates:

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

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

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

type: enum

[manual]

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

city_id*: int32

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

address: null,string

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: enum

[bounded]

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

start: null,string

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

end: null,string

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

offset: null,string

}

null

}

null

city_id*: int32

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

address: null,string

coordinates:

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

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

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

type: enum

[manual]

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

city_id*: int32

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

address: null,string

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

coordinates:

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

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

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

type: enum

[manual]

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

city_id*: int32

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

address: null,string

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

coordinates:

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

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:{...}

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

type: enum

[manual]

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

city_id*: int32

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

address: null,string

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).

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).

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).

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).

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).

amount*: double

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

amount*: double

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

}

null

}

null

no_winner_end_options*:{...}

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

type: enum

[archive]

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

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).

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
1C

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]}}'

Процедура Выполнить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).

time:

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

ONE-OF

1:{...}

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

type: enum

[bounded]

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

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: enum

[bounded]

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

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: enum

[bounded]

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

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: enum

[bounded]

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

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).

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: enum

[bounded]

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

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: enum

[bounded]

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

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

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).

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).

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).

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).

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).

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).

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).

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":[...],

"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":[...],

"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":[...],

"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":[...],

"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":[...]

{}

]

}

Груз может быть добавлен:

на Общую площадку - тогда он будет виден всем пользователям ATI.SU. При этом он может быть поднят в поиске за счет приоритетного показа, который позволит привлечь больше внимания к грузу и увеличить охват. Метод для добавления и изменения параметров приоритетного показа:

Сохранение или обновление настроек приоритетного показа на груз

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
1C

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}}'

Процедура Выполнить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

Успешный ответ

на Персональную площадку - тогда он будет виден только тем пользователям, которые добавлены на данную Площадку. Создать Площадку и пригласить на нее пользователей вы можете через интерфейс на сайте ATI.SU или через API.

Создать площадку

post /v2/boards/public/boards/create

Модель и примеры
Консоль

Параметры

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

Запрос

Модель

{...}

all_departments_allowed*: boolean

Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения Если передано true, то DepartmentsIds должен быть null или пустым Пример: true

board_exchange_direction*: enum

[0, 1, 2]

Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)

exchange — Обмен грузами/машинами
input — Грузы/машины для владельца площадки
output - Грузы/машины от владельца площадки

0 — Информация от участников к владельцу
1 — Информация от владельца к участникам
2 — Обмен между всеми участниками

board_requirements:{...}

Опциональный список требований к площадке.
Поддерживаемые требования:
- требуемые от участников файлы и сканы RequirementDocumentTypeDto
Пример:  [{ "type_id": null, "type_name": "Сертификат партнера нашей компании", "is_requirable": true }] 

requirement_document_types:[{...}]

Список документов, требуемых к загрузке участниками площадки

base_type_id: enum

[1, 2, 3, 4, 5, 6]

Id базового типа документа

1 - Свидетельство о постановке на налоговый учет (ИНН)
2 - Свидетельство о регистрации юрлица или ИП
3 - Учредительные документы
4 - Реквизиты
5 - Прайс-лист
6 - Коммерческое предложение

1 — Свидетельство о постановке на налоговый учет (ИНН)
2 — Свидетельство о регистрации юрлица или ИП
3 — Учредительные документы
4 — Реквизиты
5 — Прайс-лист
6 — Коммерческое предложение

custom_type_name: string

Пользовательское имя типа документа, только для пользовательских типов

is_requirable*: boolean

Данный тип файла обязателен к предоставлению

}]

rules: string

Правила площадки (можно использовать html-тэги "b", "i", "span", "u", "ul", "li", "br")

}

board_type*: enum

[0, 1]

Тип содержимого на площадке

loads - Площадка с грузами
trucks - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)

0 — Грузы
1 — Машины

color: string

Цвет плашки площадки Пример: "#d8cfd0"

departments_ids: [int32]

Перечень подразделений компании, которым доступна площадка. В случае, если передан не пустой перечень значение AllDepartmentsAllowed должно быть false. Ответственный контакт ResponsibleContactId должен состоять (принадлежать) хотя бы одному из указанных подразделений Пример: [100302, 100303]

description: string

Описание площадки (можно использовать тэги "b", "i", "span", "u", "ul", "li", "br") Пример: "Лучшая площадка из всех созданных"

name_for_users: string

Публичное имя, видимое участникам площадки (до 50 символов) Пример: "Приходите, покупайте"

private_name: string

Имя, которое видит только владелец площадки (до 50 символов) Пример: "Покупайте, приходите"

public*: boolean

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

responsible_contact_id: int32

ID контакта ответственного пользователя Пример: 1

subscribe_to_notifications: boolean

Подписывать на уведомления новых участников. Пример: true

}

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

CURL
1C

curl 'https://api.ati.su/v2/boards/public/boards/create' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"all_departments_allowed":false,"board_exchange_direction":"0","board_requirements":{"requirement_document_types":[{"base_type_id":"1","custom_type_name":"string","is_requirable":false}],"rules":"string"},"board_type":"0","color":"string","departments_ids":[0],"description":"string","name_for_users":"string","private_name":"string","public":false,"responsible_contact_id":0,"subscribe_to_notifications":false}'

Процедура Выполнить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/boards/public/boards/create", "{""all_departments_allowed"":false,""board_exchange_direction"":""0"",""board_requirements"":{""requirement_document_types"":[{""base_type_id"":""1"",""custom_type_name"":""string"",""is_requirable"":false}],""rules"":""string""},""board_type"":""0"",""color"":""string"",""departments_ids"":[0],""description"":""string"",""name_for_users"":""string"",""private_name"":""string"",""public"":false,""responsible_contact_id"":0,""subscribe_to_notifications"":false}");

Ответ

200 Данные о площадке

Модель

{...}

all_departments_allowed*: boolean

Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения Пример: true

available_for_contact*: boolean

Площадка доступна для данного контакта Пример: true

board_exchange_direction*: enum

[0, 1, 2]

Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)

exchange — Обмен грузами/машинами
input — Грузы/машины для владельца площадки
output - Грузы/машины от владельца площадки

0 — Информация от участников к владельцу
1 — Информация от владельца к участникам
2 — Обмен между всеми участниками

board_type*: enum

[0, 1]

Тип содержимого на площадке

loads - Площадка с грузами
trucks - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)

0 — Грузы
1 — Машины

color: string

Цвет площадки Пример: "#d8cfd0"

created_on*: date-time

Время создания площадки (timestamp) Пример: 1556201954901

departments_ids: [int32]

Перечень подразделений компании, которым доступна площадка Пример: [100302, 100303]

id: string

ID площадки (строка 24 символа) Пример: "507f1f77bcf86cd799439011"

name: string

Название площадки Пример: "Образцово-показательная площадка"

owner_ati_id: string

Код участника АТИ создавшего площадку Пример: "1111111"

owner_firm*: int32

Код участника АТИ создавшего площадку Пример: 1111111

updated_on*: date-time

Последнее время изменения площадки (Timestamp) Пример: 1556201954901

view_only_own*: boolean

Участник может видеть только свои грузы/машины Пример: true

}

Пример

{...}

"all_departments_allowed":false,

"available_for_contact":false,

"board_exchange_direction":"0",

"board_type":"0",

"color":"string",

"created_on":"1970-01-01T00:00:00.000Z",

"departments_ids":[...],

"id":"string",

"name":"string",

"owner_ati_id":"string",

"owner_firm":0,

"updated_on":"1970-01-01T00:00:00.000Z",

"view_only_own":false

}

400 Ошибка валидации или другая

Модель

{...}

error: string

Код ошибки

reason: string

Текст ошибки

details:{...}

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

any-key: {missing-type-info}

}

errors_list: [string]

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

}

Пример

{...}

"error":"string",

"reason":"string",

"details":{...},

"any-key":null

"errors_list":[...]

"string"

]

}

Пригласить участника АТИ на площадку

post /v2/boards/public/participants/invite

Модель и примеры
Консоль

Параметры

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

Запрос

Модель

{...}

ati_id: string

код участника в АТИ

board_id: string

ID площадки

contact_id: int32

ID контакта

}

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

CURL
1C

curl 'https://api.ati.su/v2/boards/public/participants/invite' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ati_id":"string","board_id":"string","contact_id":0}'

Процедура Выполнить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/boards/public/participants/invite", "{""ati_id"":""string"",""board_id"":""string"",""contact_id"":0}");

Ответ

200 ID приглашения

Модель

string

Пример

"string"

400 Ошибка валидации

Модель

{...}

error: string

Код ошибки

reason: string

Текст ошибки

details:{...}

any-key: {missing-type-info}

}

errors_list: [string]

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

}

Пример

{...}

"error":"string",

"reason":"string",

"details":{...},

"any-key":null

"errors_list":[...]

"string"

]

}

Полная документация API Площадок.

После того, как Площадка будет создана, вы сможете добавлять на неё грузы.

Добавляя груз, вы можете выбрать, каким образом будет сформирована итоговая ставка за перевозку:

если опубликовать груз с запросом ставки, то перевозчики будут предлагать вам свои цены - встречные предложения, из которых вы сможете выбрать наиболее интересный для вас вариант;
если опубликовать груз с фиксированной ставкой, но с возможностью торга, то перевозчики смогут сделать вам встречные предложения, опираясь на ту цену, которую изначально указали вы. И у вас также будет возможность выбрать наиболее интересный для вас вариант;
если опубликовать груз с фиксированной ставкой, без возможности торга, то его смогут взять те перевозчики, которые будут согласны перевезти груз за указанную вами цену;
если опубликовать груз с Торгами (Аукционом), то конечная ставка за перевозку будет сформирована после Торгов.

Безналичных ставок с НДС у груза может быть несколько — набор payment.rates_with_vat, не больше одной на процент. Какие проценты доступны для какой валюты — в разделе Ставки НДС.

Полная документация API грузов.