orders_object.md

Объект Order

Имя	Тип	Описание
id	string	Идентификатор заказа
number	string	Номер заказа
promoCode	string	Промокод
status	Order.Status	Статус заказа
organization	Order.Organization	Организация, осуществляющая перевозку
dates	Order.Dates	Даты создания/обновления заказа
editing	Order.Editing	Конфигурация редактирования заказа
cost	Order.Cost	Стоимость (только поле total)
services	[Order.Service]	Массив услуг

Объект Order.Status

Имя	Тип	Описание
message	string	Краткое описание статуса
description	string	Полное описание статуса
isTaken	boolean	Заказ принят
isGiven	boolean	Заказ выдан
isCanceled	boolean	Заказ отменен
isPaid	boolean	Заказ оплачен
canUserRequestDriverCallback	boolean	Возможность запроса звонка от водителя

Объект Order.Organization

Имя	Тип	Описание
id	string	Идентификатор организации
name	string	Название

Объект Order.Dates

Имя	Тип	Описание
created	string	Дата создания заказа
updated	string	Дата обновления заказа
arrivalFrom	string	Верхняя граница по времени прибытия груза
arrivalTo	string	Нижняя граница по времени прибытия груза

Объект Order.Editing

Имя	Тип	Описание
canBeCanceled	string	Заказ может быть отменен
fields	boolean	Поля, доступные для редактирования

Объект Order.Cost

Имя	Тип	Описание
base	number	Базовая цена услуги
discount	number	Скидка
total	number	Итоговая цена (base + discount)
details	Order.Cost.Discount	Массив ценообразующих компонентов
actions	Order.Cost.Action	Массив влияющих на цену действий

Объект Order.Cost.Details

Имя	Тип	Описание
id	string	Идентификатор услуги
name	string	Название
cost	Order.Cost	Цена без полей details и actions

Объект Order.Cost.Action

Имя	Тип	Описание
id	string	Идентификатор услуги
name	string	Название

Объект Order.Cargo

Имя	Тип	Описание
type	string	Тип груза
hasCorrespondence	boolean	Корреспонденция
declaredCost	number	Заявленная стоимость груза
packages	Order.Cargo.Packages	Упаковка
total	Order.Cargo.Total	Суммарные параметры

Объект Order.Cargo.Packages

Имя	Тип	Описание
bag1	integer	Мешок 55×105 см, шт.
bag2	integer	Мешок 70×120 см, шт.
box1	integer	Коробка 40×20×20 см, шт.
box2	integer	Коробка 40×40×20 см, шт.
box3	integer	Коробка 40×40×40 см, шт.
box4	integer	Коробка 80×40×40 см, шт.
sealPackage	integer	Пломбирование, шт.
safePackage	integer	Сейф-пакет, шт.
hardPackageVolume	number	Жесткая упаковка, м³
extraPackageVolume	number	Дополнительная упаковка, м³
bubbleFilmVolume	number	Воздушно-пузырьковая пленка, м³

Объект Order.Cargo.Total

Имя	Тип	Описание
all	object	Общие:
volume	number	Объем, м³
weight	number	Вес, кг
quantity	integer	Количество, шт.
noGab	object	Негабарит:
volume	number	Объем, м³
weight	number	Вес, кг
max	object	Максимальные:
length	number	Длина, м
width	number	Ширина, м
height	number	Высота, м
weight	number	Вес, кг

Объект Order.Service

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

Услуга «Межтерминальная перевозка»

Имя	Тип	Описание	Значение
type	string	Тип услуги	"shipping"
name	string	Название услуги
counteragents	Counteragents	Контрагенты, участвующие в заказе
from	Order.Location	Место отправления
to	Order.Location	Место получения (терминал)
cargo	Order.Cargo	Груз
cost	Order.Cost	Стоимость услуги

Услуга «Забор груза»

Имя	Тип	Описание	Значение
type	string	Тип услуги	"deliveryFrom"
name	string	Название услуги
counteragents	Counteragents	Контрагенты, участвующие в заказе
from	Order.Location	Место забора груза
cost	Order.Cost	Стоимость услуги

Услуга «Отвоз груза»

Имя	Тип	Описание	Значение
type	string	Тип услуги	"deliveryTo"
name	string	Название услуги
counteragents	Counteragents	Контрагенты, участвующие в заказе
to	Order.Location	Место отвоза груза
cost	Order.Cost	Стоимость услуги

Услуга «Погрузочные работы»

Имя	Тип	Описание	Значение
type	string	Тип услуги	"fromLoadingWorks"
name	string	Название услуги
counteragents	Counteragents	Контрагенты, участвующие в заказе
works	object	Работы:
works.needWork	boolean	Погрузочные работы
works.hasLift	boolean	Грузовой лифт
works.floor	integer	Этаж
cost	Order.Cost	Стоимость услуги

Услуга «Разгрузочные работы»

Имя	Тип	Описание	Значение
type	string	Тип услуги	"toLoadingWorks"
name	string	Название услуги
counteragents	Counteragents	Контрагенты, участвующие в заказе
works	object	Работы:
works.needWork	boolean	Разгрузочные работы
works.hasLift	boolean	Грузовой лифт
works.floor	integer	Этаж
cost	Order.Cost	Стоимость услуги

Услуга «Ответственное хранение»

Имя	Тип	Описание	Значение
type	string	Тип услуги	"paidStoring"
name	string	Название услуги
dates	object	Даты:
dates.from	string	начало начисления платы за хранение
counteragents	Counteragents	Контрагенты, участвующие в заказе
cost	Order.Cost	Стоимость услуги

Услуга «Возврат сопроводительных документов»

Имя	Тип	Описание	Значение
type	string	Тип услуги	"returnOfSupportingDocuments"
name	string	Название услуги
location	Order.Location	Адрес возврата
counteragents	Counteragents	Контрагенты, участвующие в заказе
cost	Order.Cost	Стоимость услуги

Объект Order.Location

Имя	Тип	Описание
id	string	Идентификатор населенного пункта
type	string	Тип (например, "г" — город)
name	string	Название
address	Order.Location.Address	Адрес
terminal	Order.Location.Terminal	Терминал

Объект Order.Location.Address

Имя	Тип	Описание
address	string	Идентификатор населенного пункта
dates	object	Дата и время относительно часового пояса населенного пункта:
dates.from	Date	начальная дата
dates.to	Date	конечная дата

Объект Order.Location.Terminal

Имя	Тип	Описание
id	string	terminalId
address	string	Адрес терминала
dates	object	Дата и время относительно часового пояса населенного пункта:
dates.from	Date	отправление
dates.to	Date	прибытие