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

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

Версия

Создать заявку на груз.

post /v2/cargos

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

Запрос

Модель

{...}

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

cargo_application*:{...}

Заявка груза

external_id: null,string

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

route*:{...}

Маршрут

loading*:{...}

Загрузка

dates*:

Даты загрузки

ANY-OF

1:{...}

Даты готовности к загрузке.

type: enum

[ready]

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

is_available_tomorrow: null,boolean

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

time:

Время загрузки

ONE-OF

Время загрузки.

ANY-OF

1:{...}

Время загрузки в интервале «с/по».

type: enum

[bounded]

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

start: null,string

end: null,string

По

offset: null,string

Часовой пояс

}

2:{...}

Круглосуточное время загрузки.

type: enum

[round-the-clock]

Тип времени — круглосуточно (round-the-clock).

}

null

}

2:{...}

Дата погрузки "С даты", type = 'from-date'

type: enum

[from-date]

Тип даты — с даты (from-date).

first_date: date-time

Дата начала

last_date: date-time

Дата конца

time:

Время загрузки

ONE-OF

Время загрузки.

ANY-OF

1:{...}

Время загрузки в интервале «с/по».

type: enum

[bounded]

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

start: null,string

end: null,string

По

offset: null,string

Часовой пояс

}

2:{...}

Круглосуточное время загрузки.

type: enum

[round-the-clock]

Тип времени — круглосуточно (round-the-clock).

}

null

}

3:{...}

Постоянные даты загрузки.

type: enum

[permanent]

Тип даты — постоянно (permanent).

periodicity*: string

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

time:

Время загрузки

ONE-OF

Время загрузки.

ANY-OF

1:{...}

Время загрузки в интервале «с/по».

type: enum

[bounded]

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

start: null,string

end: null,string

По

offset: null,string

Часовой пояс

}

2:{...}

Круглосуточное время загрузки.

type: enum

[round-the-clock]

Тип времени — круглосуточно (round-the-clock).

}

null

}

4:{...}

Даты загрузки для запроса ставки (груза нет).

type: enum

[rate-request]

Тип даты — запрос ставки (rate-request).

}

cargos*:[{...}]

Параметры грузов

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 типа упаковки из словаря типов упаковок

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]

Ближайшие города. Id города из словаря городов

city_id*: int32

Id города из словаря городов

address: null,string

Адрес в населённом пункте Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:

Расположение

ANY-OF

1:{...}

Расположение точки, заданное вручную.

type: enum

[manual]

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

city_id*: int32

Id города из словаря городов

address: null,string

Адрес в населённом пункте Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

}

2:{...}

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

type: enum

[organization]

Тип расположения точки — из организации (organization).

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

unloading*:{...}

Разгрузка

dates:

Даты разгрузки

ONE-OF

1:{...}

Даты разгрузки.

first_date: date-time

Дата разгрузки

last_date: date-time

Поздняя дата разгрузки

time:

Время разгрузки

ONE-OF

Время загрузки.

ANY-OF

1:{...}

Время загрузки в интервале «с/по».

type: enum

[bounded]

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

start: null,string

end: null,string

По

offset: null,string

Часовой пояс

}

2:{...}

Круглосуточное время загрузки.

type: enum

[round-the-clock]

Тип времени — круглосуточно (round-the-clock).

}

null

}

null

near_cities: [int32]

Ближайшие города. Id города из словаря городов

city_id*: int32

Id города из словаря городов

address: null,string

Адрес в населённом пункте Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

location*:

Расположение

ANY-OF

1:{...}

Расположение точки, заданное вручную.

type: enum

[manual]

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

city_id*: int32

Id города из словаря городов

address: null,string

Адрес в населённом пункте Поле не должно содержать emoji-символы и emoji-последовательности

coordinates:

Координаты

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

}

2:{...}

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

type: enum

[organization]

Тип расположения точки — из организации (organization).

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

way_points:[]

Точки маршрута

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

Оплата

ANY-OF

1:{...}

Оплата с торгом.

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

НДС процент

}]

hide_counter_offers: null,boolean

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

direct_offer: null,boolean

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

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

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

using_fuel: null,boolean

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

}

null

payment_mode:

Режим оплаты

ONE-OF

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

ANY-OF

1:{...}

Оплата на выгрузке.

type: enum

[on-unloading]

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

}

2:{...}

Оплата через N банковских дней.

type: enum

[delayed-payment]

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

payment_delay_days: int32

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

}

null

}

2:{...}

Оплата без торга.

type: enum

[without-bargaining]

Тип оплаты — без торга (without-bargaining).

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

НДС процент

}]

hide_counter_offers: null,boolean

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

direct_offer: null,boolean

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

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

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

using_fuel: null,boolean

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

}

null

payment_mode:

Режим оплаты

ONE-OF

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

ANY-OF

1:{...}

Оплата на выгрузке.

type: enum

[on-unloading]

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

}

2:{...}

Оплата через N банковских дней.

type: enum

[delayed-payment]

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

payment_delay_days: int32

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

}

null

}

3:{...}

Оплата с запросом ставки.

type: enum

[rate-request]

Тип оплаты — запрос ставки (rate-request).

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

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

ANY-OF

1:{...}

Оплата на выгрузке.

type: enum

[on-unloading]

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

}

2:{...}

Оплата через N банковских дней.

type: enum

[delayed-payment]

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

payment_delay_days: int32

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

}

null

}

4:{...}

Оплата через Торги.

type: enum

[auction]

Тип оплаты — Торги (auction).

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

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

ANY-OF

1:{...}

Повышение ставки после перезапуска — абсолютное значение в валюте.

type: enum

[currency]

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

amount*: double

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

}

2:{...}

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

type: enum

[percent]

Тип повышения — процент от начальной ставки (percent).

amount*: double

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

}

null

}

null

no_winner_end_options*:

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

ANY-OF

1:{...}

Завершение Торгов — переместить заявку в архив.

type: enum

[archive]

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

}

2:{...}

Завершение Торгов — опубликовать заявку со ставкой.

type: enum

[publish-with-rate]

Действие — опубликовать заявку со ставкой (publish-with-rate).

currency_type: int32

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

rate_with_vat: double

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

rates_with_vat:[{...}]

Безналичные ставки с НДС

rate_with_vat*: double

Ставка

vat_percent: int32

НДС процент

}]

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

}

3:{...}

Завершение Торгов — опубликовать заявку с запросом ставки.

type: enum

[publish-rate-request]

Действие — опубликовать заявку с запросом ставки (publish-rate-request).

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

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

ANY-OF

1:{...}

Оплата на выгрузке.

type: enum

[on-unloading]

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

}

2:{...}

Оплата через N банковских дней.

type: enum

[delayed-payment]

Тип режима оплаты — оплата через N банковских дней (delayed-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
1C

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":20}],"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", "/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"":20}],""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 Заявка на груз успешно создана и опубликована.

Модель

{...}

Ответ на создание заявки на груз через Public 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*:

Даты загрузки

ANY-OF

1:{...}

Дата погрузки «С даты».

type: enum

[from-date]

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

time:

Время загрузки

ONE-OF

Время загрузки.

ANY-OF

1:{...}

Время загрузки в интервале «с/по».

type: enum

[bounded]

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

start: null,string

Время "с"

end: null,string

Время "по"

offset: null,string

Часовой пояс

}

2:{...}

Круглосуточное время загрузки.

type: enum

[round-the-clock]

Тип времени — круглосуточно (round-the-clock).

}

null

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

}

2:{...}

Даты готовности к загрузке.

type: enum

[ready]

Тип даты — готов (ready).

is_available_tomorrow*: boolean

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

time:

Время загрузки

ONE-OF

Время загрузки.

ANY-OF

1:{...}

Время загрузки в интервале «с/по».

type: enum

[bounded]

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

start: null,string

Время "с"

end: null,string

Время "по"

offset: null,string

Часовой пояс

}

2:{...}

Круглосуточное время загрузки.

type: enum

[round-the-clock]

Тип времени — круглосуточно (round-the-clock).

}

null

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

}

3:{...}

Постоянные даты загрузки.

type: enum

[permanent]

Тип даты — постоянно (permanent).

periodicity*: string

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

time:

Время загрузки

ONE-OF

Время загрузки.

ANY-OF

1:{...}

Время загрузки в интервале «с/по».

type: enum

[bounded]

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

start: null,string

Время "с"

end: null,string

Время "по"

offset: null,string

Часовой пояс

}

2:{...}

Круглосуточное время загрузки.

type: enum

[round-the-clock]

Тип времени — круглосуточно (round-the-clock).

}

null

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

}

4:{...}

Даты загрузки для запроса ставки (груза нет).

type: enum

[rate-request]

Тип даты — запрос ставки (rate-request).

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

}

cargos*:[{...}]

Параметры грузов на загрузку

name_id*: int32

Id наименования груза из словаря (TODO ссылка на словарь)

name*: string

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

packaging:

Упаковка

ONE-OF

1:{...}

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

type*: int32

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

quantity: int32

Количество

}

null

cargo_id*: int32

Порядковый Id груза внутри заявки

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

Ближайшие крупные города

id*: int32

Id города из словаря городов

distance: double

Расстояние до города

}]

city_id*: int32

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

city*:{...}

Информация о населённом пункте

city_id*: int32

Id города из словаря городов

region_id: int32

Id региона из словаря регионов

country_id: int32

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

}

coordinates:

Координаты

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

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

organization:

Данные об организации из справочника (TODO ссылка на api), если она была указана в качестве адреса

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель.

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

null

}

unloading*:{...}

Разгрузка

near_cities: [int32]

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

dates:

Даты разгрузки

ONE-OF

1:{...}

Даты разгрузки.

first_date: date-time

Дата разгрузки

last_date: date-time

Поздняя дата разгрузки

time:

Время разгрузки

ONE-OF

Время загрузки.

ANY-OF

1:{...}

Время загрузки в интервале «с/по».

type: enum

[bounded]

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

start: null,string

Время "с"

end: null,string

Время "по"

offset: null,string

Часовой пояс

}

2:{...}

Круглосуточное время загрузки.

type: enum

[round-the-clock]

Тип времени — круглосуточно (round-the-clock).

}

null

}

null

nearby_cities:[{...}]

Ближайшие крупные города

id*: int32

Id города из словаря городов

distance: double

Расстояние до города

}]

city_id*: int32

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

city*:{...}

Информация о населённом пункте

city_id*: int32

Id города из словаря городов

region_id: int32

Id региона из словаря регионов

country_id: int32

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

}

coordinates:

Координаты

ONE-OF

1:{...}

Координаты.

longitude*: double

Долгота

latitude*: double

Широта

}

null

address: null,string

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

organization:

Данные об организации из справочника (TODO ссылка на api), если она была указана в качестве адреса

ONE-OF

1:{...}

Организация — грузоотправитель или грузополучатель.

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

null

}

way_points:[]

Точки маршрута

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

Оплата

ANY-OF

1:{...}

Оплата с торгом.

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

НДС процент

}]

hide_counter_offers*: boolean

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

direct_offer*: boolean

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

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

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

using_fuel*: boolean

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

}

null

payment_mode:

Режим оплаты

ONE-OF

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

ANY-OF

1:{...}

Оплата через N банковских дней.

type: enum

[delayed-payment]

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

payment_delay_days*: int32

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

}

2:{...}

Оплата на выгрузке.

type: enum

[on-unloading]

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

}

null

}

2:{...}

Оплата без торга.

type: enum

[without-bargaining]

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

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

НДС процент

}]

hide_counter_offers*: boolean

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

direct_offer*: boolean

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

prepayment:

Предоплата

ONE-OF

1:{...}

Предоплата.

percent: int32

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

using_fuel*: boolean

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

}

null

payment_mode:

Режим оплаты

ONE-OF

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

ANY-OF

1:{...}

Оплата через N банковских дней.

type: enum

[delayed-payment]

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

payment_delay_days*: int32

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

}

2:{...}

Оплата на выгрузке.

type: enum

[on-unloading]

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

}

null

}

3:{...}

Оплата с запросом ставки.

type: enum

[rate-request]

Тип оплаты — запрос ставки (rate-request).

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

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

ANY-OF

1:{...}

Оплата через N банковских дней.

type: enum

[delayed-payment]

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

payment_delay_days*: int32

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

}

2:{...}

Оплата на выгрузке.

type: enum

[on-unloading]

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

}

null

}

4:{...}

Оплата через Торги.

type: enum

[auction]

Тип оплаты — Торги (auction).

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

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

ANY-OF

1:{...}

Завершение Торгов — переместить заявку в архив.

type: enum

[archive]

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

}

2:{...}

Завершение Торгов — опубликовать заявку со ставкой.

type: enum

[publish-with-rate]

Действие — опубликовать заявку со ставкой (publish-with-rate).

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

НДС процент

}]

}

3:{...}

Завершение Торгов — опубликовать заявку с запросом ставки.

type: enum

[publish-rate-request]

Действие — опубликовать заявку с запросом ставки (publish-rate-request).

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

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

ANY-OF

1:{...}

Повышение ставки после перезапуска — абсолютное значение в валюте.

type: enum

[currency]

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

amount*: double

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

}

2:{...}

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

type: enum

[percent]

Тип повышения — процент от начальной ставки (percent).

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

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

ANY-OF

1:{...}

Оплата через N банковских дней.

type: enum

[delayed-payment]

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

payment_delay_days*: int32

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

}

2:{...}

Оплата на выгрузке.

type: enum

[on-unloading]

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

}

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":20

}

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

{}

]

}

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

post /v1.0/loads

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

Запрос

Модель

{...}

LoadMeta:{...}

Метаданные для интеграторов

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные
Максимальная длина 1024 символа

}

ContactId1*: int32

Идентификатор первого выбранного контакта.
Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами
Контакт должен быть виден для остальных участников АТИ

ContactId2: int32 (nullable)

Идентификатор второго выбранного контакта, если не выбрано, то null
Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу
Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC
Минимальное значение равно текущей дате
При значении параметра DateType равным 0, допустимое значение поля - текущая дата
При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 60 дней вперед
При значении параметра 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 - Готов к загрузке
1 - с Х по У
2 - постоянно
3 - груза нет, запрос ставки

PeriodicityId: int32

Периодичность загрузки
Если параметр DateType не равен 2, PeriodicityId равен 0.
Иначе PeriodicityId может принимать следующие значения:

1 - ежедневно
100 - по рабочим дням

OrderNumber: string

Номер заказа
Ограничение по длине: 250 символов

Krugoreis: boolean

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

Loading*:{...}

Загрузка

CityId*: int32

Идентификатор города загрузки/разгрузки
Значение из словаря городов АТИ

Latitude: decimal (nullable)

Широта города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Максимальная длина 100 символов.

TimeStart: date-time (nullable)

Время начала загрузки/разгрузки
Не указывается при значении параметра DateType равным 3.
Не указывается при значении IsRoundTheClock: true

TimeEnd: date-time (nullable)

Время завершения загрузки/разгрузки
Не указывается при значении параметра DateType равным 3.
Не указывается при значении IsRoundTheClock: true

IsRoundTheClock: boolean

Определяет выбрано ли значение Круглосуточно
По умолчанию - false
Не указывается при значении параметра DateType равным 3.

LargeCities: [int32]

Массив идентификаторов ближайших крупных городов
Значение из словаря городов АТИ
Максимальное количество - 10 штук

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

ExtraPoints:[{...}]

Список дополнительных пунктов маршрута Максимальное количество - 15 штук

CityId*: int32

Идентификатор города
Значение из словаря городов АТИ

PointType*: int32

Тип точки:

1 - загрузка
2 - разгрузка
3 - таможня
8 - проехать через

Latitude: decimal (nullable)

Долгота

Longitude: decimal (nullable)

Широта

Street: string

Улица или район

OrdinalId: int32

Порядковый номер

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки

LoadingTimeStart: time-span (nullable)

Время начала загрузки/разгрузки

LoadingTimeEnd: time-span (nullable)

Время окончания загрузки/разгрузки

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

UnloadingCargos:[{...}]

CargoId: int32

Id груза

Weight: double (nullable)

Вес

Volume: double (nullable)

Объём

PackagingQuantity: int32 (nullable)

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

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

Unloading*:{...}

Разгрузка

CityId*: int32

Идентификатор города загрузки/разгрузки
Значение из словаря городов АТИ

Latitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Максимальная длина 100 символов.

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

Cargo*:{...}

Информация о грузе

Weight: double

Вес груза в тоннах
Обязательный параметр, если не задан параметр Volume.

Volume: double

Объем груза в кубических метрах
Обязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа

ADR: int32

Параметр, определяющий степень опасности груза
Допустимое значение от 0 до 9. По умолчанию - 0

CargoTypeId*: int32

Идентификатор наименования груза
Значение из Словаря наименований грузов

CargoType: string

Строковое наименование груза.
Обязательный параметр, если значение параметра CargoTypeId равно 59.
Максимальная длина названия - 50 символов.
Этот параметр должен быть пустым, если параметр CargoTypeId отличен от 59.
В этом поле запрещено указывать контактную информацию

PackType: int32

Идентификатор наименования упаковки (навалом, коробки, россыпью...)
Значение из Словаря наименований грузов

PalletCount: int32

Количество упаковок для груза
Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза
Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

1 - только отдельной машиной
2 - отдельной или догрузом

SborGruz: boolean

Определяет, является ли груз сборным

Size:{...}

Параметры размера груза

Length: double

Длина груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

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

WidthHighlight: boolean

Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)

HeightHighlight: boolean

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

}

Transport*:{...}

Параметры транспорта

CarType*: int64

Битовая сумма ID кузовов
Значение из словаря кузовов АТИ

LoadingType: int32

Битовая сумма ID типов загрузки
Значение из словаря вариантов загрузки АТИ

LoadingLogicalOperator: string

Тип условия загрузки:

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

UnloadingType: int32

Битовая сумма ID типов разгрузки.
Значение из словаря вариантов разагрузки АТИ

UnloadingLogicalOperator: string

Тип условия разгрузки:

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

TrucksQuantity: int32

Количество машин
Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

Минимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный"
Допустимое значение от -99 до 999

TemperatureTo: int32 (nullable)

Максимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный"
Допустимое значение от -99 до 999

Stsepka: boolean

Определяет, нужна ли сцепка для груза

Pnevmohod: boolean

Определяет, нужен ли пневмоход для груза

Koniki: boolean

Определяет, нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

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

IsTracking: boolean

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

}

Payment*:{...}

Оплата

CurrencyId: int32

Идентификатор валюты
По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false
Значение из словаря валют АТИ

MoneyType: int32

Идентификатор варианта оплаты
По умолчанию - 22. Должен принимать значение 22, если параметр FixedRate равен false
Значение из словаря вариантов оплаты АТИ

RateSum: decimal

Ставка для груза
Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр MoneyType равен 22 и RateSum > 0, тогда поля SumWithNDS и SumWithoutNDS должны быть пустыми или принимать значение 0

SumWithNDS: decimal

Ставка б/нал с НДС
Обязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0

SumWithoutNDS: decimal

Ставка б/нал без НДС
Обязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр 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. Не учитывается, если параметр FixedRate равен false

DirectContract: boolean

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

InFuel: boolean

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

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

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

AcceptPaymentTypes: int32

Позволяет указать форму оплаты при выборе параметра "Запрос ставки":

1 - наличные
2 - б/нал с НДС
3 - нал и б/нал с НДС
4 - б/нал без НДС
5 - нал и б/нал без НДС
6 - б/нал с НДС и без НДС
7 - нал и б/нал с НДС и без НДС
0 - указана фикс. ставка

}

InviteSettings:{...}

Настройки автоприглашений

InviteDelayInSeconds: int32

Время в секундах сбора встречных предложений, по истечение которого будет создано приглашение по лучшему из них

InviteDurationInSeconds: int32

Время в секундах действия приглашения

}

PriorityView:{...}

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

DailyLimit: decimal

Суточный лимит списания по услуге

Должен иметь длину не более 5 символов
Не более 2 символов после запятой
Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

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

OrderLimit: decimal

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

Должен иметь длину не более 5 символов
Не более 2 символов после запятой
Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

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

Минимальное значение 0,6
Не более 2 символов после запятой
Должен иметь длину не более 5 символов

}

Stealth:{...}

Настройки показа груза

ListIdToHide: guid (nullable)

Режим стэлс, ID списка для которого данный груз показываться не будет
Получить ID списка можно с помощью API списков фирмы

FirmRegDateToHide: date-time (nullable)

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

ScoreToHide: double (nullable)

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

}

LoadFiles:[{...}]

Файлы к грузу Перед добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. API для хранения файлов)

Id: guid

Идентификатор файла, возвращается при загрузке файла в АТИ-Доки

FileType: int32

Тип загруженного файла:

1 - документ

Attributes: int32

Битовый набор опции файла

0 - Значение по умолчанию. Данный файл доступен по ссылке
1 - Данный файл доступен только владельцу груза

Name: string

Имя файла
Для имени файла разрешено использовать следующие символы: цифры, заглавные и строчные буквы латинского и кириллического алфавита, дефис, точка, пробел. Длинна: до 100 символов. Имя файла присваивается при загрузке в АТИ-Доки

Link: string

Ссылка, по которой можно скачать файл, возвращается при загрузке файла в АТИ-Доки

Size: int32

Размер файла
Информационное поле, на текущий момент не используется

}]

Deal:{...}

Auction:{...}

Параметры аукциона

StartRate*: decimal

Начальная ставка аукциона
Параметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.

Currency*: int32

Валюта аукциона
Значение из словаря валют АТИ

Step*: decimal

Минимальное изменение ставки по аукциону
Параметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.

PaymentType*: enum

[1, 22, 23, 24, 25]

Тип оплаты

22: любой
1: наличные
23: по карте
24: безнал с НДС
25: безнал без НДС

AcceptSecondPayType: boolean

Принимать ставки без НДС. Параметр можно указать, если начальная ставка указана с НДС (PaymentType=24)

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

Нужно ли продление аукциона, если была ставка в последние 5 минут до окончания

RenewTime: int32 (nullable)

Время, на которое надо сдвигать окончание аукциона при включенном AutoRenew

MaxRenewTime: int32 (nullable)

Максимально допустимое время, на которое можно сдвинуть окончание аукциона при включенном AutoRenew
Указывать, если raiseBid = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

Максимально допустимая ставка по аукциону
Указывать, если raiseBid = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.

RaiseBidInterval: int32 (nullable)

Период увеличения ставки при отсутствии предложений
При RaiseBid = true должно принимать значение не меньше 1 минуты и не больше 24 часов.

ResponseInMinutes: int32 (nullable)

Указывает, через какой промежуток времени с момента публикации аукциона принимать встречные предложения:

1 - сразу
15, 30, 60, 120, 180 - время в минутах
null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

Длительность аукциона в минутах: 30, 60, 120, 180, 240, 360, 720, 1440, 2880, 4320, 5760, 7200
Значение не может быть больше времени актуальности груза LastDate

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчет до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:{...}

Параметры перезапуска аукциона

AuctionFinishAction: enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны:

1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
2 - Опубликовать с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе
3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно.
Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно
Если параметр не передать, по умолчанию 0

DurationAfterRestart: int32 (nullable)

Длительность торгов в минутах после перезапуска
Необязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

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

WinnerCriterion: enum

[0, 1]

Критерий выбора победителя торгов

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.

}

Boards:[{...}]

Список площадок

BoardId: string

ID площадки

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, UnloadFirstDate принимает значение null

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null.
Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

}

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

CURL
1C

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":"string"},"ContactId1":0,"ContactId2":0,"Note":"string","FirstDate":"1970-01-01T00:00:00.000Z","LastDate":"1970-01-01T00:00:00.000Z","DateType":0,"PeriodicityId":0,"OrderNumber":"string","Krugoreis":false,"Loading":{"CityId":0,"Latitude":0.5,"Longitude":0.5,"Street":"string","TimeStart":"1970-01-01T00:00:00.000Z","TimeEnd":"1970-01-01T00:00:00.000Z","IsRoundTheClock":false,"LargeCities":[0],"LoadingCargos":[{"CargoId":0,"NameId":0,"Name":"string","PackagingType":0,"PackagingQuantity":0,"Weight":0.5,"Volume":0.5,"Sizes":{"Length":0.5,"Width":0.5,"Height":0.5,"Diameter":0.5,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}}]},"ExtraPoints":[{"CityId":0,"PointType":0,"Latitude":0.5,"Longitude":0.5,"Street":"string","OrdinalId":0,"IsRoundTheClock":false,"LoadingDateStart":"1970-01-01T00:00:00.000Z","LoadingDateEnd":"1970-01-01T00:00:00.000Z","LoadingTimeStart":null,"LoadingTimeEnd":null,"LoadingCargos":[{"CargoId":0,"NameId":0,"Name":"string","PackagingType":0,"PackagingQuantity":0,"Weight":0.5,"Volume":0.5,"Sizes":{"Length":0.5,"Width":0.5,"Height":0.5,"Diameter":0.5,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}}],"UnloadingCargos":[{"CargoId":0,"Weight":0.5,"Volume":0.5,"PackagingQuantity":0,"IsDefinedByTtn":false}]}],"Unloading":{"CityId":0,"Latitude":0.5,"Longitude":0.5,"Street":"string","TimeStart":"1970-01-01T00:00:00.000Z","TimeEnd":"1970-01-01T00:00:00.000Z","IsRoundTheClock":false,"LargeCities":[0],"LoadingCargos":[{"CargoId":0,"NameId":0,"Name":"string","PackagingType":0,"PackagingQuantity":0,"Weight":0.5,"Volume":0.5,"Sizes":{"Length":0.5,"Width":0.5,"Height":0.5,"Diameter":0.5,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}}]},"Cargo":{"Weight":0.5,"Volume":0.5,"ADR":0,"CargoTypeId":0,"CargoType":"string","PackType":0,"PalletCount":0,"BeltCount":0,"DogruzType":0,"SborGruz":false,"Size":{"Length":0.5,"Width":0.5,"Height":0.5,"Diameter":0.5,"LengthHighlight":false,"WidthHighlight":false,"HeightHighlight":false}},"Transport":{"CarType":0,"LoadingType":0,"LoadingLogicalOperator":"string","UnloadingType":0,"UnloadingLogicalOperator":"string","TrucksQuantity":0,"TemperatureFrom":0,"TemperatureTo":0,"Stsepka":false,"Pnevmohod":false,"Koniki":false,"TIR":false,"CMR":false,"T1":false,"SanPassport":false,"IsTracking":false},"Payment":{"CurrencyId":0,"MoneyType":0,"RateSum":0.5,"SumWithNDS":0.5,"SumWithoutNDS":0.5,"PrepayPercent":0,"PrepayPercentEnabled":false,"PayDays":0,"PayDaysEnabled":false,"FixedRate":false,"Torg":false,"DirectContract":false,"InFuel":false,"OnUnloading":false,"HideResponses":false,"AcceptPaymentTypes":0},"InviteSettings":{"InviteDelayInSeconds":0,"InviteDurationInSeconds":0},"PriorityView":{"DailyLimit":0.5,"IsForPayedOnly":false,"OrderLimit":0.5,"ViewRate":0.5},"Stealth":{"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6","FirmRegDateToHide":"1970-01-01T00:00:00.000Z","ScoreToHide":0.5},"LoadFiles":[{"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","FileType":0,"Attributes":0,"Name":"string","Link":"string","Size":0}],"Deal":{"Auction":{"StartRate":0.5,"Currency":0,"Step":0.5,"PaymentType":0,"AcceptSecondPayType":false,"StartDate":"1970-01-01T00:00:00.000Z","EndDate":"1970-01-01T00:00:00.000Z","EndDateBoundary":"1970-01-01T00:00:00.000Z","Nds":0.5,"TimeToProvideDocuments":0.5,"AutoRenew":false,"RenewTime":0,"MaxRenewTime":0,"RaiseBid":false,"MaxRate":0.5,"RaiseBidInterval":0,"ResponseInMinutes":0,"Duration":0,"StartSinceFirstBet":false,"AuctionRestartParameters":{"AuctionFinishAction":0,"InitRestartCount":0,"InitChangeWinnerCount":0,"DurationAfterRestart":0},"AcceptCounterOffersOnlyBeforeFirstBet":false,"WinnerCriterion":0}},"Boards":[{"BoardId":"string","PublicationTime":"1970-01-01T00:00:00.000Z","IsReservationEnabled":false,"PublicationOption":0}],"UnloadFirstDate":"1970-01-01T00:00:00.000Z","UnloadLastDate":"1970-01-01T00:00:00.000Z"}'

Процедура Выполнить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"":""string""},""ContactId1"":0,""ContactId2"":0,""Note"":""string"",""FirstDate"":""1970-01-01T00:00:00.000Z"",""LastDate"":""1970-01-01T00:00:00.000Z"",""DateType"":0,""PeriodicityId"":0,""OrderNumber"":""string"",""Krugoreis"":false,""Loading"":{""CityId"":0,""Latitude"":0.5,""Longitude"":0.5,""Street"":""string"",""TimeStart"":""1970-01-01T00:00:00.000Z"",""TimeEnd"":""1970-01-01T00:00:00.000Z"",""IsRoundTheClock"":false,""LargeCities"":[0],""LoadingCargos"":[{""CargoId"":0,""NameId"":0,""Name"":""string"",""PackagingType"":0,""PackagingQuantity"":0,""Weight"":0.5,""Volume"":0.5,""Sizes"":{""Length"":0.5,""Width"":0.5,""Height"":0.5,""Diameter"":0.5,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}}]},""ExtraPoints"":[{""CityId"":0,""PointType"":0,""Latitude"":0.5,""Longitude"":0.5,""Street"":""string"",""OrdinalId"":0,""IsRoundTheClock"":false,""LoadingDateStart"":""1970-01-01T00:00:00.000Z"",""LoadingDateEnd"":""1970-01-01T00:00:00.000Z"",""LoadingTimeStart"":null,""LoadingTimeEnd"":null,""LoadingCargos"":[{""CargoId"":0,""NameId"":0,""Name"":""string"",""PackagingType"":0,""PackagingQuantity"":0,""Weight"":0.5,""Volume"":0.5,""Sizes"":{""Length"":0.5,""Width"":0.5,""Height"":0.5,""Diameter"":0.5,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}}],""UnloadingCargos"":[{""CargoId"":0,""Weight"":0.5,""Volume"":0.5,""PackagingQuantity"":0,""IsDefinedByTtn"":false}]}],""Unloading"":{""CityId"":0,""Latitude"":0.5,""Longitude"":0.5,""Street"":""string"",""TimeStart"":""1970-01-01T00:00:00.000Z"",""TimeEnd"":""1970-01-01T00:00:00.000Z"",""IsRoundTheClock"":false,""LargeCities"":[0],""LoadingCargos"":[{""CargoId"":0,""NameId"":0,""Name"":""string"",""PackagingType"":0,""PackagingQuantity"":0,""Weight"":0.5,""Volume"":0.5,""Sizes"":{""Length"":0.5,""Width"":0.5,""Height"":0.5,""Diameter"":0.5,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}}]},""Cargo"":{""Weight"":0.5,""Volume"":0.5,""ADR"":0,""CargoTypeId"":0,""CargoType"":""string"",""PackType"":0,""PalletCount"":0,""BeltCount"":0,""DogruzType"":0,""SborGruz"":false,""Size"":{""Length"":0.5,""Width"":0.5,""Height"":0.5,""Diameter"":0.5,""LengthHighlight"":false,""WidthHighlight"":false,""HeightHighlight"":false}},""Transport"":{""CarType"":0,""LoadingType"":0,""LoadingLogicalOperator"":""string"",""UnloadingType"":0,""UnloadingLogicalOperator"":""string"",""TrucksQuantity"":0,""TemperatureFrom"":0,""TemperatureTo"":0,""Stsepka"":false,""Pnevmohod"":false,""Koniki"":false,""TIR"":false,""CMR"":false,""T1"":false,""SanPassport"":false,""IsTracking"":false},""Payment"":{""CurrencyId"":0,""MoneyType"":0,""RateSum"":0.5,""SumWithNDS"":0.5,""SumWithoutNDS"":0.5,""PrepayPercent"":0,""PrepayPercentEnabled"":false,""PayDays"":0,""PayDaysEnabled"":false,""FixedRate"":false,""Torg"":false,""DirectContract"":false,""InFuel"":false,""OnUnloading"":false,""HideResponses"":false,""AcceptPaymentTypes"":0},""InviteSettings"":{""InviteDelayInSeconds"":0,""InviteDurationInSeconds"":0},""PriorityView"":{""DailyLimit"":0.5,""IsForPayedOnly"":false,""OrderLimit"":0.5,""ViewRate"":0.5},""Stealth"":{""ListIdToHide"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""FirmRegDateToHide"":""1970-01-01T00:00:00.000Z"",""ScoreToHide"":0.5},""LoadFiles"":[{""Id"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""FileType"":0,""Attributes"":0,""Name"":""string"",""Link"":""string"",""Size"":0}],""Deal"":{""Auction"":{""StartRate"":0.5,""Currency"":0,""Step"":0.5,""PaymentType"":0,""AcceptSecondPayType"":false,""StartDate"":""1970-01-01T00:00:00.000Z"",""EndDate"":""1970-01-01T00:00:00.000Z"",""EndDateBoundary"":""1970-01-01T00:00:00.000Z"",""Nds"":0.5,""TimeToProvideDocuments"":0.5,""AutoRenew"":false,""RenewTime"":0,""MaxRenewTime"":0,""RaiseBid"":false,""MaxRate"":0.5,""RaiseBidInterval"":0,""ResponseInMinutes"":0,""Duration"":0,""StartSinceFirstBet"":false,""AuctionRestartParameters"":{""AuctionFinishAction"":0,""InitRestartCount"":0,""InitChangeWinnerCount"":0,""DurationAfterRestart"":0},""AcceptCounterOffersOnlyBeforeFirstBet"":false,""WinnerCriterion"":0}},""Boards"":[{""BoardId"":""string"",""PublicationTime"":""1970-01-01T00:00:00.000Z"",""IsReservationEnabled"":false,""PublicationOption"":0}],""UnloadFirstDate"":""1970-01-01T00:00:00.000Z"",""UnloadLastDate"":""1970-01-01T00:00:00.000Z""}");

Ответ

200 Груз

Модель

{...}

LoadMeta:{...}

Метаданные для интеграторов

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные
Максимальная длина 1024 символа

}

ContactId1*: int32

ContactId2: int32 (nullable)

Note: string

Примечание к грузу
Ограничение по длине: 1000 символов

FirstDate: date-time

LastDate: date-time

DateType: int32

Выбор типа готовности груза к перевозке

0 - Готов к загрузке
1 - с Х по У
2 - постоянно
3 - груза нет, запрос ставки

PeriodicityId: int32

1 - ежедневно
100 - по рабочим дням

OrderNumber: string

Номер заказа
Ограничение по длине: 250 символов

Krugoreis: boolean

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

Loading*:{...}

Загрузка

CityId*: int32

Идентификатор города загрузки/разгрузки
Значение из словаря городов АТИ

Latitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Максимальная длина 100 символов.

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

ExtraPoints:[{...}]

Список дополнительных пунктов маршрута Максимальное количество - 15 штук

CityId*: int32

Идентификатор города
Значение из словаря городов АТИ

PointType*: int32

Тип точки:

1 - загрузка
2 - разгрузка
3 - таможня
8 - проехать через

Latitude: decimal (nullable)

Долгота

Longitude: decimal (nullable)

Широта

Street: string

Улица или район

OrdinalId: int32

Порядковый номер

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки

LoadingTimeStart: time-span (nullable)

Время начала загрузки/разгрузки

LoadingTimeEnd: time-span (nullable)

Время окончания загрузки/разгрузки

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

UnloadingCargos:[{...}]

CargoId: int32

Id груза

Weight: double (nullable)

Вес

Volume: double (nullable)

Объём

PackagingQuantity: int32 (nullable)

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

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

Unloading*:{...}

Разгрузка

CityId*: int32

Идентификатор города загрузки/разгрузки
Значение из словаря городов АТИ

Latitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Максимальная длина 100 символов.

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

Cargo*:{...}

Информация о грузе

Weight: double

Вес груза в тоннах
Обязательный параметр, если не задан параметр Volume.

Volume: double

ADR: int32

Параметр, определяющий степень опасности груза
Допустимое значение от 0 до 9. По умолчанию - 0

CargoTypeId*: int32

Идентификатор наименования груза
Значение из Словаря наименований грузов

CargoType: string

PackType: int32

Идентификатор наименования упаковки (навалом, коробки, россыпью...)
Значение из Словаря наименований грузов

PalletCount: int32

Количество упаковок для груза
Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза
Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

1 - только отдельной машиной
2 - отдельной или догрузом

SborGruz: boolean

Определяет, является ли груз сборным

Size:{...}

Параметры размера груза

Length: double

Длина груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

Transport*:{...}

Параметры транспорта

CarType*: int64

Битовая сумма ID кузовов
Значение из словаря кузовов АТИ

LoadingType: int32

Битовая сумма ID типов загрузки
Значение из словаря вариантов загрузки АТИ

LoadingLogicalOperator: string

Тип условия загрузки:

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

UnloadingType: int32

Битовая сумма ID типов разгрузки.
Значение из словаря вариантов разагрузки АТИ

UnloadingLogicalOperator: string

Тип условия разгрузки:

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

TrucksQuantity: int32

Количество машин
Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

TemperatureTo: int32 (nullable)

Stsepka: boolean

Определяет, нужна ли сцепка для груза

Pnevmohod: boolean

Определяет, нужен ли пневмоход для груза

Koniki: boolean

Определяет, нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

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

IsTracking: boolean

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

}

Payment*:{...}

Оплата

CurrencyId: int32

MoneyType: int32

RateSum: decimal

SumWithNDS: decimal

SumWithoutNDS: decimal

PrepayPercent: int32

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

PayDaysEnabled: boolean

FixedRate: boolean

Torg: boolean

Возможен ли торг
По умолчанию - false. Не учитывается, если параметр FixedRate равен false

DirectContract: boolean

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

InFuel: boolean

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

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

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

AcceptPaymentTypes: int32

Позволяет указать форму оплаты при выборе параметра "Запрос ставки":

1 - наличные
2 - б/нал с НДС
3 - нал и б/нал с НДС
4 - б/нал без НДС
5 - нал и б/нал без НДС
6 - б/нал с НДС и без НДС
7 - нал и б/нал с НДС и без НДС
0 - указана фикс. ставка

}

InviteSettings:{...}

Настройки автоприглашений

InviteDelayInSeconds: int32

InviteDurationInSeconds: int32

Время в секундах действия приглашения

}

PriorityView:{...}

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

DailyLimit: decimal

Суточный лимит списания по услуге

Должен иметь длину не более 5 символов
Не более 2 символов после запятой
Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

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

OrderLimit: decimal

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

Должен иметь длину не более 5 символов
Не более 2 символов после запятой
Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

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

Минимальное значение 0,6
Не более 2 символов после запятой
Должен иметь длину не более 5 символов

MoneySpentPerDay: decimal

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

MoneySpentPerOrder: decimal

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

}

Stealth:{...}

Настройки показа груза

ListIdToHide: guid (nullable)

FirmRegDateToHide: date-time (nullable)

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

ScoreToHide: double (nullable)

}

LoadFiles:[{...}]

Id: guid

Идентификатор файла, возвращается при загрузке файла в АТИ-Доки

FileType: int32

Тип загруженного файла:

1 - документ

Attributes: int32

Битовый набор опции файла

0 - Значение по умолчанию. Данный файл доступен по ссылке
1 - Данный файл доступен только владельцу груза

Name: string

Link: string

Ссылка, по которой можно скачать файл, возвращается при загрузке файла в АТИ-Доки

Size: int32

Размер файла
Информационное поле, на текущий момент не используется

}]

Deal:{...}

Auction:{...}

Параметры аукциона

StartRate*: decimal

Currency*: int32

Валюта аукциона
Значение из словаря валют АТИ

Step*: decimal

PaymentType*: enum

[1, 22, 23, 24, 25]

Тип оплаты

22: любой
1: наличные
23: по карте
24: безнал с НДС
25: безнал без НДС

AcceptSecondPayType: boolean

Принимать ставки без НДС. Параметр можно указать, если начальная ставка указана с НДС (PaymentType=24)

StartDate: date-time

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

AutoRenew: boolean

Нужно ли продление аукциона, если была ставка в последние 5 минут до окончания

RenewTime: int32 (nullable)

Время, на которое надо сдвигать окончание аукциона при включенном AutoRenew

MaxRenewTime: int32 (nullable)

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

RaiseBidInterval: int32 (nullable)

ResponseInMinutes: int32 (nullable)

Указывает, через какой промежуток времени с момента публикации аукциона принимать встречные предложения:

1 - сразу
15, 30, 60, 120, 180 - время в минутах
null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчет до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:{...}

Параметры перезапуска аукциона

AuctionFinishAction: enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны:

1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
2 - Опубликовать с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе
3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно.
Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

DurationAfterRestart: int32 (nullable)

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

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

WinnerCriterion: enum

[0, 1]

Критерий выбора победителя торгов

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.

AuctionId: guid

Id аукциона

LoadId: guid

Id груза, для которого активен аукцион

ActiveDealId: guid (nullable)

Id сделки, привязанной к аукциону

State: 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 установлен State = Winner)

AuctionRates:[{...}]

Список ставок по аукциону

AuctionRateId: guid

ID ставки

AddedAt: date-time

Когда сделана ставка

RateFirm:{...}

Фирма, оставившая заявку

Score: double

"Звезды" фирмы

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

[0, 1, -8, -7, -6, -5, -4, -3, -2, -1]

Статус ставки

1: Победная ставка в аукционе
0: Обычная ставка по аукциону (участник аукциона)
-2: Участник аукциона отменил ставку
-3: Бывший победитель, который не прислал документы
-4: Победитель отказался от участия
-5: Грузовладелец отменил безоговорочную сделку
-6: Победитель отменил безоговорочную сделку
-7: Победитель отклонил документ
-8: Грузовладелец отклонил документ

LoadingDate: date-time (nullable)

Ближайшая возможная для перевозчика дата загрузки
Используется только в аукционах с критерием победы по ставке и дате загрузки

FirmId: int32

Код фирмы, сделавшей ставку

ContactId: int32

Контакт, сделавший ставку

}]

}

Boards:[{...}]

Список площадок

BoardId: string

ID площадки

PublicationTime: date-time (nullable)

Время публикации на площадке
Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

PublicationOption: int32

Параметры публикации груза:

0 - сразу
1 - через 15 минут
2 - через 30 минут
3 - через час
4 - через 3 часа
5 - через 6 часов
6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Показывает является ли площадка Общей

}]

UnloadFirstDate: date-time (nullable)

UnloadLastDate: date-time (nullable)

ArchiveDate: date-time (nullable)

Дата и время переноса в архив

ArchiveReason: enum (nullable)

[Unknown, System, Manual, Complaints, UnwantedContent, DeleteCsvLoad, MergeLoadsAfterEdit, ContactDoesNotHaveAccessToVirtualPayments, VerticesLoadDelete, StealthStatisticError, CheckDuplicateComplaints, DeleteContact, DeleteFirm, CleanOldLoadsJob]

Причина переноса в архив

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

ID валюты озвученной ставки

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Есть ли доступ на удаление груза.

HasPermissionsToLoad: boolean

Есть ли доступ на работу с грузом (без учета прав).

CanBeEdited: boolean

Есть ли доступ на редактирование груза.

CanBeRenewed: boolean

Есть ли доступ на обновление груза.

CanBeRestored: boolean

Есть ли доступ на восстановление груза

EditRestriction: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на редактирование груза:

0 - Вы имеете доступ к работе с грузом
1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
2 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Превышен лимит актуальных грузов
4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
5 - У вашего контакта недостаточно прав для работы с данным грузом
6 - Груз имеет завершенные Торги, операции с грузом запрещены
7 - Сервис сделок временно недоступен
8 - Нельзя изменять или удалять груз из сквозных торгов
9 - У вашего контакта недостаточно прав для создания грузов
10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
15 - Ваш контакт должен быть указан первым в грузе

DeleteRestriction: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на удаление контакта:

0 - Вы имеете доступ к работе с грузом
1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
2 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Превышен лимит актуальных грузов
4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
5 - У вашего контакта недостаточно прав для работы с данным грузом
6 - Груз имеет завершенные Торги, операции с грузом запрещены
7 - Сервис сделок временно недоступен
8 - Нельзя изменять или удалять груз из сквозных торгов
9 - У вашего контакта недостаточно прав для создания грузов
10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
15 - Ваш контакт должен быть указан первым в грузе

RestoreRestriction: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на восстановление груза:

0 - Вы имеете доступ к работе с грузом
1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
2 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Превышен лимит актуальных грузов
4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
5 - У вашего контакта недостаточно прав для работы с данным грузом
6 - Груз имеет завершенные Торги, операции с грузом запрещены
7 - Сервис сделок временно недоступен
8 - Нельзя изменять или удалять груз из сквозных торгов
9 - У вашего контакта недостаточно прав для создания грузов
10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
15 - Ваш контакт должен быть указан первым в грузе

RenewRestriction: string

Причина отказа в доступе на обновление груза.

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

RefreshedAt: date-time

Дата последнего обновления груза в формате UTC (поднятие груза в поисковой выдаче)

UpdatedAt: date-time

Дата последнего изменения груза в формате UTC

AddedAt: date-time

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

Distance: int32

Расстояние по дорогам в км

PlatonRoadsLength: int32

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

TollRoadsLength: int32

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

TravelTime: time-span

Время в пути

Zimnik: boolean

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

Ferries: boolean

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

FirmId: string

Идентификатор фирмы

AuctionId: guid (nullable)

Id аукциона

}

Пример

{...}

"LoadMeta":{...},

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

"MetaData":"string"

"ContactId1":0,

"ContactId2":0,

"Note":"string",

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

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

"DateType":0,

"PeriodicityId":0,

"OrderNumber":"string",

"Krugoreis":false,

"Loading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

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

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

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"ExtraPoints":[...],

{...}

"CityId":0,

"PointType":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

"OrdinalId":0,

"IsRoundTheClock":false,

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

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

"LoadingTimeStart":null,

"LoadingTimeEnd":null,

"LoadingCargos":[...],

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"UnloadingCargos":[...]

{...}

"CargoId":0,

"Weight":0.5,

"Volume":0.5,

"PackagingQuantity":0,

"IsDefinedByTtn":false

}

]

}

"Unloading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

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

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

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"Cargo":{...},

"Weight":0.5,

"Volume":0.5,

"ADR":0,

"CargoTypeId":0,

"CargoType":"string",

"PackType":0,

"PalletCount":0,

"BeltCount":0,

"DogruzType":0,

"SborGruz":false,

"Size":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"Transport":{...},

"CarType":0,

"LoadingType":0,

"LoadingLogicalOperator":"string",

"UnloadingType":0,

"UnloadingLogicalOperator":"string",

"TrucksQuantity":0,

"TemperatureFrom":0,

"TemperatureTo":0,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false

"Payment":{...},

"CurrencyId":0,

"MoneyType":0,

"RateSum":0.5,

"SumWithNDS":0.5,

"SumWithoutNDS":0.5,

"PrepayPercent":0,

"PrepayPercentEnabled":false,

"PayDays":0,

"PayDaysEnabled":false,

"FixedRate":false,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

"InviteSettings":{...},

"InviteDelayInSeconds":0,

"InviteDurationInSeconds":0

"PriorityView":{...},

"DailyLimit":0.5,

"IsForPayedOnly":false,

"OrderLimit":0.5,

"ViewRate":0.5,

"MoneySpentPerDay":0.5,

"MoneySpentPerOrder":0.5

"Stealth":{...},

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

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

"ScoreToHide":0.5

"LoadFiles":[...],

{...}

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

"FileType":0,

"Attributes":0,

"Name":"string",

"Link":"string",

"Size":0

}

"Deal":{...},

"Auction":{...}

"StartRate":0.5,

"Currency":0,

"Step":0.5,

"PaymentType":0,

"AcceptSecondPayType":false,

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

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

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

"Nds":0.5,

"TimeToProvideDocuments":0.5,

"AutoRenew":false,

"RenewTime":0,

"MaxRenewTime":0,

"RaiseBid":false,

"MaxRate":0.5,

"RaiseBidInterval":0,

"ResponseInMinutes":0,

"Duration":0,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":0,

"InitChangeWinnerCount":0,

"DurationAfterRestart":0

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

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

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

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

"State":0,

"Finished":false,

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

"AuctionRates":[...]

{...}

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

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

"RateFirm":{...},

"Score":0.5,

"Status":0,

"Name":"string",

"ContactName":"string",

"AtiId":"string"

"Rate":0.5,

"State":0,

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

"FirmId":0,

"ContactId":0

}

]

}

"Boards":[...],

{...}

"BoardId":"string",

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

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":false,

"IsCommonBoard":false

}

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

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

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

"ArchiveReason":"Unknown",

"TruePrice":0,

"TrueCurrencyId":0,

"ResponseCount":0,

"OfferCount":0,

"CanBeDeleted":false,

"HasPermissionsToLoad":false,

"CanBeEdited":false,

"CanBeRenewed":false,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"string",

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

"LoadNumber":"string",

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

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

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

"Distance":0,

"PlatonRoadsLength":0,

"TollRoadsLength":0,

"TravelTime":"?",

"Zimnik":false,

"Ferries":false,

"FirmId":"string",

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

202 У Вас уже есть груз с такими же параметрами, поэтому два груза объединены в один

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

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

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

Версия

Изменение параметров приоритетного показа у груза. Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

put /v1.0/loads/{loadId}/priority

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

Запрос

Модель

{...}

DailyLimit: decimal

Суточный лимит списания по услуге

Должен иметь длину не более 5 символов
Не более 2 символов после запятой
Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

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

OrderLimit: decimal

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

Должен иметь длину не более 5 символов
Не более 2 символов после запятой
Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate: decimal

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

Минимальное значение 0,6
Не более 2 символов после запятой
Должен иметь длину не более 5 символов

MoneySpentPerDay: decimal

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

MoneySpentPerOrder: decimal

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

}

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

CURL
1C

curl 'https://api.ati.su/v1.0/loads/{loadId}/priority' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"DailyLimit":0.5,"IsForPayedOnly":false,"OrderLimit":0.5,"ViewRate":0.5,"MoneySpentPerDay":0.5,"MoneySpentPerOrder":0.5}'

Процедура Выполнить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"":0.5,""IsForPayedOnly"":false,""OrderLimit"":0.5,""ViewRate"":0.5,""MoneySpentPerDay"":0.5,""MoneySpentPerOrder"":0.5}");

Ответ

200 Актуальное состояние груза

Модель

{...}

LoadMeta:{...}

Метаданные для интеграторов

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные
Максимальная длина 1024 символа

}

ContactId1*: int32

ContactId2: int32 (nullable)

Note: string

Примечание к грузу
Ограничение по длине: 1000 символов

FirstDate: date-time

LastDate: date-time

DateType: int32

Выбор типа готовности груза к перевозке

0 - Готов к загрузке
1 - с Х по У
2 - постоянно
3 - груза нет, запрос ставки

PeriodicityId: int32

1 - ежедневно
100 - по рабочим дням

OrderNumber: string

Номер заказа
Ограничение по длине: 250 символов

Krugoreis: boolean

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

Loading*:{...}

Загрузка

CityId*: int32

Идентификатор города загрузки/разгрузки
Значение из словаря городов АТИ

Latitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Максимальная длина 100 символов.

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

ExtraPoints:[{...}]

Список дополнительных пунктов маршрута Максимальное количество - 15 штук

CityId*: int32

Идентификатор города
Значение из словаря городов АТИ

PointType*: int32

Тип точки:

1 - загрузка
2 - разгрузка
3 - таможня
8 - проехать через

Latitude: decimal (nullable)

Долгота

Longitude: decimal (nullable)

Широта

Street: string

Улица или район

OrdinalId: int32

Порядковый номер

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки

LoadingTimeStart: time-span (nullable)

Время начала загрузки/разгрузки

LoadingTimeEnd: time-span (nullable)

Время окончания загрузки/разгрузки

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

UnloadingCargos:[{...}]

CargoId: int32

Id груза

Weight: double (nullable)

Вес

Volume: double (nullable)

Объём

PackagingQuantity: int32 (nullable)

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

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

Unloading*:{...}

Разгрузка

CityId*: int32

Идентификатор города загрузки/разгрузки
Значение из словаря городов АТИ

Latitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Максимальная длина 100 символов.

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

Cargo*:{...}

Информация о грузе

Weight: double

Вес груза в тоннах
Обязательный параметр, если не задан параметр Volume.

Volume: double

ADR: int32

Параметр, определяющий степень опасности груза
Допустимое значение от 0 до 9. По умолчанию - 0

CargoTypeId*: int32

Идентификатор наименования груза
Значение из Словаря наименований грузов

CargoType: string

PackType: int32

Идентификатор наименования упаковки (навалом, коробки, россыпью...)
Значение из Словаря наименований грузов

PalletCount: int32

Количество упаковок для груза
Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза
Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

1 - только отдельной машиной
2 - отдельной или догрузом

SborGruz: boolean

Определяет, является ли груз сборным

Size:{...}

Параметры размера груза

Length: double

Длина груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

Transport*:{...}

Параметры транспорта

CarType*: int64

Битовая сумма ID кузовов
Значение из словаря кузовов АТИ

LoadingType: int32

Битовая сумма ID типов загрузки
Значение из словаря вариантов загрузки АТИ

LoadingLogicalOperator: string

Тип условия загрузки:

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

UnloadingType: int32

Битовая сумма ID типов разгрузки.
Значение из словаря вариантов разагрузки АТИ

UnloadingLogicalOperator: string

Тип условия разгрузки:

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

TrucksQuantity: int32

Количество машин
Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

TemperatureTo: int32 (nullable)

Stsepka: boolean

Определяет, нужна ли сцепка для груза

Pnevmohod: boolean

Определяет, нужен ли пневмоход для груза

Koniki: boolean

Определяет, нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

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

IsTracking: boolean

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

}

Payment*:{...}

Оплата

CurrencyId: int32

MoneyType: int32

RateSum: decimal

SumWithNDS: decimal

SumWithoutNDS: decimal

PrepayPercent: int32

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

PayDaysEnabled: boolean

FixedRate: boolean

Torg: boolean

Возможен ли торг
По умолчанию - false. Не учитывается, если параметр FixedRate равен false

DirectContract: boolean

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

InFuel: boolean

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

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

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

AcceptPaymentTypes: int32

Позволяет указать форму оплаты при выборе параметра "Запрос ставки":

1 - наличные
2 - б/нал с НДС
3 - нал и б/нал с НДС
4 - б/нал без НДС
5 - нал и б/нал без НДС
6 - б/нал с НДС и без НДС
7 - нал и б/нал с НДС и без НДС
0 - указана фикс. ставка

}

InviteSettings:{...}

Настройки автоприглашений

InviteDelayInSeconds: int32

InviteDurationInSeconds: int32

Время в секундах действия приглашения

}

PriorityView:{...}

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

DailyLimit: decimal

Суточный лимит списания по услуге

Должен иметь длину не более 5 символов
Не более 2 символов после запятой
Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

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

OrderLimit: decimal

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

Должен иметь длину не более 5 символов
Не более 2 символов после запятой
Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

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

Минимальное значение 0,6
Не более 2 символов после запятой
Должен иметь длину не более 5 символов

MoneySpentPerDay: decimal

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

MoneySpentPerOrder: decimal

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

}

Stealth:{...}

Настройки показа груза

ListIdToHide: guid (nullable)

FirmRegDateToHide: date-time (nullable)

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

ScoreToHide: double (nullable)

}

LoadFiles:[{...}]

Id: guid

Идентификатор файла, возвращается при загрузке файла в АТИ-Доки

FileType: int32

Тип загруженного файла:

1 - документ

Attributes: int32

Битовый набор опции файла

0 - Значение по умолчанию. Данный файл доступен по ссылке
1 - Данный файл доступен только владельцу груза

Name: string

Link: string

Ссылка, по которой можно скачать файл, возвращается при загрузке файла в АТИ-Доки

Size: int32

Размер файла
Информационное поле, на текущий момент не используется

}]

Deal:{...}

Auction:{...}

Параметры аукциона

StartRate*: decimal

Currency*: int32

Валюта аукциона
Значение из словаря валют АТИ

Step*: decimal

PaymentType*: enum

[1, 22, 23, 24, 25]

Тип оплаты

22: любой
1: наличные
23: по карте
24: безнал с НДС
25: безнал без НДС

AcceptSecondPayType: boolean

Принимать ставки без НДС. Параметр можно указать, если начальная ставка указана с НДС (PaymentType=24)

StartDate: date-time

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

AutoRenew: boolean

Нужно ли продление аукциона, если была ставка в последние 5 минут до окончания

RenewTime: int32 (nullable)

Время, на которое надо сдвигать окончание аукциона при включенном AutoRenew

MaxRenewTime: int32 (nullable)

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

RaiseBidInterval: int32 (nullable)

ResponseInMinutes: int32 (nullable)

Указывает, через какой промежуток времени с момента публикации аукциона принимать встречные предложения:

1 - сразу
15, 30, 60, 120, 180 - время в минутах
null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчет до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:{...}

Параметры перезапуска аукциона

AuctionFinishAction: enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны:

1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
2 - Опубликовать с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе
3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно.
Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

DurationAfterRestart: int32 (nullable)

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

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

WinnerCriterion: enum

[0, 1]

Критерий выбора победителя торгов

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.

AuctionId: guid

Id аукциона

LoadId: guid

Id груза, для которого активен аукцион

ActiveDealId: guid (nullable)

Id сделки, привязанной к аукциону

State: 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 установлен State = Winner)

AuctionRates:[{...}]

Список ставок по аукциону

AuctionRateId: guid

ID ставки

AddedAt: date-time

Когда сделана ставка

RateFirm:{...}

Фирма, оставившая заявку

Score: double

"Звезды" фирмы

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

[0, 1, -8, -7, -6, -5, -4, -3, -2, -1]

Статус ставки

1: Победная ставка в аукционе
0: Обычная ставка по аукциону (участник аукциона)
-2: Участник аукциона отменил ставку
-3: Бывший победитель, который не прислал документы
-4: Победитель отказался от участия
-5: Грузовладелец отменил безоговорочную сделку
-6: Победитель отменил безоговорочную сделку
-7: Победитель отклонил документ
-8: Грузовладелец отклонил документ

LoadingDate: date-time (nullable)

FirmId: int32

Код фирмы, сделавшей ставку

ContactId: int32

Контакт, сделавший ставку

}]

}

Boards:[{...}]

Список площадок

BoardId: string

ID площадки

PublicationTime: date-time (nullable)

Время публикации на площадке
Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

PublicationOption: int32

Параметры публикации груза:

0 - сразу
1 - через 15 минут
2 - через 30 минут
3 - через час
4 - через 3 часа
5 - через 6 часов
6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Показывает является ли площадка Общей

}]

UnloadFirstDate: date-time (nullable)

UnloadLastDate: date-time (nullable)

ArchiveDate: date-time (nullable)

Дата и время переноса в архив

ArchiveReason: enum (nullable)

Причина переноса в архив

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

ID валюты озвученной ставки

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Есть ли доступ на удаление груза.

HasPermissionsToLoad: boolean

Есть ли доступ на работу с грузом (без учета прав).

CanBeEdited: boolean

Есть ли доступ на редактирование груза.

CanBeRenewed: boolean

Есть ли доступ на обновление груза.

CanBeRestored: boolean

Есть ли доступ на восстановление груза

EditRestriction: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на редактирование груза:

0 - Вы имеете доступ к работе с грузом
1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
2 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Превышен лимит актуальных грузов
4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
5 - У вашего контакта недостаточно прав для работы с данным грузом
6 - Груз имеет завершенные Торги, операции с грузом запрещены
7 - Сервис сделок временно недоступен
8 - Нельзя изменять или удалять груз из сквозных торгов
9 - У вашего контакта недостаточно прав для создания грузов
10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
15 - Ваш контакт должен быть указан первым в грузе

DeleteRestriction: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на удаление контакта:

0 - Вы имеете доступ к работе с грузом
1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
2 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Превышен лимит актуальных грузов
4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
5 - У вашего контакта недостаточно прав для работы с данным грузом
6 - Груз имеет завершенные Торги, операции с грузом запрещены
7 - Сервис сделок временно недоступен
8 - Нельзя изменять или удалять груз из сквозных торгов
9 - У вашего контакта недостаточно прав для создания грузов
10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
15 - Ваш контакт должен быть указан первым в грузе

RestoreRestriction: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на восстановление груза:

0 - Вы имеете доступ к работе с грузом
1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
2 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Превышен лимит актуальных грузов
4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
5 - У вашего контакта недостаточно прав для работы с данным грузом
6 - Груз имеет завершенные Торги, операции с грузом запрещены
7 - Сервис сделок временно недоступен
8 - Нельзя изменять или удалять груз из сквозных торгов
9 - У вашего контакта недостаточно прав для создания грузов
10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
15 - Ваш контакт должен быть указан первым в грузе

RenewRestriction: string

Причина отказа в доступе на обновление груза.

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

RefreshedAt: date-time

Дата последнего обновления груза в формате UTC (поднятие груза в поисковой выдаче)

UpdatedAt: date-time

Дата последнего изменения груза в формате UTC

AddedAt: date-time

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

Distance: int32

Расстояние по дорогам в км

PlatonRoadsLength: int32

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

TollRoadsLength: int32

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

TravelTime: time-span

Время в пути

Zimnik: boolean

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

Ferries: boolean

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

FirmId: string

Идентификатор фирмы

AuctionId: guid (nullable)

Id аукциона

}

Пример

{...}

"LoadMeta":{...},

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

"MetaData":"string"

"ContactId1":0,

"ContactId2":0,

"Note":"string",

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

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

"DateType":0,

"PeriodicityId":0,

"OrderNumber":"string",

"Krugoreis":false,

"Loading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

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

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

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"ExtraPoints":[...],

{...}

"CityId":0,

"PointType":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

"OrdinalId":0,

"IsRoundTheClock":false,

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

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

"LoadingTimeStart":null,

"LoadingTimeEnd":null,

"LoadingCargos":[...],

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"UnloadingCargos":[...]

{...}

"CargoId":0,

"Weight":0.5,

"Volume":0.5,

"PackagingQuantity":0,

"IsDefinedByTtn":false

}

]

}

"Unloading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

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

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

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"Cargo":{...},

"Weight":0.5,

"Volume":0.5,

"ADR":0,

"CargoTypeId":0,

"CargoType":"string",

"PackType":0,

"PalletCount":0,

"BeltCount":0,

"DogruzType":0,

"SborGruz":false,

"Size":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"Transport":{...},

"CarType":0,

"LoadingType":0,

"LoadingLogicalOperator":"string",

"UnloadingType":0,

"UnloadingLogicalOperator":"string",

"TrucksQuantity":0,

"TemperatureFrom":0,

"TemperatureTo":0,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false

"Payment":{...},

"CurrencyId":0,

"MoneyType":0,

"RateSum":0.5,

"SumWithNDS":0.5,

"SumWithoutNDS":0.5,

"PrepayPercent":0,

"PrepayPercentEnabled":false,

"PayDays":0,

"PayDaysEnabled":false,

"FixedRate":false,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

"InviteSettings":{...},

"InviteDelayInSeconds":0,

"InviteDurationInSeconds":0

"PriorityView":{...},

"DailyLimit":0.5,

"IsForPayedOnly":false,

"OrderLimit":0.5,

"ViewRate":0.5,

"MoneySpentPerDay":0.5,

"MoneySpentPerOrder":0.5

"Stealth":{...},

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

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

"ScoreToHide":0.5

"LoadFiles":[...],

{...}

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

"FileType":0,

"Attributes":0,

"Name":"string",

"Link":"string",

"Size":0

}

"Deal":{...},

"Auction":{...}

"StartRate":0.5,

"Currency":0,

"Step":0.5,

"PaymentType":0,

"AcceptSecondPayType":false,

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

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

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

"Nds":0.5,

"TimeToProvideDocuments":0.5,

"AutoRenew":false,

"RenewTime":0,

"MaxRenewTime":0,

"RaiseBid":false,

"MaxRate":0.5,

"RaiseBidInterval":0,

"ResponseInMinutes":0,

"Duration":0,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":0,

"InitChangeWinnerCount":0,

"DurationAfterRestart":0

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

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

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

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

"State":0,

"Finished":false,

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

"AuctionRates":[...]

{...}

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

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

"RateFirm":{...},

"Score":0.5,

"Status":0,

"Name":"string",

"ContactName":"string",

"AtiId":"string"

"Rate":0.5,

"State":0,

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

"FirmId":0,

"ContactId":0

}

]

}

"Boards":[...],

{...}

"BoardId":"string",

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

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":false,

"IsCommonBoard":false

}

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

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

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

"ArchiveReason":"Unknown",

"TruePrice":0,

"TrueCurrencyId":0,

"ResponseCount":0,

"OfferCount":0,

"CanBeDeleted":false,

"HasPermissionsToLoad":false,

"CanBeEdited":false,

"CanBeRenewed":false,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"string",

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

"LoadNumber":"string",

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

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

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

"Distance":0,

"PlatonRoadsLength":0,

"TollRoadsLength":0,

"TravelTime":"?",

"Zimnik":false,

"Ferries":false,

"FirmId":"string",

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

put /gw/cargos-priority-view-api/v2/cargos/{cargoApplicationId}/priority-view

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

Запрос

Модель

{...}

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 Площадок.

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

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

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

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