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

Описание

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

Примечание: Знак вопроса "?" в колонке "Тип" означает, что параметр может принимать значение null.

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

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

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

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

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

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

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

Название
Тип
Описание
Особые значения
Обязательный
city_id
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 символов.

+/-
time_starttimeВремя начала загрузки/разгрузкиПри значении параметра DateType равным 3, поле не учитывается 
time_endtimeВремя завершения загрузки/разгрузкиПри значении параметра DateType равным 3, поле не учитывается 
large_citiesLargeCity[]Массив структур "Ближайший крупный город"Описание на данный момент уточняется 

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

Название
Тип
Описание
Особые значения
Обязательный
weight
floatВес груза в тоннахОбязательный параметр, если не задан параметр Volume. Максимальная длина - 4 символа+/-
volumefloatОбъем груза в кубических метрахОбязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа+/-
adrintПараметр, определяющий степень опасности грузаДопустимое значение от 0 до 9. По умолчанию - 0 
cargo_type_idintИдентификатор наименования грузаЗначение из словаря. Обязательный параметр+
cargo_typestringНаименование грузаОбязательный параметр, если значение параметра CargoTypeId равно 59. Максимальная длина названия - 50 символов. Этот параметр должен быть пустым, если параметр CargoTypeId отличен от 59. В этом поле запрещено указывать контактную информацию+/-
pack_type_idintИдентификатор наименования упаковки (навалом, коробки, россыпью, запаллечен .... пирамида)Значение из словаря. По умолчанию - 0 
pallet_countintКоличество упаковок для грузаДопустимое значение от 0 до 9999. По умолчанию - 0 
belt_countintКоличество ремней для грузаДопустимое значение от 0 до 9999. По умолчанию - 0 
dogruz_typeintПараметр, отвечающий за способ перевозки груза
  • 1 - только отдельной машиной
  • 2 - отдельной или догрузом
  • 3 - только догрузом
+
sbor_gruzboolОпределяет, является ли груз сборнымПо умолчанию - false 
sizeSizeСтруктура "Size"  

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

Название
Тип
Описание
Особые значения
Обязательный
lengthfloatДлина груза в метрахДопустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0 
widthfloatШирина груза в метрахДопустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0 
heightfloatВысота груза в метрахДопустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0 
length_highlightboolВыделение красным цветом длины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)По умолчанию - false 
width_highlightboolВыделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)По умолчанию - false 
height_highlightboolВыделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)По умолчанию - false 

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

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

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

 
unloading_type_bit_maskintБитовая сумма id типов разгрузкиЗначение из словаря  
unloading_logical_operatorstringТип условия разгрузки: "OR" - необходимо, чтобы присутствовал один из способов разгрузки; "AND" - необходимо, чтобы присутствовали все выбранные типы разгрузкиПо умолчанию - "OR" 
trucks_quantityintКоличество машинДопустимое значение от 1 до 99. По умолчанию - 1 
temperature_fromintМинимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный"Допустимое значение от -99 до 999 
temperature_tointМаксимальная температура для груза, если выбран тип кузова "Рефрижератор", "Рефрижератор с перегородкой", "Рефрижератор-мультирежимный"Допустимое значение от -99 до 999 
stsepkaboolОпределяет, выбрана ли сцепка для грузаПо умолчанию - false 
pnevmohodboolОпределяет, выбран ли пневмоход для грузаПо умолчанию - false 
konikiboolОпределяет, выбраны ли коники для грузаПо умолчанию - false 
tirboolДокументы на транспорт, необходимые для провоза этого груза: документы TIRПо умолчанию - false 
cmrboolДокументы на транспорт, необходимые для провоза этого груза: документы CMRПо умолчанию - false 
t1boolДокументы на транспорт, необходимые для провоза этого груза: документы T1По умолчанию - false 
san_passportboolДокументы на транспорт, необходимые для провоза этого груза: медкнижкаПо умолчанию - false 

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

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

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

+/-
currency_id intИдентификатор валютыЗначение из словаря. По умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false 
rate_sumfloatСтавка для грузаОбязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр MoneyType равен 22 и RateSum > 0, тогда поля SumWithNDS и SumWithoutNDS должны быть пустыми или принимать значение 0+/-
sum_with_ndsfloatСтавка б/нал с НДС для грузаОбязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0+/-
sum_without_ndsfloatСтавка б/нал без НДС для грузаОбязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0+/-
prepay_percentintПроцент предоплатыДопустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false 
pay_daysintОплата будет произведена через выбранное количество банковских днейДопустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false 
fixed_rateboolTrue, если ставка указана, False, если запрос ставкиПо умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1 
torgboolОпределяет, возможен ли торгПо умолчанию - false. Не учитывается, если параметр FixedRate равен false 
prepay_percent_enabledboolОпределяет, что предоплата включенаПо умолчанию - false 
direct_contractboolПараметр, который определяет, включен ли прямой договорПо умолчанию - false 
on_unloadingboolПараметр, который определяет, осуществляется ли оплата на выгрузкеПо умолчанию - false. Не может быть установлен в true, если параметр PayDaysEnabled тоже установлен в true 
pay_days_enabledboolПараметр, что включен флажок "через банк. дней"По умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true 

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

Название
Тип
Описание
Особые значения
Обязательный
listId_to_hideguid?ID списка для которого груз показываться не будет +/-
firm_reg_date_to_hidedateTime?Для фирм с датой регистрации меньше указанной груз будет скрытПо умолчанию - 0+/-

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

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

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

Название
Тип
Описание
Особые значения
Обязательный
daily_limitfloatСуточный лимит списания по услуге
  • Должен иметь длину не более 5 символов
  • Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
  • Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0
+/-
is_for_payed_onlyboolПоказывать приоритетный показ только платным пользователям  
order_limitfloatЛимит на заявку
  • Должен иметь длину не более 5 символов
  • Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)
  • Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0
+/-
view_ratefloatСтавка за просмотр
  • Минимальное значение 0,3
  • Должен иметь длину не более 5 символов
+
money_spent_per_dayfloatКоличество денег, потраченное на заявку за деньТолько для чтения 
money_spent_per_orderfloatКоличество денег, потраченное на заявку в целомТолько для чтения 

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

Название
Тип
Описание
Особенные значения
Обязательный
load_id
guidИдентификатор грузаТолько для чтения 
ati_idstringИдентификатор фирмыТолько для чтения 
contact_id1intИдентификатор первого выбранного контактаДолжен присутствовать в фирме и быть видимым контактом+
contact_id2int?Идентификатор второго выбранного контакта, если не выбрано, то nullМожет иметь значение null. Иначе должен быть валидным видимым контактом фирмы. 
notestringПримечание к грузуОграничение по длине: 250 символов 
updated_atdateTimeДата последнего изменения груза в формате UTCТолько для чтения 
added_atdateTimeВремя добавления груза в формате UTCТолько для чтения 
archived_atdateTimeВрем добавления груза в архивДата архивации груза. Актуально для архивных грузов. Для актуальных грузов всегда null. Только для чтения. 
first_datedateДата, начиная с которой груз актуален, UTC
  • Минимальное значение равно текущей дате
  • При значении параметра DateType равным 0, допустимое значение поля - текущая дата
  • При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 60 дней вперед
  • При значении параметра DateType равным 2, допустимое значение поля - текущая дата
  • При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты
 
last_datedateДата, после которой груз не актуален, в формате UTC
  • Минимальное значение равно значению параметра FirstDate
  • При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед
  • При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед
  • При значении параметра DateType равным 2, данное поле вычисляется автоматически по формуле FirstDate + 2 месяца, передаваемое значение игнорируется, нужно передавать валидную дату в UTC-формате
  • При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется, нужно передавать валидную дату в UTC-формате
 
date_typeintВыбор типа готовности груза к перевозке
  • 0 - готов к загрузке
  • 1 - с Х по У
  • 2 - постоянно
  • 3 - груза нет, запрос ставки
 
distanceintРасстояние для груза, при расчете учитываются дополнительные пункты разгрузкиТолько для чтения 
krugoreisboolПараметр, который определяет, включен ли кругорейс для перевозки груза  
zimnikboolПараметр, который определяет, включен ли зимник для перевозки грузаТолько для чтения 
ferriesboolПараметр, который определяет, учитывать ли паромные переправы для перевозки грузаТолько для чтения 
loading
LoadingСтруктура "Loading" +
unloadingUnloadingСтруктура "Unloading" +
extra_points

ExtraPoint []

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

Максимальное количество - 15 штук 
cargoCargoСтруктура "Cargo" +
transportTransportСтруктура "Transport" +
paymentPaymentСтруктура "Payment" +
stealthStealthСтруктура "Stealth"  
periodicity_idintПериодичность загрузки

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

  • 1 - ежедневно
  • 100 - по рабочим дням
 
boardsBoard []Список площадок груза
  • Если площадок нет или есть только общая площадка, то поле не добавляется в груз.
    Идентификатор общей площадки a0a0a0a0a0a0a0a0a0a0a0a0
  • Площадки не должны дублироваться
 
priority_viewPriorityViewСтруктура "PriorityView"  
true_priceintОзвученная ставкаТолько для чтения 
true_currency_idintID валюты озвученной ставкиТолько для чтения 
has_responseintОпределяет, имеется ли на груз хотя бы одно встречное предложениеТолько для чтения 
has_complaintintОпределяет, имеется ли на груз хотя бы одна жалобаТолько для чтения