Структура "Груз" [1.0]

Описание

Здесь вы сможете найти описание основных параметров структуры "Груз".

Вложенные структуры

Структура "ExtraPoint"

Представляет собой структуру, описывающую дополнительный пункт разгрузки\загрузки

НазваниеТипОписаниеОсобые значенияОбязательный
CityIdintИдентификатор городаЗначение из словаря+
PointTypeint

Тип пункта разгрузки:

  • 1 - загрузка
  • 2 - разгрузка
  • 3 - таможня

+
LatitudedecimalШирота

LongitudedecimalДолгота

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

Структуры "Loading"/"Unloading"

НазваниеТипОписаниеОсобые значенияОбязательный
CityId
intИдентификатор города загрузки/разгрузкиЗначение из словаря +
LatitudefloatШирота города загрузки/разгрузки

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

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

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

+/-
LongitudefloatДолгота города загрузки/разгрузки

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

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

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

+/-
StreetstringУлица или район города загрузки/разгрузкиПараметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:
  1. указан город Москва;
  2. указан город Санкт-Петербург;
  3. города загрузки и разгрузки совпадают.

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

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

Не указывается при значении параметра DateType равным 3.

Не указывается при значении IsRoundTheClock: true


TimeEndtimeВремя завершения загрузки/разгрузки

Не указывается при значении параметра DateType равным 3.

Не указывается при значении IsRoundTheClock: true


IsRoundTheClockboolОпределяет выбрано ли значение Круглосуточно

По умолчанию - false

Не указывается при значении параметра DateType равным 3.


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

Структура "Cargo"

НазваниеТипОписаниеОсобые значенияОбязательный
Weight
floatВес груза в тоннахОбязательный параметр, если не задан параметр Volume. Максимальная длина - 4 символа+/-
VolumefloatОбъем груза в кубических метрахОбязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа+/-
ADRintПараметр, определяющий степень опасности грузаДопустимое значение от 0 до 9. По умолчанию - 0
CargoTypeIdintИдентификатор наименования грузаЗначение из словаря. Обязательный параметр+
CargoTypestringНаименование грузаОбязательный параметр, если значение параметра CargoTypeId равно 59. Максимальная длина названия - 50 символов. Этот параметр должен быть пустым, если параметр CargoTypeId отличен от 59. В этом поле запрещено указывать контактную информацию+/-
PackTypeintИдентификатор наименования упаковки (навалом, коробки, россыпью, запаллечен .... пирамида)Значение из словаря. По умолчанию - 0
PalletCountintКоличество упаковок для грузаДопустимое значение от 0 до 9999. По умолчанию - 0
BeltCountintКоличество ремней для грузаДопустимое значение от 0 до 9999. По умолчанию - 0
DogruzTypeintПараметр, отвечающий за способ перевозки груза
  • 1 - только отдельной машиной
  • 2 - отдельной или догрузом
  • 3 - только догрузом
+
SborGruzboolОпределяет, является ли груз сборнымПо умолчанию - false
SizeSizeСтруктура "Size"

Структура "Size"

НазваниеТипОписаниеОсобые значенияОбязательный
LengthfloatДлина груза в метрахДопустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0
WidthfloatШирина груза в метрахДопустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0
HeightfloatВысота груза в метрахДопустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0
LengthHighlightboolВыделение красным цветом длины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)По умолчанию - false
WidthHighlightboolВыделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)По умолчанию - false
HeightHighlightboolВыделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)По умолчанию - false
DiameterfloatДиаметр груза в метрахДопустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0

Структура "Transport"

НазваниеТипОписаниеОсобые значенияОбязательный
CarType
int64Битовая сумма id кузововЗначение из словаря+
LoadingTypeintБитовая сумма id типов загрузки. Например: только "Верхняя" будет иметь значение 1; "Верхняя", "Боковая" и "Со снятием стоек" имеют значение 67 (1 + 2 + 64)Значение из словаря
LoadingLogicalOperatorstringТип условия загрузки: "OR" - необходимо, чтобы присутствовал один из способов загрузки; "AND" - необходимо, чтобы присутствовали все выбранные типы загрузки

По умолчанию - "OR"


UnloadingTypeintБитовая сумма id типов разгрузкиЗначение из словаря 
UnloadingLogicalOperatorstringТип условия разгрузки: "OR" - необходимо, чтобы присутствовал один из способов разгрузки; "AND" - необходимо, чтобы присутствовали все выбранные типы разгрузкиПо умолчанию - "OR"
TrucksQuantityintКоличество машинДопустимое значение от 1 до 99. По умолчанию - 1
TemperatureFromintМинимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный"Допустимое значение от -99 до 999
TemperatureTointМаксимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный"Допустимое значение от -99 до 999
StsepkaboolОпределяет, выбрана ли сцепка для грузаПо умолчанию - false
PnevmohodboolОпределяет, выбран ли пневмоход для грузаПо умолчанию - false
KonikiboolОпределяет, выбраны ли коники для грузаПо умолчанию - false
TIRboolДокументы на транспорт, необходимые для провоза этого груза: документы TIRПо умолчанию - false
CMRboolДокументы на транспорт, необходимые для провоза этого груза: документы CMRПо умолчанию - false
T1boolДокументы на транспорт, необходимые для провоза этого груза: документы T1По умолчанию - false
SanPassportboolДокументы на транспорт, необходимые для провоза этого груза: медкнижкаПо умолчанию - false

Структура "Payment"

НазваниеТипОписаниеОсобые значенияОбязательный
MoneyType
intИдентификатор оплаты

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

+/-
CurrencyId intИдентификатор валютыЗначение из словаря. По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false
RateSumdecimalСтавка для грузаОбязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр MoneyType равен 22 и RateSum > 0, тогда поля SumWithNDS и SumWithoutNDS должны быть пустыми или принимать значение 0+/-
SumWithNDSdecimalСтавка б/нал с НДС для грузаОбязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0+/-
SumWithoutNDSdecimalСтавка б/нал без НДС для грузаОбязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0+/-
PrepayPercentintПроцент предоплатыДопустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false
PayDaysintОплата будет произведена через выбранное количество банковских днейДопустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false
FixedRateboolTrue, если ставка указана, False, если запрос ставкиПо умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1
TorgboolОпределяет, возможен ли торгПо умолчанию - false. Не учитывается, если параметр FixedRate равен false
PrepayPercentEnabledboolОпределяет, что предоплата включенаПо умолчанию - false
InFuelboolОпределяет, что предоплата топливом включенаПо умолчанию - false. Не может быть установлен в true, если параметр PrepayPercentEnabled  установлен в false
DirectContractboolПараметр, который определяет, включен ли прямой договорПо умолчанию - false
OnUnloadingboolПараметр, который определяет, осуществляется ли оплата на выгрузкеПо умолчанию - false. Не может быть установлен в true, если параметр PayDaysEnabled тоже установлен в true
HideResponsesboolПараметр, который определяет, будут ли скрыты встречные предложенияПо умолчанию - false
PayDaysEnabledboolПараметр, что включен флажок "через банк. дней"По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true
AcceptPaymentTypesintПозволяет указать форму оплаты при выборе параметра "Запрос ставки"
  • 1 - нал
  • 2 - б/нал с НДС
  • 3 - нал и б/нал с НДС
  • 4 - б/нал без НДС
  • 5 - нал и б/нал без НДС
  • 6 - б/нал с НДС и без НДС
  • 7 - нал и б/нал с НДС и без НДС
  • 0 - указана фикс. ставка

Структура "Stealth"

НазваниеТипОписаниеОсобые значенияОбязательный
ListIdToHideguid?ID списка для которого груз показываться не будетДопустимое значение (32 шестнадцатеричных цифры, например {79A67512-81B5-4CB2-809B-58A4EA61D556})+/-
FirmRegDateToHidedateTime?Для фирм с датой регистрации меньше указанной груз будет скрыт
+/-
ScoreToHidedouble?Минимальное количество баллов фирмы

Структура "Board"

НазваниеТипОписаниеОсобые значенияОбязательный
BoardIdstringID площадки
+
PublicationTimedateTime?Время публикации на площадкеУчитывается, если PublicationOption равно 6.
PublicationOptionint
  • 0 - сразу
  • 1 - через 15 минут
  • 2 - через 30 минут
  • 3 - через час
  • 4 - через 3 часа
  • 5 - через 6 часов
  • 6 - указать точное время

IsPublishedboolПоказывает, что груз уже опубликован на страницеТолько для чтения
IsCommonBoardboolПоказывает является ли площадка ОбщейТолько для чтения
IsReservationEnabledboolПоказывает разрешено ли бронирование грузов на Общей площадкеУчитывается только для Общей площадки. Только при включенном Stealt

Структура "Deal"

НазваниеТипОписаниеОсобые значенияОбязательный
AuctionAuctionСтруктура "Аукцион" (Торги)

Структура "PriorityView"

НазваниеТипОписаниеОсобые значенияОбязательный
DailyLimitintСуточный лимит списания по услуге
  • Должен иметь длину не более 5 символов
  • Не более 2 символов после запятой
  • Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
  • Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0
+/-
IsForPayedOnlyboolПоказывать приоритетный показ только платным пользователям

OrderLimitintЛимит на заявку
  • Должен иметь длину не более 5 символов
  • Не более 2 символов после запятой
  • Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
  • Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0
+/-
ViewRatedecimalСтавка за просмотр
  • Минимальное значение 0,3
  • Не более 2 символов после запятой
  • Должен иметь длину не более 5 символов
+
MoneySpentPerDaydecimalКоличество денег, потраченное на заявку за деньТолько для чтения
MoneySpentPerOrderdecimalКоличество денег, потраченное на заявку в целомТолько для чтения


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

Название

Тип

Описание

Особые значения

Обязательный

IdguidИдентификатор файлаИдентификатор возвращается при загрузке файла в АТИ-Доки. (см. API для хранения файлов)+
AttributesintБитовый набор опции файла

Возможные значения:

1 - Данный файл доступен только владельцу груза

0 - Значение по умолчанию. Данный файл доступен по ссылке.


LinkstringСсылка на файлСсылка по которой можно скачать файл возвращается при загрузке файла в АТИ-Доки. (см. API для хранения файлов)+
NamestringИмя файла

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

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

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

Возможные значения:
1 - Документ

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

Список параметров

НазваниеТипОписаниеОсобенные значенияОбязательный
Id
guidИдентификатор грузаТолько для чтения
FirmIdintИдентификатор фирмыТолько для чтения
LoadNumberstringНомер груза
  • Только для чтения
  • Ограничение по длине: 24 символов

ContactId1intИдентификатор первого выбранного контактаДолжен присутствовать в фирме и быть видимым контактом+
ContactId2int?Идентификатор второго выбранного контакта, если не выбрано, то nullМожет иметь значение null. Иначе должен присутствовать в фирме и быть видимым контактом
NotestringПримечание к грузуОграничение по длине: 1000 символов
OrderNumberstringНомер груза/заказа
  • Необязательное поле
  • Ограничение по длине: 20 символов

UpdatedAtdateTimeДата последнего изменения груза в формате UTCТолько для чтения
AddedAtdateTimeВремя добавления груза в формате UTCТолько для чтения
FirstDatedateДата, начиная с которой груз актуален, UTC

Минимальное значение равно текущей дате

При значении параметра DateType равным 0, допустимое значение поля - текущая дата

При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 60 дней вперед

При значении параметра DateType равным 2, допустимое значение поля - текущая дата

При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать


LastDatedateДата, после которой груз не актуален, в формате UTC

Минимальное значение равно значению параметра FirstDate

При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед

При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед

При значении параметра DateType равным 2, данное поле вычисляется автоматически по формуле FirstDate + 2 месяца, передаваемое значение игнорируется

При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется


UnloadFirstDatedateДата начала разгрузки, в формате UTC

Может иметь значение null

Минимальное значение равно текущей дате

При значении параметра DateType равным 3, UnloadFirstDate принимает значение null


UnloadLastDatedateДата окончания разгрузки, в формате UTC

Может иметь значение null

Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate

При значении параметра DateType равным 3, UnloadFirstDate принимает значение null


DateTypeintВыбор типа готовности груза к перевозке
  • 0 - готов к загрузке
  • 1 - с Х по У
  • 2 - постоянно
  • 3 - груза нет, запрос ставки

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

ZimnikboolПараметр, который определяет, включен ли зимник для перевозки грузаТолько для чтения
FerriesboolПараметр, который определяет, учитывать ли паромные переправы для перевозки грузаТолько для чтения
Loading
LoadingСтруктура "Loading"
+
UnloadingUnloadingСтруктура "Unloading"
+
ExtraPoints

ExtraPoint []

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

Максимальное количество - 15 штук
CargoCargoСтруктура "Cargo"
+
TransportTransportСтруктура "Transport"
+
PaymentPaymentСтруктура "Payment"
+
StealthStealthСтруктура "Stealth"

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

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

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

BoardsBoard []Список площадок груза
  • Если площадок нет или есть только общая площадка, то поле не добавляется в груз.
    Идентификатор общей площадки a0a0a0a0a0a0a0a0a0a0a0a0
  • Площадки не должны дублироваться

PriorityViewPriorityViewСтруктура "PriorityView"

DealDealСтруктура "Deal"

TruePriceintОзвученная ставкаТолько для чтения
TrueCurrencyIdintID валюты озвученной ставкиТолько для чтения
ResponseCountintКоличество отзывов о грузе(без встречных предложений)Только для чтения
OfferCountintКоличество встречных предложенийТолько для чтения
CanBeDeletedboolМожно ли удалить грузТолько для чтения
CanBeRenewedboolМожно ли обновить груз. В архивном грузе всегда false.Только для чтения
CanBeEditedboolМожно ли отредактировать груз. В архивном грузе всегда false.Только для чтения
DeleteRestrictionintЗначение из словаря, пояснение к тому, почему можно или нельзя удалить груз. Только для чтения
RenewRestrictionstringСтрока с пояснением к тому, почему можно или нельзя обновить груз. В архивном грузе всегда пусто.Только для чтения
EditRestrictionintЗначение из словаря, пояснение к тому, почему можно или нельзя удалить груз. В архивном грузе всегда 0.Только для чтения
LoadFilesLoadFile []Файлы к грузуПеред добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки
AuctionIdguidId аукционаТолько для чтения
PlatonRoadsLengthintПротяженность дорог в км, в построенном пути за которые взимается плата по системе ПлатонТолько для чтения
TollRoadsLengthintПротяженность платных дорог в построенном пути в кмТолько для чтения
TravelTimetimespanВремя в путиТолько для чтения

isOfferAvailable

boolДоступ на оставление встречных предложений и остальных отзывов на грузыТолько для чтения

Структура "LoadMeta" - метаданные для интеграторов

НазваниеТипОписаниеОсобые значенияОбязательный
LoadMetaIdguidИдентификатор метаданных
-
MetaDatastringМетаданныеМаксимальная длина 1024 символа-