Описание полей груза

Страница описывает структуру объекта груза, который возвращают методы списка и карточки.

Основные поля

Поле Тип Описание
id string UUID груза
external_id integer | null внешний идентификатор
external_additional_id string | null дополнительный внешний идентификатор
status string статус груза
type string тип записи
hash string | null хэш груза

Источник груза

Поле Тип Описание
source object | null объект источника груза
source.id mixed идентификатор партнёра-источника
source.name string название источника
source.short_name string краткое название источника
source.link string ссылка на исходный заказ

Для фильтрации по источникам используйте Источники грузов.

Грузоотправитель

Поле Тип Описание
shipper object | null объект грузоотправителя
shipper.id mixed идентификатор компании
shipper.name string название компании
shipper.type string тип компании
shipper.inn string | null ИНН
shipper.security_status mixed статус благонадёжности
shipper.owner object | null владелец компании

Поля shipper.owner

Поле Тип Описание
shipper.owner.id mixed идентификатор пользователя
shipper.owner.name string имя
shipper.owner.surname string | null фамилия
shipper.owner.patronymic string | null отчество
shipper.owner.type string | null тип пользователя
shipper.owner.email string | null email
shipper.owner.phone string | null телефон
shipper.owner.full_name string полное имя
shipper.owner.work_week mixed рабочая неделя
shipper.owner.company_status mixed статус в компании
shipper.owner.last_activity_at string | null дата последней активности
shipper.owner.role object | null роль
shipper.owner.department object | null подразделение

Поля shipper.owner.role

Поле Тип Описание
shipper.owner.role.id mixed идентификатор роли
shipper.owner.role.name string название роли
shipper.owner.role.slug string системный slug роли

Поля shipper.owner.department

Поле Тип Описание
shipper.owner.department.id mixed идентификатор отдела
shipper.owner.department.name string название отдела
shipper.owner.department.description string | null описание отдела
shipper.owner.department.users array пользователи отдела

Финансы и параметры перевозки

Поле Тип Описание
auction mixed данные аукциона
price_vat number | null цена с НДС
price number | null цена
price_carrier number | null цена для перевозчика
price_carrier_vat number | null цена для перевозчика с НДС
weight integer | null вес
volume number | null объём
distance number | null дистанция
payment mixed блок оплаты

Даты

Поле Тип Описание
load_first_date string | null начало окна погрузки
load_last_date string | null конец окна погрузки
unload_first_date string | null начало окна выгрузки
unload_last_date string | null конец окна выгрузки
created_at string | null дата создания
updated_at string | null дата обновления
deleted_at string | null дата удаления

updated_at особенно важен для инкрементальной синхронизации через Список грузов.

Контакты и дополнительные данные

Поле Тип Описание
contacts array список контактов или идентификаторов
extra object дополнительные поля
extra.note string | null примечание
extra.url string | null ссылка

Поля contacts[]

Поле Тип Описание
contacts[].id mixed идентификатор контакта
contacts[].name string имя
contacts[].phone string | null телефон
contacts[].surname string | null фамилия
contacts[].full_name string полное имя

Требования к транспорту

Поле Тип Описание
size mixed габариты
truck object требования к кузову и режиму

Поля truck

Поле Тип Описание
truck.pallet_count mixed число паллет
truck.belt_count mixed число ремней
truck.temperature_from mixed нижняя граница температуры
truck.temperature_to mixed верхняя граница температуры
truck.adr mixed ADR

Справочные коллекции и объекты

Поле Тип Описание
truck_types array типы транспорта
load_types array типы погрузки
unload_types array типы выгрузки
pack_type object | null тип упаковки
cargo_type object | null тип груза
money_type object | null тип оплаты
currency object | null валюта
additional_conditions array дополнительные условия
additional_equipments array дополнительное оборудование

Поля truck_types[]

Поле Тип Описание
truck_types[].id integer идентификатор типа транспорта
truck_types[].name string название типа транспорта
truck_types[].short_name string краткое название типа транспорта

Поля load_types[] и unload_types[]

Поле Тип Описание
load_types[].id integer идентификатор типа погрузки
load_types[].name string название типа погрузки
load_types[].short_name string краткое название типа погрузки
unload_types[].id integer идентификатор типа выгрузки
unload_types[].name string название типа выгрузки
unload_types[].short_name string краткое название типа выгрузки

Поля pack_type, cargo_type, money_type, currency

Поле Тип Описание
pack_type.id integer идентификатор типа упаковки
pack_type.name string название типа упаковки
cargo_type.id integer идентификатор типа груза
cargo_type.name string название типа груза
money_type.id integer идентификатор типа оплаты
money_type.name string название типа оплаты
currency.id integer идентификатор валюты
currency.name string название валюты

Маршрут

Поле points содержит точки маршрута.

Поле Тип Описание
points.start object | null точка погрузки
points.finish object | null точка выгрузки
points.extra array промежуточные точки

Поля точки маршрута

Поле Тип Описание
id mixed идентификатор точки
place_id mixed идентификатор места
type string | null тип операции
position string | null позиция точки
first_date string | null начало временного окна
last_date string | null конец временного окна
address string | null адрес
latitude number | null широта
longitude number | null долгота
city object | null город
company object | null компания точки

Поля city

Поле Тип Описание
city.id integer идентификатор города
city.name string название города
city.fias_id string | null FIAS ID
city.latitude number | null широта города
city.longitude number | null долгота города
city.region object | null регион
city.country object | null страна

Поля city.region

Поле Тип Описание
city.region.id integer идентификатор региона
city.region.name string название региона
city.region.country object | null страна региона

Поля city.country

Поле Тип Описание
city.country.id integer идентификатор страны
city.country.name string название страны

Поля company

Поле Тип Описание
company.id mixed идентификатор компании
company.name string название компании
company.type string | null тип компании
company.inn string | null ИНН
company.security_status mixed статус благонадёжности
company.owner object | null владелец компании

Как использовать эту страницу