Архивные грузы

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

Восстановление одного архивного груза

post

/v2/cargos/{cargoApplicationId}/restore

cargoApplicationId

uuid

Развернуть все Свернуть все

body

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

{...}

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

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 — груза нет, запрос ставки

time:{...}

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

type*: string

Тип времени

bounded — с/по
round-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 — круглосуточно

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 — круглосуточно

start: HH:mm (nullable)

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

periodicity*: string

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

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

time:{...}

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

type*: string

Тип времени

bounded — с/по
round-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

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 — круглосуточно

start: HH:mm (nullable)

end: HH:mm (nullable)

По

offset: +HH:mm (nullable)

Часовой пояс

}

way_points:[{...}]

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

type*: string

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

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 — круглосуточно

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

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 — круглосуточно

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

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

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)

Пневмоход

}

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 — торги

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 банковских дней

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 банковских дней

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 банковских дней

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 банковских дней

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 — процент от начальной ставки

amount*: double (nullable)

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

amount*: double (nullable)

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

}

no_winner_end_options*:{...}

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

type*: string

Действие

archive — переместить заявку в архив
publish-with-rate — опубликовать заявку со ставкой
publish-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

Копировать

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

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

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

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

"is_tracking":false,

"adr":0,

"belts_count":0,

"required_capacity":0.5,

"body_loading":{...},

"types":[...],

"is_all_required":false

"body_unloading":{...},

"types":[...],

"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

}

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

Заявка груза

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

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 — груза нет, запрос ставки

first_date*: date-time

Дата начала

last_date*: date-time

Дата конца

time:{...}

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

type*: string

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

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

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

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 - точка "ехать через"

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

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

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

medical_card*: boolean

Медкнижка

}

requirements:{...}

Требования

logging_truck*: boolean

Коники

road_train*: boolean

Сцепка

air_suspension*: boolean

Пневмоход

}

payment*:{...}

Оплата

type*: string

Тип оплаты:

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

hide_counter_offers*: boolean

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

direct_offer*: boolean

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

prepayment:{...}

Предоплата

percent: int32 (nullable)

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

using_fuel*: boolean

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

}

payment_mode:{...}

Режим оплаты

type*: string

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

delayed-payment — через несколько дней
on-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 — на выгрузке

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 — на выгрузке

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 — на выгрузке

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

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 — процент от начальной ставки

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

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Восстановление одного груза

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

put

/v1.0/unpublished-loads/{loadId}/restore

loadId

guid

Развернуть все Свернуть все

body

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

Груз

{...}

LoadMeta:{...}

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

LoadMetaId: guid (nullable)

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

MetaData: string

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

}

ContactId1*: int32

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

ContactId2: int32 (nullable)

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

Note: string

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

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC
Минимальное значение равно текущей дате
При значении параметра DateType равным 0, допустимое значение поля - текущая дата
При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 60 дней вперед
При значении параметра DateType равным 2, допустимое значение поля - текущая дата
При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC
Минимальное значение равно значению параметра FirstDate
При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед
При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед
При значении параметра DateType равным 2, данное поле вычисляется автоматически по формуле FirstDate + 2 месяца, передаваемое значение игнорируется
При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

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

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

PeriodicityId: int32

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

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

OrderNumber: string

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

Krugoreis: boolean

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

Loading*:{...}

Загрузка

CityId*: int32

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

Latitude: decimal (nullable)

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

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

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

Longitude: decimal (nullable)

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

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

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

Street: string

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

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

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

TimeStart: date-time (nullable)

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

TimeEnd: date-time (nullable)

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

IsRoundTheClock: boolean

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

LargeCities: [int32]

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

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

ExtraPoints:[{...}]

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

CityId*: int32

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

PointType*: int32

Тип точки:

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

Latitude: decimal (nullable)

Долгота

Longitude: decimal (nullable)

Широта

Street: string

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

OrdinalId: int32

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

IsRoundTheClock: boolean

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

LoadingDateStart: date-time (nullable)

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

LoadingDateEnd: date-time (nullable)

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

LoadingTimeStart: time-span (nullable)

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

LoadingTimeEnd: time-span (nullable)

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

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

UnloadingCargos:[{...}]

CargoId: int32

Id груза

Weight: double (nullable)

Вес

Volume: double (nullable)

Объём

PackagingQuantity: int32 (nullable)

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

IsDefinedByTtn: boolean

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

}]

Unloading*:{...}

Разгрузка

CityId*: int32

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

Latitude: decimal (nullable)

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

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

Longitude: decimal (nullable)

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

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

Street: string

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

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

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

Cargo*:{...}

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

Weight: double

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

Volume: double

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

ADR: int32

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

CargoTypeId*: int32

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

CargoType: string

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

PackType: int32

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

PalletCount: int32

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

BeltCount: int32

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

DogruzType*: int32

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

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

SborGruz: boolean

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

Size:{...}

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

Length: double

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

Width: double

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

Height: double

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

Diameter: double

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

LengthHighlight: boolean

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

WidthHighlight: boolean

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

HeightHighlight: boolean

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

}

Transport*:{...}

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

CarType*: int64

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

LoadingType: int32

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

LoadingLogicalOperator: string

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

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

UnloadingType: int32

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

UnloadingLogicalOperator: string

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

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

TrucksQuantity: int32

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

TemperatureFrom: int32 (nullable)

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

TemperatureTo: int32 (nullable)

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

Stsepka: boolean

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

Pnevmohod: boolean

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

Koniki: boolean

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

TIR: boolean

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

CMR: boolean

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

T1: boolean

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

SanPassport: boolean

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

IsTracking: boolean

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

}

Payment*:{...}

Оплата

CurrencyId: int32

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

MoneyType: int32

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

RateSum: decimal

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

SumWithNDS: decimal

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

SumWithoutNDS: decimal

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

PrepayPercent: int32

Процент предоплаты
Допустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false

PrepayPercentEnabled: boolean

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

PayDays: int32

Через сколько банковских дней оплата
Допустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false

PayDaysEnabled: boolean

Параметр, что включен флажок "через банк. дней"
По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true

FixedRate: boolean

true, если ставка задана, false если запрос ставки
По умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1

Torg: boolean

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

DirectContract: boolean

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

InFuel: boolean

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

OnUnloading: boolean

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

HideResponses: boolean

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

AcceptPaymentTypes: int32

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

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

}

InviteSettings:{...}

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

InviteDelayInSeconds: int32

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

InviteDurationInSeconds: int32

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

}

PriorityView:{...}

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

DailyLimit: decimal

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

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

IsForPayedOnly: boolean

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

OrderLimit: decimal

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

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

ViewRate*: decimal

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

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

}

Stealth:{...}

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

ListIdToHide: guid (nullable)

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

FirmRegDateToHide: date-time (nullable)

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

ScoreToHide: double (nullable)

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

}

LoadFiles:[{...}]

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

Id: guid

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

FileType: int32

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

1 - документ

Attributes: int32

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

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

Name: string

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

Link: string

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

Size: int32

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

}]

Deal:{...}

Auction:{...}

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

StartRate*: decimal

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

Currency*: int32

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

Step*: decimal

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

PaymentType*: enum

[1, 22, 23, 24, 25]

Тип оплаты

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

AcceptSecondPayType: boolean

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

StartDate: date-time

Время начала аукциона. Должно быть позже времени начала публикации груза на площадке. По умолчанию устанавливается текущая дата UTC.

EndDate: date-time (nullable)

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

EndDateBoundary: date-time (nullable)

Время окончания аукциона "завершить не позже". Если указанное время, меньше значения Duration - аукцион заканчивается по времени "завершить не позже", если нет автопродления. Время устанавливается в формате UTC.

Nds: decimal (nullable)

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

TimeToProvideDocuments*: decimal

Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.

AutoRenew: boolean

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

RenewTime: int32 (nullable)

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

MaxRenewTime: int32 (nullable)

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

RaiseBid: boolean

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

MaxRate: decimal (nullable)

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

RaiseBidInterval: int32 (nullable)

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

ResponseInMinutes: int32 (nullable)

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

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

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

Duration: int32

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

StartSinceFirstBet: boolean

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

AuctionRestartParameters:{...}

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

AuctionFinishAction: enum

[1, 2, 3]

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

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

InitRestartCount: int32

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

InitChangeWinnerCount: int32

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

DurationAfterRestart: int32 (nullable)

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

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

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

WinnerCriterion: enum

[0, 1]

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

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

}

Boards:[{...}]

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

BoardId: string

ID площадки

PublicationTime: date-time (nullable)

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

IsReservationEnabled: boolean

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

PublicationOption: int32

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

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

}]

UnloadFirstDate: date-time (nullable)

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

UnloadLastDate: date-time (nullable)

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

}

CURL

Копировать

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

Ответ

200 Восстановленный груз

Развернуть все Свернуть все

Пример

Модель

{...}

"LoadMeta":{...},

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

"MetaData":"string"

"ContactId1":0,

"ContactId2":0,

"Note":"string",

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

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

"DateType":0,

"PeriodicityId":0,

"OrderNumber":"string",

"Krugoreis":false,

"Loading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

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

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

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"ExtraPoints":[...],

{...}

"CityId":0,

"PointType":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

"OrdinalId":0,

"IsRoundTheClock":false,

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

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

"LoadingTimeStart":null,

"LoadingTimeEnd":null,

"LoadingCargos":[...],

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"UnloadingCargos":[...]

{...}

"CargoId":0,

"Weight":0.5,

"Volume":0.5,

"PackagingQuantity":0,

"IsDefinedByTtn":false

}

]

}

"Unloading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

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

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

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"Cargo":{...},

"Weight":0.5,

"Volume":0.5,

"ADR":0,

"CargoTypeId":0,

"CargoType":"string",

"PackType":0,

"PalletCount":0,

"BeltCount":0,

"DogruzType":0,

"SborGruz":false,

"Size":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"Transport":{...},

"CarType":0,

"LoadingType":0,

"LoadingLogicalOperator":"string",

"UnloadingType":0,

"UnloadingLogicalOperator":"string",

"TrucksQuantity":0,

"TemperatureFrom":0,

"TemperatureTo":0,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false

"Payment":{...},

"CurrencyId":0,

"MoneyType":0,

"RateSum":0.5,

"SumWithNDS":0.5,

"SumWithoutNDS":0.5,

"PrepayPercent":0,

"PrepayPercentEnabled":false,

"PayDays":0,

"PayDaysEnabled":false,

"FixedRate":false,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

"InviteSettings":{...},

"InviteDelayInSeconds":0,

"InviteDurationInSeconds":0

"PriorityView":{...},

"DailyLimit":0.5,

"IsForPayedOnly":false,

"OrderLimit":0.5,

"ViewRate":0.5,

"MoneySpentPerDay":0.5,

"MoneySpentPerOrder":0.5

"Stealth":{...},

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

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

"ScoreToHide":0.5

"LoadFiles":[...],

{...}

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

"FileType":0,

"Attributes":0,

"Name":"string",

"Link":"string",

"Size":0

}

"Deal":{...},

"Auction":{...}

"StartRate":0.5,

"Currency":0,

"Step":0.5,

"PaymentType":0,

"AcceptSecondPayType":false,

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

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

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

"Nds":0.5,

"TimeToProvideDocuments":0.5,

"AutoRenew":false,

"RenewTime":0,

"MaxRenewTime":0,

"RaiseBid":false,

"MaxRate":0.5,

"RaiseBidInterval":0,

"ResponseInMinutes":0,

"Duration":0,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":0,

"InitChangeWinnerCount":0,

"DurationAfterRestart":0

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

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

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

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

"State":0,

"Finished":false,

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

"AuctionRates":[...]

{...}

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

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

"RateFirm":{...},

"Score":0.5,

"Status":0,

"Name":"string",

"ContactName":"string",

"AtiId":"string"

"Rate":0.5,

"State":0,

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

"FirmId":0,

"ContactId":0

}

]

}

"Boards":[...],

{...}

"BoardId":"string",

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

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":false,

"IsCommonBoard":false

}

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

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

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

"ArchiveReason":"Unknown",

"TruePrice":0,

"TrueCurrencyId":0,

"ResponseCount":0,

"OfferCount":0,

"CanBeDeleted":false,

"HasPermissionsToLoad":false,

"CanBeEdited":false,

"CanBeRenewed":false,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"string",

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

"LoadNumber":"string",

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

}

{...}

LoadMeta:{...}

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

LoadMetaId: guid (nullable)

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

MetaData: string

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

}

ContactId1*: int32

ContactId2: int32 (nullable)

Note: string

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

FirstDate: date-time

LastDate: date-time

DateType: int32

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

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

PeriodicityId: int32

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

OrderNumber: string

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

Krugoreis: boolean

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

Loading*:{...}

Загрузка

CityId*: int32

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

Latitude: decimal (nullable)

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

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

Longitude: decimal (nullable)

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

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

Street: string

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

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

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

ExtraPoints:[{...}]

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

CityId*: int32

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

PointType*: int32

Тип точки:

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

Latitude: decimal (nullable)

Долгота

Longitude: decimal (nullable)

Широта

Street: string

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

OrdinalId: int32

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

IsRoundTheClock: boolean

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

LoadingDateStart: date-time (nullable)

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

LoadingDateEnd: date-time (nullable)

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

LoadingTimeStart: time-span (nullable)

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

LoadingTimeEnd: time-span (nullable)

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

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

UnloadingCargos:[{...}]

CargoId: int32

Id груза

Weight: double (nullable)

Вес

Volume: double (nullable)

Объём

PackagingQuantity: int32 (nullable)

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

IsDefinedByTtn: boolean

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

}]

Unloading*:{...}

Разгрузка

CityId*: int32

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

Latitude: decimal (nullable)

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

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

Longitude: decimal (nullable)

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

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

Street: string

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

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

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

Cargo*:{...}

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

Weight: double

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

Volume: double

ADR: int32

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

CargoTypeId*: int32

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

CargoType: string

PackType: int32

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

PalletCount: int32

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

BeltCount: int32

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

DogruzType*: int32

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

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

SborGruz: boolean

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

Size:{...}

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

Length: double

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

Width: double

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

Height: double

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

Diameter: double

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

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

Transport*:{...}

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

CarType*: int64

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

LoadingType: int32

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

LoadingLogicalOperator: string

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

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

UnloadingType: int32

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

UnloadingLogicalOperator: string

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

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

TrucksQuantity: int32

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

TemperatureFrom: int32 (nullable)

TemperatureTo: int32 (nullable)

Stsepka: boolean

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

Pnevmohod: boolean

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

Koniki: boolean

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

TIR: boolean

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

CMR: boolean

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

T1: boolean

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

SanPassport: boolean

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

IsTracking: boolean

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

}

Payment*:{...}

Оплата

CurrencyId: int32

MoneyType: int32

RateSum: decimal

SumWithNDS: decimal

SumWithoutNDS: decimal

PrepayPercent: int32

PrepayPercentEnabled: boolean

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

PayDays: int32

PayDaysEnabled: boolean

FixedRate: boolean

Torg: boolean

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

DirectContract: boolean

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

InFuel: boolean

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

OnUnloading: boolean

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

HideResponses: boolean

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

AcceptPaymentTypes: int32

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

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

}

InviteSettings:{...}

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

InviteDelayInSeconds: int32

InviteDurationInSeconds: int32

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

}

PriorityView:{...}

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

DailyLimit: decimal

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

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

IsForPayedOnly: boolean

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

OrderLimit: decimal

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

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

ViewRate*: decimal

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

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

MoneySpentPerDay: decimal

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

MoneySpentPerOrder: decimal

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

}

Stealth:{...}

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

ListIdToHide: guid (nullable)

FirmRegDateToHide: date-time (nullable)

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

ScoreToHide: double (nullable)

}

LoadFiles:[{...}]

Id: guid

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

FileType: int32

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

1 - документ

Attributes: int32

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

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

Name: string

Link: string

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

Size: int32

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

}]

Deal:{...}

Auction:{...}

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

StartRate*: decimal

Currency*: int32

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

Step*: decimal

PaymentType*: enum

[1, 22, 23, 24, 25]

Тип оплаты

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

AcceptSecondPayType: boolean

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

StartDate: date-time

EndDate: date-time (nullable)

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

EndDateBoundary: date-time (nullable)

Nds: decimal (nullable)

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

TimeToProvideDocuments*: decimal

AutoRenew: boolean

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

RenewTime: int32 (nullable)

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

MaxRenewTime: int32 (nullable)

RaiseBid: boolean

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

MaxRate: decimal (nullable)

RaiseBidInterval: int32 (nullable)

ResponseInMinutes: int32 (nullable)

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

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

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

Duration: int32

StartSinceFirstBet: boolean

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

AuctionRestartParameters:{...}

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

AuctionFinishAction: enum

[1, 2, 3]

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

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

InitRestartCount: int32

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

InitChangeWinnerCount: int32

DurationAfterRestart: int32 (nullable)

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

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

WinnerCriterion: enum

[0, 1]

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

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

AuctionId: guid

Id аукциона

LoadId: guid

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

ActiveDealId: guid (nullable)

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

State: enum

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

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

-100 - Не удалось определить состояние аукциона
-14 - Аукцион отменен руками грузовладельца
-13 - Аукцион удален, т.к. расторгнут заказ
-12 - Аукцион без ставок завершен
-11 - Аукцион удален автоматически
-10 - Аукцион удален т.к. сделка завершена
-9 - Аукцион удален
-8 - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет
-7 - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель
-6 - При включенном копировании грузов: торги завершены, экспедитор не является победителем
-5 - Одна ставка лучшая по цене, другая по дате
-4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
-3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
-2 - Закончился, ждем когда победитель возьмет груз
-1 - Закончился, ставок нет
0 - Идет, ставок нет
1 - Идет (уже есть валидные ставки)

Finished: boolean

Завершен ли аукцион

WinDate: date-time (nullable)

Время выигрыша ставки (когда для определенной ставки в AuctionRates установлен State = Winner)

AuctionRates:[{...}]

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

AuctionRateId: guid

ID ставки

AddedAt: date-time

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

RateFirm:{...}

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

Score: double

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

Status: enum

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

Тип звезд фирмы

0: Серый
1: Красный
2: Желтый
3: Зеленый
4: Партнер АТИ
5: Сотрудник АТИ
6: Гос. органы
7: ОДКС

Name: string

Имя фирмы

ContactName: string

Имя контакта

AtiId: string

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

}

Rate: decimal

Ставка на груз, которую поставил пользователь

State: enum

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

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

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

LoadingDate: date-time (nullable)

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

FirmId: int32

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

ContactId: int32

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

}]

}

Boards:[{...}]

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

BoardId: string

ID площадки

PublicationTime: date-time (nullable)

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

IsReservationEnabled: boolean

PublicationOption: int32

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

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

IsPublished: boolean

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

IsCommonBoard: boolean

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

}]

UnloadFirstDate: date-time (nullable)

UnloadLastDate: date-time (nullable)

ArchiveDate: date-time (nullable)

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

ArchiveReason: enum (nullable)

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

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

TruePrice: int32

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

TrueCurrencyId: int32

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

ResponseCount: int32

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

OfferCount: int32

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

CanBeDeleted: boolean

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

HasPermissionsToLoad: boolean

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

CanBeEdited: boolean

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

CanBeRenewed: boolean

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

CanBeRestored: boolean

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

EditRestriction: enum

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

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

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

DeleteRestriction: enum

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

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

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

RestoreRestriction: enum

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

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

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

RenewRestriction: string

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

Id: guid

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

LoadNumber: string

Номер груза

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 аукциона

}

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

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

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

Reason: string

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

Error: string

Ключ ошибки

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

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

Reason: string

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

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Групповое восстановление архивных грузов

Групповое восстановление грузов

put

/v1.0/unpublished-loads/restore

ids

array

Добавить еще поле

CURL

Копировать

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

Ответ

200 Статус

Развернуть все Свернуть все

Пример

Модель

{...}

"any-key":{...}

"Status":0,

"Message":"string"

}

{...}

any-key:{...}

Status: int32

Статус операции для груза.

8 - Произошла внутренняя ошибка при обработке груза
7 - Ошибка валидации груза
6 - Груз был объединен с другим грузом
5 - Найден дубликат в актуальных грузах
4 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Нет доступа
2 - Груз был обновлен или добавлен менее часа назад
1 - Груз не найден
0 - Успех
-1 - Меньше 0 - произошла незапланированная ошибка

Message: string

Сообщение, которое отдается пользователю

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

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

Reason: string

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

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение одного архивного груза

Метод для получения заданного архивного груза

get

/v1.0/unpublished-loads/{loadId}

loadId

guid

id архивного груза

CURL

Копировать

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

Ответ

200 Архивный груз

Развернуть все Свернуть все

Пример

Модель

{...}

"LoadMeta":{...},

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

"MetaData":"string"

"ContactId1":0,

"ContactId2":0,

"Note":"string",

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

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

"DateType":0,

"PeriodicityId":0,

"OrderNumber":"string",

"Krugoreis":false,

"Loading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

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

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

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"ExtraPoints":[...],

{...}

"CityId":0,

"PointType":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

"OrdinalId":0,

"IsRoundTheClock":false,

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

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

"LoadingTimeStart":null,

"LoadingTimeEnd":null,

"LoadingCargos":[...],

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"UnloadingCargos":[...]

{...}

"CargoId":0,

"Weight":0.5,

"Volume":0.5,

"PackagingQuantity":0,

"IsDefinedByTtn":false

}

]

}

"Unloading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

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

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

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"Cargo":{...},

"Weight":0.5,

"Volume":0.5,

"ADR":0,

"CargoTypeId":0,

"CargoType":"string",

"PackType":0,

"PalletCount":0,

"BeltCount":0,

"DogruzType":0,

"SborGruz":false,

"Size":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"Transport":{...},

"CarType":0,

"LoadingType":0,

"LoadingLogicalOperator":"string",

"UnloadingType":0,

"UnloadingLogicalOperator":"string",

"TrucksQuantity":0,

"TemperatureFrom":0,

"TemperatureTo":0,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false

"Payment":{...},

"CurrencyId":0,

"MoneyType":0,

"RateSum":0.5,

"SumWithNDS":0.5,

"SumWithoutNDS":0.5,

"PrepayPercent":0,

"PrepayPercentEnabled":false,

"PayDays":0,

"PayDaysEnabled":false,

"FixedRate":false,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

"InviteSettings":{...},

"InviteDelayInSeconds":0,

"InviteDurationInSeconds":0

"PriorityView":{...},

"DailyLimit":0.5,

"IsForPayedOnly":false,

"OrderLimit":0.5,

"ViewRate":0.5,

"MoneySpentPerDay":0.5,

"MoneySpentPerOrder":0.5

"Stealth":{...},

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

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

"ScoreToHide":0.5

"LoadFiles":[...],

{...}

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

"FileType":0,

"Attributes":0,

"Name":"string",

"Link":"string",

"Size":0

}

"Deal":{...},

"Auction":{...}

"StartRate":0.5,

"Currency":0,

"Step":0.5,

"PaymentType":0,

"AcceptSecondPayType":false,

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

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

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

"Nds":0.5,

"TimeToProvideDocuments":0.5,

"AutoRenew":false,

"RenewTime":0,

"MaxRenewTime":0,

"RaiseBid":false,

"MaxRate":0.5,

"RaiseBidInterval":0,

"ResponseInMinutes":0,

"Duration":0,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":0,

"InitChangeWinnerCount":0,

"DurationAfterRestart":0

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

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

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

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

"State":0,

"Finished":false,

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

"AuctionRates":[...]

{...}

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

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

"RateFirm":{...},

"Score":0.5,

"Status":0,

"Name":"string",

"ContactName":"string",

"AtiId":"string"

"Rate":0.5,

"State":0,

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

"FirmId":0,

"ContactId":0

}

]

}

"Boards":[...],

{...}

"BoardId":"string",

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

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":false,

"IsCommonBoard":false

}

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

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

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

"ArchiveReason":"Unknown",

"TruePrice":0,

"TrueCurrencyId":0,

"ResponseCount":0,

"OfferCount":0,

"CanBeDeleted":false,

"HasPermissionsToLoad":false,

"CanBeEdited":false,

"CanBeRenewed":false,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"string",

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

"LoadNumber":"string",

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

}

{...}

LoadMeta:{...}

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

LoadMetaId: guid (nullable)

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

MetaData: string

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

}

ContactId1*: int32

ContactId2: int32 (nullable)

Note: string

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

FirstDate: date-time

LastDate: date-time

DateType: int32

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

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

PeriodicityId: int32

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

OrderNumber: string

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

Krugoreis: boolean

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

Loading*:{...}

Загрузка

CityId*: int32

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

Latitude: decimal (nullable)

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

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

Longitude: decimal (nullable)

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

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

Street: string

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

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

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

ExtraPoints:[{...}]

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

CityId*: int32

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

PointType*: int32

Тип точки:

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

Latitude: decimal (nullable)

Долгота

Longitude: decimal (nullable)

Широта

Street: string

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

OrdinalId: int32

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

IsRoundTheClock: boolean

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

LoadingDateStart: date-time (nullable)

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

LoadingDateEnd: date-time (nullable)

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

LoadingTimeStart: time-span (nullable)

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

LoadingTimeEnd: time-span (nullable)

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

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

UnloadingCargos:[{...}]

CargoId: int32

Id груза

Weight: double (nullable)

Вес

Volume: double (nullable)

Объём

PackagingQuantity: int32 (nullable)

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

IsDefinedByTtn: boolean

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

}]

Unloading*:{...}

Разгрузка

CityId*: int32

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

Latitude: decimal (nullable)

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

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

Longitude: decimal (nullable)

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

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

Street: string

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

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

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

Cargo*:{...}

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

Weight: double

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

Volume: double

ADR: int32

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

CargoTypeId*: int32

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

CargoType: string

PackType: int32

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

PalletCount: int32

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

BeltCount: int32

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

DogruzType*: int32

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

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

SborGruz: boolean

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

Size:{...}

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

Length: double

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

Width: double

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

Height: double

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

Diameter: double

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

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

Transport*:{...}

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

CarType*: int64

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

LoadingType: int32

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

LoadingLogicalOperator: string

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

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

UnloadingType: int32

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

UnloadingLogicalOperator: string

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

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

TrucksQuantity: int32

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

TemperatureFrom: int32 (nullable)

TemperatureTo: int32 (nullable)

Stsepka: boolean

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

Pnevmohod: boolean

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

Koniki: boolean

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

TIR: boolean

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

CMR: boolean

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

T1: boolean

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

SanPassport: boolean

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

IsTracking: boolean

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

}

Payment*:{...}

Оплата

CurrencyId: int32

MoneyType: int32

RateSum: decimal

SumWithNDS: decimal

SumWithoutNDS: decimal

PrepayPercent: int32

PrepayPercentEnabled: boolean

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

PayDays: int32

PayDaysEnabled: boolean

FixedRate: boolean

Torg: boolean

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

DirectContract: boolean

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

InFuel: boolean

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

OnUnloading: boolean

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

HideResponses: boolean

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

AcceptPaymentTypes: int32

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

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

}

InviteSettings:{...}

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

InviteDelayInSeconds: int32

InviteDurationInSeconds: int32

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

}

PriorityView:{...}

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

DailyLimit: decimal

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

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

IsForPayedOnly: boolean

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

OrderLimit: decimal

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

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

ViewRate*: decimal

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

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

MoneySpentPerDay: decimal

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

MoneySpentPerOrder: decimal

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

}

Stealth:{...}

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

ListIdToHide: guid (nullable)

FirmRegDateToHide: date-time (nullable)

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

ScoreToHide: double (nullable)

}

LoadFiles:[{...}]

Id: guid

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

FileType: int32

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

1 - документ

Attributes: int32

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

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

Name: string

Link: string

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

Size: int32

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

}]

Deal:{...}

Auction:{...}

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

StartRate*: decimal

Currency*: int32

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

Step*: decimal

PaymentType*: enum

[1, 22, 23, 24, 25]

Тип оплаты

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

AcceptSecondPayType: boolean

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

StartDate: date-time

EndDate: date-time (nullable)

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

EndDateBoundary: date-time (nullable)

Nds: decimal (nullable)

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

TimeToProvideDocuments*: decimal

AutoRenew: boolean

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

RenewTime: int32 (nullable)

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

MaxRenewTime: int32 (nullable)

RaiseBid: boolean

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

MaxRate: decimal (nullable)

RaiseBidInterval: int32 (nullable)

ResponseInMinutes: int32 (nullable)

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

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

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

Duration: int32

StartSinceFirstBet: boolean

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

AuctionRestartParameters:{...}

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

AuctionFinishAction: enum

[1, 2, 3]

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

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

InitRestartCount: int32

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

InitChangeWinnerCount: int32

DurationAfterRestart: int32 (nullable)

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

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

WinnerCriterion: enum

[0, 1]

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

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

AuctionId: guid

Id аукциона

LoadId: guid

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

ActiveDealId: guid (nullable)

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

State: enum

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

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

-100 - Не удалось определить состояние аукциона
-14 - Аукцион отменен руками грузовладельца
-13 - Аукцион удален, т.к. расторгнут заказ
-12 - Аукцион без ставок завершен
-11 - Аукцион удален автоматически
-10 - Аукцион удален т.к. сделка завершена
-9 - Аукцион удален
-8 - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет
-7 - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель
-6 - При включенном копировании грузов: торги завершены, экспедитор не является победителем
-5 - Одна ставка лучшая по цене, другая по дате
-4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
-3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
-2 - Закончился, ждем когда победитель возьмет груз
-1 - Закончился, ставок нет
0 - Идет, ставок нет
1 - Идет (уже есть валидные ставки)

Finished: boolean

Завершен ли аукцион

WinDate: date-time (nullable)

Время выигрыша ставки (когда для определенной ставки в AuctionRates установлен State = Winner)

AuctionRates:[{...}]

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

AuctionRateId: guid

ID ставки

AddedAt: date-time

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

RateFirm:{...}

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

Score: double

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

Status: enum

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

Тип звезд фирмы

0: Серый
1: Красный
2: Желтый
3: Зеленый
4: Партнер АТИ
5: Сотрудник АТИ
6: Гос. органы
7: ОДКС

Name: string

Имя фирмы

ContactName: string

Имя контакта

AtiId: string

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

}

Rate: decimal

Ставка на груз, которую поставил пользователь

State: enum

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

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

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

LoadingDate: date-time (nullable)

FirmId: int32

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

ContactId: int32

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

}]

}

Boards:[{...}]

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

BoardId: string

ID площадки

PublicationTime: date-time (nullable)

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

IsReservationEnabled: boolean

PublicationOption: int32

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

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

IsPublished: boolean

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

IsCommonBoard: boolean

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

}]

UnloadFirstDate: date-time (nullable)

UnloadLastDate: date-time (nullable)

ArchiveDate: date-time (nullable)

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

ArchiveReason: enum (nullable)

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

TruePrice: int32

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

TrueCurrencyId: int32

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

ResponseCount: int32

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

OfferCount: int32

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

CanBeDeleted: boolean

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

HasPermissionsToLoad: boolean

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

CanBeEdited: boolean

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

CanBeRenewed: boolean

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

CanBeRestored: boolean

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

EditRestriction: enum

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

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

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

DeleteRestriction: enum

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

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

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

RestoreRestriction: enum

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

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

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

RenewRestriction: string

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

Id: guid

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

LoadNumber: string

Номер груза

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 аукциона

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

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

Reason: string

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

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение всех архивных грузов

Доступен фильтр по контакту. При передаче значения в contactId будут получены только те грузы, у которых ContactId1 == contactId либо ContactId2 == contactId.

Метод для получения списка всех архивных грузов

get

/v1.0/unpublished-loads

contactId

int32

ID контакта

CURL

Копировать

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

Ответ

200 Архивные грузы

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"LoadMeta":{...},

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

"MetaData":"string"

"ContactId1":0,

"ContactId2":0,

"Note":"string",

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

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

"DateType":0,

"PeriodicityId":0,

"OrderNumber":"string",

"Krugoreis":false,

"Loading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

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

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

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"ExtraPoints":[...],

{...}

"CityId":0,

"PointType":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

"OrdinalId":0,

"IsRoundTheClock":false,

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

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

"LoadingTimeStart":null,

"LoadingTimeEnd":null,

"LoadingCargos":[...],

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"UnloadingCargos":[...]

{...}

"CargoId":0,

"Weight":0.5,

"Volume":0.5,

"PackagingQuantity":0,

"IsDefinedByTtn":false

}

]

}

"Unloading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

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

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

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"Cargo":{...},

"Weight":0.5,

"Volume":0.5,

"ADR":0,

"CargoTypeId":0,

"CargoType":"string",

"PackType":0,

"PalletCount":0,

"BeltCount":0,

"DogruzType":0,

"SborGruz":false,

"Size":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"Transport":{...},

"CarType":0,

"LoadingType":0,

"LoadingLogicalOperator":"string",

"UnloadingType":0,

"UnloadingLogicalOperator":"string",

"TrucksQuantity":0,

"TemperatureFrom":0,

"TemperatureTo":0,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false

"Payment":{...},

"CurrencyId":0,

"MoneyType":0,

"RateSum":0.5,

"SumWithNDS":0.5,

"SumWithoutNDS":0.5,

"PrepayPercent":0,

"PrepayPercentEnabled":false,

"PayDays":0,

"PayDaysEnabled":false,

"FixedRate":false,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

"InviteSettings":{...},

"InviteDelayInSeconds":0,

"InviteDurationInSeconds":0

"PriorityView":{...},

"DailyLimit":0.5,

"IsForPayedOnly":false,

"OrderLimit":0.5,

"ViewRate":0.5,

"MoneySpentPerDay":0.5,

"MoneySpentPerOrder":0.5

"Stealth":{...},

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

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

"ScoreToHide":0.5

"LoadFiles":[...],

{...}

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

"FileType":0,

"Attributes":0,

"Name":"string",

"Link":"string",

"Size":0

}

"Deal":{...},

"Auction":{...}

"StartRate":0.5,

"Currency":0,

"Step":0.5,

"PaymentType":0,

"AcceptSecondPayType":false,

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

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

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

"Nds":0.5,

"TimeToProvideDocuments":0.5,

"AutoRenew":false,

"RenewTime":0,

"MaxRenewTime":0,

"RaiseBid":false,

"MaxRate":0.5,

"RaiseBidInterval":0,

"ResponseInMinutes":0,

"Duration":0,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":0,

"InitChangeWinnerCount":0,

"DurationAfterRestart":0

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

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

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

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

"State":0,

"Finished":false,

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

"AuctionRates":[...]

{...}

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

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

"RateFirm":{...},

"Score":0.5,

"Status":0,

"Name":"string",

"ContactName":"string",

"AtiId":"string"

"Rate":0.5,

"State":0,

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

"FirmId":0,

"ContactId":0

}

]

}

"Boards":[...],

{...}

"BoardId":"string",

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

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":false,

"IsCommonBoard":false

}

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

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

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

"ArchiveReason":"Unknown",

"TruePrice":0,

"TrueCurrencyId":0,

"ResponseCount":0,

"OfferCount":0,

"CanBeDeleted":false,

"HasPermissionsToLoad":false,

"CanBeEdited":false,

"CanBeRenewed":false,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"string",

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

"LoadNumber":"string",

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

}

]

[{...}]

LoadMeta:{...}

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

LoadMetaId: guid (nullable)

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

MetaData: string

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

}

ContactId1*: int32

ContactId2: int32 (nullable)

Note: string

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

FirstDate: date-time

LastDate: date-time

DateType: int32

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

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

PeriodicityId: int32

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

OrderNumber: string

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

Krugoreis: boolean

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

Loading*:{...}

Загрузка

CityId*: int32

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

Latitude: decimal (nullable)

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

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

Longitude: decimal (nullable)

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

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

Street: string

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

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

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

ExtraPoints:[{...}]

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

CityId*: int32

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

PointType*: int32

Тип точки:

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

Latitude: decimal (nullable)

Долгота

Longitude: decimal (nullable)

Широта

Street: string

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

OrdinalId: int32

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

IsRoundTheClock: boolean

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

LoadingDateStart: date-time (nullable)

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

LoadingDateEnd: date-time (nullable)

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

LoadingTimeStart: time-span (nullable)

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

LoadingTimeEnd: time-span (nullable)

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

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

UnloadingCargos:[{...}]

CargoId: int32

Id груза

Weight: double (nullable)

Вес

Volume: double (nullable)

Объём

PackagingQuantity: int32 (nullable)

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

IsDefinedByTtn: boolean

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

}]

Unloading*:{...}

Разгрузка

CityId*: int32

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

Latitude: decimal (nullable)

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

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

Longitude: decimal (nullable)

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

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

Street: string

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

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

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

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

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

Cargo*:{...}

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

Weight: double

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

Volume: double

ADR: int32

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

CargoTypeId*: int32

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

CargoType: string

PackType: int32

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

PalletCount: int32

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

BeltCount: int32

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

DogruzType*: int32

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

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

SborGruz: boolean

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

Size:{...}

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

Length: double

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

Width: double

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

Height: double

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

Diameter: double

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

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

Transport*:{...}

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

CarType*: int64

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

LoadingType: int32

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

LoadingLogicalOperator: string

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

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

UnloadingType: int32

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

UnloadingLogicalOperator: string

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

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

TrucksQuantity: int32

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

TemperatureFrom: int32 (nullable)

TemperatureTo: int32 (nullable)

Stsepka: boolean

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

Pnevmohod: boolean

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

Koniki: boolean

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

TIR: boolean

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

CMR: boolean

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

T1: boolean

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

SanPassport: boolean

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

IsTracking: boolean

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

}

Payment*:{...}

Оплата

CurrencyId: int32

MoneyType: int32

RateSum: decimal

SumWithNDS: decimal

SumWithoutNDS: decimal

PrepayPercent: int32

PrepayPercentEnabled: boolean

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

PayDays: int32

PayDaysEnabled: boolean

FixedRate: boolean

Torg: boolean

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

DirectContract: boolean

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

InFuel: boolean

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

OnUnloading: boolean

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

HideResponses: boolean

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

AcceptPaymentTypes: int32

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

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

}

InviteSettings:{...}

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

InviteDelayInSeconds: int32

InviteDurationInSeconds: int32

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

}

PriorityView:{...}

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

DailyLimit: decimal

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

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

IsForPayedOnly: boolean

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

OrderLimit: decimal

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

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

ViewRate*: decimal

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

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

MoneySpentPerDay: decimal

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

MoneySpentPerOrder: decimal

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

}

Stealth:{...}

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

ListIdToHide: guid (nullable)

FirmRegDateToHide: date-time (nullable)

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

ScoreToHide: double (nullable)

}

LoadFiles:[{...}]

Id: guid

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

FileType: int32

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

1 - документ

Attributes: int32

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

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

Name: string

Link: string

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

Size: int32

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

}]

Deal:{...}

Auction:{...}

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

StartRate*: decimal

Currency*: int32

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

Step*: decimal

PaymentType*: enum

[1, 22, 23, 24, 25]

Тип оплаты

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

AcceptSecondPayType: boolean

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

StartDate: date-time

EndDate: date-time (nullable)

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

EndDateBoundary: date-time (nullable)

Nds: decimal (nullable)

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

TimeToProvideDocuments*: decimal

AutoRenew: boolean

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

RenewTime: int32 (nullable)

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

MaxRenewTime: int32 (nullable)

RaiseBid: boolean

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

MaxRate: decimal (nullable)

RaiseBidInterval: int32 (nullable)

ResponseInMinutes: int32 (nullable)

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

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

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

Duration: int32

StartSinceFirstBet: boolean

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

AuctionRestartParameters:{...}

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

AuctionFinishAction: enum

[1, 2, 3]

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

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

InitRestartCount: int32

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

InitChangeWinnerCount: int32

DurationAfterRestart: int32 (nullable)

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

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

WinnerCriterion: enum

[0, 1]

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

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

AuctionId: guid

Id аукциона

LoadId: guid

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

ActiveDealId: guid (nullable)

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

State: enum

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

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

-100 - Не удалось определить состояние аукциона
-14 - Аукцион отменен руками грузовладельца
-13 - Аукцион удален, т.к. расторгнут заказ
-12 - Аукцион без ставок завершен
-11 - Аукцион удален автоматически
-10 - Аукцион удален т.к. сделка завершена
-9 - Аукцион удален
-8 - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет
-7 - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель
-6 - При включенном копировании грузов: торги завершены, экспедитор не является победителем
-5 - Одна ставка лучшая по цене, другая по дате
-4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
-3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
-2 - Закончился, ждем когда победитель возьмет груз
-1 - Закончился, ставок нет
0 - Идет, ставок нет
1 - Идет (уже есть валидные ставки)

Finished: boolean

Завершен ли аукцион

WinDate: date-time (nullable)

Время выигрыша ставки (когда для определенной ставки в AuctionRates установлен State = Winner)

AuctionRates:[{...}]

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

AuctionRateId: guid

ID ставки

AddedAt: date-time

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

RateFirm:{...}

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

Score: double

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

Status: enum

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

Тип звезд фирмы

0: Серый
1: Красный
2: Желтый
3: Зеленый
4: Партнер АТИ
5: Сотрудник АТИ
6: Гос. органы
7: ОДКС

Name: string

Имя фирмы

ContactName: string

Имя контакта

AtiId: string

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

}

Rate: decimal

Ставка на груз, которую поставил пользователь

State: enum

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

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

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

LoadingDate: date-time (nullable)

FirmId: int32

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

ContactId: int32

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

}]

}

Boards:[{...}]

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

BoardId: string

ID площадки

PublicationTime: date-time (nullable)

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

IsReservationEnabled: boolean

PublicationOption: int32

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

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

IsPublished: boolean

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

IsCommonBoard: boolean

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

}]

UnloadFirstDate: date-time (nullable)

UnloadLastDate: date-time (nullable)

ArchiveDate: date-time (nullable)

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

ArchiveReason: enum (nullable)

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

TruePrice: int32

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

TrueCurrencyId: int32

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

ResponseCount: int32

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

OfferCount: int32

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

CanBeDeleted: boolean

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

HasPermissionsToLoad: boolean

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

CanBeEdited: boolean

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

CanBeRenewed: boolean

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

CanBeRestored: boolean

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

EditRestriction: enum

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

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

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

DeleteRestriction: enum

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

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

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

RestoreRestriction: enum

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

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

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

RenewRestriction: string

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

Id: guid

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

LoadNumber: string

Номер груза

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 аукциона

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

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

Reason: string

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

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление одного архивного груза

Удаление одного груза

delete

/v1.0/unpublished-loads/{loadId}

loadId

guid

CURL

Копировать

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

Ответ

200 Статус

Развернуть все Свернуть все

Пример

Модель

{...}

"any-key":{...}

"Status":0,

"Message":"string"

}

{...}

any-key:{...}

Status: int32

Статус операции для груза.

8 - Произошла внутренняя ошибка при обработке груза
7 - Ошибка валидации груза
6 - Груз был объединен с другим грузом
5 - Найден дубликат в актуальных грузах
4 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Нет доступа
2 - Груз был обновлен или добавлен менее часа назад
1 - Груз не найден
0 - Успех
-1 - Меньше 0 - произошла незапланированная ошибка

Message: string

Сообщение, которое отдается пользователю

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

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

Reason: string

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

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление нескольких архивных грузов

Метод для удаления списка архивных грузов

delete

/v1.0/unpublished-loads

ids

array

Добавить еще поле

id грузов для удаления

CURL

Копировать

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

Ответ

200 Статус

Развернуть все Свернуть все

Пример

Модель

{...}

"any-key":{...}

"Status":0,

"Message":"string"

}

{...}

any-key:{...}

Status: int32

Статус операции для груза.

8 - Произошла внутренняя ошибка при обработке груза
7 - Ошибка валидации груза
6 - Груз был объединен с другим грузом
5 - Найден дубликат в актуальных грузах
4 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Нет доступа
2 - Груз был обновлен или добавлен менее часа назад
1 - Груз не найден
0 - Успех
-1 - Меньше 0 - произошла незапланированная ошибка

Message: string

Сообщение, которое отдается пользователю

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

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

Reason: string

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

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

Получение всех комментариев ко всем архивным грузам для текущей фирмы

Ответ будет представлен в виде словаря, где ключ - это id груза, а значение - массив структуры “комментарий”.

Получение всех комментариев фирмы ко всем грузам

get

/v1.0/unpublished-loads/comments

CURL

Копировать

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

Ответ

200 Комментарии ко всем архивным грузам фирмы

Развернуть все Свернуть все

Пример

Модель

{...}

"any-key":[...]

{...}

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

"Message":"string",

"ContactId":0,

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

}

]

}

{...}

any-key:[{...}]

CommentId: guid

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

Message: string

Комментарий

ContactId: int32

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

CommentDateTime: date-time

Время, когда комментарий был оставлен

}]

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

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

Reason: string

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

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение всех комментариев к архивному грузу для текущей фирмы

Получение всех комментариев к грузу для текущей фирмы.

get

/v1.0/unpublished-loads/{loadId}/comments

loadId

guid

ID груза

CURL

Копировать

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

Ответ

200 Комментарии к архивному грузу

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

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

"Message":"string",

"ContactId":0,

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

}

]

[{...}]

CommentId: guid

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

Message: string

Комментарий

ContactId: int32

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

CommentDateTime: date-time

Время, когда комментарий был оставлен

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

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

Reason: string

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

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

При редактировании комментария у изменённого комментария поменяется CommentId.

Требования к комментарию

комментарий не может быть пустым
длина комментария не более 128 символов
если для фирмы включен режим раздельного доступа, то количество комментариев ограничено одним на контакт, иначе – одним комментарием на фирму
комментарий можно добавлять только к собственному грузу

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

put

/v1.0/unpublished-loads/{loadId}/comments

loadId

guid

ID груза

                
                body

                        string
                      
                      "string"

                      Комментарий

CURL

Копировать

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

Ответ

200 Комментарий к архивному грузу

Развернуть все Свернуть все

Пример

Модель

{...}

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

"Message":"string",

"ContactId":0,

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

}

{...}

CommentId: guid

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

Message: string

Комментарий

ContactId: int32

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

CommentDateTime: date-time

Время, когда комментарий был оставлен

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

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

Reason: string

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

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление комментария у архивного груза.

Удаление комментария у груза.

delete

/v1.0/unpublished-loads/{loadId}/comments

loadId

guid

ID груза

CURL

Копировать

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

Ответ

200 Комментарий к архивному грузу успешно удален

Развернуть все Свернуть все

Пример

Модель

"string"

string

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

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

Reason: string

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

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

Отзыв может быть “Встречным предложением”, “Груза нет”, “Озвученная ставка”.

Требования к дате, передаваемой в 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+3(Москва)

Получение встречных предложений на все архивные грузы фирмы

Получение встречных предложений на грузы фирмы с одной или несколькими ставками .

get

/v1.0/unpublished-loads/new/responses

dateFrom

date-time

Дата в UTC, начиная с которой необходимо показывать отзывы. Если ничего не передано, значит показываем абсолютно все отзывы. Если не передать модификатор часового пояса, дата отправляется в формате UTC+3 (Москва)

CURL

Копировать

Пример ответа

Ответ

200 Массив отзывов на все грузы фирмы

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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"

}

]

[{...}]

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

ИНН

}

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение отзывов на архивный груз по ID

Получение отзывов на конкретный груз фирмы. На данный момент можно получить только встречные предложения.

get

/v1.0/unpublished-loads/new/{loadId}/responses

loadId

guid

ID груза

dateFrom

date-time

CURL

Копировать

Пример ответа

Ответ

200 Массив отзывов

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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"

}

]

[{...}]

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

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

PayAfterMaxBankDays: int32

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

ИНН

}

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение отзывов на архивные грузы в виде словаря

Ответ будет представлен в виде словаря, где ключ – id архивного груза, а значение - массив структур “отзыв на груз”, содержащий:

Result, представляющий набор отзывов для данного груза;
Status, представляющий статус груза: если архивный груз с таким id не найден у вашей фирмы, статус равен 0, иначе статус равен 1. Если у архивного груза статус равен 0, то массив отзывов всегда пуст.

Список ключей словаря полностью совпадает со списком архивных грузов, для которых были запрошены отзывы.

Получение отзывов на заданные грузы фирмы в виде словаря. На данный момент можно получить только встречные предложения.

get

/v1.0/unpublished-loads/new/responses/by-ids

dateFrom

date-time

loadIds

array

Добавить еще поле

Массив id грузов, для которых нужно получить отзывы

CURL

Копировать

Пример ответа

Ответ

200 Массив отзывов по заданным грузам в виде словаря

Развернуть все Свернуть все

Пример

Модель

{...}

"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"

}

{...}

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

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

PayAfterMaxBankDays: int32

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

Причина ошибки

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление встречных предложений у своего архивного груза

Позволяет удалить встречные предложения с указанными id для своего груза

delete

/v1.0/unpublished-loads/new/{loadId}/responses

loadId

guid

ID груза

ids

array

Добавить еще поле

ID отзывов (если нужно удалить встречные предложения у своего груза)

CURL

Копировать

Пример ответа

Ответ

200

Развернуть все Свернуть все

Пример

Модель

{...}

"any-key":{...}

"Status":0,

"Message":"string",

"Error":"string",

"Reason":"string"

}

{...}

any-key:{...}

Status: int32

Статус операции

0 - Успех
-1 - Меньше 0 - произошла незапланированная ошибка

Message: string

Сообщение о результате

Error: string

Ключ ошибки, если Status не равен 0

Reason: string

Причина ошибки, если Status не равен 0

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Методы для поиска архивных грузов

Получение архивных грузов по метаданным

get

/v1.0/unpublished-loads/by_meta/{loadMetaId}

loadMetaId

guid

CURL

Копировать

Пример ответа

Ответ

200 Архивные грузы

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"LoadMeta":{...},

"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"MetaData":"string"

"ContactId1":0,

"ContactId2":0,

"Note":"string",

"FirstDate":"1970-01-01T00:00:00.000Z",

"LastDate":"1970-01-01T00:00:00.000Z",

"DateType":0,

"PeriodicityId":0,

"OrderNumber":"string",

"Krugoreis":false,

"Loading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

"TimeStart":"1970-01-01T00:00:00.000Z",

"TimeEnd":"1970-01-01T00:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"ExtraPoints":[...],

{...}

"CityId":0,

"PointType":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

"OrdinalId":0,

"IsRoundTheClock":false,

"LoadingDateStart":"1970-01-01T00:00:00.000Z",

"LoadingDateEnd":"1970-01-01T00:00:00.000Z",

"LoadingTimeStart":null,

"LoadingTimeEnd":null,

"LoadingCargos":[...],

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"UnloadingCargos":[...]

{...}

"CargoId":0,

"Weight":0.5,

"Volume":0.5,

"PackagingQuantity":0,

"IsDefinedByTtn":false

}

]

}

"Unloading":{...},

"CityId":0,

"Latitude":0.5,

"Longitude":0.5,

"Street":"string",

"TimeStart":"1970-01-01T00:00:00.000Z",

"TimeEnd":"1970-01-01T00:00:00.000Z",

"IsRoundTheClock":false,

"LargeCities":[...],

"LoadingCargos":[...]

{...}

"CargoId":0,

"NameId":0,

"Name":"string",

"PackagingType":0,

"PackagingQuantity":0,

"Weight":0.5,

"Volume":0.5,

"Sizes":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

]

"Cargo":{...},

"Weight":0.5,

"Volume":0.5,

"ADR":0,

"CargoTypeId":0,

"CargoType":"string",

"PackType":0,

"PalletCount":0,

"BeltCount":0,

"DogruzType":0,

"SborGruz":false,

"Size":{...}

"Length":0.5,

"Width":0.5,

"Height":0.5,

"Diameter":0.5,

"LengthHighlight":false,

"WidthHighlight":false,

"HeightHighlight":false

}

"Transport":{...},

"CarType":0,

"LoadingType":0,

"LoadingLogicalOperator":"string",

"UnloadingType":0,

"UnloadingLogicalOperator":"string",

"TrucksQuantity":0,

"TemperatureFrom":0,

"TemperatureTo":0,

"Stsepka":false,

"Pnevmohod":false,

"Koniki":false,

"TIR":false,

"CMR":false,

"T1":false,

"SanPassport":false,

"IsTracking":false

"Payment":{...},

"CurrencyId":0,

"MoneyType":0,

"RateSum":0.5,

"SumWithNDS":0.5,

"SumWithoutNDS":0.5,

"PrepayPercent":0,

"PrepayPercentEnabled":false,

"PayDays":0,

"PayDaysEnabled":false,

"FixedRate":false,

"Torg":false,

"DirectContract":false,

"InFuel":false,

"OnUnloading":false,

"HideResponses":false,

"AcceptPaymentTypes":0

"InviteSettings":{...},

"InviteDelayInSeconds":0,

"InviteDurationInSeconds":0

"PriorityView":{...},

"DailyLimit":0.5,

"IsForPayedOnly":false,

"OrderLimit":0.5,

"ViewRate":0.5,

"MoneySpentPerDay":0.5,

"MoneySpentPerOrder":0.5

"Stealth":{...},

"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"FirmRegDateToHide":"1970-01-01T00:00:00.000Z",

"ScoreToHide":0.5

"LoadFiles":[...],

{...}

"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"FileType":0,

"Attributes":0,

"Name":"string",

"Link":"string",

"Size":0

}

"Deal":{...},

"Auction":{...}

"StartRate":0.5,

"Currency":0,

"Step":0.5,

"PaymentType":0,

"AcceptSecondPayType":false,

"StartDate":"1970-01-01T00:00:00.000Z",

"EndDate":"1970-01-01T00:00:00.000Z",

"EndDateBoundary":"1970-01-01T00:00:00.000Z",

"Nds":0.5,

"TimeToProvideDocuments":0.5,

"AutoRenew":false,

"RenewTime":0,

"MaxRenewTime":0,

"RaiseBid":false,

"MaxRate":0.5,

"RaiseBidInterval":0,

"ResponseInMinutes":0,

"Duration":0,

"StartSinceFirstBet":false,

"AuctionRestartParameters":{...},

"AuctionFinishAction":0,

"InitRestartCount":0,

"InitChangeWinnerCount":0,

"DurationAfterRestart":0

"AcceptCounterOffersOnlyBeforeFirstBet":false,

"WinnerCriterion":0,

"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ActiveDealId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"State":0,

"Finished":false,

"WinDate":"1970-01-01T00:00:00.000Z",

"AuctionRates":[...]

{...}

"AuctionRateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"AddedAt":"1970-01-01T00:00:00.000Z",

"RateFirm":{...},

"Score":0.5,

"Status":0,

"Name":"string",

"ContactName":"string",

"AtiId":"string"

"Rate":0.5,

"State":0,

"LoadingDate":"1970-01-01T00:00:00.000Z",

"FirmId":0,

"ContactId":0

}

]

}

"Boards":[...],

{...}

"BoardId":"string",

"PublicationTime":"1970-01-01T00:00:00.000Z",

"IsReservationEnabled":false,

"PublicationOption":0,

"IsPublished":false,

"IsCommonBoard":false

}

"UnloadFirstDate":"1970-01-01T00:00:00.000Z",

"UnloadLastDate":"1970-01-01T00:00:00.000Z",

"ArchiveDate":"1970-01-01T00:00:00.000Z",

"ArchiveReason":"Unknown",

"TruePrice":0,

"TrueCurrencyId":0,

"ResponseCount":0,

"OfferCount":0,

"CanBeDeleted":false,

"HasPermissionsToLoad":false,

"CanBeEdited":false,

"CanBeRenewed":false,

"CanBeRestored":false,

"EditRestriction":0,

"DeleteRestriction":0,

"RestoreRestriction":0,

"RenewRestriction":"string",

"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"LoadNumber":"string",

"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"

}

]

[{...}]

LoadMeta:{...}

Метаданные для интеграторов

LoadMetaId: guid (nullable)

Идентификатор метаданных

MetaData: string

Метаданные
Максимальная длина 1024 символа

}

ContactId1*: int32

ContactId2: int32 (nullable)

Note: string

Примечание к грузу
Ограничение по длине: 1000 символов

FirstDate: date-time

LastDate: date-time

DateType: int32

Выбор типа готовности груза к перевозке

0 - Готов к загрузке
1 - с Х по У
2 - постоянно
3 - груза нет, запрос ставки

PeriodicityId: int32

1 - ежедневно
100 - по рабочим дням

OrderNumber: string

Номер заказа
Ограничение по длине: 250 символов

Krugoreis: boolean

Параметр, который определяет, включен ли кругорейс для перевозки груза

Loading*:{...}

Загрузка

CityId*: int32

Идентификатор города загрузки/разгрузки
Значение из словаря городов АТИ

Latitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Максимальная длина 100 символов.

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

Наименование груза

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

ExtraPoints:[{...}]

Список дополнительных пунктов маршрута
Максимальное количество - 15 штук

CityId*: int32

Идентификатор города
Значение из словаря городов АТИ

PointType*: int32

Тип точки:

1 - загрузка
2 - разгрузка
3 - таможня
8 - проехать через

Latitude: decimal (nullable)

Долгота

Longitude: decimal (nullable)

Широта

Street: string

Улица или район

OrdinalId: int32

Порядковый номер

IsRoundTheClock: boolean

Загрузка/разгрузка круглосуточно

LoadingDateStart: date-time (nullable)

Дата начала периода загрузки/разгрузки

LoadingDateEnd: date-time (nullable)

Дата окончания периода загрузки/разгрузки

LoadingTimeStart: time-span (nullable)

Время начала загрузки/разгрузки

LoadingTimeEnd: time-span (nullable)

Время окончания загрузки/разгрузки

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

Наименование груза

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

UnloadingCargos:[{...}]

CargoId: int32

Id груза

Weight: double (nullable)

Вес

Volume: double (nullable)

Объём

PackagingQuantity: int32 (nullable)

Выгружаемая часть упаковки

IsDefinedByTtn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

Unloading*:{...}

Разгрузка

CityId*: int32

Идентификатор города загрузки/разгрузки
Значение из словаря городов АТИ

Latitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Longitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Longitude: decimal (nullable)

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Если параметр Latitude задан, то необходимо указать и этот параметр.
Допустимое значение от -90 до 90.

Street: string

указан город Москва;
указан город Санкт-Петербург;
города загрузки и разгрузки совпадают.

Максимальная длина 100 символов.

TimeStart: date-time (nullable)

TimeEnd: date-time (nullable)

IsRoundTheClock: boolean

LargeCities: [int32]

LoadingCargos:[{...}]

CargoId: int32

Id груза

NameId: int32

Наименование груза

Name: string

PackagingType: int32 (nullable)

Упаковка

PackagingQuantity: int32 (nullable)

Weight: double (nullable)

Volume: double (nullable)

Объем

Sizes:{...}

Габариты

Length: double

Width: double

Height: double

Diameter: double

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

}]

}

Cargo*:{...}

Информация о грузе

Weight: double

Вес груза в тоннах
Обязательный параметр, если не задан параметр Volume.

Volume: double

ADR: int32

Параметр, определяющий степень опасности груза
Допустимое значение от 0 до 9. По умолчанию - 0

CargoTypeId*: int32

Идентификатор наименования груза
Значение из Словаря наименований грузов

CargoType: string

PackType: int32

Идентификатор наименования упаковки (навалом, коробки, россыпью...)
Значение из Словаря наименований грузов

PalletCount: int32

Количество упаковок для груза
Допустимое значение от 0 до 9999. По умолчанию - 0

BeltCount: int32

Количество ремней для груза
Допустимое значение от 0 до 9999. По умолчанию - 0

DogruzType*: int32

Вариант перевозки:

1 - только отдельной машиной
2 - отдельной или догрузом

SborGruz: boolean

Определяет, является ли груз сборным

Size:{...}

Параметры размера груза

Length: double

Длина груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Width: double

Ширина груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Height: double

Высота груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Diameter: double

Диаметр груза в метрах
Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

LengthHighlight: boolean

WidthHighlight: boolean

HeightHighlight: boolean

}

Transport*:{...}

Параметры транспорта

CarType*: int64

Битовая сумма ID кузовов
Значение из словаря кузовов АТИ

LoadingType: int32

Битовая сумма ID типов загрузки
Значение из словаря вариантов загрузки АТИ

LoadingLogicalOperator: string

Тип условия загрузки:

OR - необходимо, чтобы присутствовал один из способов загрузки
AND - необходимо, чтобы присутствовали все выбранные типы загрузки

UnloadingType: int32

Битовая сумма ID типов разгрузки.
Значение из словаря вариантов разагрузки АТИ

UnloadingLogicalOperator: string

Тип условия разгрузки:

OR - необходимо, чтобы присутствовал один из способов разгрузки
AND - необходимо, чтобы присутствовали все выбранные типы разгрузки

TrucksQuantity: int32

Количество машин
Допустимое значение от 1 до 99. По умолчанию - 1

TemperatureFrom: int32 (nullable)

TemperatureTo: int32 (nullable)

Stsepka: boolean

Определяет, нужна ли сцепка для груза

Pnevmohod: boolean

Определяет, нужен ли пневмоход для груза

Koniki: boolean

Определяет, нужны ли коники для груза

TIR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы TIR

CMR: boolean

Документы на транспорт, необходимые для провоза этого груза: документы CMR

T1: boolean

Документы на транспорт, необходимые для провоза этого груза: документы T1

SanPassport: boolean

Документы на транспорт, необходимые для провоза этого груза: медкнижка

IsTracking: boolean

Трекинг через АТИ Водитель

}

Payment*:{...}

Оплата

CurrencyId: int32

MoneyType: int32

RateSum: decimal

SumWithNDS: decimal

SumWithoutNDS: decimal

PrepayPercent: int32

PrepayPercentEnabled: boolean

Есть ли предоплата

PayDays: int32

PayDaysEnabled: boolean

FixedRate: boolean

Torg: boolean

Возможен ли торг
По умолчанию - false. Не учитывается, если параметр FixedRate равен false

DirectContract: boolean

Прямой договор

InFuel: boolean

Предоплата топливом

OnUnloading: boolean

Оплата на выгрузке

HideResponses: boolean

Скрыть встречные предложения

AcceptPaymentTypes: int32

Позволяет указать форму оплаты при выборе параметра "Запрос ставки":

1 - наличные
2 - б/нал с НДС
3 - нал и б/нал с НДС
4 - б/нал без НДС
5 - нал и б/нал без НДС
6 - б/нал с НДС и без НДС
7 - нал и б/нал с НДС и без НДС
0 - указана фикс. ставка

}

InviteSettings:{...}

Настройки автоприглашений

InviteDelayInSeconds: int32

InviteDurationInSeconds: int32

Время в секундах действия приглашения

}

PriorityView:{...}

Приоритетный показ

DailyLimit: decimal

Суточный лимит списания по услуге

Должен иметь длину не более 5 символов
Не более 2 символов после запятой
Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

IsForPayedOnly: boolean

Показывать приоритетный показ только платным пользователям

OrderLimit: decimal

Лимит на заявку

Должен иметь длину не более 5 символов
Не более 2 символов после запятой
Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0

ViewRate*: decimal

Ставка за просмотр

Минимальное значение 0,6
Не более 2 символов после запятой
Должен иметь длину не более 5 символов

MoneySpentPerDay: decimal

Количество денег, потраченное на заявку за день. Только для чтения

MoneySpentPerOrder: decimal

Количество денег, потраченное на заявку в целом. Только для чтения

}

Stealth:{...}

Настройки показа груза

ListIdToHide: guid (nullable)

FirmRegDateToHide: date-time (nullable)

Режим стэлс, Для фирм с датой регистрации меньше данной груз показываться не будет

ScoreToHide: double (nullable)

}

LoadFiles:[{...}]

Id: guid

Идентификатор файла, возвращается при загрузке файла в АТИ-Доки

FileType: int32

Тип загруженного файла:

1 - документ

Attributes: int32

Битовый набор опции файла

0 - Значение по умолчанию. Данный файл доступен по ссылке
1 - Данный файл доступен только владельцу груза

Name: string

Link: string

Ссылка, по которой можно скачать файл, возвращается при загрузке файла в АТИ-Доки

Size: int32

Размер файла
Информационное поле, на текущий момент не используется

}]

Deal:{...}

Auction:{...}

Параметры аукциона

StartRate*: decimal

Currency*: int32

Валюта аукциона
Значение из словаря валют АТИ

Step*: decimal

PaymentType*: enum

[1, 22, 23, 24, 25]

Тип оплаты

22: любой
1: наличные
23: по карте
24: безнал с НДС
25: безнал без НДС

AcceptSecondPayType: boolean

Принимать ставки без НДС. Параметр можно указать, если начальная ставка указана с НДС (PaymentType=24)

StartDate: date-time

EndDate: date-time (nullable)

Время окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundary: date-time (nullable)

Nds: decimal (nullable)

% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

TimeToProvideDocuments*: decimal

AutoRenew: boolean

Нужно ли продление аукциона, если была ставка в последние 5 минут до окончания

RenewTime: int32 (nullable)

Время, на которое надо сдвигать окончание аукциона при включенном AutoRenew

MaxRenewTime: int32 (nullable)

RaiseBid: boolean

Повысить ставку на Шаг, если нет предложений

MaxRate: decimal (nullable)

RaiseBidInterval: int32 (nullable)

ResponseInMinutes: int32 (nullable)

Указывает, через какой промежуток времени с момента публикации аукциона принимать встречные предложения:

1 - сразу
15, 30, 60, 120, 180 - время в минутах
null - не принимать

Если AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки

Duration: int32

StartSinceFirstBet: boolean

Флаг, определяющий, что обратный отсчет до окончания аукциона начинается только после первой ставки.

AuctionRestartParameters:{...}

Параметры перезапуска аукциона

AuctionFinishAction: enum

[1, 2, 3]

Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны:

1 - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)
2 - Опубликовать с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе
3 - Перенести груз в архив

InitRestartCount: int32

Количество перезапусков Торгов, от 0 до 3 включительно.
Если параметр не передать, по умолчанию 0

InitChangeWinnerCount: int32

DurationAfterRestart: int32 (nullable)

}

AcceptCounterOffersOnlyBeforeFirstBet: boolean

Можно принимать встречные предложения только до первой ставки?

WinnerCriterion: enum

[0, 1]

Критерий выбора победителя торгов

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.

AuctionId: guid

Id аукциона

LoadId: guid

Id груза, для которого активен аукцион

ActiveDealId: guid (nullable)

Id сделки, привязанной к аукциону

State: enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона

-100 - Не удалось определить состояние аукциона
-14 - Аукцион отменен руками грузовладельца
-13 - Аукцион удален, т.к. расторгнут заказ
-12 - Аукцион без ставок завершен
-11 - Аукцион удален автоматически
-10 - Аукцион удален т.к. сделка завершена
-9 - Аукцион удален
-8 - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет
-7 - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель
-6 - При включенном копировании грузов: торги завершены, экспедитор не является победителем
-5 - Одна ставка лучшая по цене, другая по дате
-4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
-3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
-2 - Закончился, ждем когда победитель возьмет груз
-1 - Закончился, ставок нет
0 - Идет, ставок нет
1 - Идет (уже есть валидные ставки)

Finished: boolean

Завершен ли аукцион

WinDate: date-time (nullable)

Время выигрыша ставки (когда для определенной ставки в AuctionRates установлен State = Winner)

AuctionRates:[{...}]

Список ставок по аукциону

AuctionRateId: guid

ID ставки

AddedAt: date-time

Когда сделана ставка

RateFirm:{...}

Фирма, оставившая заявку

Score: double

"Звезды" фирмы

Status: enum

[0, 1, 2, 3, 4, 5, 6, 7]

Тип звезд фирмы

0: Серый
1: Красный
2: Желтый
3: Зеленый
4: Партнер АТИ
5: Сотрудник АТИ
6: Гос. органы
7: ОДКС

Name: string

Имя фирмы

ContactName: string

Имя контакта

AtiId: string

Идентификатор фирмы в АТИ

}

Rate: decimal

Ставка на груз, которую поставил пользователь

State: enum

[0, 1, -8, -7, -6, -5, -4, -3, -2, -1]

Статус ставки

1: Победная ставка в аукционе
0: Обычная ставка по аукциону (участник аукциона)
-2: Участник аукциона отменил ставку
-3: Бывший победитель, который не прислал документы
-4: Победитель отказался от участия
-5: Грузовладелец отменил безоговорочную сделку
-6: Победитель отменил безоговорочную сделку
-7: Победитель отклонил документ
-8: Грузовладелец отклонил документ

LoadingDate: date-time (nullable)

FirmId: int32

Код фирмы, сделавшей ставку

ContactId: int32

Контакт, сделавший ставку

}]

}

Boards:[{...}]

Список площадок

BoardId: string

ID площадки

PublicationTime: date-time (nullable)

Время публикации на площадке
Учитывается, если PublicationOption равно 6

IsReservationEnabled: boolean

PublicationOption: int32

Параметры публикации груза:

0 - сразу
1 - через 15 минут
2 - через 30 минут
3 - через час
4 - через 3 часа
5 - через 6 часов
6 - указать точное время

IsPublished: boolean

Показывает, что груз уже опубликован на странице

IsCommonBoard: boolean

Показывает является ли площадка Общей

}]

UnloadFirstDate: date-time (nullable)

UnloadLastDate: date-time (nullable)

ArchiveDate: date-time (nullable)

Дата и время переноса в архив

ArchiveReason: enum (nullable)

Причина переноса в архив

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

ID валюты озвученной ставки

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Есть ли доступ на удаление груза.

HasPermissionsToLoad: boolean

Есть ли доступ на работу с грузом (без учета прав).

CanBeEdited: boolean

Есть ли доступ на редактирование груза.

CanBeRenewed: boolean

Есть ли доступ на обновление груза.

CanBeRestored: boolean

Есть ли доступ на восстановление груза

EditRestriction: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на редактирование груза:

0 - Вы имеете доступ к работе с грузом
1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
2 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Превышен лимит актуальных грузов
4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
5 - У вашего контакта недостаточно прав для работы с данным грузом
6 - Груз имеет завершенные Торги, операции с грузом запрещены
7 - Сервис сделок временно недоступен
8 - Нельзя изменять или удалять груз из сквозных торгов
9 - У вашего контакта недостаточно прав для создания грузов
10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
15 - Ваш контакт должен быть указан первым в грузе

DeleteRestriction: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на удаление контакта:

0 - Вы имеете доступ к работе с грузом
1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
2 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Превышен лимит актуальных грузов
4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
5 - У вашего контакта недостаточно прав для работы с данным грузом
6 - Груз имеет завершенные Торги, операции с грузом запрещены
7 - Сервис сделок временно недоступен
8 - Нельзя изменять или удалять груз из сквозных торгов
9 - У вашего контакта недостаточно прав для создания грузов
10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
15 - Ваш контакт должен быть указан первым в грузе

RestoreRestriction: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на восстановление груза:

0 - Вы имеете доступ к работе с грузом
1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
2 - Груз зарезервирован/взят, операции с грузом запрещены
3 - Превышен лимит актуальных грузов
4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
5 - У вашего контакта недостаточно прав для работы с данным грузом
6 - Груз имеет завершенные Торги, операции с грузом запрещены
7 - Сервис сделок временно недоступен
8 - Нельзя изменять или удалять груз из сквозных торгов
9 - У вашего контакта недостаточно прав для создания грузов
10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
15 - Ваш контакт должен быть указан первым в грузе

RenewRestriction: string

Причина отказа в доступе на обновление груза.

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

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 аукциона

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...