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

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

Важно

Методы версии v1.0 больше не поддерживаются и скоро будут полностью удалены. Рекомендуем как можно быстрее перейти на актуальную версию API, чтобы избежать сбоев в работе интеграции.

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

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

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

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

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

Версия 2 1.0

post /v2/cargos

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

Запрос

Модель

{...}

cargo_application*:{...}

Заявка груза

external_id: string

Максимальное количество символов 250

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

route*:{...}

Маршрут

loading*:{...}

Загрузка

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

near_cities: [int32]

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

dates*:{...}

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

type*: string

Тип даты

• ready — готов к загрузке
• from-date — с даты
• permanent — постоянно
• rate-request — груза нет, запрос ставки

readyfrom-datepermanentrate-request

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

is_available_tomorrow: boolean (nullable)

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

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

first_date: yyyy-MM-dd (nullable)

Дата начала

last_date: yyyy-MM-dd (nullable)

Дата конца

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

periodicity*: string

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

• everyday — каждый день
• workdays — по рабочим дням

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

}

cargos*:[{...}]

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

id*: int32 (nullable)

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

name*: string

Максимальное количество символов 200

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

weight*:{...}

Вес

type: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double (nullable)

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

}

volume*:{...}

Объём

quantity*: double (nullable)

Количество

}

packaging:{...}

Упаковка

type*: int32 (nullable)

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

quantity: int32 (nullable)

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

height:{...}

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

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

width:{...}

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

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

diameter: double (nullable)

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

}

}]

}

unloading*:{...}

Разгрузка

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

near_cities: [int32]

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

dates:{...}

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

first_date: date-time (nullable)

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

last_date: date-time (nullable)

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

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

}

}

way_points:[{...}]

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

type*: string

loadingunloadingcustomsgo-through

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

cargos:[{...}]

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

id*: int32 (nullable)

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

name*: string

Максимальное количество символов 200

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

weight*:{...}

Вес

type: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double (nullable)

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

}

volume*:{...}

Объём

quantity*: double (nullable)

Количество

}

packaging:{...}

Упаковка

type*: int32 (nullable)

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

quantity: int32 (nullable)

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

height:{...}

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

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

width:{...}

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

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

diameter: double (nullable)

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

}

}]

loading_date:{...}

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

first_date: yyyy-MM-dd (nullable)

Дата начала

last_date: yyyy-MM-dd (nullable)

Дата конца

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

}

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

cargos:[{...}]

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

id*: int32 (nullable)

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

weight:{...}

Выгружаемая часть веса

type: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double (nullable)

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

}

volume:{...}

Выгружаемая часть объёма

quantity*: double (nullable)

Количество

}

packaging_quantity: int32 (nullable)

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

is_defined_by_ttn: boolean (nullable)

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

}]

unloading_date:{...}

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

first_date: yyyy-MM-dd (nullable)

Дата начала

last_date: yyyy-MM-dd (nullable)

Дата конца

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

}

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

}]

is_round_trip: boolean (nullable)

Кругорейс

deprecated

}

truck*:{...}

Транспорт

trucks_count: int32 (nullable)

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

load_type*: string

Загрузка:

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

body_types*: [int32]

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

body_loading:{...}

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

types: [int32]

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

is_all_required: boolean (nullable)

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

}

body_unloading:{...}

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

types: [int32]

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

is_all_required: boolean (nullable)

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

}

temperature:{...}

Температура

from: int32 (nullable)

От

to: int32 (nullable)

До

}

documents:{...}

Разрешения

tir: boolean (nullable)

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

cmr: boolean (nullable)

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

t1: boolean (nullable)

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

medical_card: boolean (nullable)

Медкнижка

}

requirements:{...}

Требования

logging_truck: boolean (nullable)

Коники

road_train: boolean (nullable)

Сцепка

air_suspension: boolean (nullable)

Пневмоход

team_driving: boolean (nullable)

Экипаж - требуется 2 водителя

}

adr: int32 (nullable)

ADR

belts_count: int32 (nullable)

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

is_tracking: boolean (nullable)

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

required_capacity: double (nullable)

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

}

payment*:{...}

Оплата

type*: string

Тип оплаты.

• with-bargaining — возможен торг
• without-bargaining — без торга
• rate-request — запрос ставки
• auction — торги

with-bargainingwithout-bargainingrate-requestauction

hide_counter_offers: boolean (nullable)

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

direct_offer: boolean (nullable)

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel: boolean (nullable)

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• on-unloading — оплата на выгрузке
• delayed-payment — оплата через N банковских дней

on-unloadingdelayed-payment

payment_delay_days: int32 (nullable)

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

}

currency_type: int32 (nullable)

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

rate_with_vat: double (nullable)

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

rate_without_vat: double (nullable)

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

cash: double (nullable)

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

on_card: boolean (nullable)

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

auto_invites_settings:{...}

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

invite_delay: string

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

invite_duration: string

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

max_percent_deviation: int32 (nullable)

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

need_archive_on_invite: boolean

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

}

hide_counter_offers: boolean (nullable)

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

direct_offer: boolean (nullable)

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel: boolean (nullable)

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• on-unloading — оплата на выгрузке
• delayed-payment — оплата через N банковских дней

on-unloadingdelayed-payment

payment_delay_days: int32 (nullable)

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

}

currency_type: int32 (nullable)

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

rate_with_vat: double (nullable)

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

rate_without_vat: double (nullable)

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

cash: double (nullable)

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

on_card: boolean (nullable)

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

hide_counter_offers: boolean (nullable)

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

direct_offer: boolean (nullable)

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel: boolean (nullable)

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• on-unloading — оплата на выгрузке
• delayed-payment — оплата через N банковских дней

on-unloadingdelayed-payment

payment_delay_days: int32 (nullable)

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

}

rate_with_vat_available: boolean (nullable)

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

rate_without_vat_available: boolean (nullable)

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

cash_available: boolean (nullable)

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

auto_invites_settings:{...}

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

invite_delay: string

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

invite_duration: string

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

max_percent_deviation: int32 (nullable)

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

need_archive_on_invite: boolean

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

}

hide_counter_offers: boolean (nullable)

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

direct_offer: boolean (nullable)

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel: boolean (nullable)

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• on-unloading — оплата на выгрузке
• delayed-payment — оплата через N банковских дней

on-unloadingdelayed-payment

payment_delay_days: int32 (nullable)

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

}

accept_bids_with_vat*: boolean (nullable)

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

accept_bids_without_vat: boolean (nullable)

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

vat_percents: int32 (nullable)

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

start_rate*: double (nullable)

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

auction_currency_type*: int32 (nullable)

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

bid_step*: double (nullable)

Шаг ставок

auction_duration*:{...}

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

fixed_duration: 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: boolean (nullable)

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

finish_until: date-time (nullable)

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

}

accept_counter_offers:{...}

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

acceptance_delay: string

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

• 30m — 30 минут
• 1h — 1 час
• 2h — 2 часа
• 3h — 3 часа
• 4h — 4 часа
• 6h — 6 часов
• 12h — 12 часов

until_first_bid: boolean (nullable)

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

}

auto_renew:{...}

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

step*: int32 (nullable)

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

limit*: int32 (nullable)

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

}

is_antisniper: boolean (nullable)

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

rate_rise:{...}

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

periodicity*: int32 (nullable)

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

rate_limit*: double (nullable)

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

}

winner_criteria*: string

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

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

time_to_provide_documents*: HH:mm (nullable)

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

winner_reselection_count: int32 (nullable)

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

auction_restart:{...}

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

count*: int32 (nullable)

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

new_duration*: string

Длительность Торгов после перезапуска:

• 30m — 30 минут
• 1h — 1 час
• 2h — 2 часа
• 3h — 3 часа
• 4h — 4 часа
• 6h — 6 часов
• 12h — 12 часов

rate_increase:{...}

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

type*: string

Тип повышения ставки после перезапуска.

• currency — в валюте ставки, абсолютное значение
• percent — процент от начальной ставки

currencypercent

amount*: double (nullable)

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

amount*: double (nullable)

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

}

}

no_winner_end_options*:{...}

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

type*: string

Действие

• archive — переместить заявку в архив
• publish-with-rate — опубликовать заявку со ставкой
• publish-rate-request — опубликовать заявку с запросом ставки

archivepublish-with-ratepublish-rate-request

currency_type: int32 (nullable)

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

rate_with_vat: double (nullable)

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

rate_without_vat: double (nullable)

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

cash: double (nullable)

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

on_card: boolean (nullable)

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

auto_invites_settings:{...}

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

invite_delay: string

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

invite_duration: string

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

max_percent_deviation: int32 (nullable)

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

need_archive_on_invite: boolean

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

}

rate_with_vat_available: boolean (nullable)

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

rate_without_vat_available: boolean (nullable)

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

cash_available: boolean (nullable)

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

auto_invites_settings:{...}

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

invite_delay: string

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

invite_duration: string

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

max_percent_deviation: int32 (nullable)

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

need_archive_on_invite: boolean

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

}

}

keep_rates: boolean (nullable)

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

}

documents:[{...}]

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

id: string

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

deprecated

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 (nullable)

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

cancel_publish_on_auction_bet: boolean (nullable)

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

reservation_enabled: boolean (nullable)

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

}]

paid_features:{...}

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

priority_view:{...}

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

rate*: double (nullable)

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

limit: double (nullable)

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

daily_limit: double (nullable)

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

only_for_paid_users: boolean (nullable)

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

}

stealth:{...}

Стэлс

list_id: uuid (nullable)

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

minimal_registration_date: date-time (nullable)

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

minimal_stars_count: int32 (nullable)

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

}

}

note: string

Максимальное количество символов 1000

Примечание к заявке

contacts*: [int32]

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

}

}

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

CURL

curl 'https://api.ati.su/v2/cargos' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"cargo_application":{"external_id":"string","route":{"loading":{"location":{"type":"string"}},"unloading":{"location":{"type":"string"}},"way_points":[{"location":{"type":"string"}}]},"truck":{"trucks_count":0,"load_type":"string","body_types":[0],"body_loading":{"types":[0],"is_all_required":false},"body_unloading":{"types":[0],"is_all_required":false},"temperature":{"from":0,"to":0},"documents":{"tir":false,"cmr":false,"t1":false,"medical_card":false},"requirements":{"logging_truck":false,"road_train":false,"air_suspension":false,"team_driving":false},"adr":0,"belts_count":0,"is_tracking":false,"required_capacity":0.5},"payment":{"type":"string","hide_counter_offers":false,"direct_offer":false,"prepayment":{"percent":0,"using_fuel":false},"payment_mode":{"type":"string"}},"documents":[{"file_id":"string"}],"boards":[{"id":"string","publication_mode":"string","publication_time":"1970-01-01T00:00:00.000Z","cancel_publish_on_auction_bet":false,"reservation_enabled":false}],"paid_features":{"priority_view":{"rate":0.5,"limit":0.5,"daily_limit":0.5,"only_for_paid_users":false},"stealth":{"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","minimal_registration_date":"1970-01-01T00:00:00.000Z","minimal_stars_count":0}},"note":"string","contacts":[0]}}'

1C

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

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

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

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v2/cargos", "{""cargo_application"":{""external_id"":""string"",""route"":{""loading"":{""location"":{""type"":""string""}},""unloading"":{""location"":{""type"":""string""}},""way_points"":[{""location"":{""type"":""string""}}]},""truck"":{""trucks_count"":0,""load_type"":""string"",""body_types"":[0],""body_loading"":{""types"":[0],""is_all_required"":false},""body_unloading"":{""types"":[0],""is_all_required"":false},""temperature"":{""from"":0,""to"":0},""documents"":{""tir"":false,""cmr"":false,""t1"":false,""medical_card"":false},""requirements"":{""logging_truck"":false,""road_train"":false,""air_suspension"":false,""team_driving"":false},""adr"":0,""belts_count"":0,""is_tracking"":false,""required_capacity"":0.5},""payment"":{""type"":""string"",""hide_counter_offers"":false,""direct_offer"":false,""prepayment"":{""percent"":0,""using_fuel"":false},""payment_mode"":{""type"":""string""}},""documents"":[{""file_id"":""string""}],""boards"":[{""id"":""string"",""publication_mode"":""string"",""publication_time"":""1970-01-01T00:00:00.000Z"",""cancel_publish_on_auction_bet"":false,""reservation_enabled"":false}],""paid_features"":{""priority_view"":{""rate"":0.5,""limit"":0.5,""daily_limit"":0.5,""only_for_paid_users"":false},""stealth"":{""list_id"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""minimal_registration_date"":""1970-01-01T00:00:00.000Z"",""minimal_stars_count"":0}},""note"":""string"",""contacts"":[0]}}");

Ответ

200 Success

Модель

{...}

cargo_application:{...}

Заявка груза

cargo_id: uuid

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

deprecated

cargo_number: string

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

deprecated

source: int32

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

deprecated

contacts: [int32]

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

distance: int32

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

deprecated

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 (nullable)

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

external_id: string (nullable)

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

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,
• internal-cargos-api,
• public-cargos-api,
• internal-atrucks,
• internal-torgtrans,
• csv_import,
• pass-through,
• unknown

route*:{...}

Маршрут

loading*:{...}

Загрузка

city_id*: int32

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

deprecated

city*:{...}

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

city_id*: int32

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

region_id: int32 (nullable)

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

country_id: int32 (nullable)

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

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

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

organization:{...}

Данные об организации из справочника

organization_id*: uuid

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

address_id*: uuid

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

}

near_cities: [int32]

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

dates*:{...}

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

type*: string

Тип даты:

• from-date — в промежутке дат first_date и last_date
• ready — готов
• permanent — постоянно
• rate-request — груза нет, запрос ставки

from-datereadypermanentrate-request

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

time:{...}

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

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

is_available_tomorrow*: boolean

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

time:{...}

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

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

periodicity*: string

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

• everyday — "каждый день"
• workdays — "по рабочим дням"

time:{...}

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

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

}

cargos*:[{...}]

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

cargo_id*: int32

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

weight:{...}

Вес

type*: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double

Количество

}

volume:{...}

Объём

quantity*: double

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double

Значение

is_highlighted*: boolean

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

}

height:{...}

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

value*: double

Значение

is_highlighted*: boolean

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

}

width:{...}

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

value*: double

Значение

is_highlighted*: boolean

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

}

diameter: double (nullable)

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

}

name*: string

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

packaging:{...}

Упаковка

type*: int32

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

quantity: int32 (nullable)

Количество

}

}]

nearby_cities:[{...}]

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

id*: int32

distance: double (nullable)

}]

}

unloading*:{...}

Разгрузка

city_id*: int32

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

deprecated

city*:{...}

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

city_id*: int32

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

region_id: int32 (nullable)

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

country_id: int32 (nullable)

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

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

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

organization:{...}

Данные об организации из справочника

organization_id*: uuid

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

address_id*: uuid

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

}

near_cities: [int32]

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

dates:{...}

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

first_date: date-time (nullable)

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

last_date: date-time (nullable)

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

time:{...}

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

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

}

nearby_cities:[{...}]

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

id*: int32

distance: double (nullable)

}]

}

way_points:[{...}]

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

type*: string

Тип промежуточной точки:

• loading - точка загрузки
• unloading - точка разгрузки
• customs - таможня
• go-through - точка "ехать через"

loadingunloadingcustomsgo-through

city_id*: int32

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

deprecated

city*:{...}

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

city_id*: int32

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

region_id: int32 (nullable)

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

country_id: int32 (nullable)

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

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

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

organization:{...}

Данные об организации из справочника

organization_id*: uuid

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

address_id*: uuid

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

}

cargos:[{...}]

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

cargo_id*: int32

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

weight:{...}

Вес

type*: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double

Количество

}

volume:{...}

Объём

quantity*: double

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double

Значение

is_highlighted*: boolean

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

}

height:{...}

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

value*: double

Значение

is_highlighted*: boolean

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

}

width:{...}

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

value*: double

Значение

is_highlighted*: boolean

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

}

diameter: double (nullable)

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

}

name*: string

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

packaging:{...}

Упаковка

type*: int32

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

quantity: int32 (nullable)

Количество

}

}]

loading_date:{...}

Даты и время загрузки

first_date: date-time (nullable)

Дата начала

last_date: date-time (nullable)

Дата конца

time:{...}

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

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

}

city_id*: int32

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

deprecated

city*:{...}

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

city_id*: int32

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

region_id: int32 (nullable)

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

country_id: int32 (nullable)

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

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

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

organization:{...}

Данные об организации из справочника

organization_id*: uuid

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

address_id*: uuid

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

}

cargos:[{...}]

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

cargo_id*: int32

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

weight:{...}

Вес

type*: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double

Количество

}

volume:{...}

Объём

quantity*: double

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double

Значение

is_highlighted*: boolean

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

}

height:{...}

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

value*: double

Значение

is_highlighted*: boolean

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

}

width:{...}

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

value*: double

Значение

is_highlighted*: boolean

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

}

diameter: double (nullable)

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

}

packaging_quantity: int32 (nullable)

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

is_defined_by_ttn: boolean (nullable)

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

}]

unloading_date:{...}

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

first_date: date-time (nullable)

Дата начала

last_date: date-time (nullable)

Дата конца

time:{...}

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

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

}

city_id*: int32

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

deprecated

city*:{...}

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

city_id*: int32

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

region_id: int32 (nullable)

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

country_id: int32 (nullable)

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

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

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

organization:{...}

Данные об организации из справочника

organization_id*: uuid

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

address_id*: uuid

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

}

city_id*: int32

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

deprecated

city*:{...}

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

city_id*: int32

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

region_id: int32 (nullable)

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

country_id: int32 (nullable)

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

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

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

organization:{...}

Данные об организации из справочника

organization_id*: uuid

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

address_id*: uuid

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

}

}]

is_round_trip: boolean (nullable)

Кругорейс

}

truck*:{...}

Транспорт

trucks_count*: int32

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

load_type*: string

Загрузка:

• ftl — отдельной машиной
• dont-care — не важно

body_types*: [int32]

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

is_tracking*: boolean

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

adr: int32 (nullable)

ADR

belts_count: int32 (nullable)

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

required_capacity: double (nullable)

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

body_loading:{...}

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

types*: [int32]

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

is_all_required*: boolean

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

}

body_unloading:{...}

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

types*: [int32]

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

is_all_required*: boolean

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

}

temperature:{...}

Температура

from: int32 (nullable)

От

to: int32 (nullable)

До

}

documents:{...}

Разрешения

tir*: boolean

TIR

cmr*: boolean

CMR

t1*: boolean

T1

medical_card*: boolean

Медкнижка

}

requirements:{...}

Требования

logging_truck*: boolean

Коники

road_train*: boolean

Сцепка

air_suspension*: boolean

Пневмоход

team_driving*: boolean

Экипаж - требуется 2 водителя

}

}

payment*:{...}

Оплата

type*: string

Тип оплаты:

• with-bargaining - ставка с возможностью торга
• without-bargaining - ставка без возможности торга
• rate-request - запрос ставки
• auction - у заявки проводятся Торги

with-bargainingwithout-bargainingrate-requestauction

hide_counter_offers*: boolean

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

direct_offer*: boolean

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel*: boolean

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

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

}

currency_type*: int32

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

rate_with_vat: double (nullable)

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

rate_without_vat: double (nullable)

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

cash: double (nullable)

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

on_card: boolean (nullable)

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

auto_invites_settings:{...}

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

invite_delay*: string

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

invite_duration*: string

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

need_archive_on_invite*: boolean

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

max_percent_deviation: int32 (nullable)

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

}

hide_counter_offers*: boolean

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

direct_offer*: boolean

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel*: boolean

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

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

}

currency_type*: int32

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

rate_with_vat: double (nullable)

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

rate_without_vat: double (nullable)

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

cash: double (nullable)

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

on_card: boolean (nullable)

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

hide_counter_offers*: boolean

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

direct_offer*: boolean

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel*: boolean

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

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

}

rate_with_vat_available*: boolean

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

rate_without_vat_available*: boolean

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

cash_available*: boolean

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

auto_invites_settings:{...}

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

invite_delay*: string

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

invite_duration*: string

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

need_archive_on_invite*: boolean

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

max_percent_deviation: int32 (nullable)

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

}

hide_counter_offers*: boolean

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

direct_offer*: boolean

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel*: boolean

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

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

}

auction_id*: uuid

Id Торгов

start_rate*: double

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

auction_currency_type*: int32

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

bid_step*: double

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

accept_bids_with_vat*: boolean

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

accept_bids_without_vat: boolean (nullable)

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

vat_percents: int32 (nullable)

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

is_antisniper*: boolean

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

time_to_provide_documents*: HH:mm

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

winner_criteria*: string

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

winner_reselection_count: int32 (nullable)

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

auction_duration*:{...}

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

fixed_duration: string (nullable)

Может быть 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 (nullable)

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

}

no_winner_end_options*:{...}

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

type*: string

Действие: archive — переместить заявку в архив publish-with-rate — опубликовать заявку со ставкой publish-rate-request — опубликовать заявку с запросом ставки

archivepublish-with-ratepublish-rate-request

currency_type*: int32

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

rate_with_vat: double (nullable)

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

rate_without_vat: double (nullable)

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

cash: double (nullable)

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

on_card: boolean (nullable)

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

auto_invites_settings:{...}

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

invite_delay*: string

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

invite_duration*: string

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

need_archive_on_invite*: boolean

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

max_percent_deviation: int32 (nullable)

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

}

rate_with_vat_available*: boolean

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

rate_without_vat_available*: boolean

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

cash_available*: boolean

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

auto_invites_settings:{...}

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

invite_delay*: string

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

invite_duration*: string

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

need_archive_on_invite*: boolean

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

max_percent_deviation: int32 (nullable)

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

}

}

accept_counter_offers:{...}

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

acceptance_delay: string (nullable)

Может быть null, в таком случае будем принимать встречные предложения сразу. Принимать встречные предложения через:

• 30m — 30 минут
• 1h — 1 час
• 2h — 2 часа
• 3h — 3 часа
• 4h — 4 часа
• 6h — 6 часов
• 12h — 12 часов

until_first_bid*: boolean

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

}

auto_renew:{...}

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

step*: int32

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

limit*: int32

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

}

rate_rise:{...}

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

periodicity*: int32

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

rate_limit*: double

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

}

auction_restart:{...}

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

count*: int32

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

new_duration*: string

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

rate_increase:{...}

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

type*: string

Тип повышения ставки после перезапуска: currency — в валюте ставки, абсолютное значение percent — процент от начальной ставки

currencypercent

amount*: double

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

amount*: double

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

}

}

}

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

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

reservation_enabled*: boolean

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

is_published*: boolean

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

}]

documents:[{...}]

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

id: string

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

deprecated

file_id*: string

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

name*: string

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

link*: string

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

}]

application_contacts*:[{...}]

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

id*: int32

Id контакта

}]

paid_features:{...}

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

priority_view:{...}

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

money_spent_per_day: double

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

deprecated

money_spent_per_order: double

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

deprecated

rate*: double

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

only_for_paid_users*: boolean

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

limit: double (nullable)

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

daily_limit: double (nullable)

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

}

stealth:{...}

Стэлс

list_id: uuid (nullable)

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

minimal_registration_date: date-time (nullable)

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

minimal_stars_count: int32 (nullable)

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

}

}

note: string (nullable)

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

lot_id: uuid (nullable)

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

lot_number: int32 (nullable)

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

is_pass_through_copy: boolean (nullable)

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

is_archived: boolean (nullable)

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

archive_date: date-time (nullable)

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

}

}

Пример

{...}

"cargo_application":{...}

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

"snapshot_id":0,

"cargo_application_number":"string",

"department_id":0,

"persistent_user_id":0,

"actor_contact_id":0,

"external_id":"string",

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

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

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

"origin_source":"string",

"route":{...},

"loading":{...},

"city":{...},

"city_id":0,

"region_id":0,

"country_id":0

},

"coordinates":{...},

"longitude":0.5,

"latitude":0.5

},

"address":"string",

"organization":{...}

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

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

}

},

"unloading":{...},

"city":{...},

"city_id":0,

"region_id":0,

"country_id":0

},

"coordinates":{...},

"longitude":0.5,

"latitude":0.5

},

"address":"string",

"organization":{...}

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

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

}

},

"way_points":[...],

{...}

"city":{...},

"city_id":0,

"region_id":0,

"country_id":0

},

"coordinates":{...},

"longitude":0.5,

"latitude":0.5

},

"address":"string",

"organization":{...}

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

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

}

}

],

"is_round_trip":false

},

"truck":{...},

"trucks_count":0,

"load_type":"string",

"body_types":[...],

0

],

"is_tracking":false,

"adr":0,

"belts_count":0,

"required_capacity":0.5,

"body_loading":{...},

"types":[...],

0

],

"is_all_required":false

},

"body_unloading":{...},

"types":[...],

0

],

"is_all_required":false

},

"temperature":{...},

"from":0,

"to":0

},

"documents":{...},

"tir":false,

"cmr":false,

"t1":false,

"medical_card":false

},

"requirements":{...}

"logging_truck":false,

"road_train":false,

"air_suspension":false,

"team_driving":false

}

},

"payment":{...},

"type":"string",

"hide_counter_offers":false,

"direct_offer":false,

"prepayment":{...},

"percent":0,

"using_fuel":false

},

"payment_mode":{...}

"type":"string"

}

},

"boards":[...],

{...}

"id":"string",

"publication_mode":"string",

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

"cancel_publish_on_auction_bet":false,

"reservation_enabled":false,

"is_published":false

}

],

"documents":[...],

{...}

"file_id":"string",

"name":"string",

"link":"string"

}

],

"application_contacts":[...],

{...}

"id":0

}

],

"paid_features":{...},

"priority_view":{...},

"rate":0.5,

"only_for_paid_users":false,

"limit":0.5,

"daily_limit":0.5

},

"stealth":{...}

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

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

"minimal_stars_count":0

}

},

"note":"string",

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

"lot_number":0,

"is_pass_through_copy":false,

"is_archived":false,

"archive_date":"1970-01-01T00:00:00.000Z"

}

}

Консоль

Отправить

Параметры

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

{ "cargo_application": { "external_id": "string", "route": { "loading": { "location": { "type": "string" } }, "unloading": { "location": { "type": "string" } }, "way_points": [ { "location": { "type": "string" } } ] }, "truck": { "trucks_count": 0, "load_type": "string", "body_types": [ 0 ], "body_loading": { "types": [ 0 ], "is_all_required": false }, "body_unloading": { "types": [ 0 ], "is_all_required": false }, "temperature": { "from": 0, "to": 0 }, "documents": { "tir": false, "cmr": false, "t1": false, "medical_card": false }, "requirements": { "logging_truck": false, "road_train": false, "air_suspension": false, "team_driving": false }, "adr": 0, "belts_count": 0, "is_tracking": false, "required_capacity": 0.5 }, "payment": { "type": "string", "hide_counter_offers": false, "direct_offer": false, "prepayment": { "percent": 0, "using_fuel": false }, "payment_mode": { "type": "string" } }, "documents": [ { "file_id": "string" } ], "boards": [ { "id": "string", "publication_mode": "string", "publication_time": "1970-01-01T00:00:00.000Z", "cancel_publish_on_auction_bet": false, "reservation_enabled": false } ], "paid_features": { "priority_view": { "rate": 0.5, "limit": 0.5, "daily_limit": 0.5, "only_for_paid_users": false }, "stealth": { "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "minimal_registration_date": "1970-01-01T00:00:00.000Z", "minimal_stars_count": 0 } }, "note": "string", "contacts": [ 0 ] } }

Добавление груза Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией 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 символов) и выполняется хотя бы одно из трех условий:

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

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

Longitude: decimal (nullable)

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

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

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

Street: string

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

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

Максимальная длина 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)

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

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

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

Longitude: decimal (nullable)

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

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

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

Street: string

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

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

Максимальная длина 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

}

}]

}

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

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

1C

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

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

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

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v1.0/loads", "{""LoadMeta"":{""LoadMetaId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""MetaData"":""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

Идентификатор первого выбранного контакта.
Список всех контактов и их идентификаторы можно получить с помощью 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 символов) и выполняется хотя бы одно из трех условий:

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

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

Longitude: decimal (nullable)

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

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

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

Street: string

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

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

Максимальная длина 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)

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

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

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

Longitude: decimal (nullable)

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

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

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

Street: string

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

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

Максимальная длина 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

}

}]

}

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 символов

MoneySpentPerDay: decimal

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

MoneySpentPerOrder: decimal

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

}

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 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.

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

Показывает разрешено ли бронирование грузов на Общей площадке
Учитывается только для Общей площадки, только при включенном Stealth

PublicationOption: int32

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

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

IsPublished: boolean

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

IsCommonBoard: boolean

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

}]

UnloadFirstDate: date-time (nullable)

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

UnloadLastDate: date-time (nullable)

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

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

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,

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

}

Консоль

Отправить

Параметры

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

{ "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" }

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

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

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

Ограничение частоты: не более 5000 запросов за 24 часа на один контакт. При достижении лимита сервер возвращает 429 Too Many Requests в течение 24 часов.

Версия 2 1.0

put /v2/cargos/{cargoApplicationId}

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

Запрос

Модель

{...}

cargo_application:{...}

Заявка груза

external_id: string

Максимальное количество символов 250

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

route*:{...}

Маршрут

loading*:{...}

Загрузка

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

near_cities: [int32]

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

dates*:{...}

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

type*: string

Тип даты

• ready — готов к загрузке
• from-date — с даты
• permanent — постоянно
• rate-request — груза нет, запрос ставки

readyfrom-datepermanentrate-request

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

is_available_tomorrow: boolean (nullable)

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

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

first_date: yyyy-MM-dd (nullable)

Дата начала

last_date: yyyy-MM-dd (nullable)

Дата конца

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

periodicity*: string

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

• everyday — каждый день
• workdays — по рабочим дням

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

}

cargos*:[{...}]

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

id*: int32 (nullable)

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

name*: string

Максимальное количество символов 200

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

weight*:{...}

Вес

type: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double (nullable)

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

}

volume*:{...}

Объём

quantity*: double (nullable)

Количество

}

packaging:{...}

Упаковка

type*: int32 (nullable)

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

quantity: int32 (nullable)

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

height:{...}

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

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

width:{...}

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

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

diameter: double (nullable)

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

}

}]

}

unloading*:{...}

Разгрузка

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

near_cities: [int32]

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

dates:{...}

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

first_date: date-time (nullable)

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

last_date: date-time (nullable)

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

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

}

}

way_points:[{...}]

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

type*: string

loadingunloadingcustomsgo-through

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

cargos:[{...}]

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

id*: int32 (nullable)

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

name*: string

Максимальное количество символов 200

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

weight*:{...}

Вес

type: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double (nullable)

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

}

volume*:{...}

Объём

quantity*: double (nullable)

Количество

}

packaging:{...}

Упаковка

type*: int32 (nullable)

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

quantity: int32 (nullable)

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

height:{...}

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

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

width:{...}

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

value*: double (nullable)

Значение

is_highlighted: boolean (nullable)

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

}

diameter: double (nullable)

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

}

}]

loading_date:{...}

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

first_date: yyyy-MM-dd (nullable)

Дата начала

last_date: yyyy-MM-dd (nullable)

Дата конца

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

}

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

cargos:[{...}]

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

id*: int32 (nullable)

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

weight:{...}

Выгружаемая часть веса

type: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double (nullable)

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

}

volume:{...}

Выгружаемая часть объёма

quantity*: double (nullable)

Количество

}

packaging_quantity: int32 (nullable)

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

is_defined_by_ttn: boolean (nullable)

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

}]

unloading_date:{...}

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

first_date: yyyy-MM-dd (nullable)

Дата начала

last_date: yyyy-MM-dd (nullable)

Дата конца

time:{...}

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

type*: string

Тип времени

• bounded — с/по
• round-the-clock — круглосуточно

boundedround-the-clock

start: HH:mm (nullable)

С

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

}

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

city_id*: int32 (nullable)

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

deprecated

address: string

Максимальное количество символов 200

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

deprecated

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

location*:{...}

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

type*: string

manualorganization

city_id*: int32 (nullable)

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

address: string

Максимальное количество символов 200

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

coordinates:{...}

Координаты

longitude*: double (nullable)

>=-180 and <= 180

Долгота

latitude*: double (nullable)

>=-90 and <= 90

Широта

}

organization_id*: uuid (nullable)

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

address_id*: uuid (nullable)

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

}

}]

is_round_trip: boolean (nullable)

Кругорейс

deprecated

}

truck*:{...}

Транспорт

trucks_count: int32 (nullable)

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

load_type*: string

Загрузка:

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

body_types*: [int32]

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

body_loading:{...}

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

types: [int32]

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

is_all_required: boolean (nullable)

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

}

body_unloading:{...}

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

types: [int32]

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

is_all_required: boolean (nullable)

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

}

temperature:{...}

Температура

from: int32 (nullable)

От

to: int32 (nullable)

До

}

documents:{...}

Разрешения

tir: boolean (nullable)

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

cmr: boolean (nullable)

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

t1: boolean (nullable)

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

medical_card: boolean (nullable)

Медкнижка

}

requirements:{...}

Требования

logging_truck: boolean (nullable)

Коники

road_train: boolean (nullable)

Сцепка

air_suspension: boolean (nullable)

Пневмоход

team_driving: boolean (nullable)

Экипаж - требуется 2 водителя

}

adr: int32 (nullable)

ADR

belts_count: int32 (nullable)

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

is_tracking: boolean (nullable)

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

required_capacity: double (nullable)

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

}

payment*:{...}

Оплата

type*: string

Тип оплаты.

• with-bargaining — возможен торг
• without-bargaining — без торга
• rate-request — запрос ставки
• auction — торги

with-bargainingwithout-bargainingrate-requestauction

hide_counter_offers: boolean (nullable)

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

direct_offer: boolean (nullable)

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel: boolean (nullable)

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• on-unloading — оплата на выгрузке
• delayed-payment — оплата через N банковских дней

on-unloadingdelayed-payment

payment_delay_days: int32 (nullable)

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

}

currency_type: int32 (nullable)

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

rate_with_vat: double (nullable)

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

rate_without_vat: double (nullable)

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

cash: double (nullable)

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

on_card: boolean (nullable)

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

auto_invites_settings:{...}

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

invite_delay: string

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

invite_duration: string

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

max_percent_deviation: int32 (nullable)

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

need_archive_on_invite: boolean

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

}

hide_counter_offers: boolean (nullable)

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

direct_offer: boolean (nullable)

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel: boolean (nullable)

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• on-unloading — оплата на выгрузке
• delayed-payment — оплата через N банковских дней

on-unloadingdelayed-payment

payment_delay_days: int32 (nullable)

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

}

currency_type: int32 (nullable)

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

rate_with_vat: double (nullable)

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

rate_without_vat: double (nullable)

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

cash: double (nullable)

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

on_card: boolean (nullable)

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

hide_counter_offers: boolean (nullable)

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

direct_offer: boolean (nullable)

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel: boolean (nullable)

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• on-unloading — оплата на выгрузке
• delayed-payment — оплата через N банковских дней

on-unloadingdelayed-payment

payment_delay_days: int32 (nullable)

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

}

rate_with_vat_available: boolean (nullable)

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

rate_without_vat_available: boolean (nullable)

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

cash_available: boolean (nullable)

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

auto_invites_settings:{...}

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

invite_delay: string

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

invite_duration: string

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

max_percent_deviation: int32 (nullable)

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

need_archive_on_invite: boolean

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

}

hide_counter_offers: boolean (nullable)

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

direct_offer: boolean (nullable)

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel: boolean (nullable)

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

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• on-unloading — оплата на выгрузке
• delayed-payment — оплата через N банковских дней

on-unloadingdelayed-payment

payment_delay_days: int32 (nullable)

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

}

accept_bids_with_vat*: boolean (nullable)

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

accept_bids_without_vat: boolean (nullable)

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

vat_percents: int32 (nullable)

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

start_rate*: double (nullable)

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

auction_currency_type*: int32 (nullable)

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

bid_step*: double (nullable)

Шаг ставок

auction_duration*:{...}

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

fixed_duration: 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: boolean (nullable)

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

finish_until: date-time (nullable)

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

}

accept_counter_offers:{...}

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

acceptance_delay: string

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

• 30m — 30 минут
• 1h — 1 час
• 2h — 2 часа
• 3h — 3 часа
• 4h — 4 часа
• 6h — 6 часов
• 12h — 12 часов

until_first_bid: boolean (nullable)

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

}

auto_renew:{...}

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

step*: int32 (nullable)

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

limit*: int32 (nullable)

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

}

is_antisniper: boolean (nullable)

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

rate_rise:{...}

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

periodicity*: int32 (nullable)

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

rate_limit*: double (nullable)

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

}

winner_criteria*: string

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

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

time_to_provide_documents*: HH:mm (nullable)

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

winner_reselection_count: int32 (nullable)

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

auction_restart:{...}

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

count*: int32 (nullable)

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

new_duration*: string

Длительность Торгов после перезапуска:

• 30m — 30 минут
• 1h — 1 час
• 2h — 2 часа
• 3h — 3 часа
• 4h — 4 часа
• 6h — 6 часов
• 12h — 12 часов

rate_increase:{...}

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

type*: string

Тип повышения ставки после перезапуска.

• currency — в валюте ставки, абсолютное значение
• percent — процент от начальной ставки

currencypercent

amount*: double (nullable)

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

amount*: double (nullable)

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

}

}

no_winner_end_options*:{...}

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

type*: string

Действие

• archive — переместить заявку в архив
• publish-with-rate — опубликовать заявку со ставкой
• publish-rate-request — опубликовать заявку с запросом ставки

archivepublish-with-ratepublish-rate-request

currency_type: int32 (nullable)

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

rate_with_vat: double (nullable)

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

rate_without_vat: double (nullable)

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

cash: double (nullable)

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

on_card: boolean (nullable)

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

auto_invites_settings:{...}

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

invite_delay: string

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

invite_duration: string

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

max_percent_deviation: int32 (nullable)

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

need_archive_on_invite: boolean

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

}

rate_with_vat_available: boolean (nullable)

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

rate_without_vat_available: boolean (nullable)

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

cash_available: boolean (nullable)

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

auto_invites_settings:{...}

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

invite_delay: string

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

invite_duration: string

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

max_percent_deviation: int32 (nullable)

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

need_archive_on_invite: boolean

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

}

}

keep_rates: boolean (nullable)

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

}

documents:[{...}]

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

id: string

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

deprecated

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 (nullable)

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

cancel_publish_on_auction_bet: boolean (nullable)

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

reservation_enabled: boolean (nullable)

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

}]

paid_features:{...}

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

priority_view:{...}

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

rate*: double (nullable)

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

limit: double (nullable)

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

daily_limit: double (nullable)

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

only_for_paid_users: boolean (nullable)

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

}

stealth:{...}

Стэлс

list_id: uuid (nullable)

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

minimal_registration_date: date-time (nullable)

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

minimal_stars_count: int32 (nullable)

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

}

}

note: string

Максимальное количество символов 1000

Примечание к заявке

contacts*: [int32]

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

}

}

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

CURL

curl 'https://api.ati.su/v2/cargos/{cargoApplicationId}' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"cargo_application":{"external_id":"string","route":{"loading":{"location":{"type":"string"}},"unloading":{"location":{"type":"string"}},"way_points":[{"location":{"type":"string"}}]},"truck":{"trucks_count":0,"load_type":"string","body_types":[0],"body_loading":{"types":[0],"is_all_required":false},"body_unloading":{"types":[0],"is_all_required":false},"temperature":{"from":0,"to":0},"documents":{"tir":false,"cmr":false,"t1":false,"medical_card":false},"requirements":{"logging_truck":false,"road_train":false,"air_suspension":false,"team_driving":false},"adr":0,"belts_count":0,"is_tracking":false,"required_capacity":0.5},"payment":{"type":"string","hide_counter_offers":false,"direct_offer":false,"prepayment":{"percent":0,"using_fuel":false},"payment_mode":{"type":"string"}},"documents":[{"file_id":"string"}],"boards":[{"id":"string","publication_mode":"string","publication_time":"1970-01-01T00:00:00.000Z","cancel_publish_on_auction_bet":false,"reservation_enabled":false}],"paid_features":{"priority_view":{"rate":0.5,"limit":0.5,"daily_limit":0.5,"only_for_paid_users":false},"stealth":{"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","minimal_registration_date":"1970-01-01T00:00:00.000Z","minimal_stars_count":0}},"note":"string","contacts":[0]}}'

1C

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

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

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

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v2/cargos/{cargoApplicationId}", "{""cargo_application"":{""external_id"":""string"",""route"":{""loading"":{""location"":{""type"":""string""}},""unloading"":{""location"":{""type"":""string""}},""way_points"":[{""location"":{""type"":""string""}}]},""truck"":{""trucks_count"":0,""load_type"":""string"",""body_types"":[0],""body_loading"":{""types"":[0],""is_all_required"":false},""body_unloading"":{""types"":[0],""is_all_required"":false},""temperature"":{""from"":0,""to"":0},""documents"":{""tir"":false,""cmr"":false,""t1"":false,""medical_card"":false},""requirements"":{""logging_truck"":false,""road_train"":false,""air_suspension"":false,""team_driving"":false},""adr"":0,""belts_count"":0,""is_tracking"":false,""required_capacity"":0.5},""payment"":{""type"":""string"",""hide_counter_offers"":false,""direct_offer"":false,""prepayment"":{""percent"":0,""using_fuel"":false},""payment_mode"":{""type"":""string""}},""documents"":[{""file_id"":""string""}],""boards"":[{""id"":""string"",""publication_mode"":""string"",""publication_time"":""1970-01-01T00:00:00.000Z"",""cancel_publish_on_auction_bet"":false,""reservation_enabled"":false}],""paid_features"":{""priority_view"":{""rate"":0.5,""limit"":0.5,""daily_limit"":0.5,""only_for_paid_users"":false},""stealth"":{""list_id"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""minimal_registration_date"":""1970-01-01T00:00:00.000Z"",""minimal_stars_count"":0}},""note"":""string"",""contacts"":[0]}}");

Ответ

200 Success

Модель

{...}

cargo_application:{...}

Заявка груза

cargo_id: uuid

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

deprecated

cargo_number: string

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

deprecated

source: int32

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

deprecated

contacts: [int32]

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

distance: int32

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

deprecated

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 (nullable)

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

external_id: string (nullable)

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

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,
• internal-cargos-api,
• public-cargos-api,
• internal-atrucks,
• internal-torgtrans,
• csv_import,
• pass-through,
• unknown

route*:{...}

Маршрут

loading*:{...}

Загрузка

city_id*: int32

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

deprecated

city*:{...}

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

city_id*: int32

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

region_id: int32 (nullable)

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

country_id: int32 (nullable)

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

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

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

organization:{...}

Данные об организации из справочника

organization_id*: uuid

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

address_id*: uuid

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

}

near_cities: [int32]

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

dates*:{...}

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

type*: string

Тип даты:

• from-date — в промежутке дат first_date и last_date
• ready — готов
• permanent — постоянно
• rate-request — груза нет, запрос ставки

from-datereadypermanentrate-request

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

time:{...}

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

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

is_available_tomorrow*: boolean

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

time:{...}

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

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

periodicity*: string

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

• everyday — "каждый день"
• workdays — "по рабочим дням"

time:{...}

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

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

}

cargos*:[{...}]

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

cargo_id*: int32

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

weight:{...}

Вес

type*: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double

Количество

}

volume:{...}

Объём

quantity*: double

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double

Значение

is_highlighted*: boolean

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

}

height:{...}

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

value*: double

Значение

is_highlighted*: boolean

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

}

width:{...}

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

value*: double

Значение

is_highlighted*: boolean

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

}

diameter: double (nullable)

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

}

name*: string

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

packaging:{...}

Упаковка

type*: int32

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

quantity: int32 (nullable)

Количество

}

}]

nearby_cities:[{...}]

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

id*: int32

distance: double (nullable)

}]

}

unloading*:{...}

Разгрузка

city_id*: int32

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

deprecated

city*:{...}

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

city_id*: int32

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

region_id: int32 (nullable)

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

country_id: int32 (nullable)

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

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

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

organization:{...}

Данные об организации из справочника

organization_id*: uuid

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

address_id*: uuid

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

}

near_cities: [int32]

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

dates:{...}

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

first_date: date-time (nullable)

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

last_date: date-time (nullable)

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

time:{...}

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

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

}

nearby_cities:[{...}]

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

id*: int32

distance: double (nullable)

}]

}

way_points:[{...}]

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

type*: string

Тип промежуточной точки:

• loading - точка загрузки
• unloading - точка разгрузки
• customs - таможня
• go-through - точка "ехать через"

loadingunloadingcustomsgo-through

city_id*: int32

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

deprecated

city*:{...}

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

city_id*: int32

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

region_id: int32 (nullable)

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

country_id: int32 (nullable)

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

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

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

organization:{...}

Данные об организации из справочника

organization_id*: uuid

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

address_id*: uuid

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

}

cargos:[{...}]

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

cargo_id*: int32

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

weight:{...}

Вес

type*: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double

Количество

}

volume:{...}

Объём

quantity*: double

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double

Значение

is_highlighted*: boolean

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

}

height:{...}

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

value*: double

Значение

is_highlighted*: boolean

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

}

width:{...}

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

value*: double

Значение

is_highlighted*: boolean

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

}

diameter: double (nullable)

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

}

name*: string

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

packaging:{...}

Упаковка

type*: int32

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

quantity: int32 (nullable)

Количество

}

}]

loading_date:{...}

Даты и время загрузки

first_date: date-time (nullable)

Дата начала

last_date: date-time (nullable)

Дата конца

time:{...}

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

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

}

city_id*: int32

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

deprecated

city*:{...}

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

city_id*: int32

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

region_id: int32 (nullable)

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

country_id: int32 (nullable)

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

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

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

organization:{...}

Данные об организации из справочника

organization_id*: uuid

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

address_id*: uuid

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

}

cargos:[{...}]

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

cargo_id*: int32

Порядковый Id груза внутри заявки

weight:{...}

Вес

type*: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double

Количество

}

volume:{...}

Объём

quantity*: double

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

height:{...}

Высота, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

width:{...}

Ширина, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

diameter: double (nullable)

Диаметр, метры

}

packaging_quantity: int32 (nullable)

Выгружаемая часть упаковки

is_defined_by_ttn: boolean (nullable)

Выгружаемая часть груза будет определена в ТТН

}]

unloading_date:{...}

Параметры даты и времени разгрузки

first_date: date-time (nullable)

Дата начала

last_date: date-time (nullable)

Дата конца

time:{...}

Время загрузки

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

}

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

deprecated

city*:{...}

Информация о населённом пункте

city_id*: int32

Id города из словаря городов

region_id: int32 (nullable)

Id региона из словаря регионов

country_id: int32 (nullable)

Id страны из словаря стран

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

Адрес в населённом пункте

organization:{...}

Данные об организации из справочника

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

deprecated

city*:{...}

Информация о населённом пункте

city_id*: int32

Id города из словаря городов

region_id: int32 (nullable)

Id региона из словаря регионов

country_id: int32 (nullable)

Id страны из словаря стран

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

Адрес в населённом пункте

organization:{...}

Данные об организации из справочника

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

}]

is_round_trip: boolean (nullable)

Кругорейс

}

truck*:{...}

Транспорт

trucks_count*: int32

Количество машин

load_type*: string

Загрузка:

• ftl — отдельной машиной
• dont-care — не важно

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

is_tracking*: boolean

Трекинг через АТИ Водитель

adr: int32 (nullable)

ADR

belts_count: int32 (nullable)

Количество ремней

required_capacity: double (nullable)

Требуемая грузоподъемность в тоннах

body_loading:{...}

Способы загрузки

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

body_unloading:{...}

Способы разгрузки

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

temperature:{...}

Температура

from: int32 (nullable)

От

to: int32 (nullable)

До

}

documents:{...}

Разрешения

tir*: boolean

TIR

cmr*: boolean

CMR

t1*: boolean

T1

medical_card*: boolean

Медкнижка

}

requirements:{...}

Требования

logging_truck*: boolean

Коники

road_train*: boolean

Сцепка

air_suspension*: boolean

Пневмоход

team_driving*: boolean

Экипаж - требуется 2 водителя

}

}

payment*:{...}

Оплата

type*: string

Тип оплаты:

• with-bargaining - ставка с возможностью торга
• without-bargaining - ставка без возможности торга
• rate-request - запрос ставки
• auction - у заявки проводятся Торги

with-bargainingwithout-bargainingrate-requestauction

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:{...}

Предоплата

percent: int32 (nullable)

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double (nullable)

Ставка безнал с НДС

rate_without_vat: double (nullable)

Ставка безнал без НДС

cash: double (nullable)

Ставка наличными

on_card: boolean (nullable)

Возможность отправлять наличные на карту

auto_invites_settings:{...}

Настройки автоматического приглашения на лучшее встречное предложение

invite_delay*: string

Период приема встречного предложения до автоматического приглашения

invite_duration*: string

Период действия автоматического приглашения

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32 (nullable)

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:{...}

Предоплата

percent: int32 (nullable)

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double (nullable)

Ставка безнал с НДС

rate_without_vat: double (nullable)

Ставка безнал без НДС

cash: double (nullable)

Ставка наличными

on_card: boolean (nullable)

Возможность отправлять наличные на карту

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:{...}

Предоплата

percent: int32 (nullable)

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:{...}

Настройки автоматического приглашения на лучшее встречное предложение

invite_delay*: string

Период приема встречного предложения до автоматического приглашения

invite_duration*: string

Период действия автоматического приглашения

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32 (nullable)

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:{...}

Предоплата

percent: int32 (nullable)

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

auction_id*: uuid

Id Торгов

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты, в которой будут вестись Торги. Значение из словаря валют

bid_step*: double

Шаг ставки Торгов

accept_bids_with_vat*: boolean

Принимать ставки с НДС

accept_bids_without_vat: boolean (nullable)

Принимать ставки без НДС

vat_percents: int32 (nullable)

Размер НДС, в процентах

is_antisniper*: boolean

Опция Антиснайпер

time_to_provide_documents*: HH:mm

Время, за которое победитель обязан предоставить документы

winner_criteria*: string

Критерий выбора победителя: best-rate — по лучшей ставке matching-date — с учётом даты загрузки и лучшей ставки

winner_reselection_count: int32 (nullable)

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: string (nullable)

Может быть 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 (nullable)

Точные дата и время завершения Торгов

}

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type*: string

Действие: archive — переместить заявку в архив publish-with-rate — опубликовать заявку со ставкой publish-rate-request — опубликовать заявку с запросом ставки

archivepublish-with-ratepublish-rate-request

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double (nullable)

Ставка безнал с НДС

rate_without_vat: double (nullable)

Ставка безнал без НДС

cash: double (nullable)

Ставка наличными

on_card: boolean (nullable)

Возможность отправлять наличные на карту

auto_invites_settings:{...}

Автоматическое приглашение на лучшее встречное предложение

invite_delay*: string

Период приема встречного предложения до автоматического приглашения

invite_duration*: string

Период действия автоматического приглашения

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32 (nullable)

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:{...}

Автоматическое приглашение на лучшее встречное предложение

invite_delay*: string

Период приема встречного предложения до автоматического приглашения

invite_duration*: string

Период действия автоматического приглашения

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32 (nullable)

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

}

accept_counter_offers:{...}

Параметры доступности встречных предложений во время проведения Торгов

acceptance_delay: string (nullable)

Может быть null, в таком случае будем принимать встречные предложения сразу. Принимать встречные предложения через:

• 30m — 30 минут
• 1h — 1 час
• 2h — 2 часа
• 3h — 3 часа
• 4h — 4 часа
• 6h — 6 часов
• 12h — 12 часов

until_first_bid*: boolean

Принимать встречные предложения до первой ставки по Торгам

}

auto_renew:{...}

Параметры автопродления Торгов

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

rate_rise:{...}

Параметры повышения ставки Торгов при отсутствии ставок

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

auction_restart:{...}

Параметры перезапуска Торгов в случае отсутствия ставок

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов

rate_increase:{...}

Параметры повышения начальной ставки после перезапуска торгов.

type*: string

Тип повышения ставки после перезапуска: currency — в валюте ставки, абсолютное значение percent — процент от начальной ставки

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

}

}

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

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

reservation_enabled*: boolean

Разрешить перевозчикам бронировать груз

is_published*: boolean

Груз опубликован на площадке

}]

documents:[{...}]

Фото груза и документов

id: string

Старый id документа OBSOLETE используй поле FileID

deprecated

file_id*: string

Id документа в API Плюшкин (TODO ссылка)

name*: string

Название документа

link*: string

Ссылка на документ

}]

application_contacts*:[{...}]

Информация о контактах груза

id*: int32

Id контакта

}]

paid_features:{...}

Платные услуги

priority_view:{...}

Приоритетный показ

money_spent_per_day: double

Потрачено атисов за день OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

deprecated

money_spent_per_order: double

Потрачено атисов на эту заявку OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

deprecated

rate*: double

Ставка за просмотр

only_for_paid_users*: boolean

Показывать приоритетный груз только платным пользователям

limit: double (nullable)

Лимит на заявку

daily_limit: double (nullable)

Суточный лимит

}

stealth:{...}

Стэлс

list_id: uuid (nullable)

Id списка фирм для скрытия

minimal_registration_date: date-time (nullable)

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32 (nullable)

Минимальное количество звёзд фирм, которые будут видеть груз

}

}

note: string (nullable)

Примечание к грузу

lot_id: uuid (nullable)

Id Лота, к которому прикреплён данный груз

lot_number: int32 (nullable)

Номер Лота, к которому прикреплён данный груз

is_pass_through_copy: boolean (nullable)

Является ли груз сквозной копией

is_archived: boolean (nullable)

Отправлен ли груз в архив

archive_date: date-time (nullable)

Время отправки груза в архив, UTC

}

}

Пример

{...}

"cargo_application":{...}

"cargo_application_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"snapshot_id":0,

"cargo_application_number":"string",

"department_id":0,

"persistent_user_id":0,

"actor_contact_id":0,

"external_id":"string",

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"refreshed_at":"1970-01-01T00:00:00.000Z",

"origin_source":"string",

"route":{...},

"loading":{...},

"city":{...},

"city_id":0,

"region_id":0,

"country_id":0

},

"coordinates":{...},

"longitude":0.5,

"latitude":0.5

},

"address":"string",

"organization":{...}

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

},

"unloading":{...},

"city":{...},

"city_id":0,

"region_id":0,

"country_id":0

},

"coordinates":{...},

"longitude":0.5,

"latitude":0.5

},

"address":"string",

"organization":{...}

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

},

"way_points":[...],

{...}

"city":{...},

"city_id":0,

"region_id":0,

"country_id":0

},

"coordinates":{...},

"longitude":0.5,

"latitude":0.5

},

"address":"string",

"organization":{...}

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

}

],

"is_round_trip":false

},

"truck":{...},

"trucks_count":0,

"load_type":"string",

"body_types":[...],

0

],

"is_tracking":false,

"adr":0,

"belts_count":0,

"required_capacity":0.5,

"body_loading":{...},

"types":[...],

0

],

"is_all_required":false

},

"body_unloading":{...},

"types":[...],

0

],

"is_all_required":false

},

"temperature":{...},

"from":0,

"to":0

},

"documents":{...},

"tir":false,

"cmr":false,

"t1":false,

"medical_card":false

},

"requirements":{...}

"logging_truck":false,

"road_train":false,

"air_suspension":false,

"team_driving":false

}

},

"payment":{...},

"type":"string",

"hide_counter_offers":false,

"direct_offer":false,

"prepayment":{...},

"percent":0,

"using_fuel":false

},

"payment_mode":{...}

"type":"string"

}

},

"boards":[...],

{...}

"id":"string",

"publication_mode":"string",

"publication_time":"1970-01-01T00:00:00.000Z",

"cancel_publish_on_auction_bet":false,

"reservation_enabled":false,

"is_published":false

}

],

"documents":[...],

{...}

"file_id":"string",

"name":"string",

"link":"string"

}

],

"application_contacts":[...],

{...}

"id":0

}

],

"paid_features":{...},

"priority_view":{...},

"rate":0.5,

"only_for_paid_users":false,

"limit":0.5,

"daily_limit":0.5

},

"stealth":{...}

"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"minimal_registration_date":"1970-01-01T00:00:00.000Z",

"minimal_stars_count":0

}

},

"note":"string",

"lot_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"lot_number":0,

"is_pass_through_copy":false,

"is_archived":false,

"archive_date":"1970-01-01T00:00:00.000Z"

}

}

Консоль

Отправить

Параметры

cargoApplicationId

{ "cargo_application": { "external_id": "string", "route": { "loading": { "location": { "type": "string" } }, "unloading": { "location": { "type": "string" } }, "way_points": [ { "location": { "type": "string" } } ] }, "truck": { "trucks_count": 0, "load_type": "string", "body_types": [ 0 ], "body_loading": { "types": [ 0 ], "is_all_required": false }, "body_unloading": { "types": [ 0 ], "is_all_required": false }, "temperature": { "from": 0, "to": 0 }, "documents": { "tir": false, "cmr": false, "t1": false, "medical_card": false }, "requirements": { "logging_truck": false, "road_train": false, "air_suspension": false, "team_driving": false }, "adr": 0, "belts_count": 0, "is_tracking": false, "required_capacity": 0.5 }, "payment": { "type": "string", "hide_counter_offers": false, "direct_offer": false, "prepayment": { "percent": 0, "using_fuel": false }, "payment_mode": { "type": "string" } }, "documents": [ { "file_id": "string" } ], "boards": [ { "id": "string", "publication_mode": "string", "publication_time": "1970-01-01T00:00:00.000Z", "cancel_publish_on_auction_bet": false, "reservation_enabled": false } ], "paid_features": { "priority_view": { "rate": 0.5, "limit": 0.5, "daily_limit": 0.5, "only_for_paid_users": false }, "stealth": { "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "minimal_registration_date": "1970-01-01T00:00:00.000Z", "minimal_stars_count": 0 } }, "note": "string", "contacts": [ 0 ] } }

Редактирование груза Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

put /v1.0/loads/{loadId}

Модель и примеры

Запрос

Модель

{...}

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 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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)

Широта города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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

}

}]

}

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

curl 'https://api.ati.su/v1.0/loads/{loadId}' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"LoadMeta":{"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","MetaData":"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"}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/{loadId}", "{""LoadMeta"":{""LoadMetaId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""MetaData"":""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

Идентификатор первого выбранного контакта.
Список всех контактов и их идентификаторы можно получить с помощью 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 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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)

Широта города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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

}

}]

}

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 символов

MoneySpentPerDay: decimal

Количество денег, потраченное на заявку за день. Только для чтения

MoneySpentPerOrder: decimal

Количество денег, потраченное на заявку в целом. Только для чтения

}

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 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.

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

Показывает разрешено ли бронирование грузов на Общей площадке
Учитывается только для Общей площадки, только при включенном Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Показывает является ли площадка Общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC.
Может иметь значение null.
Минимальное значение равно текущей дате.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null.
Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

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":[...],

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,

"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"

}

Консоль

Отправить

Параметры

loadId 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": [ 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" }

Получение одного груза

Версия 2 1.0

get /v2/cargos/{cargoApplicationId}

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v2/cargos/{cargoApplicationId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v2/cargos/{cargoApplicationId}");

Ответ

200 Success

Модель

{...}

Контракт заявки груза, ожидаемый в ответах публичного http api работы с грузами

cargo_id: uuid

ID груза OBSOLETE используй поле CargoApplicationId

deprecated

cargo_number: string

Номер груза, автоматически генерируемый ATI.SU OBSOLETE используй поле CargoApplicationNumber

deprecated

source: int32

OBSOLETE используй поле OriginSource

deprecated

contacts: [int32]

Контакты OBSOLETE используй поле ApplicationContacts

distance: int32

Дистанция, км

deprecated

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 (nullable)

Идентификатор контакта, разместившего заявку

external_id: string (nullable)

Внешний номер груза или заказа

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,
• internal-cargos-api,
• public-cargos-api,
• internal-atrucks,
• internal-torgtrans,
• csv_import,
• pass-through,
• unknown

route*:{...}

Маршрут

loading*:{...}

Загрузка

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

deprecated

city*:{...}

Информация о населённом пункте

city_id*: int32

Id города из словаря городов

region_id: int32 (nullable)

Id региона из словаря регионов

country_id: int32 (nullable)

Id страны из словаря стран

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

Адрес в населённом пункте

organization:{...}

Данные об организации из справочника

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates*:{...}

Даты загрузки

type*: string

Тип даты:

• from-date — в промежутке дат first_date и last_date
• ready — готов
• permanent — постоянно
• rate-request — груза нет, запрос ставки

from-datereadypermanentrate-request

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

time:{...}

Время загрузки

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

is_available_tomorrow*: boolean

Готов к загрузке сегодня и завтра (TODO возможно убрать)

time:{...}

Время загрузки

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

periodicity*: string

Периодичность постоянной загрузки:

• everyday — "каждый день"
• workdays — "по рабочим дням"

time:{...}

Время загрузки

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

}

cargos*:[{...}]

Параметры грузов на загрузку

cargo_id*: int32

Порядковый Id груза внутри заявки

weight:{...}

Вес

type*: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double

Количество

}

volume:{...}

Объём

quantity*: double

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

height:{...}

Высота, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

width:{...}

Ширина, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

diameter: double (nullable)

Диаметр, метры

}

name*: string

Наименование груза

packaging:{...}

Упаковка

type*: int32

Id типа упаковки из словаря типов упаковок

quantity: int32 (nullable)

Количество

}

}]

nearby_cities:[{...}]

Ближайшие крупные города

id*: int32

distance: double (nullable)

}]

}

unloading*:{...}

Разгрузка

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

deprecated

city*:{...}

Информация о населённом пункте

city_id*: int32

Id города из словаря городов

region_id: int32 (nullable)

Id региона из словаря регионов

country_id: int32 (nullable)

Id страны из словаря стран

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

Адрес в населённом пункте

organization:{...}

Данные об организации из справочника

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

near_cities: [int32]

Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities

dates:{...}

Даты разгрузки

first_date: date-time (nullable)

Дата разгрузки

last_date: date-time (nullable)

Поздняя дата разгрузки

time:{...}

Время разгрузки

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

}

nearby_cities:[{...}]

Ближайшие крупные города

id*: int32

distance: double (nullable)

}]

}

way_points:[{...}]

Точки маршрута

type*: string

Тип промежуточной точки:

• loading - точка загрузки
• unloading - точка разгрузки
• customs - таможня
• go-through - точка "ехать через"

loadingunloadingcustomsgo-through

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

deprecated

city*:{...}

Информация о населённом пункте

city_id*: int32

Id города из словаря городов

region_id: int32 (nullable)

Id региона из словаря регионов

country_id: int32 (nullable)

Id страны из словаря стран

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

Адрес в населённом пункте

organization:{...}

Данные об организации из справочника

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

cargos:[{...}]

Параметры загружаемых грузов

cargo_id*: int32

Порядковый Id груза внутри заявки

weight:{...}

Вес

type*: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double

Количество

}

volume:{...}

Объём

quantity*: double

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

height:{...}

Высота, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

width:{...}

Ширина, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

diameter: double (nullable)

Диаметр, метры

}

name*: string

Наименование груза

packaging:{...}

Упаковка

type*: int32

Id типа упаковки из словаря типов упаковок

quantity: int32 (nullable)

Количество

}

}]

loading_date:{...}

Даты и время загрузки

first_date: date-time (nullable)

Дата начала

last_date: date-time (nullable)

Дата конца

time:{...}

Время загрузки

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

}

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

deprecated

city*:{...}

Информация о населённом пункте

city_id*: int32

Id города из словаря городов

region_id: int32 (nullable)

Id региона из словаря регионов

country_id: int32 (nullable)

Id страны из словаря стран

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

Адрес в населённом пункте

organization:{...}

Данные об организации из справочника

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

cargos:[{...}]

Параметры разгружаемых грузов

cargo_id*: int32

Порядковый Id груза внутри заявки

weight:{...}

Вес

type*: string

Тип:

• tons — тонны
• kilos — килограммы

quantity*: double

Количество

}

volume:{...}

Объём

quantity*: double

Количество

}

sizes:{...}

Габариты

length:{...}

Длина, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

height:{...}

Высота, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

width:{...}

Ширина, метры

value*: double

Значение

is_highlighted*: boolean

Выделить значение цветом в результатах поиска

}

diameter: double (nullable)

Диаметр, метры

}

packaging_quantity: int32 (nullable)

Выгружаемая часть упаковки

is_defined_by_ttn: boolean (nullable)

Выгружаемая часть груза будет определена в ТТН

}]

unloading_date:{...}

Параметры даты и времени разгрузки

first_date: date-time (nullable)

Дата начала

last_date: date-time (nullable)

Дата конца

time:{...}

Время загрузки

type*: string

boundedround-the-clock

start: HH:mm (nullable)

Время "с"

end: HH:mm (nullable)

Время "по"

offset: +HH:mm (nullable)

Часовой пояс

}

}

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

deprecated

city*:{...}

Информация о населённом пункте

city_id*: int32

Id города из словаря городов

region_id: int32 (nullable)

Id региона из словаря регионов

country_id: int32 (nullable)

Id страны из словаря стран

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

Адрес в населённом пункте

organization:{...}

Данные об организации из справочника

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

city_id*: int32

Id города из словаря OBSOLETE используй поле City.CityId

deprecated

city*:{...}

Информация о населённом пункте

city_id*: int32

Id города из словаря городов

region_id: int32 (nullable)

Id региона из словаря регионов

country_id: int32 (nullable)

Id страны из словаря стран

}

coordinates:{...}

Координаты

longitude*: double

Долгота

latitude*: double

Широта

}

address: string (nullable)

Адрес в населённом пункте

organization:{...}

Данные об организации из справочника

organization_id*: uuid

Id из справочника организаций

address_id*: uuid

Id адреса в организации

}

}]

is_round_trip: boolean (nullable)

Кругорейс

}

truck*:{...}

Транспорт

trucks_count*: int32

Количество машин

load_type*: string

Загрузка:

• ftl — отдельной машиной
• dont-care — не важно

body_types*: [int32]

TypeId типов кузовов. Значение TypeId из словаря кузовов

is_tracking*: boolean

Трекинг через АТИ Водитель

adr: int32 (nullable)

ADR

belts_count: int32 (nullable)

Количество ремней

required_capacity: double (nullable)

Требуемая грузоподъемность в тоннах

body_loading:{...}

Способы загрузки

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

body_unloading:{...}

Способы разгрузки

types*: [int32]

Id типа загрузки из словаря типов загрузок

is_all_required*: boolean

Обязательны все выбранные

}

temperature:{...}

Температура

from: int32 (nullable)

От

to: int32 (nullable)

До

}

documents:{...}

Разрешения

tir*: boolean

TIR

cmr*: boolean

CMR

t1*: boolean

T1

medical_card*: boolean

Медкнижка

}

requirements:{...}

Требования

logging_truck*: boolean

Коники

road_train*: boolean

Сцепка

air_suspension*: boolean

Пневмоход

team_driving*: boolean

Экипаж - требуется 2 водителя

}

}

payment*:{...}

Оплата

type*: string

Тип оплаты:

• with-bargaining - ставка с возможностью торга
• without-bargaining - ставка без возможности торга
• rate-request - запрос ставки
• auction - у заявки проводятся Торги

with-bargainingwithout-bargainingrate-requestauction

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:{...}

Предоплата

percent: int32 (nullable)

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double (nullable)

Ставка безнал с НДС

rate_without_vat: double (nullable)

Ставка безнал без НДС

cash: double (nullable)

Ставка наличными

on_card: boolean (nullable)

Возможность отправлять наличные на карту

auto_invites_settings:{...}

Настройки автоматического приглашения на лучшее встречное предложение

invite_delay*: string

Период приема встречного предложения до автоматического приглашения

invite_duration*: string

Период действия автоматического приглашения

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32 (nullable)

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:{...}

Предоплата

percent: int32 (nullable)

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double (nullable)

Ставка безнал с НДС

rate_without_vat: double (nullable)

Ставка безнал без НДС

cash: double (nullable)

Ставка наличными

on_card: boolean (nullable)

Возможность отправлять наличные на карту

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:{...}

Предоплата

percent: int32 (nullable)

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:{...}

Настройки автоматического приглашения на лучшее встречное предложение

invite_delay*: string

Период приема встречного предложения до автоматического приглашения

invite_duration*: string

Период действия автоматического приглашения

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32 (nullable)

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

hide_counter_offers*: boolean

Встречные предложения видны только вам

direct_offer*: boolean

Прямой договор

prepayment:{...}

Предоплата

percent: int32 (nullable)

Процент предоплаты

using_fuel*: boolean

Предоплата топливом

}

payment_mode:{...}

Режим оплаты

type*: string

Тип режима оплаты:

• delayed-payment — через несколько дней
• on-unloading — на выгрузке

delayed-paymenton-unloading

payment_delay_days*: int32

Количество банковских дней

}

auction_id*: uuid

Id Торгов

start_rate*: double

Начальная ставка Торгов

auction_currency_type*: int32

Id валюты, в которой будут вестись Торги. Значение из словаря валют

bid_step*: double

Шаг ставки Торгов

accept_bids_with_vat*: boolean

Принимать ставки с НДС

accept_bids_without_vat: boolean (nullable)

Принимать ставки без НДС

vat_percents: int32 (nullable)

Размер НДС, в процентах

is_antisniper*: boolean

Опция Антиснайпер

time_to_provide_documents*: HH:mm

Время, за которое победитель обязан предоставить документы

winner_criteria*: string

Критерий выбора победителя: best-rate — по лучшей ставке matching-date — с учётом даты загрузки и лучшей ставки

winner_reselection_count: int32 (nullable)

Количество автоматических переназначений победителя Торгов, в случае отказа от груза

auction_duration*:{...}

Параметры длительности Торгов

fixed_duration: string (nullable)

Может быть 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 (nullable)

Точные дата и время завершения Торгов

}

no_winner_end_options*:{...}

Действие при окончательном завершении Торгов без победителя

type*: string

Действие: archive — переместить заявку в архив publish-with-rate — опубликовать заявку со ставкой publish-rate-request — опубликовать заявку с запросом ставки

archivepublish-with-ratepublish-rate-request

currency_type*: int32

Id валюты из словаря валют

rate_with_vat: double (nullable)

Ставка безнал с НДС

rate_without_vat: double (nullable)

Ставка безнал без НДС

cash: double (nullable)

Ставка наличными

on_card: boolean (nullable)

Возможность отправлять наличные на карту

auto_invites_settings:{...}

Автоматическое приглашение на лучшее встречное предложение

invite_delay*: string

Период приема встречного предложения до автоматического приглашения

invite_duration*: string

Период действия автоматического приглашения

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32 (nullable)

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

rate_with_vat_available*: boolean

Можно предлагать ставки безнал с НДС

rate_without_vat_available*: boolean

Можно предлагать ставки безнал без НДС

cash_available*: boolean

Можно предлагать ставки наличными

auto_invites_settings:{...}

Автоматическое приглашение на лучшее встречное предложение

invite_delay*: string

Период приема встречного предложения до автоматического приглашения

invite_duration*: string

Период действия автоматического приглашения

need_archive_on_invite*: boolean

Архивировать заявку при срабатывании автоматического приглашения

max_percent_deviation: int32 (nullable)

Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения

}

}

accept_counter_offers:{...}

Параметры доступности встречных предложений во время проведения Торгов

acceptance_delay: string (nullable)

Может быть null, в таком случае будем принимать встречные предложения сразу. Принимать встречные предложения через:

• 30m — 30 минут
• 1h — 1 час
• 2h — 2 часа
• 3h — 3 часа
• 4h — 4 часа
• 6h — 6 часов
• 12h — 12 часов

until_first_bid*: boolean

Принимать встречные предложения до первой ставки по Торгам

}

auto_renew:{...}

Параметры автопродления Торгов

step*: int32

Количество минут, на которые будут продливаться Торги

limit*: int32

Максимальное время, на которое будут продливаться Торги (в минутах)

}

rate_rise:{...}

Параметры повышения ставки Торгов при отсутствии ставок

periodicity*: int32

Периодичность повышения

rate_limit*: double

Максимальное значение ставки Торгов

}

auction_restart:{...}

Параметры перезапуска Торгов в случае отсутствия ставок

count*: int32

Количество перезапусков

new_duration*: string

Длительность Торгов после перезапуска: 30m — 30 минут 1h — 1 час 2h — 2 часа 3h — 3 часа 4h — 4 часа 6h — 6 часов 12h — 12 часов

rate_increase:{...}

Параметры повышения начальной ставки после перезапуска торгов.

type*: string

Тип повышения ставки после перезапуска: currency — в валюте ставки, абсолютное значение percent — процент от начальной ставки

currencypercent

amount*: double

Значение, на которое нужно повысить начальную ставку.

amount*: double

Значение, на которое нужно повысить начальную ставку.

}

}

}

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

Не публиковать груз при отложенной публикации, если появилась ставка по Торгам

reservation_enabled*: boolean

Разрешить перевозчикам бронировать груз

is_published*: boolean

Груз опубликован на площадке

}]

documents:[{...}]

Фото груза и документов

id: string

Старый id документа OBSOLETE используй поле FileID

deprecated

file_id*: string

Id документа в API Плюшкин (TODO ссылка)

name*: string

Название документа

link*: string

Ссылка на документ

}]

application_contacts*:[{...}]

Информация о контактах груза

id*: int32

Id контакта

}]

paid_features:{...}

Платные услуги

priority_view:{...}

Приоритетный показ

money_spent_per_day: double

Потрачено атисов за день OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

deprecated

money_spent_per_order: double

Потрачено атисов на эту заявку OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам

deprecated

rate*: double

Ставка за просмотр

only_for_paid_users*: boolean

Показывать приоритетный груз только платным пользователям

limit: double (nullable)

Лимит на заявку

daily_limit: double (nullable)

Суточный лимит

}

stealth:{...}

Стэлс

list_id: uuid (nullable)

Id списка фирм для скрытия

minimal_registration_date: date-time (nullable)

Минимальная дата регистрации фирм, которые будут видеть груза

minimal_stars_count: int32 (nullable)

Минимальное количество звёзд фирм, которые будут видеть груз

}

}

note: string (nullable)

Примечание к грузу

lot_id: uuid (nullable)

Id Лота, к которому прикреплён данный груз

lot_number: int32 (nullable)

Номер Лота, к которому прикреплён данный груз

is_pass_through_copy: boolean (nullable)

Является ли груз сквозной копией

is_archived: boolean (nullable)

Отправлен ли груз в архив

archive_date: date-time (nullable)

Время отправки груза в архив, UTC

}

Пример

{...}

"cargo_application_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"snapshot_id":0,

"cargo_application_number":"string",

"department_id":0,

"persistent_user_id":0,

"actor_contact_id":0,

"external_id":"string",

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"refreshed_at":"1970-01-01T00:00:00.000Z",

"origin_source":"string",

"route":{...},

"loading":{...},

"city":{...},

"city_id":0,

"region_id":0,

"country_id":0

},

"coordinates":{...},

"longitude":0.5,

"latitude":0.5

},

"address":"string",

"organization":{...}

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

},

"unloading":{...},

"city":{...},

"city_id":0,

"region_id":0,

"country_id":0

},

"coordinates":{...},

"longitude":0.5,

"latitude":0.5

},

"address":"string",

"organization":{...}

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

},

"way_points":[...],

{...}

"city":{...},

"city_id":0,

"region_id":0,

"country_id":0

},

"coordinates":{...},

"longitude":0.5,

"latitude":0.5

},

"address":"string",

"organization":{...}

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

}

],

"is_round_trip":false

},

"truck":{...},

"trucks_count":0,

"load_type":"string",

"body_types":[...],

0

],

"is_tracking":false,

"adr":0,

"belts_count":0,

"required_capacity":0.5,

"body_loading":{...},

"types":[...],

0

],

"is_all_required":false

},

"body_unloading":{...},

"types":[...],

0

],

"is_all_required":false

},

"temperature":{...},

"from":0,

"to":0

},

"documents":{...},

"tir":false,

"cmr":false,

"t1":false,

"medical_card":false

},

"requirements":{...}

"logging_truck":false,

"road_train":false,

"air_suspension":false,

"team_driving":false

}

},

"payment":{...},

"type":"string",

"hide_counter_offers":false,

"direct_offer":false,

"prepayment":{...},

"percent":0,

"using_fuel":false

},

"payment_mode":{...}

"type":"string"

}

},

"boards":[...],

{...}

"id":"string",

"publication_mode":"string",

"publication_time":"1970-01-01T00:00:00.000Z",

"cancel_publish_on_auction_bet":false,

"reservation_enabled":false,

"is_published":false

}

],

"documents":[...],

{...}

"file_id":"string",

"name":"string",

"link":"string"

}

],

"application_contacts":[...],

{...}

"id":0

}

],

"paid_features":{...},

"priority_view":{...},

"rate":0.5,

"only_for_paid_users":false,

"limit":0.5,

"daily_limit":0.5

},

"stealth":{...}

"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"minimal_registration_date":"1970-01-01T00:00:00.000Z",

"minimal_stars_count":0

}

},

"note":"string",

"lot_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"lot_number":0,

"is_pass_through_copy":false,

"is_archived":false,

"archive_date":"1970-01-01T00:00:00.000Z"

}

Консоль

Отправить

Параметры

cargoApplicationId

Получение одного груза с выбранным id Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

get /v1.0/loads/{loadId}

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/{loadId}");

Ответ

200 Груз

Модель

{...}

LoadMeta:{...}

Метаданные для интеграторов

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 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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)

Широта города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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

}

}]

}

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 символов

MoneySpentPerDay: decimal

Количество денег, потраченное на заявку за день. Только для чтения

MoneySpentPerOrder: decimal

Количество денег, потраченное на заявку в целом. Только для чтения

}

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 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.

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

Показывает разрешено ли бронирование грузов на Общей площадке
Учитывается только для Общей площадки, только при включенном Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Показывает является ли площадка Общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC.
Может иметь значение null.
Минимальное значение равно текущей дате.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null.
Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

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":[...],

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,

"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"

}

Консоль

Отправить

Параметры

loadId ID груза

Получение всех своих грузов

Доступен фильтр по контакту. При передаче значения в contactId будут получены только те грузы, у которых ContactId1 == contactId либо ContactId2 == contactId.
Получать этим методом чужие грузы с общей площадки нельзя. Метод предназначен для работы со своими грузами.

Получение всех грузов фирмы

get /v1.0/loads

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads");

Ответ

200 Грузы

Модель

[{...}]

LoadMeta:{...}

Метаданные для интеграторов

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 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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)

Широта города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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

}

}]

}

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 символов

MoneySpentPerDay: decimal

Количество денег, потраченное на заявку за день. Только для чтения

MoneySpentPerOrder: decimal

Количество денег, потраченное на заявку в целом. Только для чтения

}

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 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.

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

Показывает разрешено ли бронирование грузов на Общей площадке
Учитывается только для Общей площадки, только при включенном Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Показывает является ли площадка Общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC.
Может иметь значение null.
Минимальное значение равно текущей дате.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null.
Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

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":[...],

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,

"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"

}

Консоль

Отправить

Параметры

contactId ID контакта

Обновление одного груза

Важно

Обновление груза доступно не чаще одного раза в 60 минут. При более частом вызове метод возвращает ошибку c HTTP статусом 403 и кодом cargo_application_delay_not_ellapsed.

Версия 2 1

Позволяет обновить груз с указанным id. Обновление груза нужно, чтобы он поднимался на более высокие позиции в поисковой выдаче.

put /v2/cargos/{requestedCargoApplicationId}/refresh

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v2/cargos/{requestedCargoApplicationId}/refresh' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v2/cargos/{requestedCargoApplicationId}/refresh");

Ответ

200 Success

Модель

null

Пример

null

Консоль

Отправить

Параметры

requestedCargoApplicationId

Позволяет обновить груз с указанным id. Обновление грузов нужно, чтобы ваш груз показывался в списке грузов на более высокой позиции. Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

put /v1.0/loads/{loadId}/renew

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/renew' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/{loadId}/renew");

Ответ

200 Статус

Модель

{...}

any-key:{...}

Status: int32

Статус операции для груза.

• 8 - Произошла внутренняя ошибка при обработке груза
• 7 - Ошибка валидации груза
• 6 - Груз был объединен с другим грузом
• 5 - Найден дубликат в актуальных грузах
• 4 - Груз зарезервирован/взят, операции с грузом запрещены
• 3 - Нет доступа
• 2 - Груз был обновлен или добавлен менее часа назад
• 1 - Груз не найден
• 0 - Успех
• -1 - Меньше 0 - произошла незапланированная ошибка

Message: string

Сообщение, которое отдается пользователю

}

}

Пример

{...}

"any-key":{...}

"Status":0,

"Message":"string"

}

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

loadId ID груза

Обновление нескольких грузов

Важно

Обновление выполняется только для тех грузов, у которых с прошлого обновления прошло более 60 минут. Для грузов, по которым 60-минутная пауза еще не истекла, в ответе возвращается ошибка по конкретному грузу с кодом cargo_application_delay_not_ellapsed. HTTP-статус метода будет 200 OK даже если часть грузов не была обновлена.

Версия 2 1

Позволяет обновить грузы с указанными id. Обновление груза нужно, чтобы он поднимался на более высокие позиции в поисковой выдаче.

put /v2/cargos/refresh

Модель и примеры

Запрос

Модель

[uuid]

Пример запроса

CURL

curl 'https://api.ati.su/v2/cargos/refresh' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '["3fa85f64-5717-4562-b3fc-2c963f66afa6"]'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v2/cargos/refresh", "[""3fa85f64-5717-4562-b3fc-2c963f66afa6""]");

Ответ

200 Success

Модель

{...}

refresh_operation_responses:{...}

Результаты обновления грузов

any-key:{...}

message: string

status_code: string

}

}

}

Пример

{...}

"refresh_operation_responses":{...}

"any-key":{...}

"message":"string",

"status_code":"string"

}

}

}

Консоль

Отправить

Параметры

Нет параметров

[ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ]

Позволяет обновить грузы с указанными id. Обновление грузов нужно, чтобы ваш груз показывался в списке грузов на более высокой позиции. Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

put /v1.0/loads/renew

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/renew' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/renew");

Ответ

200 Статус

Модель

{...}

any-key:{...}

Status: int32

Статус операции для груза.

• 8 - Произошла внутренняя ошибка при обработке груза
• 7 - Ошибка валидации груза
• 6 - Груз был объединен с другим грузом
• 5 - Найден дубликат в актуальных грузах
• 4 - Груз зарезервирован/взят, операции с грузом запрещены
• 3 - Нет доступа
• 2 - Груз был обновлен или добавлен менее часа назад
• 1 - Груз не найден
• 0 - Успех
• -1 - Меньше 0 - произошла незапланированная ошибка

Message: string

Сообщение, которое отдается пользователю

}

}

Пример

{...}

"any-key":{...}

"Status":0,

"Message":"string"

}

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

ids

Удаление одного груза

Позволяет удалить груз с указанным id.

delete /v1.0/loads/{loadId}

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.0/loads/{loadId}");

Ответ

200 Статус

Модель

{...}

any-key:{...}

Status: int32

Статус операции для груза.

• 8 - Произошла внутренняя ошибка при обработке груза
• 7 - Ошибка валидации груза
• 6 - Груз был объединен с другим грузом
• 5 - Найден дубликат в актуальных грузах
• 4 - Груз зарезервирован/взят, операции с грузом запрещены
• 3 - Нет доступа
• 2 - Груз был обновлен или добавлен менее часа назад
• 1 - Груз не найден
• 0 - Успех
• -1 - Меньше 0 - произошла незапланированная ошибка

Message: string

Сообщение, которое отдается пользователю

}

}

Пример

{...}

"any-key":{...}

"Status":0,

"Message":"string"

}

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

loadId ID груза

Удаление нескольких грузов

Позволяет удалить грузы с указанными id.

delete /v1.0/loads

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.0/loads");

Ответ

200 Статус

Модель

{...}

any-key:{...}

Status: int32

Статус операции для груза.

• 8 - Произошла внутренняя ошибка при обработке груза
• 7 - Ошибка валидации груза
• 6 - Груз был объединен с другим грузом
• 5 - Найден дубликат в актуальных грузах
• 4 - Груз зарезервирован/взят, операции с грузом запрещены
• 3 - Нет доступа
• 2 - Груз был обновлен или добавлен менее часа назад
• 1 - Груз не найден
• 0 - Успех
• -1 - Меньше 0 - произошла незапланированная ошибка

Message: string

Сообщение, которое отдается пользователю

}

}

Пример

{...}

"any-key":{...}

"Status":0,

"Message":"string"

}

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

ids ID грузов

Изменение приоритетного показа

Версия 1.0 2

Изменение параметров приоритетного показа у груза. Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией 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

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}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/{loadId}/priority", "{""DailyLimit"":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

Идентификатор первого выбранного контакта.
Список всех контактов и их идентификаторы можно получить с помощью 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 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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)

Широта города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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

}

}]

}

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 символов

MoneySpentPerDay: decimal

Количество денег, потраченное на заявку за день. Только для чтения

MoneySpentPerOrder: decimal

Количество денег, потраченное на заявку в целом. Только для чтения

}

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 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.

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

Показывает разрешено ли бронирование грузов на Общей площадке
Учитывается только для Общей площадки, только при включенном Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Показывает является ли площадка Общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC.
Может иметь значение null.
Минимальное значение равно текущей дате.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null.
Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

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":[...],

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,

"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"

}

Консоль

Отправить

Параметры

loadId ID груза

{ "DailyLimit": 0.5, "IsForPayedOnly": false, "OrderLimit": 0.5, "ViewRate": 0.5, "MoneySpentPerDay": 0.5, "MoneySpentPerOrder": 0.5 }

put /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

curl 'https://api.ati.su/v2/cargos/{cargoApplicationId}/priority-view' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"priority_view":{"view_rate":0.5,"daily_limit":0.5,"order_limit":0.5,"is_for_paid_only":false}}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/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

Модель

null

Пример

null

Консоль

Отправить

Параметры

cargoApplicationId

{ "priority_view": { "view_rate": 0.5, "daily_limit": 0.5, "order_limit": 0.5, "is_for_paid_only": false } }

Удаление приоритетного показа

Версия 1.0 2

Обнуление параметров приоритетного показа у груза. Данная версия метода устарела и её поддержка будет прекращена. Пожалуйста, пользуйтесь актуальной версией API.

delete /v1.0/loads/{loadId}/priority

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/priority' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.0/loads/{loadId}/priority");

Ответ

200 Актуальное состояние груза

Модель

{...}

LoadMeta:{...}

Метаданные для интеграторов

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 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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)

Широта города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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

}

}]

}

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 символов

MoneySpentPerDay: decimal

Количество денег, потраченное на заявку за день. Только для чтения

MoneySpentPerOrder: decimal

Количество денег, потраченное на заявку в целом. Только для чтения

}

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 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.

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

Показывает разрешено ли бронирование грузов на Общей площадке
Учитывается только для Общей площадки, только при включенном Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Показывает является ли площадка Общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC.
Может иметь значение null.
Минимальное значение равно текущей дате.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null.
Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

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":[...],

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,

"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"

}

Консоль

Отправить

Параметры

loadId ID груза

delete /v2/cargos/{cargoApplicationId}/priority-view

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v2/cargos/{cargoApplicationId}/priority-view' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v2/cargos/{cargoApplicationId}/priority-view");

Ответ

200 Success

Модель

null

Пример

null

Консоль

Отправить

Параметры

cargoApplicationId

Методы для работы с комментариями к грузам

Получение всех комментариев ко всем грузам для текущей фирмы

Ответ будет представлен в виде словаря, где ключ - это id груза, а значение - массив структуры “комментарий”.

Получение всех комментариев фирмы ко всем грузам

get /v1.0/loads/comments

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/comments' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/comments");

Ответ

200 Комментарии ко всем грузам фирмы

Модель

{...}

any-key:[{...}]

CommentId: guid

Идентификатор комментария

Message: string

Комментарий

ContactId: int32

Контакт фирмы, который оставил комментарий

CommentDateTime: date-time

Время, когда комментарий был оставлен

}]

}

Пример

{...}

"any-key":[...]

{...}

"CommentId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Message":"string",

"ContactId":0,

"CommentDateTime":"1970-01-01T00:00:00.000Z"

}

]

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

Нет параметров

Получение всех комментариев к грузу для текущей фирмы

Получение всех комментариев к грузу для текущей фирмы.

get /v1.0/loads/{loadId}/comments

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/comments' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/{loadId}/comments");

Ответ

200 Комментарии к грузу

Модель

[{...}]

CommentId: guid

Идентификатор комментария

Message: string

Комментарий

ContactId: int32

Контакт фирмы, который оставил комментарий

CommentDateTime: date-time

Время, когда комментарий был оставлен

}]

Пример

[...]

{...}

"CommentId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Message":"string",

"ContactId":0,

"CommentDateTime":"1970-01-01T00:00:00.000Z"

}

]

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

loadId ID груза

Добавление либо редактирование комментария к грузу

При редактировании комментария у изменённого комментария поменяется CommentId.

Требования к комментарию

• комментарий не может быть пустым
• длина комментария не более 128 символов
• если для фирмы включен режим раздельного доступа, то количество комментариев к одному грузу ограничено одним комментарием на контакт, иначе – одним комментарием на фирму

Добавление либо редактирование комментария к грузу

put /v1.0/loads/{loadId}/comments

Модель и примеры

Запрос

Модель

string

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/comments' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '"string"'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/{loadId}/comments", """string""");

Ответ

200 Комментарий к грузу

Модель

{...}

CommentId: guid

Идентификатор комментария

Message: string

Комментарий

ContactId: int32

Контакт фирмы, который оставил комментарий

CommentDateTime: date-time

Время, когда комментарий был оставлен

}

Пример

{...}

"CommentId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Message":"string",

"ContactId":0,

"CommentDateTime":"1970-01-01T00:00:00.000Z"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

loadId ID груза

"string"

Удаление комментария у груза

Удаление комментария у груза.

delete /v1.0/loads/{loadId}/comments

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/comments' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.0/loads/{loadId}/comments");

Ответ

200 Комментарий к грузу успешно удален

Модель

string

Пример

"string"

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

loadId ID груза

Методы для работы с отзывами к грузам

Отзыв может быть “Встречным предложением” с одной или несколькими ставками, “Груза нет”, “Озвученная ставка”.

Требования к дате, передаваемой в dateFrom при отправке запросов на получение отзывов:

• Дата в UTC, начиная с которой необходимо показывать отзывы. Если ничего не передано, значит показываем абсолютно все отзывы
• Формат даты: yyyy-mm-ddThh:mm:ss<timezone_specifier>, где timezone_specifier обозначает спецификатор часового пояса, например:
  • Z - дата в формате UTC. Пример, 2016-04-28T20:01:57Z;
  • -hh:mm - часовой пояс UTC-hh:mm. Пример UTC-1: 2016-04-28T20:01:57-01:00;
  • %2Bhh:mm - часовой пояс UTC+hh:mm. Пример UTC+1: 2016-04-28T20:01:57%2B01:00;
• Если модификатора часового пояса нет, дата отправляется в формате UTC±00:00

Методы API для работы со встречными предложениями по грузам

Создание встречного предложения

Метод используется для первичной отправки встречного предложения по грузу cargoId. После успешного вызова сохраните Id встречного предложения из ответа: он потребуется для изменения и удаления.

post /gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers

Модель и примеры

Запрос

Модель

{...}

contact_id*: int32

Контакт, от лица которого выставляется встречное предложение

price*: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id*: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price*: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id*: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price*: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id*: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

prepay_percent*: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days*: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти груз

pay_attributes*: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

}

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"contact_id":0,"price":0.5,"currency_id":0,"nds_price":0.5,"nds_currency_id":0,"not_nds_price":0.5,"not_nds_currency_id":0,"note":"string","prepay_percent":0,"pay_after_max_bank_days":0,"loading_date":"1970-01-01T00:00:00.000Z","pay_attributes":0}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers", "{""contact_id"":0,""price"":0.5,""currency_id"":0,""nds_price"":0.5,""nds_currency_id"":0,""not_nds_price"":0.5,""not_nds_currency_id"":0,""note"":""string"",""prepay_percent"":0,""pay_after_max_bank_days"":0,""loading_date"":""1970-01-01T00:00:00.000Z"",""pay_attributes"":0}");

Ответ

200 Созданное встречное предложение

Модель

{...}

id: uuid

Id встречного предложения

cargo_id: uuid

Id груза, на который оставлено встречное предложение

cargo_number: string

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32 (nullable)

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

counter_offer_source: int32

Обозначение источника, откуда добавлено встречное предложение.

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным. Только для чтения.

is_cargo_published: boolean

Относится ли встречное предложение к публикующемуся грузу. Только для чтения.

firm_info:{...}

Информация о фирме, оставившей встречное предложение

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Статус фирмы

full_firm_name: string

Полное название фирмы

contact:{...}

Информация о контакте фирмы, оставившем встречное предложение

id: int32

Id контакта в фирме

name: string (nullable)

Имя контакта

telephone: string (nullable)

Телефон

email: string (nullable)

Электронная почта

icq: string (nullable)

Аккаунт ICQ

mobile: string (nullable)

Телефон (мобильный)

mobile_operator: string (nullable)

Мобильный оператор

skype_name: string (nullable)

Аккаунт Skype

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

location:{...}

Информация о местоположении фирмы

city_id: int32

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

full_name: string (nullable)

Составное название из названий города, региона и страны, разделенных запятой

short_name: string (nullable)

Составное название из города, региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

is_regional_center: boolean

Является ли город региональным центром

city_size: int32

Размер города по числу жителей

fias_id: uuid (nullable)

Id в базе ФИАС

attributes: int32

Атрибуты города

city_name: string

Название города

region_name: string (nullable)

Название региона

country_name: string (nullable)

Название страны

country_code_name: string (nullable)

Буквенный код страны

}

}

inn: string (nullable)

ИНН

}

}

Пример

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"string",

"cargo_firm_id":0,

"firm_id":0,

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"price":0.5,

"currency_id":0,

"nds_price":0.5,

"nds_currency_id":0,

"not_nds_price":0.5,

"not_nds_currency_id":0,

"counter_offer_source":0,

"note":"string",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"1970-01-01T00:00:00.000Z",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":0.5,

"status":0,

"full_firm_name":"string",

"contact":{...},

"id":0,

"name":"string",

"telephone":"string",

"email":"string",

"icq":"string",

"mobile":"string",

"mobile_operator":"string",

"skype_name":"string",

"city_id":0,

"location":{...}

"city_id":0,

"region_id":0,

"country_id":0,

"full_name":"string",

"short_name":"string",

"is_regional_center":false,

"city_size":0,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"attributes":0,

"city_name":"string",

"region_name":"string",

"country_name":"string",

"country_code_name":"string"

}

},

"inn":"string"

}

}

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId Id груза, для которого создаётся встречное предложение

{ "contact_id": 0, "price": 0.5, "currency_id": 0, "nds_price": 0.5, "nds_currency_id": 0, "not_nds_price": 0.5, "not_nds_currency_id": 0, "note": "string", "prepay_percent": 0, "pay_after_max_bank_days": 0, "loading_date": "1970-01-01T00:00:00.000Z", "pay_attributes": 0 }

Изменение встречного предложения

Метод изменяет уже отправленное встречное предложение по id. Используйте его, когда меняются ставка, условия оплаты или комментарий, чтобы не создавать дублирующие предложения.

put /gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/{id}

Модель и примеры

Запрос

Модель

{...}

contact_id*: int32

Контакт, от лица которого выставляется встречное предложение

price*: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id*: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price*: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id*: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price*: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id*: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

prepay_percent*: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days*: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти груз

pay_attributes*: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

}

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/{id}' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"contact_id":0,"price":0.5,"currency_id":0,"nds_price":0.5,"nds_currency_id":0,"not_nds_price":0.5,"not_nds_currency_id":0,"note":"string","prepay_percent":0,"pay_after_max_bank_days":0,"loading_date":"1970-01-01T00:00:00.000Z","pay_attributes":0}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/{id}", "{""contact_id"":0,""price"":0.5,""currency_id"":0,""nds_price"":0.5,""nds_currency_id"":0,""not_nds_price"":0.5,""not_nds_currency_id"":0,""note"":""string"",""prepay_percent"":0,""pay_after_max_bank_days"":0,""loading_date"":""1970-01-01T00:00:00.000Z"",""pay_attributes"":0}");

Ответ

200 Измененное встречное предложение

Модель

{...}

id: uuid

Id встречного предложения

cargo_id: uuid

Id груза, на который оставлено встречное предложение

cargo_number: string

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32 (nullable)

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

counter_offer_source: int32

Обозначение источника, откуда добавлено встречное предложение.

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным. Только для чтения.

is_cargo_published: boolean

Относится ли встречное предложение к публикующемуся грузу. Только для чтения.

firm_info:{...}

Информация о фирме, оставившей встречное предложение

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Статус фирмы

full_firm_name: string

Полное название фирмы

contact:{...}

Информация о контакте фирмы, оставившем встречное предложение

id: int32

Id контакта в фирме

name: string (nullable)

Имя контакта

telephone: string (nullable)

Телефон

email: string (nullable)

Электронная почта

icq: string (nullable)

Аккаунт ICQ

mobile: string (nullable)

Телефон (мобильный)

mobile_operator: string (nullable)

Мобильный оператор

skype_name: string (nullable)

Аккаунт Skype

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

location:{...}

Информация о местоположении фирмы

city_id: int32

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

full_name: string (nullable)

Составное название из названий города, региона и страны, разделенных запятой

short_name: string (nullable)

Составное название из города, региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

is_regional_center: boolean

Является ли город региональным центром

city_size: int32

Размер города по числу жителей

fias_id: uuid (nullable)

Id в базе ФИАС

attributes: int32

Атрибуты города

city_name: string

Название города

region_name: string (nullable)

Название региона

country_name: string (nullable)

Название страны

country_code_name: string (nullable)

Буквенный код страны

}

}

inn: string (nullable)

ИНН

}

}

Пример

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"string",

"cargo_firm_id":0,

"firm_id":0,

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"price":0.5,

"currency_id":0,

"nds_price":0.5,

"nds_currency_id":0,

"not_nds_price":0.5,

"not_nds_currency_id":0,

"counter_offer_source":0,

"note":"string",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"1970-01-01T00:00:00.000Z",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":0.5,

"status":0,

"full_firm_name":"string",

"contact":{...},

"id":0,

"name":"string",

"telephone":"string",

"email":"string",

"icq":"string",

"mobile":"string",

"mobile_operator":"string",

"skype_name":"string",

"city_id":0,

"location":{...}

"city_id":0,

"region_id":0,

"country_id":0,

"full_name":"string",

"short_name":"string",

"is_regional_center":false,

"city_size":0,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"attributes":0,

"city_name":"string",

"region_name":"string",

"country_name":"string",

"country_code_name":"string"

}

},

"inn":"string"

}

}

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId Id груза, к которому относится изменяемое встречное предложение

id Id встречного предложения

{ "contact_id": 0, "price": 0.5, "currency_id": 0, "nds_price": 0.5, "nds_currency_id": 0, "not_nds_price": 0.5, "not_nds_currency_id": 0, "note": "string", "prepay_percent": 0, "pay_after_max_bank_days": 0, "loading_date": "1970-01-01T00:00:00.000Z", "pay_attributes": 0 }

Удаление своих встречных предложений для чужого опубликованного груза

Метод позволяет снять свои встречные предложения с чужого опубликованного груза. Используйте его, когда нужно отозвать участие в торге без влияния на предложения других участников.

delete /gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/my

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/my' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/my");

Ответ

200 Успешное удаление

Модель

{...}

success: boolean

Признак успешного удаления

}

Пример

{...}

"success":true

}

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId Id чужого опубликованного груза, для которого нужно удалить свои встречные предложения

Удаление чужих встречных предложений для своего груза

Метод используется владельцем груза для удаления выбранных входящих предложений. Передавайте в body массив counterOfferIds, чтобы удалить только нужные предложения.

delete /gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers

Модель и примеры

Запрос

Модель

[uuid]

Список id встречных предложений, которые нужно удалить

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '["c1a01f34-d39a-4fbc-b67d-065afce257e8"]'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers", "[""c1a01f34-d39a-4fbc-b67d-065afce257e8""]");

Ответ

200 Статусы удаления по встречным предложениям

Модель

{...}

any-key:{...}

status: int32

Статус операции.

• 1 - Груз не найден
• 0 - Успех
• 9 - Встречное предложение на груз не найдено
• <0 - Произошла незапланированная ошибка

message: string (nullable)

Сообщение о результате

error: string (nullable)

Ключ ошибки

result:{...}

Встречное предложение

id: uuid

Id встречного предложения

cargo_id: uuid

Id груза, на который оставлено встречное предложение

cargo_number: string

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32 (nullable)

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

counter_offer_source: int32

Обозначение источника, откуда добавлено встречное предложение.

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным. Только для чтения.

is_cargo_published: boolean

Относится ли встречное предложение к публикующемуся грузу. Только для чтения.

firm_info:{...}

Информация о фирме, оставившей встречное предложение

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Статус фирмы

full_firm_name: string

Полное название фирмы

contact:{...}

Информация о контакте фирмы, оставившем встречное предложение

id: int32

Id контакта в фирме

name: string (nullable)

Имя контакта

telephone: string (nullable)

Телефон

email: string (nullable)

Электронная почта

icq: string (nullable)

Аккаунт ICQ

mobile: string (nullable)

Телефон (мобильный)

mobile_operator: string (nullable)

Мобильный оператор

skype_name: string (nullable)

Аккаунт Skype

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

location:{...}

Информация о местоположении фирмы

city_id: int32

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

full_name: string (nullable)

Составное название из названий города, региона и страны, разделенных запятой

short_name: string (nullable)

Составное название из города, региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

is_regional_center: boolean

Является ли город региональным центром

city_size: int32

Размер города по числу жителей

fias_id: uuid (nullable)

Id в базе ФИАС

attributes: int32

Атрибуты города

city_name: string

Название города

region_name: string (nullable)

Название региона

country_name: string (nullable)

Название страны

country_code_name: string (nullable)

Буквенный код страны

}

}

inn: string (nullable)

ИНН

}

}

}

}

Пример

{...}

"any-key":{...}

"status":0,

"message":"string",

"error":"string",

"result":{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"string",

"cargo_firm_id":0,

"firm_id":0,

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"price":0.5,

"currency_id":0,

"nds_price":0.5,

"nds_currency_id":0,

"not_nds_price":0.5,

"not_nds_currency_id":0,

"counter_offer_source":0,

"note":"string",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"1970-01-01T00:00:00.000Z",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":0.5,

"status":0,

"full_firm_name":"string",

"contact":{...},

"id":0,

"name":"string",

"telephone":"string",

"email":"string",

"icq":"string",

"mobile":"string",

"mobile_operator":"string",

"skype_name":"string",

"city_id":0,

"location":{...}

"city_id":0,

"region_id":0,

"country_id":0,

"full_name":"string",

"short_name":"string",

"is_regional_center":false,

"city_size":0,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"attributes":0,

"city_name":"string",

"region_name":"string",

"country_name":"string",

"country_code_name":"string"

}

},

"inn":"string"

}

}

}

}

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId Id своего опубликованного груза, для которого нужно удалить чужие встречные предложения

[ "c1a01f34-d39a-4fbc-b67d-065afce257e8" ]

Получение встречных предложений для опубликованного груза

Метод возвращает предложения по конкретному опубликованному грузу. Чтобы получать встречные предложения, которые были созданы или изменились с определенного момента времени, используйте параметр fromDate.

get /gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers");

Ответ

200 Список встречных предложений

Модель

[{...}]

id: uuid

Id встречного предложения

cargo_id: uuid

Id груза, на который оставлено встречное предложение

cargo_number: string

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32 (nullable)

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

counter_offer_source: int32

Обозначение источника, откуда добавлено встречное предложение.

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным. Только для чтения.

is_cargo_published: boolean

Относится ли встречное предложение к публикующемуся грузу. Только для чтения.

firm_info:{...}

Информация о фирме, оставившей встречное предложение

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Статус фирмы

full_firm_name: string

Полное название фирмы

contact:{...}

Информация о контакте фирмы, оставившем встречное предложение

id: int32

Id контакта в фирме

name: string (nullable)

Имя контакта

telephone: string (nullable)

Телефон

email: string (nullable)

Электронная почта

icq: string (nullable)

Аккаунт ICQ

mobile: string (nullable)

Телефон (мобильный)

mobile_operator: string (nullable)

Мобильный оператор

skype_name: string (nullable)

Аккаунт Skype

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

location:{...}

Информация о местоположении фирмы

city_id: int32

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

full_name: string (nullable)

Составное название из названий города, региона и страны, разделенных запятой

short_name: string (nullable)

Составное название из города, региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

is_regional_center: boolean

Является ли город региональным центром

city_size: int32

Размер города по числу жителей

fias_id: uuid (nullable)

Id в базе ФИАС

attributes: int32

Атрибуты города

city_name: string

Название города

region_name: string (nullable)

Название региона

country_name: string (nullable)

Название страны

country_code_name: string (nullable)

Буквенный код страны

}

}

inn: string (nullable)

ИНН

}

}]

Пример

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"string",

"cargo_firm_id":0,

"firm_id":0,

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"price":0.5,

"currency_id":0,

"nds_price":0.5,

"nds_currency_id":0,

"not_nds_price":0.5,

"not_nds_currency_id":0,

"counter_offer_source":0,

"note":"string",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"1970-01-01T00:00:00.000Z",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":0.5,

"status":0,

"full_firm_name":"string",

"contact":{...},

"id":0,

"name":"string",

"telephone":"string",

"email":"string",

"icq":"string",

"mobile":"string",

"mobile_operator":"string",

"skype_name":"string",

"city_id":0,

"location":{...}

"city_id":0,

"region_id":0,

"country_id":0,

"full_name":"string",

"short_name":"string",

"is_regional_center":false,

"city_size":0,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"attributes":0,

"city_name":"string",

"region_name":"string",

"country_name":"string",

"country_code_name":"string"

}

},

"inn":"string"

}

}

]

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId Id груза, для которого нужно получить встречные предложения

fromDate Дата в UTC, начиная с которой необходимо показывать встречные предложения. Если ничего не передано, показываются все встречные предложения.

Получение встречных предложений для всех опубликованных грузов

Метод возвращает предложения по всем опубликованным грузам фирмы. Обычно используется в фоновой синхронизации с fromDate, чтобы не загружать полный список при каждом опросе.

get /gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers");

Ответ

200 Список встречных предложений

Модель

[{...}]

id: uuid

Id встречного предложения

cargo_id: uuid

Id груза, на который оставлено встречное предложение

cargo_number: string

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32 (nullable)

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

counter_offer_source: int32

Обозначение источника, откуда добавлено встречное предложение.

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным. Только для чтения.

is_cargo_published: boolean

Относится ли встречное предложение к публикующемуся грузу. Только для чтения.

firm_info:{...}

Информация о фирме, оставившей встречное предложение

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Статус фирмы

full_firm_name: string

Полное название фирмы

contact:{...}

Информация о контакте фирмы, оставившем встречное предложение

id: int32

Id контакта в фирме

name: string (nullable)

Имя контакта

telephone: string (nullable)

Телефон

email: string (nullable)

Электронная почта

icq: string (nullable)

Аккаунт ICQ

mobile: string (nullable)

Телефон (мобильный)

mobile_operator: string (nullable)

Мобильный оператор

skype_name: string (nullable)

Аккаунт Skype

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

location:{...}

Информация о местоположении фирмы

city_id: int32

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

full_name: string (nullable)

Составное название из названий города, региона и страны, разделенных запятой

short_name: string (nullable)

Составное название из города, региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

is_regional_center: boolean

Является ли город региональным центром

city_size: int32

Размер города по числу жителей

fias_id: uuid (nullable)

Id в базе ФИАС

attributes: int32

Атрибуты города

city_name: string

Название города

region_name: string (nullable)

Название региона

country_name: string (nullable)

Название страны

country_code_name: string (nullable)

Буквенный код страны

}

}

inn: string (nullable)

ИНН

}

}]

Пример

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"string",

"cargo_firm_id":0,

"firm_id":0,

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"price":0.5,

"currency_id":0,

"nds_price":0.5,

"nds_currency_id":0,

"not_nds_price":0.5,

"not_nds_currency_id":0,

"counter_offer_source":0,

"note":"string",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"1970-01-01T00:00:00.000Z",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":0.5,

"status":0,

"full_firm_name":"string",

"contact":{...},

"id":0,

"name":"string",

"telephone":"string",

"email":"string",

"icq":"string",

"mobile":"string",

"mobile_operator":"string",

"skype_name":"string",

"city_id":0,

"location":{...}

"city_id":0,

"region_id":0,

"country_id":0,

"full_name":"string",

"short_name":"string",

"is_regional_center":false,

"city_size":0,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"attributes":0,

"city_name":"string",

"region_name":"string",

"country_name":"string",

"country_code_name":"string"

}

},

"inn":"string"

}

}

]

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

fromDate Дата в UTC, начиная с которой необходимо показывать встречные предложения. Если ничего не передано, показываются все встречные предложения.

Получение встречных предложений для опубликованных грузов по их ID

Ответ будет представлен в виде словаря, где ключ - id груза, а значение - структура со статусом и списком встречных предложений, содержащий:

• Result, представляющий набор встречных предложений для данного груза;
• Status, представляющий статус груза: если груз с таким id не найден у вашей фирмы, статус равен 1, иначе статус равен 0. Если у груза статус равен 1, то массив встречных предложений всегда пуст.

Список ключей словаря полностью совпадает со списком грузов, для которых были запрошены встречные предложения. Параметр onlyActual используйте, если в интеграции нужно работать только с актуальными предложениями.

get /gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/by-cargo-ids

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/by-cargo-ids' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/by-cargo-ids");

Ответ

200 Словарь встречных предложений по грузам

Модель

{...}

any-key:{...}

status: int32

Статус операции.

• 1 - Груз не найден
• 0 - Успех
• 9 - Встречное предложение на груз не найдено
• <0 - Произошла незапланированная ошибка

message: string (nullable)

Сообщение о результате

error: string (nullable)

Ключ ошибки

result:[{...}]

Список встречных предложений

id: uuid

Id встречного предложения

cargo_id: uuid

Id груза, на который оставлено встречное предложение

cargo_number: string

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32 (nullable)

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

counter_offer_source: int32

Обозначение источника, откуда добавлено встречное предложение.

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным. Только для чтения.

is_cargo_published: boolean

Относится ли встречное предложение к публикующемуся грузу. Только для чтения.

firm_info:{...}

Информация о фирме, оставившей встречное предложение

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Статус фирмы

full_firm_name: string

Полное название фирмы

contact:{...}

Информация о контакте фирмы, оставившем встречное предложение

id: int32

Id контакта в фирме

name: string (nullable)

Имя контакта

telephone: string (nullable)

Телефон

email: string (nullable)

Электронная почта

icq: string (nullable)

Аккаунт ICQ

mobile: string (nullable)

Телефон (мобильный)

mobile_operator: string (nullable)

Мобильный оператор

skype_name: string (nullable)

Аккаунт Skype

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

location:{...}

Информация о местоположении фирмы

city_id: int32

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

full_name: string (nullable)

Составное название из названий города, региона и страны, разделенных запятой

short_name: string (nullable)

Составное название из города, региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

is_regional_center: boolean

Является ли город региональным центром

city_size: int32

Размер города по числу жителей

fias_id: uuid (nullable)

Id в базе ФИАС

attributes: int32

Атрибуты города

city_name: string

Название города

region_name: string (nullable)

Название региона

country_name: string (nullable)

Название страны

country_code_name: string (nullable)

Буквенный код страны

}

}

inn: string (nullable)

ИНН

}

}]

}

}

Пример

{...}

"any-key":{...}

"status":0,

"message":"string",

"error":"string",

"result":[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"string",

"cargo_firm_id":0,

"firm_id":0,

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"price":0.5,

"currency_id":0,

"nds_price":0.5,

"nds_currency_id":0,

"not_nds_price":0.5,

"not_nds_currency_id":0,

"counter_offer_source":0,

"note":"string",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"1970-01-01T00:00:00.000Z",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":0.5,

"status":0,

"full_firm_name":"string",

"contact":{...},

"id":0,

"name":"string",

"telephone":"string",

"email":"string",

"icq":"string",

"mobile":"string",

"mobile_operator":"string",

"skype_name":"string",

"city_id":0,

"location":{...}

"city_id":0,

"region_id":0,

"country_id":0,

"full_name":"string",

"short_name":"string",

"is_regional_center":false,

"city_size":0,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"attributes":0,

"city_name":"string",

"region_name":"string",

"country_name":"string",

"country_code_name":"string"

}

},

"inn":"string"

}

}

]

}

}

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

dateFrom Дата в UTC, начиная с которой необходимо показывать встречные предложения. Если ничего не передано, показываются все встречные предложения.

onlyActual true false Только актуальные встречные предложения

cargoIds Массив id грузов, для которых нужно получить встречные предложения

Получение статусов своих встречных предложений на чужие грузы

Метод возвращает статусы ваших предложений по чужим грузам. Удобен как быстрый предварительный шаг перед детальной загрузкой самих предложений.

get /gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/statuses

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/statuses' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/statuses");

Ответ

200 Список статусов

Модель

[{...}]

cargo_id: uuid

Id груза

has_active: boolean

Есть ли активные встречные предложения по грузу

}]

Пример

[...]

{...}

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"has_active":false

}

]

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

dateFrom Дата в UTC, начиная с которой необходимо показывать встречные предложения. Если ничего не передано, показываются все встречные предложения.

Получение встречного предложения по его ID

Метод возвращает одно конкретное предложение по id. Используйте его, когда нужно открыть карточку предложения напрямую, без загрузки общих списков.

get /gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/{id}

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/{id}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/{id}");

Ответ

200 Встречное предложение

Модель

{...}

id: uuid

Id встречного предложения

cargo_id: uuid

Id груза, на который оставлено встречное предложение

cargo_number: string

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32 (nullable)

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

counter_offer_source: int32

Обозначение источника, откуда добавлено встречное предложение.

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным. Только для чтения.

is_cargo_published: boolean

Относится ли встречное предложение к публикующемуся грузу. Только для чтения.

firm_info:{...}

Информация о фирме, оставившей встречное предложение

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Статус фирмы

full_firm_name: string

Полное название фирмы

contact:{...}

Информация о контакте фирмы, оставившем встречное предложение

id: int32

Id контакта в фирме

name: string (nullable)

Имя контакта

telephone: string (nullable)

Телефон

email: string (nullable)

Электронная почта

icq: string (nullable)

Аккаунт ICQ

mobile: string (nullable)

Телефон (мобильный)

mobile_operator: string (nullable)

Мобильный оператор

skype_name: string (nullable)

Аккаунт Skype

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

location:{...}

Информация о местоположении фирмы

city_id: int32

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

full_name: string (nullable)

Составное название из названий города, региона и страны, разделенных запятой

short_name: string (nullable)

Составное название из города, региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

is_regional_center: boolean

Является ли город региональным центром

city_size: int32

Размер города по числу жителей

fias_id: uuid (nullable)

Id в базе ФИАС

attributes: int32

Атрибуты города

city_name: string

Название города

region_name: string (nullable)

Название региона

country_name: string (nullable)

Название страны

country_code_name: string (nullable)

Буквенный код страны

}

}

inn: string (nullable)

ИНН

}

}

Пример

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"string",

"cargo_firm_id":0,

"firm_id":0,

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"price":0.5,

"currency_id":0,

"nds_price":0.5,

"nds_currency_id":0,

"not_nds_price":0.5,

"not_nds_currency_id":0,

"counter_offer_source":0,

"note":"string",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"1970-01-01T00:00:00.000Z",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":0.5,

"status":0,

"full_firm_name":"string",

"contact":{...},

"id":0,

"name":"string",

"telephone":"string",

"email":"string",

"icq":"string",

"mobile":"string",

"mobile_operator":"string",

"skype_name":"string",

"city_id":0,

"location":{...}

"city_id":0,

"region_id":0,

"country_id":0,

"full_name":"string",

"short_name":"string",

"is_regional_center":false,

"city_size":0,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"attributes":0,

"city_name":"string",

"region_name":"string",

"country_name":"string",

"country_code_name":"string"

}

},

"inn":"string"

}

}

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

id Id встречного предложения

Получение встречных предложений для неопубликованных грузов

Метод возвращает предложения по всем неопубликованным грузам фирмы. Для получения только изменений передавайте fromDate.

get /gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers");

Ответ

200 Список встречных предложений

Модель

[{...}]

id: uuid

Id встречного предложения

cargo_id: uuid

Id груза, на который оставлено встречное предложение

cargo_number: string

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32 (nullable)

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

counter_offer_source: int32

Обозначение источника, откуда добавлено встречное предложение.

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным. Только для чтения.

is_cargo_published: boolean

Относится ли встречное предложение к публикующемуся грузу. Только для чтения.

firm_info:{...}

Информация о фирме, оставившей встречное предложение

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Статус фирмы

full_firm_name: string

Полное название фирмы

contact:{...}

Информация о контакте фирмы, оставившем встречное предложение

id: int32

Id контакта в фирме

name: string (nullable)

Имя контакта

telephone: string (nullable)

Телефон

email: string (nullable)

Электронная почта

icq: string (nullable)

Аккаунт ICQ

mobile: string (nullable)

Телефон (мобильный)

mobile_operator: string (nullable)

Мобильный оператор

skype_name: string (nullable)

Аккаунт Skype

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

location:{...}

Информация о местоположении фирмы

city_id: int32

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

full_name: string (nullable)

Составное название из названий города, региона и страны, разделенных запятой

short_name: string (nullable)

Составное название из города, региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

is_regional_center: boolean

Является ли город региональным центром

city_size: int32

Размер города по числу жителей

fias_id: uuid (nullable)

Id в базе ФИАС

attributes: int32

Атрибуты города

city_name: string

Название города

region_name: string (nullable)

Название региона

country_name: string (nullable)

Название страны

country_code_name: string (nullable)

Буквенный код страны

}

}

inn: string (nullable)

ИНН

}

}]

Пример

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"string",

"cargo_firm_id":0,

"firm_id":0,

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"price":0.5,

"currency_id":0,

"nds_price":0.5,

"nds_currency_id":0,

"not_nds_price":0.5,

"not_nds_currency_id":0,

"counter_offer_source":0,

"note":"string",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"1970-01-01T00:00:00.000Z",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":0.5,

"status":0,

"full_firm_name":"string",

"contact":{...},

"id":0,

"name":"string",

"telephone":"string",

"email":"string",

"icq":"string",

"mobile":"string",

"mobile_operator":"string",

"skype_name":"string",

"city_id":0,

"location":{...}

"city_id":0,

"region_id":0,

"country_id":0,

"full_name":"string",

"short_name":"string",

"is_regional_center":false,

"city_size":0,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"attributes":0,

"city_name":"string",

"region_name":"string",

"country_name":"string",

"country_code_name":"string"

}

},

"inn":"string"

}

}

]

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

fromDate Дата в UTC, начиная с которой необходимо показывать встречные предложения. Если ничего не передано, показываются все встречные предложения.

Получение встречных предложений для неопубликованного груза по его ID

Метод возвращает предложения по конкретному неопубликованному грузу. Подходит для карточки груза и получения только изменений с использованием fromDate.

get /gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers");

Ответ

200 Список встречных предложений

Модель

[{...}]

id: uuid

Id встречного предложения

cargo_id: uuid

Id груза, на который оставлено встречное предложение

cargo_number: string

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32 (nullable)

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

counter_offer_source: int32

Обозначение источника, откуда добавлено встречное предложение.

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным. Только для чтения.

is_cargo_published: boolean

Относится ли встречное предложение к публикующемуся грузу. Только для чтения.

firm_info:{...}

Информация о фирме, оставившей встречное предложение

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Статус фирмы

full_firm_name: string

Полное название фирмы

contact:{...}

Информация о контакте фирмы, оставившем встречное предложение

id: int32

Id контакта в фирме

name: string (nullable)

Имя контакта

telephone: string (nullable)

Телефон

email: string (nullable)

Электронная почта

icq: string (nullable)

Аккаунт ICQ

mobile: string (nullable)

Телефон (мобильный)

mobile_operator: string (nullable)

Мобильный оператор

skype_name: string (nullable)

Аккаунт Skype

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

location:{...}

Информация о местоположении фирмы

city_id: int32

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

full_name: string (nullable)

Составное название из названий города, региона и страны, разделенных запятой

short_name: string (nullable)

Составное название из города, региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

is_regional_center: boolean

Является ли город региональным центром

city_size: int32

Размер города по числу жителей

fias_id: uuid (nullable)

Id в базе ФИАС

attributes: int32

Атрибуты города

city_name: string

Название города

region_name: string (nullable)

Название региона

country_name: string (nullable)

Название страны

country_code_name: string (nullable)

Буквенный код страны

}

}

inn: string (nullable)

ИНН

}

}]

Пример

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"string",

"cargo_firm_id":0,

"firm_id":0,

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"price":0.5,

"currency_id":0,

"nds_price":0.5,

"nds_currency_id":0,

"not_nds_price":0.5,

"not_nds_currency_id":0,

"counter_offer_source":0,

"note":"string",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"1970-01-01T00:00:00.000Z",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":0.5,

"status":0,

"full_firm_name":"string",

"contact":{...},

"id":0,

"name":"string",

"telephone":"string",

"email":"string",

"icq":"string",

"mobile":"string",

"mobile_operator":"string",

"skype_name":"string",

"city_id":0,

"location":{...}

"city_id":0,

"region_id":0,

"country_id":0,

"full_name":"string",

"short_name":"string",

"is_regional_center":false,

"city_size":0,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"attributes":0,

"city_name":"string",

"region_name":"string",

"country_name":"string",

"country_code_name":"string"

}

},

"inn":"string"

}

}

]

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId Id неопубликованного груза, для которого нужно получить встречные предложения

fromDate Дата в UTC, начиная с которой необходимо показывать встречные предложения. Если ничего не передано, показываются все встречные предложения.

Получение встречных предложений для неопубликованных грузов по их ID

Ответ будет представлен в виде словаря, где ключ - id груза, а значение - структура со статусом и списком встречных предложений, содержащий:

• Result, представляющий набор встречных предложений для данного груза;
• Status, представляющий статус груза: если груз с таким id не найден у вашей фирмы, статус равен 1, иначе статус равен 0. Если у груза статус равен 1, то массив встречных предложений всегда пуст.

Список ключей словаря полностью совпадает со списком грузов, для которых были запрошены встречные предложения.

get /gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers/by-cargo-ids

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers/by-cargo-ids' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers/by-cargo-ids");

Ответ

200 Словарь встречных предложений по грузам

Модель

{...}

any-key:{...}

status: int32

Статус операции.

• 1 - Груз не найден
• 0 - Успех
• 9 - Встречное предложение на груз не найдено
• <0 - Произошла незапланированная ошибка

message: string (nullable)

Сообщение о результате

error: string (nullable)

Ключ ошибки

result:[{...}]

Список встречных предложений

id: uuid

Id встречного предложения

cargo_id: uuid

Id груза, на который оставлено встречное предложение

cargo_number: string

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32 (nullable)

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

counter_offer_source: int32

Обозначение источника, откуда добавлено встречное предложение.

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным. Только для чтения.

is_cargo_published: boolean

Относится ли встречное предложение к публикующемуся грузу. Только для чтения.

firm_info:{...}

Информация о фирме, оставившей встречное предложение

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Статус фирмы

full_firm_name: string

Полное название фирмы

contact:{...}

Информация о контакте фирмы, оставившем встречное предложение

id: int32

Id контакта в фирме

name: string (nullable)

Имя контакта

telephone: string (nullable)

Телефон

email: string (nullable)

Электронная почта

icq: string (nullable)

Аккаунт ICQ

mobile: string (nullable)

Телефон (мобильный)

mobile_operator: string (nullable)

Мобильный оператор

skype_name: string (nullable)

Аккаунт Skype

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

location:{...}

Информация о местоположении фирмы

city_id: int32

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

full_name: string (nullable)

Составное название из названий города, региона и страны, разделенных запятой

short_name: string (nullable)

Составное название из города, региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

is_regional_center: boolean

Является ли город региональным центром

city_size: int32

Размер города по числу жителей

fias_id: uuid (nullable)

Id в базе ФИАС

attributes: int32

Атрибуты города

city_name: string

Название города

region_name: string (nullable)

Название региона

country_name: string (nullable)

Название страны

country_code_name: string (nullable)

Буквенный код страны

}

}

inn: string (nullable)

ИНН

}

}]

}

}

Пример

{...}

"any-key":{...}

"status":0,

"message":"string",

"error":"string",

"result":[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"cargo_number":"string",

"cargo_firm_id":0,

"firm_id":0,

"added_at":"1970-01-01T00:00:00.000Z",

"updated_at":"1970-01-01T00:00:00.000Z",

"price":0.5,

"currency_id":0,

"nds_price":0.5,

"nds_currency_id":0,

"not_nds_price":0.5,

"not_nds_currency_id":0,

"counter_offer_source":0,

"note":"string",

"pay_attributes":0,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"1970-01-01T00:00:00.000Z",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":0.5,

"status":0,

"full_firm_name":"string",

"contact":{...},

"id":0,

"name":"string",

"telephone":"string",

"email":"string",

"icq":"string",

"mobile":"string",

"mobile_operator":"string",

"skype_name":"string",

"city_id":0,

"location":{...}

"city_id":0,

"region_id":0,

"country_id":0,

"full_name":"string",

"short_name":"string",

"is_regional_center":false,

"city_size":0,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"attributes":0,

"city_name":"string",

"region_name":"string",

"country_name":"string",

"country_code_name":"string"

}

},

"inn":"string"

}

}

]

}

}

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

cargoIds Массив id грузов, для которых нужно получить встречные предложения

fromDate Дата в UTC, начиная с которой необходимо показывать встречные предложения. Если ничего не передано, показываются все встречные предложения.

Удаление встречных предложений для неопубликованного груза

Метод удаляет выбранные предложения по неопубликованному грузу. Список counterOfferIds передается в query.

delete /gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers");

Ответ

200 Статусы удаления по встречным предложениям

Модель

{...}

any-key:{...}

status: int32

Статус операции.

• 1 - Груз не найден
• 0 - Успех
• 9 - Встречное предложение на груз не найдено
• <0 - Произошла незапланированная ошибка

message: string (nullable)

Сообщение о результате

error: string (nullable)

Ключ ошибки

result:{...}

Встречное предложение

id: uuid

Id встречного предложения

cargo_id: uuid

Id груза, на который оставлено встречное предложение

cargo_number: string

Номер груза

cargo_firm_id: int32

Id фирмы, которой принадлежит груз

firm_id: int32 (nullable)

Id фирмы, которая оставила встречное предложение

added_at: date-time

Дата добавления встречного предложения

updated_at: date-time

Дата изменения встречного предложения

price: decimal

Предложенная ставка встречного предложения не б/нал. Значение больше 0 и содержит не более 10 символов.

currency_id: int32

Валюта встречного предложения. Значение из словаря валют АТИ

nds_price: decimal

Предложенная ставка встречного предложения б/нал с НДС

nds_currency_id: int32

Валюта ставки встречного предложения б/нал с НДС. Значение из словаря валют АТИ

not_nds_price: decimal

Предложенная ставка встречного предложения б/нал без НДС

not_nds_currency_id: int32

Валюта ставки встречного предложения б/нал без НДС. Значение из словаря валют АТИ

counter_offer_source: int32

Обозначение источника, откуда добавлено встречное предложение.

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

note: string (nullable)

Примечание к встречному предложению
Максимальная длина - 512 символов

pay_attributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

prepay_percent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

pay_after_max_bank_days: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если pay_attributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

loading_date: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

is_outdated: boolean

Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным. Только для чтения.

is_cargo_published: boolean

Относится ли встречное предложение к публикующемуся грузу. Только для чтения.

firm_info:{...}

Информация о фирме, оставившей встречное предложение

total_score: double

Сумма очков фирмы (количество звезд)

status: int32

Статус фирмы

full_firm_name: string

Полное название фирмы

contact:{...}

Информация о контакте фирмы, оставившем встречное предложение

id: int32

Id контакта в фирме

name: string (nullable)

Имя контакта

telephone: string (nullable)

Телефон

email: string (nullable)

Электронная почта

icq: string (nullable)

Аккаунт ICQ

mobile: string (nullable)

Телефон (мобильный)

mobile_operator: string (nullable)

Мобильный оператор

skype_name: string (nullable)

Аккаунт Skype

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

location:{...}

Информация о местоположении фирмы

city_id: int32

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

full_name: string (nullable)

Составное название из названий города, региона и страны, разделенных запятой

short_name: string (nullable)

Составное название из города, региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

is_regional_center: boolean

Является ли город региональным центром

city_size: int32

Размер города по числу жителей

fias_id: uuid (nullable)

Id в базе ФИАС

attributes: int32

Атрибуты города

city_name: string

Название города

region_name: string (nullable)

Название региона

country_name: string (nullable)

Название страны

country_code_name: string (nullable)

Буквенный код страны

}

}

inn: string (nullable)

ИНН

}

}

}

}

Пример

{...}

"c1a01f34-d39a-4fbc-b67d-065afce257e8":{...}

"status":0,

"message":null,

"error":null,

"result":{...}

"id":"c1a01f34-d39a-4fbc-b67d-065afce257e8",

"cargo_id":"b7e02d91-4f6c-4a9e-9d31-2c8b5f4e1a00",

"cargo_number":"ГР-102938",

"cargo_firm_id":123456,

"firm_id":654321,

"added_at":"2026-05-04T10:15:30.000Z",

"updated_at":"2026-05-04T12:00:00.000Z",

"price":45000,

"currency_id":2,

"nds_price":42000,

"nds_currency_id":2,

"not_nds_price":38000,

"not_nds_currency_id":2,

"counter_offer_source":2,

"note":null,

"pay_attributes":10,

"prepay_percent":0,

"pay_after_max_bank_days":0,

"loading_date":"2026-05-06T08:00:00.000Z",

"is_outdated":false,

"is_cargo_published":false,

"firm_info":{...}

"total_score":4.7,

"status":1,

"full_firm_name":"ООО «Пример Транспорт»",

"contact":{...},

"id":42,

"name":"Иван Петров",

"telephone":"+74951234567",

"email":"contact@example.ru",

"icq":null,

"mobile":null,

"mobile_operator":null,

"skype_name":null,

"city_id":1,

"location":{...}

"city_id":1

}

},

"inn":"7707083893"

}

}

}

}

4XX Ошибка запроса

Модель

{...}

Тело ответа при ошибке (HTTP 4xx): общий ключ и пояснение, плюс при необходимости список ошибок по отдельным полям запроса.

error: string (nullable)

Ключ ошибки (идентификатор сценария отказа или типа сбоя).

reason: string (nullable)

Пояснение: что не так с запросом и при валидации — какие ограничения нарушены.

details:[{...}]

Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела.

property: string (nullable)

Имя поля в теле запроса, к которому относится ошибка.

reason: string (nullable)

Текстовое описание нарушения для этого поля (например, неверный формат или диапазон).

error: string (nullable)

Код или класс ошибки валидации для автоматической обработки на стороне клиента.

}]

}

Пример

{...}

"error":"string",

"reason":"string",

"details":[...]

{...}

"property":"string",

"reason":"string",

"error":"string"

}

]

}

Консоль

Отправить

Параметры

cargoId Id неопубликованного груза, для которого нужно удалить встречные предложения

counterOfferIds Массив id встречных предложений, которые нужно удалить

Получение встречных предложений на грузы фирмы с одной или несколькими ставками

Получение встречных предложений на грузы фирмы с одной или несколькими ставками .

get /v1.0/loads/new/responses

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/new/responses' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/new/responses");

Ответ

200 Массив отзывов на все грузы фирмы

Модель

[{...}]

ResponseId: guid

Id отзыва

LoadId: guid

Id груза, на который оставлен отзыв

LoadNumber: string

Номер груза

LoadFirmId: int32

Id фирмы, которой принадлежит груз

FirmId: int32

Id фирмы, которая оставила отзыв

FirmName: string

Название фирмы

ContactId: int32

Контакт, который сделал встречное предложение

AddedAt: date-time

Дата добавления отзыва

UpdatedAt: date-time

Дата изменения отзыва

Price: decimal

Предложенная цена встречного предложения

CurrencyId: int32

Валюта встречного предложения
Значение из словаря валют АТИ

NdsPrice: decimal

Предложенная цена встречного предложения с ндс

NdsCurrencyId: int32

Валюта ставки встречного предложения б/нал с НДС.Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False.
Значение из словаря валют АТИ

NotNdsPrice: decimal

Предложенная цена встречного предложения без ндс

NotNdsCurrencyId: int32

Валюта встречного предложения без ндс

CounterOfferSource: enum

[0, 1, 2, 3, 4, 5, 6]

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

Note: string

Примечание к встречному предложению
Максимальная длина - 512 символов

PayAttributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

PrepayPercent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

PayAfterMaxBankDays: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

LoadingDate: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

IsOutdated: boolean

Определяет, просрочен ли отзыв. Когда груз редактируют, удаляют, обновляют, отзыв помечается просроченным.
Только для чтения.

IsLoadPublished: boolean

Относится ли отзыв к публикующемуся грузу

IsNoLoad: boolean

Параметр "Груза нет"

AnnouncedCurrencyId: int32

Валюта "Озвученной ставки"
Значение из словаря валют АТИ

AnnouncedRate: int32

Озвученная ставка

FirmInfo:{...}

Информация о фирме, оставившей отзыв на груз

TotalScore: double

Сумма очков фирмы (количество звезд)

Status: enum

[0, 1, 2, 3, 4, 5, 6, 7]

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

FullFirmName: string

Полное название фирмы

Contact:{...}

Информация о контакте фирмы, оставившем отзыв на груз

Id: int32

Id контакта в фирме

Name: string

Имя контакта

Telephone: string

Телефон

Email: string

Электронная почта

Icq: string

Аккаунт ICQ

Mobile: string

Телефон(мобильный)

MobileOperator: string

Мобильный оператор

SkypeName: string

Аккаунт Skype

CityId: int32 (nullable)

Id города
Значение из словаря городов АТИ

Location:{...}

Информация о местоположении фирмы

CityId: int32

Id города
Значение из словаря городов АТИ

RegionId: int32 (nullable)

Id региона
Значение из словаря регионов АТИ

CountryId: int32 (nullable)

Id страны
Значение из словаря стран АТИ

FullName: string

Составное название состоящее из названий города, региона и страны разделенные через запятую

ShortName: string

Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

• 1: до 10.000
• 2: от 10.000 до 50.000;
• 3: от 50.000 до 100.000;
• 4: от 100.000 до 500.000;
• 5: от 500.000 до 1.000.000;
• 6: свыше 1.000.000.

FiasId: guid (nullable)

Id в базе ФИАС

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CountryCodeName: string

Буквенный код страны

}

}

Inn: string

ИНН

}

}]

Пример

[...]

{...}

"ResponseId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"string",

"LoadFirmId":0,

"FirmId":0,

"FirmName":"string",

"ContactId":0,

"AddedAt":"1970-01-01T00:00:00.000Z",

"UpdatedAt":"1970-01-01T00:00:00.000Z",

"Price":0.5,

"CurrencyId":0,

"NdsPrice":0.5,

"NdsCurrencyId":0,

"NotNdsPrice":0.5,

"NotNdsCurrencyId":0,

"CounterOfferSource":0,

"Note":"string",

"PayAttributes":0,

"PrepayPercent":0,

"PayAfterMaxBankDays":0,

"LoadingDate":"1970-01-01T00:00:00.000Z",

"IsOutdated":false,

"IsLoadPublished":false,

"IsNoLoad":false,

"AnnouncedCurrencyId":0,

"AnnouncedRate":0,

"FirmInfo":{...}

"TotalScore":0.5,

"Status":0,

"FullFirmName":"string",

"Contact":{...},

"Id":0,

"Name":"string",

"Telephone":"string",

"Email":"string",

"Icq":"string",

"Mobile":"string",

"MobileOperator":"string",

"SkypeName":"string",

"CityId":0,

"Location":{...}

"CityId":0,

"RegionId":0,

"CountryId":0,

"FullName":"string",

"ShortName":"string",

"IsRegionalCenter":false,

"CitySize":0,

"FiasId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"CityName":"string",

"RegionName":"string",

"CountryName":"string",

"CountryCodeName":"string"

}

},

"Inn":"string"

}

}

]

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

dateFrom Дата в UTC, начиная с которой необходимо показывать отзывы. Если ничего не передано, значит показываем абсолютно все отзывы. Если не передать модификатор часового пояса, дата отправляется в формате UTC+3 (Москва)

Получение отзывов на любой груз по ID

Если груз принадлежит вашей фирме, то вернутся все отзывы на ваш груз с полной информацией. Если груз принадлежит чужой фирме, то вернутся все отзывы на этот груз, но при этом все отзывы, кроме вашего, будут иметь в поле FirmInfo.Contact значение null.

Получение отзывов на конкретный груз фирмы. На данный момент можно получить только встречные предложения.

get /v1.0/loads/new/{loadId}/responses

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/new/{loadId}/responses' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/new/{loadId}/responses");

Ответ

200 Массив отзывов

Модель

[{...}]

ResponseId: guid

Id отзыва

LoadId: guid

Id груза, на который оставлен отзыв

LoadNumber: string

Номер груза

LoadFirmId: int32

Id фирмы, которой принадлежит груз

FirmId: int32

Id фирмы, которая оставила отзыв

FirmName: string

Название фирмы

ContactId: int32

Контакт, который сделал встречное предложение

AddedAt: date-time

Дата добавления отзыва

UpdatedAt: date-time

Дата изменения отзыва

Price: decimal

Предложенная цена встречного предложения

CurrencyId: int32

Валюта встречного предложения
Значение из словаря валют АТИ

NdsPrice: decimal

Предложенная цена встречного предложения с ндс

NdsCurrencyId: int32

Валюта ставки встречного предложения б/нал с НДС.Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False.
Значение из словаря валют АТИ

NotNdsPrice: decimal

Предложенная цена встречного предложения без ндс

NotNdsCurrencyId: int32

Валюта встречного предложения без ндс

CounterOfferSource: enum

[0, 1, 2, 3, 4, 5, 6]

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

Note: string

Примечание к встречному предложению
Максимальная длина - 512 символов

PayAttributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

PrepayPercent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

PayAfterMaxBankDays: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

LoadingDate: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

IsOutdated: boolean

Определяет, просрочен ли отзыв. Когда груз редактируют, удаляют, обновляют, отзыв помечается просроченным.
Только для чтения.

IsLoadPublished: boolean

Относится ли отзыв к публикующемуся грузу

IsNoLoad: boolean

Параметр "Груза нет"

AnnouncedCurrencyId: int32

Валюта "Озвученной ставки"
Значение из словаря валют АТИ

AnnouncedRate: int32

Озвученная ставка

FirmInfo:{...}

Информация о фирме, оставившей отзыв на груз

TotalScore: double

Сумма очков фирмы (количество звезд)

Status: enum

[0, 1, 2, 3, 4, 5, 6, 7]

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

FullFirmName: string

Полное название фирмы

Contact:{...}

Информация о контакте фирмы, оставившем отзыв на груз

Id: int32

Id контакта в фирме

Name: string

Имя контакта

Telephone: string

Телефон

Email: string

Электронная почта

Icq: string

Аккаунт ICQ

Mobile: string

Телефон(мобильный)

MobileOperator: string

Мобильный оператор

SkypeName: string

Аккаунт Skype

CityId: int32 (nullable)

Id города
Значение из словаря городов АТИ

Location:{...}

Информация о местоположении фирмы

CityId: int32

Id города
Значение из словаря городов АТИ

RegionId: int32 (nullable)

Id региона
Значение из словаря регионов АТИ

CountryId: int32 (nullable)

Id страны
Значение из словаря стран АТИ

FullName: string

Составное название состоящее из названий города, региона и страны разделенные через запятую

ShortName: string

Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

• 1: до 10.000
• 2: от 10.000 до 50.000;
• 3: от 50.000 до 100.000;
• 4: от 100.000 до 500.000;
• 5: от 500.000 до 1.000.000;
• 6: свыше 1.000.000.

FiasId: guid (nullable)

Id в базе ФИАС

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CountryCodeName: string

Буквенный код страны

}

}

Inn: string

ИНН

}

}]

Пример

[...]

{...}

"ResponseId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"string",

"LoadFirmId":0,

"FirmId":0,

"FirmName":"string",

"ContactId":0,

"AddedAt":"1970-01-01T00:00:00.000Z",

"UpdatedAt":"1970-01-01T00:00:00.000Z",

"Price":0.5,

"CurrencyId":0,

"NdsPrice":0.5,

"NdsCurrencyId":0,

"NotNdsPrice":0.5,

"NotNdsCurrencyId":0,

"CounterOfferSource":0,

"Note":"string",

"PayAttributes":0,

"PrepayPercent":0,

"PayAfterMaxBankDays":0,

"LoadingDate":"1970-01-01T00:00:00.000Z",

"IsOutdated":false,

"IsLoadPublished":false,

"IsNoLoad":false,

"AnnouncedCurrencyId":0,

"AnnouncedRate":0,

"FirmInfo":{...}

"TotalScore":0.5,

"Status":0,

"FullFirmName":"string",

"Contact":{...},

"Id":0,

"Name":"string",

"Telephone":"string",

"Email":"string",

"Icq":"string",

"Mobile":"string",

"MobileOperator":"string",

"SkypeName":"string",

"CityId":0,

"Location":{...}

"CityId":0,

"RegionId":0,

"CountryId":0,

"FullName":"string",

"ShortName":"string",

"IsRegionalCenter":false,

"CitySize":0,

"FiasId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"CityName":"string",

"RegionName":"string",

"CountryName":"string",

"CountryCodeName":"string"

}

},

"Inn":"string"

}

}

]

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

loadId ID груза

dateFrom Дата в UTC, начиная с которой необходимо показывать отзывы. Если ничего не передано, значит показываем абсолютно все отзывы. Если не передать модификатор часового пояса, дата отправляется в формате UTC+3 (Москва)

Получение отзывов на заданные грузы фирмы в виде словаря

Ответ будет представлен в виде словаря, где ключ – id груза, а значение - массив структур “отзыв на груз”, содержащий:

• Result, представляющий набор отзывов для данного груза;
• Status, представляющий статус груза: если груз с таким id не найден у вашей фирмы, статус равен 1, иначе статус равен 0. Если у груза статус равен 1, то массив отзывов всегда пуст.

Список ключей словаря полностью совпадает со списком грузов, для которых были запрошены отзывы.

Получение отзывов на заданные грузы фирмы в виде словаря. На данный момент можно получить только встречные предложения.

get /v1.0/loads/new/responses/by-ids

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/new/responses/by-ids' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/new/responses/by-ids");

Ответ

200 Массив отзывов по заданным грузам в виде словаря

Модель

{...}

any-key:{...}

Status: int32

Статус операции для груза.

• 8 - Произошла внутренняя ошибка при обработке груза
• 7 - Ошибка валидации груза
• 6 - Груз был объединен с другим грузом
• 5 - Найден дубликат в актуальных грузах
• 4 - Груз зарезервирован/взят, операции с грузом запрещены
• 3 - Нет доступа
• 2 - Груз был обновлен или добавлен менее часа назад
• 1 - Груз не найден
• 0 - Успех
• -1 - Меньше 0 - произошла незапланированная ошибка

Message: string

Сообщение, которое отдается пользователю

Result:[{...}]

Список встречных предложений

ResponseId: guid

Id отзыва

LoadId: guid

Id груза, на который оставлен отзыв

LoadNumber: string

Номер груза

LoadFirmId: int32

Id фирмы, которой принадлежит груз

FirmId: int32

Id фирмы, которая оставила отзыв

FirmName: string

Название фирмы

ContactId: int32

Контакт, который сделал встречное предложение

AddedAt: date-time

Дата добавления отзыва

UpdatedAt: date-time

Дата изменения отзыва

Price: decimal

Предложенная цена встречного предложения

CurrencyId: int32

Валюта встречного предложения
Значение из словаря валют АТИ

NdsPrice: decimal

Предложенная цена встречного предложения с ндс

NdsCurrencyId: int32

Валюта ставки встречного предложения б/нал с НДС.Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False.
Значение из словаря валют АТИ

NotNdsPrice: decimal

Предложенная цена встречного предложения без ндс

NotNdsCurrencyId: int32

Валюта встречного предложения без ндс

CounterOfferSource: enum

[0, 1, 2, 3, 4, 5, 6]

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

Note: string

Примечание к встречному предложению
Максимальная длина - 512 символов

PayAttributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

PrepayPercent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

PayAfterMaxBankDays: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

LoadingDate: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

IsOutdated: boolean

Определяет, просрочен ли отзыв. Когда груз редактируют, удаляют, обновляют, отзыв помечается просроченным.
Только для чтения.

IsLoadPublished: boolean

Относится ли отзыв к публикующемуся грузу

IsNoLoad: boolean

Параметр "Груза нет"

AnnouncedCurrencyId: int32

Валюта "Озвученной ставки"
Значение из словаря валют АТИ

AnnouncedRate: int32

Озвученная ставка

FirmInfo:{...}

Информация о фирме, оставившей отзыв на груз

TotalScore: double

Сумма очков фирмы (количество звезд)

Status: enum

[0, 1, 2, 3, 4, 5, 6, 7]

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

FullFirmName: string

Полное название фирмы

Contact:{...}

Информация о контакте фирмы, оставившем отзыв на груз

Id: int32

Id контакта в фирме

Name: string

Имя контакта

Telephone: string

Телефон

Email: string

Электронная почта

Icq: string

Аккаунт ICQ

Mobile: string

Телефон(мобильный)

MobileOperator: string

Мобильный оператор

SkypeName: string

Аккаунт Skype

CityId: int32 (nullable)

Id города
Значение из словаря городов АТИ

Location:{...}

Информация о местоположении фирмы

CityId: int32

Id города
Значение из словаря городов АТИ

RegionId: int32 (nullable)

Id региона
Значение из словаря регионов АТИ

CountryId: int32 (nullable)

Id страны
Значение из словаря стран АТИ

FullName: string

Составное название состоящее из названий города, региона и страны разделенные через запятую

ShortName: string

Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

• 1: до 10.000
• 2: от 10.000 до 50.000;
• 3: от 50.000 до 100.000;
• 4: от 100.000 до 500.000;
• 5: от 500.000 до 1.000.000;
• 6: свыше 1.000.000.

FiasId: guid (nullable)

Id в базе ФИАС

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CountryCodeName: string

Буквенный код страны

}

}

Inn: string

ИНН

}

}]

Error: string

Ключ ошибки

Reason: string

Причина ошибки

}

}

Пример

{...}

"any-key":{...}

"Status":0,

"Message":"string",

"Result":[...],

{...}

"ResponseId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"string",

"LoadFirmId":0,

"FirmId":0,

"FirmName":"string",

"ContactId":0,

"AddedAt":"1970-01-01T00:00:00.000Z",

"UpdatedAt":"1970-01-01T00:00:00.000Z",

"Price":0.5,

"CurrencyId":0,

"NdsPrice":0.5,

"NdsCurrencyId":0,

"NotNdsPrice":0.5,

"NotNdsCurrencyId":0,

"CounterOfferSource":0,

"Note":"string",

"PayAttributes":0,

"PrepayPercent":0,

"PayAfterMaxBankDays":0,

"LoadingDate":"1970-01-01T00:00:00.000Z",

"IsOutdated":false,

"IsLoadPublished":false,

"IsNoLoad":false,

"AnnouncedCurrencyId":0,

"AnnouncedRate":0,

"FirmInfo":{...}

"TotalScore":0.5,

"Status":0,

"FullFirmName":"string",

"Contact":{...},

"Id":0,

"Name":"string",

"Telephone":"string",

"Email":"string",

"Icq":"string",

"Mobile":"string",

"MobileOperator":"string",

"SkypeName":"string",

"CityId":0,

"Location":{...}

"CityId":0,

"RegionId":0,

"CountryId":0,

"FullName":"string",

"ShortName":"string",

"IsRegionalCenter":false,

"CitySize":0,

"FiasId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"CityName":"string",

"RegionName":"string",

"CountryName":"string",

"CountryCodeName":"string"

}

},

"Inn":"string"

}

}

],

"Error":"string",

"Reason":"string"

}

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

dateFrom Дата в UTC, начиная с которой необходимо показывать отзывы. Если ничего не передано, значит показываем абсолютно все отзывы. Если не передать модификатор часового пояса, дата отправляется в формате UTC+3 (Москва)

onlyActual true false Только актуальные отзывы

loadIds Массив id грузов, для которых нужно получить отзывы

Добавление либо редактирование отзыва на чужой груз

Добавление либо редактирование отзыва на чужой груз.

put /v1.0/loads/new/{loadId}/responses

Модель и примеры

Запрос

Модель

{...}

ResponseId: guid

Id отзыва
Только для чтения

LoadId: guid

Id груза, на который оставлен отзыв
Только для чтения

LoadNumber: string

Номер груза
Только для чтения

LoadFirmId: int32

Id фирмы, которой принадлежит груз
Только для чтения

FirmId: int32

Id фирмы, которая оставила отзыв
Только для чтения

ContactId: int32

Контакт, который сделал встречное предложение

AddedAt: date-time

Дата добавления отзыва
Только для чтения

UpdatedAt: date-time

Дата изменения отзыва
Только для чтения

Price: decimal

Предложенная ставка встречного предложения не б/нал. Параметр должен быть равен одной из ставок груза: RateSum, SumWithNDS или SumWithoutNDS, если у груза, которому выставляется встречное предложение, параметр FixedRate равен True И параметр Torg равен False. Значение больше 0 и содержит не более 10 символов.

CurrencyId: int32

Валюта встречного предложения. Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False
Значение из словаря валют АТИ

NdsPrice: decimal

Предложенная ставка встречного предложения б/нал с НДС

NdsCurrencyId: int32

Валюта ставки встречного предложения б/нал с НДС.Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False.
Значение из словаря валют АТИ

NotNdsPrice: decimal

Предложенная ставка встречного предложения б/нал без НДС

NotNdsCurrencyId: int32

Валюта ставки встречного предложения б/нал без НДС. Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False
Значение из словаря валют АТИ

Note: string

Примечание к встречному предложению
Максимальная длина - 512 символов

PayAttributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

PrepayPercent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

PayAfterMaxBankDays: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

LoadingDate: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

IsOutdated: boolean

Определяет, просрочен ли отзыв. Когда груз редактируют, удаляют, обновляют, отзыв помечается просроченным.
Только для чтения.

IsLoadPublished: boolean

Относится ли отзыв к публикующемуся грузу
Только для чтения

IsNoLoad: boolean

Параметр "Груза нет"

AnnouncedCurrencyId: int32

Валюта "Озвученной ставки"
Значение из словаря валют АТИ

AnnouncedRate: int32

Озвученная ставка

}

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/new/{loadId}/responses' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ResponseId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","LoadNumber":"string","LoadFirmId":0,"FirmId":0,"ContactId":0,"AddedAt":"1970-01-01T00:00:00.000Z","UpdatedAt":"1970-01-01T00:00:00.000Z","Price":0.5,"CurrencyId":0,"NdsPrice":0.5,"NdsCurrencyId":0,"NotNdsPrice":0.5,"NotNdsCurrencyId":0,"Note":"string","PayAttributes":0,"PrepayPercent":0,"PayAfterMaxBankDays":0,"LoadingDate":"1970-01-01T00:00:00.000Z","IsOutdated":false,"IsLoadPublished":false,"IsNoLoad":false,"AnnouncedCurrencyId":0,"AnnouncedRate":0}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.0/loads/new/{loadId}/responses", "{""ResponseId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""LoadId"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""LoadNumber"":""string"",""LoadFirmId"":0,""FirmId"":0,""ContactId"":0,""AddedAt"":""1970-01-01T00:00:00.000Z"",""UpdatedAt"":""1970-01-01T00:00:00.000Z"",""Price"":0.5,""CurrencyId"":0,""NdsPrice"":0.5,""NdsCurrencyId"":0,""NotNdsPrice"":0.5,""NotNdsCurrencyId"":0,""Note"":""string"",""PayAttributes"":0,""PrepayPercent"":0,""PayAfterMaxBankDays"":0,""LoadingDate"":""1970-01-01T00:00:00.000Z"",""IsOutdated"":false,""IsLoadPublished"":false,""IsNoLoad"":false,""AnnouncedCurrencyId"":0,""AnnouncedRate"":0}");

Ответ

200 Отзыв на груз

Модель

{...}

ResponseId: guid

Id отзыва

LoadId: guid

Id груза, на который оставлен отзыв

LoadNumber: string

Номер груза

LoadFirmId: int32

Id фирмы, которой принадлежит груз

FirmId: int32

Id фирмы, которая оставила отзыв

FirmName: string

Название фирмы

ContactId: int32

Контакт, который сделал встречное предложение

AddedAt: date-time

Дата добавления отзыва

UpdatedAt: date-time

Дата изменения отзыва

Price: decimal

Предложенная цена встречного предложения

CurrencyId: int32

Валюта встречного предложения
Значение из словаря валют АТИ

NdsPrice: decimal

Предложенная цена встречного предложения с ндс

NdsCurrencyId: int32

Валюта ставки встречного предложения б/нал с НДС.Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False.
Значение из словаря валют АТИ

NotNdsPrice: decimal

Предложенная цена встречного предложения без ндс

NotNdsCurrencyId: int32

Валюта встречного предложения без ндс

CounterOfferSource: enum

[0, 1, 2, 3, 4, 5, 6]

Обозначение откуда было добавлено встречное предложение

• 0 - Неизвестный источник
• 1 - Мобильное приложение
• 2 - Интегратор
• 3 - Перехват грузов интегратором
• 4 - Страница поиска грузов
• 5 - Перехват машин
• 6 - Сквозное встречное предложение, добавлено автоматически

Note: string

Примечание к встречному предложению
Максимальная длина - 512 символов

PayAttributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

• 1 - возможна оплата наличными
• 2 - возможна оплата по безналичному рассчету
• 4 - блиц
• 8 - оплата с НДС
• 16 - возможна предоплата
• 32 - оплата на выгрузке
• 64 - включена ли оплата через некоторое количество банковских дней

PrepayPercent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

PayAfterMaxBankDays: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

LoadingDate: date-time (nullable)

Дата, когда предложивший хочет перевезти ваш груз

IsOutdated: boolean

Определяет, просрочен ли отзыв. Когда груз редактируют, удаляют, обновляют, отзыв помечается просроченным.
Только для чтения.

IsLoadPublished: boolean

Относится ли отзыв к публикующемуся грузу

IsNoLoad: boolean

Параметр "Груза нет"

AnnouncedCurrencyId: int32

Валюта "Озвученной ставки"
Значение из словаря валют АТИ

AnnouncedRate: int32

Озвученная ставка

FirmInfo:{...}

Информация о фирме, оставившей отзыв на груз

TotalScore: double

Сумма очков фирмы (количество звезд)

Status: enum

[0, 1, 2, 3, 4, 5, 6, 7]

Тип звезд фирмы

• 0: Серый
• 1: Красный
• 2: Желтый
• 3: Зеленый
• 4: Партнер АТИ
• 5: Сотрудник АТИ
• 6: Гос. органы
• 7: ОДКС

FullFirmName: string

Полное название фирмы

Contact:{...}

Информация о контакте фирмы, оставившем отзыв на груз

Id: int32

Id контакта в фирме

Name: string

Имя контакта

Telephone: string

Телефон

Email: string

Электронная почта

Icq: string

Аккаунт ICQ

Mobile: string

Телефон(мобильный)

MobileOperator: string

Мобильный оператор

SkypeName: string

Аккаунт Skype

CityId: int32 (nullable)

Id города
Значение из словаря городов АТИ

Location:{...}

Информация о местоположении фирмы

CityId: int32

Id города
Значение из словаря городов АТИ

RegionId: int32 (nullable)

Id региона
Значение из словаря регионов АТИ

CountryId: int32 (nullable)

Id страны
Значение из словаря стран АТИ

FullName: string

Составное название состоящее из названий города, региона и страны разделенные через запятую

ShortName: string

Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

• 1: до 10.000
• 2: от 10.000 до 50.000;
• 3: от 50.000 до 100.000;
• 4: от 100.000 до 500.000;
• 5: от 500.000 до 1.000.000;
• 6: свыше 1.000.000.

FiasId: guid (nullable)

Id в базе ФИАС

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CountryCodeName: string

Буквенный код страны

}

}

Inn: string

ИНН

}

}

Пример

{...}

"ResponseId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"string",

"LoadFirmId":0,

"FirmId":0,

"FirmName":"string",

"ContactId":0,

"AddedAt":"1970-01-01T00:00:00.000Z",

"UpdatedAt":"1970-01-01T00:00:00.000Z",

"Price":0.5,

"CurrencyId":0,

"NdsPrice":0.5,

"NdsCurrencyId":0,

"NotNdsPrice":0.5,

"NotNdsCurrencyId":0,

"CounterOfferSource":0,

"Note":"string",

"PayAttributes":0,

"PrepayPercent":0,

"PayAfterMaxBankDays":0,

"LoadingDate":"1970-01-01T00:00:00.000Z",

"IsOutdated":false,

"IsLoadPublished":false,

"IsNoLoad":false,

"AnnouncedCurrencyId":0,

"AnnouncedRate":0,

"FirmInfo":{...}

"TotalScore":0.5,

"Status":0,

"FullFirmName":"string",

"Contact":{...},

"Id":0,

"Name":"string",

"Telephone":"string",

"Email":"string",

"Icq":"string",

"Mobile":"string",

"MobileOperator":"string",

"SkypeName":"string",

"CityId":0,

"Location":{...}

"CityId":0,

"RegionId":0,

"CountryId":0,

"FullName":"string",

"ShortName":"string",

"IsRegionalCenter":false,

"CitySize":0,

"FiasId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"CityName":"string",

"RegionName":"string",

"CountryName":"string",

"CountryCodeName":"string"

}

},

"Inn":"string"

}

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

loadId ID груза

{ "ResponseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "LoadId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "LoadNumber": "string", "LoadFirmId": 0, "FirmId": 0, "ContactId": 0, "AddedAt": "1970-01-01T00:00:00.000Z", "UpdatedAt": "1970-01-01T00:00:00.000Z", "Price": 0.5, "CurrencyId": 0, "NdsPrice": 0.5, "NdsCurrencyId": 0, "NotNdsPrice": 0.5, "NotNdsCurrencyId": 0, "Note": "string", "PayAttributes": 0, "PrepayPercent": 0, "PayAfterMaxBankDays": 0, "LoadingDate": "1970-01-01T00:00:00.000Z", "IsOutdated": false, "IsLoadPublished": false, "IsNoLoad": false, "AnnouncedCurrencyId": 0, "AnnouncedRate": 0 }

Удаление отзыва на груз

При удалении встречного предложения у своего груза, необходимо заполнить как loadId, так и ids.
При удалении отзыва на чужой груз, необходимо передать loadId.

Позволяет удалить встречные предложения с указанными id для своего груза или удалить отзыв фирмы у чужого груза.

delete /v1.0/loads/new/{loadId}/responses

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/new/{loadId}/responses' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.0/loads/new/{loadId}/responses");

Ответ

200

Модель

{...}

any-key:{...}

Status: int32

Статус операции

• 0 - Успех
• -1 - Меньше 0 - произошла незапланированная ошибка

Message: string

Сообщение о результате

Error: string

Ключ ошибки, если Status не равен 0

Reason: string

Причина ошибки, если Status не равен 0

}

}

Пример

{...}

"any-key":{...}

"Status":0,

"Message":"string",

"Error":"string",

"Reason":"string"

}

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

loadId ID груза

ids ID отзывов (если нужно удалить встречные предложения у своего груза)

Методы для поиска грузов

Поиск грузов на площадках

В теле ответа находится массив грузов, которые опубликованы на выбранных площадках. В грузах будут указаны только те площадки, в которых дата публикации меньше текущей.
Если массив boardIds пуст, будут получены грузы со всех возможных площадок.

Проводит поиск грузов, которые размещены на указанных площадках. В результате присутствуют как ваши грузы, так и грузы других пользователей.

get /v1.0/loads/search/byboards

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/search/byboards' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/loads/search/byboards");

Ответ

200 Массив грузов, которые опубликованы на выбранных площадках

Модель

[{...}]

LoadMeta:{...}

Метаданные для интеграторов

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 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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)

Широта города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

Долгота города загрузки/разгрузки
Параметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

Улица или район города загрузки/разгрузки
Параметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:

1. указан город Москва;
2. указан город Санкт-Петербург;
3. города загрузки и разгрузки совпадают.

Максимальная длина 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

}

}]

}

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 символов

MoneySpentPerDay: decimal

Количество денег, потраченное на заявку за день. Только для чтения

MoneySpentPerOrder: decimal

Количество денег, потраченное на заявку в целом. Только для чтения

}

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 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.

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

Показывает разрешено ли бронирование грузов на Общей площадке
Учитывается только для Общей площадки, только при включенном Stealth

PublicationOption: int32

Параметры публикации груза:

• 0 - сразу
• 1 - через 15 минут
• 2 - через 30 минут
• 3 - через час
• 4 - через 3 часа
• 5 - через 6 часов
• 6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Показывает является ли площадка Общей

}]

UnloadFirstDate: date-time (nullable)

Дата начала разгрузки, в формате UTC.
Может иметь значение null.
Минимальное значение равно текущей дате.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

UnloadLastDate: date-time (nullable)

Дата окончания разгрузки, в формате UTC. Может иметь значение null.
Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

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":[...],

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,

"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"

}

Консоль

Отправить

Параметры

boardIds Массив ID площадок

Методы для добавления документа к грузу

Создание документа в АТИ-Доках на груз

Данный метод позволяет создавать следующие типы документов:

• заказ
• заказ (табличный вид)
• заявка (к договору)
• заявка к договору (табличный вид)
• поручение экспедитору

Тип создаваемого документа должен быть передан в documentType в том же виде, как он указан выше.

Позволяет создавать документ заданного типа в АТИ-Доках на груз с заданным id.

post /v1.0/loads/{loadId}/atidocs/{documentType}

Модель и примеры

Запрос

Пример запроса

CURL

curl 'https://api.ati.su/v1.0/loads/{loadId}/atidocs/{documentType}' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v1.0/loads/{loadId}/atidocs/{documentType}");

Ответ

200 Статус

Модель

{...}

Id: string

Id документа

Url: string

Ссылка на документ

}

Пример

{...}

"Id":"string",

"Url":"string"

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)

Модель

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Пример

{...}

"Reason":"string",

"Error":"string"

}

Консоль

Отправить

Параметры

loadId ID груза

documentType Тип документа, который нужно создать