Документация к API

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`email`	Да	string	E-mail.
`password`	Да	string	Пароль.

Параметр	Тип	Описание
`id`	number	ID пользователя в системе.
`token`	string	Токен пользователя для авторизации в API.
`role`	string	Роль пользователя. Существует 4 типа ролей: guest – новый аккаунт без заключённого договора, с ограниченными правами доступа; client – полный доступ к возможностям сервиса; manager – менеджер с частичными правами доступа partner – партнёр.
`requisitesSubmitted`	boolean	Флаг, что реквизиты в профиле были заполнены и отправлены.
`cdekCallAvailable`	boolean	Флаг доступности прозвона заказов компанией СДЭК в городе получателя.
`settings`	object	Текущие настройки Личного кабинета: язык интерфейса, часовой пояс, E-mail и т.д.
`profile.organization`	object	Реквизиты организации/физ. лица из профиля.
`profile.bank`	object	Банковские данные из профиля.
`profile.employees`	array	Сотрудники, привязанные к данному аккаунту.
`profile.personalManager`	object \| null	Данные персонального менеджера.
`shopIds`	array	ID всех магазинов аккаунта.
`warehouseIds`	array	ID всех складов аккаунта.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`token`	Да	string	Токен аккаунта.

Параметр	Тип	Описание
`deliveryCompanyId`	number	ID компании доставки.
`deliveryCompanyName`	string	Название компании доставки.
`deliveryCompanyLogo`	string \| null	URL логотипа компании доставки.
`tariffName`	string \| null	Название тарифа доставки.
`pickupCompanyId`	number	ID компании отгрузки.
`deliveryDriver`	string	Внутреннее название драйвера компании доставки.
`deliveryDays.min`	number	Минимальный срок доставки в днях.
`deliveryDays.max`	number	Максимальный срок доставки в днях.
`deliveryPlanDays.min`	number	Минимальный срок доставки в днях, без учёта выходных дней.
`deliveryPlanDays.max`	number	Максимальный срок доставки в днях, без учёта выходных дней.
`deliveryDate.from`	string	Минимальная дата доставки.
`deliveryDate.to`	string	Максимальная дата доставки.
`services`	object	Дополнительные услуги. Ключами объекта выступают ID услуг.
`priceCommissionDeclared`	number	Стоимость страховки в рублях.
`percentCommissionDeclared`	number	Процентная ставка страховки.
`priceCommissionCod`	number	Комиссия наложенного платежа наличными в рублях.
`percentCommissionCod`	number	Процентная ставка наложенного платежа наличными.
`priceCommissionCodCard`	number	Комиссия наложенного платежа картой в рублях.
`percentCommissionCodCard`	number	Процентная ставка наложенного платежа картой.
`priceCommissionAcquiring`	number	Комиссия за эквайринг в рублях.
`percentCommissionAcquiring`	number	Процентная ставка за эквайринг.
`isPost`	boolean	Является ли данная доставка доставкой почтой.
`specificity`	array	Особенности службы доставки.
Только для доставки Почтой России и компаний курьерской доставки:
`cashPaymentAvailable`	boolean	Доступна ли оплата наличными при получении.
`cardPaymentAvailable`	boolean	Доступна ли оплата картой при получении.
`priceDelivery`	number	Чистая стоимость доставки.
`totalPrice`	number	Итоговая стоимость доставки, включающая в себя стоимость доп. услуг и комиссии.
Только для компаний курьерской доставки:
`isExpress`	boolean	Является ли данная доставка экспресс-доставкой.
`timeSelectAvailable`	boolean	Доступен ли выбор даты и времени доставки.
Только для компаний, доставляющих в пункт выдачи:
`points`	array	Массив точек самовывоза.

Параметр	Тип	Описание
`id`	number	ID точки самовывоза.
`name`	string	Название.
`longitude`	string	Долгота.
`latitude`	string	Широта.
`type`	number	Тип ПВЗ.
`description`	string \| null	Описание как пройти к ПВЗ.
`address`	string	Адрес.
`schedule`	array \| null	График работы. Массив из 7 значений (пн-вс). `null` в массиве означает нерабочий день, для рабочего дня время задаётся объектом с полями `from` и `to`. Формат времени – `HH:MM`.
`metro`	array \| null	Ближайшие станции метро (до 3-х). Выводятся в виде объектов с полями: `name` – название станции; `line` – название линии метро; `distance` – расстояние в км.
`district`	string \| null	Район города.
`photos`	array \| null	Массив URL фотографий ПВЗ.
`fittingAvailable`	boolean	Доступна ли услуга “Примерка”.
`checkupAvailable`	boolean	Доступна ли услуга “Осмотр вложения”.
`partialBuyoutAvailable`	boolean	Доступна ли услуга “Частичная выдача”.
`cashPaymentAvailable`	boolean	Доступна ли оплата наличными при получении.
`cardPaymentAvailable`	boolean	Доступна ли оплата картой при получении.
`union`	string	Точки, расположенные на карте слишком близко друг к другу, либо имеющие один и тот же адрес, имеют одинаковые значения данного параметра, что помогает выводить их на карте в виде единого маркера.
`deliveryCompanyId`	number	ID компании доставки.
`deliveryCompanyName`	string	Название компании доставки.
`deliveryDriver`	string	Внутреннее название драйвера компании доставки.
`deliveryDays.min`	number	Минимальный срок доставки в днях.
`deliveryDays.max`	number	Максимальный срок доставки в днях.
`deliveryDate.from`	string	Минимальная дата доставки.
`deliveryDate.to`	string	Максимальная дата доставки.
`deliveryHoldDays`	number	Количество дней, которое заказ будет храниться на ПВЗ.
`priceCommissionCod`	number	Комиссия наложенного платежа наличными в рублях.
`priceDelivery`	number	Чистая стоимость доставки для конкретного ПВЗ.
`totalPrice`	number	Итоговая стоимость доставки для конкретного ПВЗ, включающая в себя стоимость доп. услуг и комиссии.
`isFar`	boolean	Содержит `true` в случаях, когда данный ПВЗ находится не в населённом пункте, который был передан при запросе в калькулятор, а в ближайшем к нему. Такие ПВЗ выводятся, если в запрашиваемом населённом пункте нет ПВЗ.
`zipCode`	string \| null	Почтовый индекс.

Параметр	Тип	Описание
`id`	number	ID услуги.
`name`	string	Название услуги.
`price`	number	Стоимость услуги в рублях.
`checked`	boolean	Является ли данная услуга “выбранной” по умолчанию. Стоимость услуг, у которых этот параметр равен `true`, уже содержится в общей сумме `totalPrice`. Если необходимо получить стоимость доставки без такой услуги, вычтите её стоимость из `totalPrice`. Стоимость услуг со значением `false` не включена в `totalPrice`. Прибавьте их стоимость к `totalPrice`, чтобы получить стоимость доставки с нужными услугами.
`required`	boolean	Является ли данная услуга обязательной. Стоимость обязательных услуг содержится в общей сумме `totalPrice`. Создать заказ без этих услуг нельзя – если их ID не передать при создании заказа, заказ всё равно будет оформлен с ними.

Имя заголовка	Обязательный	Описание
`Shop-Id`	Нет	ID магазина. Если не передан, в запросе требуется задать адрес отправителя в параметре `sender`, а также тип забора в параметре `pickupType`.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`reception.countryCode`	—	string	Код страны получателя. По умолчанию `'RU'`.
`reception.cityFias`	—	string	ФИАС населённого пункта получателя.
`reception.cityName`	—	string	Название населённого пункта получателя.
`reception.cityType`	—	string	Тип населённого пункта (`'г'`, `'д'`, `'пос'` и т.п.) получателя.
`reception.zipCode`	—	string	Почтовый индекс населённого пункта получателя.
`reception.region`	—	string	Регион получателя.
`reception.area`	—	string	Район в регионе получателя.
`reception.street`	—	string	Улица получателя.
`reception.house`	—	string	Дом получателя.
`reception.bulk`	—	string	Корпус получателя.
`reception.flat`	—	string	Квартира получателя.
`sender.countryCode`	—	string	Код страны получателя. По умолчанию `'RU'`.
`sender.cityFias`	—	string	ФИАС населённого пункта отправителя.
`sender.cityName`	—	string	Название населённого пункта отправителя.
`sender.cityType`	—	string	Тип населённого пункта (`'г'`, `'д'`, `'пос'` и т.п.) отправителя.
`sender.zipCode`	—	string	Почтовый индекс населённого пункта отправителя.
`sender.region`	—	string	Регион отправителя.
`sender.area`	—	string	Район в регионе отправителя.
`sender.street`	—	string	Улица отправителя.
`sender.house`	—	string	Дом отправителя.
`sender.bulk`	—	string	Корпус отправителя.
`sender.flat`	—	string	Квартира отправителя.
`pickupType`	—	number `1`, `4`	Тип забора. Требуется передавать только если не был задан магазин через заголовок `Shop-Id`.
`products`	—	array	Товары заказа. Передаются в виде объектов со следующими полями (все параметры передаются за единицу товара): `vendorCode` – артикул; `priceDeclared` – оценочная стоимость в рублях; `priceCod` – наложенный платёж в рублях; `discount` – скидка в рублях; `dimensions.width` – ширина в см; `dimensions.height` – высота в см; `dimensions.length` – длина в см; `volume` – объём в м³; `weight` – вес в кг; `count` – количество товара.
`kits`	—	array	Комплекты товаров заказа. Передаются в виде объектов со следующими полями: `vendorCode` – артикул комплекта; `price` – стоимость комплекта (если передана, переопределяет стоимость товаров в комплекте, распределяясь поровну между всеми товарами комплекта); `count` – количество комплектов.
`priceDeclared`	—	number	Оценочная стоимость.
`priceCod`	—	number	Наложенный платёж.
`priceClient`	—	number	Стоимость доставки с клиента. Комиссия взимается как с наложенного платежа.
`pricePrePayClient`	—	number	Стоимость предоплаты за доставку с клиента. Влияет на комиссию эквайринга.
`discount`	—	number	Общая скидка на заказ (в рублях).
`marketplace.id`	—	number \| null	ID маркетплейса.
`marketplace.warehouseId`	—	number \| null	ID склада маркетплейса.
`marketplace.fbo`	—	boolean	Тип отгрузки FBO (продажа со склада маркетплейса).
`marketplace.fbs`	—	boolean	Тип отгрузки FBS (продажа со склада продавца).
`services`	—	array	ID дополнительных услуг, которые необходимо вывести в данные транспортных компаний (свойство `services` в ответе). Стоимость этих услуг не будет добавлена в общую стоимость доставки `totalPrice`.
`servicesRequired`	—	array	Обязательные дополнительные услуги. Компании, не поддерживающие эти услуги, не будут включены в список результатов. Стоимость этих услуг добавляется в общую стоимость доставки `totalPrice`.
`type`	—	number	Фильтр по типу доставки. Если передан, калькулятор вернёт только доставку указанного типа.
`companyIds`	—	array	Фильтр по компаниям доставки, позволяющий посчитать только отдельные компании. Передаётся в виде массива ID требуемых компаний.
`onlyCheap`	—	boolean	Вывод только вариантов доставки с самой низкой ценой. По умолчанию `false`.
`calcDeclared`	—	boolean	Учёт переданной оценочной стоимости (`priceDeclared`) товаров. По умолчанию `true`.
`calcCod`	—	boolean	Учёт переданного наложенного платежа (`priceCod`) товаров. По умолчанию `true`.
`hidePointFullInfo`	—	boolean	Если передано `true`, массив `points` вместо объектов с полными данными будет содержать только ID ПВЗ.
`applyWidgetSettings`	—	boolean	Применять ли настройки и правила виджетов. По умолчанию `false`.
`applyDefaultDimensions`	—	boolean	Использовать ли габариты из настроек виджетов в качестве габаритов по умолчанию. По умолчанию `false`. При использовании `applyWidgetSettings` опция не имеет смысла, т.к. с `applyWidgetSettings` габариты из настроек виджетов так же будут применяться как габариты по умолчанию.
`timeout`	—	number	Время ожидания ответа от серверов транспортных компаний (в миллисекундах). Компании, данные от которых не были получены за указанное время, не попадут в выдачу. По умолчанию 20 000 мс.
Габариты по местам:
`places`	—	array	Места. Передаются в виде объектов со следующими полями: `dimensions.width` – ширина коробки в см; `dimensions.height` – высота коробки в см; `dimensions.length` – длина коробки в см; `weight` – вес коробки в кг; `count` – количество коробок.
Общие габариты:
`weight`	—	number	Общий вес заказа в кг.
`dimensions.width`	—	number	Общая ширина заказа в см.
`dimensions.height`	—	number	Общая высота заказа в см.
`dimensions.length`	—	number	Общая длина заказа в см.
`itemCount`	—	number	Общее количество мест. По умолчанию 1.
`volume`	—	number	Общий объём в м³.

Имя заголовка	Обязательный	Описание
`Shop-Id`	Да	ID магазина.
`Type`	Да	Тип доставки.
`Company-Id`	Да	ID компании, доставку которой нужно посчитать.

Имя заголовка	Обязательный	Описание
`Shop-Id`	Да	ID магазина.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
type	—	number	Тип доставки. Если передан, будут получены только доставки указанного типа.
reception.cityFias	—	string	ФИАС населённого пункта.
reception.zipCode	—	string	Почтовый индекс населённого пункта.
reception.cityName	—	string	Название населённого пункта.
reception.countryCode	—	string	Код страны.
reception.addressString	—	string	Адрес доставки одной строкой (страна, тип и название населённого пункта).
applyWidgetSettings	—	boolean	Если передано `true`, при определении списка доступных компаний будут применяться настройки и правила виджетов.

Параметр	Тип	Описание
`id`	number	ID. Только для GET-запросов.
`statusHistory`	array	История статусов заказа от последнего к самому первому. Только для GET-запросов. Массив объектов с полями: `code` – код статуса; `date` – дата и время перехода в данный статус; `address` – адрес местонахождения заказа.
`creationDate`	string	Дата и время создания заказа. Только для GET-запросов.
`trackingUrl`	string \| null	URL для трекинга заказа. Только для GET-запросов.
`trackNumber`	string \| null	Трек-номер заказа. Только для GET-запросов.
`stickerFormed`	boolean	Были ли для заказа сформированы стикеры. Только для GET-запросов.
`isPacked`	boolean	Был ли заказ скомплектован. Только для GET-запросов.
`exceptionDeliveryCompany`	boolean	Тип отгрузки в заказе отличается от настроек склада по умолчанию. Только для GET-запросов.
`error`	string \| null	Текстовое описание ошибки заказа. Только для GET-запросов.
`pay.type`	number	Код типа оплаты. Только для GET-запросов.
`pay.prePay`	number	Сумма предоплаты в рублях. Только для GET-запросов.
`pay.status.code`	string	Код статуса оплаты. Только для GET-запросов.
`pay.status.date`	string	Дата установки статуса оплаты. Только для GET-запросов.
`priceCod`	number	Сумма наложенного платежа. Только для GET-запросов.
`cmsId`	string \| null	ID заказа в CMS (на сайте магазина).
`shopId`	number \| null	ID магазина. Если не передан, в заказе должен присутствовать адрес отправки в параметре `senderAddress`, контакты отправителя в параметре `sender` и настройки отгрузки в параметре `pickup`. Если же магазин был передан, значения в этих полях учитываться не будут и будут взяты из склада заданного магазина.
`products`	array	Товары заказа. Массив объектов с полями: `name` – название товара; `nameEn` – название товара на английском (необходимо для международной доставки почтой); `vendorCode` – артикул; `vat` – НДС. Возможные значения: `0`, `10`, `20`; `priceDeclared` – оценочная стоимость в рублях; `priceCod` – наложенный платёж в рублях (за единицу товара); `prePay` – предоплата в рублях (за единицу товара); `discount` – скидка на товар в рублях (за единицу товара); `tnved` – ТН ВЭД (необходим для международной доставки почтой); `count` – количество товара; `brand` – название бренда; `producingCountry` – код страны-производителя; `dimensions.width` – ширина отдельного товара в см (только для POST-запросов); `dimensions.height` – высота отдельного товара в см (только для POST-запросов); `dimensions.length` – длина отдельного товара в см (только для POST-запросов); `countDelivered` – количество единиц вручённого товара (только для GET-запросов). Ширина, длина и высота товаров могут передаваться при создании заказа вместо общих габаритов заказа (`dimensions.width`, `dimensions.height`, `dimensions.length`). Переданные потоварные габариты будут преобразованы в общие габариты.
`priceDeclared`	number \| null	Оценочная стоимость заказа. Применяется, если нет потоварной.
`places`	array	Габариты по местам. Массив объектов с полями: `name` – название коробки; `count` – количество коробок. Значение от 1 до 99, по умолчанию 1; `dimensions.width` – ширина коробки в см. Значение от 1 до 999, обязательный параметр; `dimensions.height` – высота коробки в см. Значение от 1 до 999, обязательный параметр; `dimensions.length` – длина коробки в см. Значение от 1 до 999, обязательный параметр; `weight` – вес в кг. Может быть дробным с точностью до грамма. Минимальное значение – 0,001 (1 грамм).
`dimensions.width`	number \| null	Общая ширина в см. Значение от 1 до 999.
`dimensions.height`	number \| null	Общая высота в см. Значение от 1 до 999.
`dimensions.length`	number \| null	Общая длина в см. Значение от 1 до 999.
`dimensions.weight`	number \| null	Общий вес в кг. Может быть дробным с точностью до грамма. Минимальное значение – 0,001 (1 грамм).
`dimensions.places`	number \| null	Общее количество мест. Значение от 1 до 99. По умолчанию 1.
`deliveryAddress.city.countryCode`	string	Код страны получателя.
`deliveryAddress.city.name`	string	Название населённого пункта получателя.
`deliveryAddress.city.fias`	string \| null	ФИАС населённого пункта получателя.
`deliveryAddress.city.type`	string \| null	Тип населённого пункта получателя (`'г'`, `'д'`, `'пос'` и т.п.).
`deliveryAddress.city.region`	string \| null	Регион получателя.
`deliveryAddress.city.area`	string \| null	Район в регионе получателя.
`deliveryAddress.street`	string \| null	Улица получателя.
`deliveryAddress.house`	string \| null	Дом получателя.
`deliveryAddress.bulk`	string \| null	Корпус получателя.
`deliveryAddress.flat`	string \| null	Квартира получателя.
`deliveryAddress.zipCode`	string \| null	Почтовый индекс получателя.
`recipient.fullName`	string	ФИО получателя.
`recipient.phone`	string	Телефон получателя.
`recipient.additionalPhone`	string \| null	Доп. телефон получателя.
`recipient.email`	string \| null	E-mail получателя.
`recipient.legalEntity.name`	string \| null	Название юр. лица получателя.
`recipient.legalEntity.TIN`	string \| null	ИНН юр. лица получателя.
`senderAddress.city.countryCode`	string \| null	Код страны отправителя.
`senderAddress.city.name`	string \| null	Название населённого пункта отправителя.
`senderAddress.city.fias`	string \| null	ФИАС населённого пункта отправителя.
`senderAddress.city.type`	string \| null	Тип населённого пункта отправителя (`'г'`, `'д'`, `'пос'` и т.п.).
`senderAddress.city.region`	string \| null	Регион отправителя.
`senderAddress.city.area`	string \| null	Район в регионе отправителя.
`senderAddress.street`	string \| null	Улица отправителя.
`senderAddress.house`	string \| null	Дом отправителя.
`senderAddress.bulk`	string \| null	Корпус отправителя.
`senderAddress.flat`	string \| null	Квартира отправителя.
`sender.fullName`	string \| null	ФИО отправителя.
`sender.phone`	string \| null	Телефон отправителя.
`pickup.type`	number \| null	Тип забора. Доступны значения `1` и `4`.
`pickup.date`	string \| null	Дата отгрузки заказа.
`pickup.pointId`	number \| null	ID точки отгрузки заказа. Можно не передавать в случае доставки компанией, позволяющей отгрузить заказ в любой свой ПВЗ.
`marketplace.id`	number \| null	ID маркетплейса.
`marketplace.warehouseId`	number \| null	ID склада маркетплейса.
`marketplace.warehouseType`	number \| null	Тип отгрузки в маркетплейс.
`services`	array	Массив ID дополнительных услуг. Только для GET-запросов.
`applyWidgetSettings`	boolean	Применять ли настройки и правила виджетов при вычислении доставки для данного заказа.
`delivery.company.id`	number	ID компании доставки.
`delivery.company.name`	string	Название компании доставки. Только для GET-запросов.
`delivery.company.abbr`	string	Сокращённое название компании доставки. Только для GET-запросов.
`delivery.company.logo`	string	URL логотипа компании доставки. Только для GET-запросов.
`delivery.company.tariff`	string \| null	Название тарифа доставки.
`delivery.type`	number	Тип доставки.
`delivery.cashPaymentAvailable`	boolean	Возможна ли оплата наличными при получении. Только для GET-запросов.
`delivery.cardPaymentAvailable`	boolean	Возможна ли оплата картой при получении. Только для GET-запросов.
`delivery.fittingAvailable`	boolean	Доступна ли услуга “Примерка”. Только для GET-запросов.
`delivery.checkupAvailable`	boolean	Доступна ли услуга “Осмотр вложения”. Только для GET-запросов.
`delivery.partialBuyoutAvailable`	boolean	Доступна ли услуга “Частичная выдача”. Только для GET-запросов.
`delivery.date.from`	string	Минимальная дата доставки. Только для GET-запросов.
`delivery.date.to`	string	Максимальная дата доставки. Только для GET-запросов.
`delivery.days.min`	number	Минимальный срок доставки в днях. Только для GET-запросов.
`delivery.days.max`	number	Максимальный срок доставки в днях. Только для GET-запросов.
`delivery.price`	number	Стоимость доставки. Только для GET-запросов.
`delivery.totalPrice`	number	Общая стоимость доставки с доп. услугами и комиссиями. Только для GET-запросов.
`delivery.factPrice`	number \| null	Фактическая стоимость доставки, подлежащая тарификации. Только для GET-запросов.
`delivery.services`	array	Массив дополнительных услуг. Содержит объекты с полями: `id` – ID услуги; `price` – стоимость в рублях. При создании/редактировании заказа необходимо передавать массив вида `[{ id: 7 }, { id: 12 }]` с ID нужных доп. услуг.
`delivery.point`	object \| null	Объект с данными ПВЗ (модель `OrderDeliveryPickupPoint`). `null`, если доставка не предполагает самовывоз из ПВЗ.
`delivery.priceCommissionDeclared`	number	Стоимость страховки в рублях. Только для GET-запросов.
`delivery.percentCommissionDeclared`	number	Процентная ставка страховки. Только для GET-запросов.
`delivery.priceCommissionCod`	number	Комиссия наложенного платежа наличными в рублях. Только для GET-запросов.
`delivery.percentCommissionCod`	number	Процентная ставка наложенного платежа наличными. Только для GET-запросов.
`delivery.priceCommissionCodCard`	number	Комиссия наложенного платежа картой в рублях. Только для GET-запросов.
`delivery.percentCommissionCodCard`	number	Процентная ставка наложенного платежа картой. Только для GET-запросов.
`delivery.priceCommissionAcquiring`	number	Комиссия за эквайринг в рублях. Только для GET-запросов.
`delivery.percentCommissionAcquiring`	number	Процентная ставка за эквайринг. Только для GET-запросов.
`clientPrice`	number	Стоимость доставки с клиента. Комиссия взимается как с наложенного платежа.
`clientPrePay`	number \| null	Сумма предоплаты за доставку.
`clientDeliveryDate`	string \| null	Желаемая дата курьерской доставки.
`clientCourierTime`	number \| null	ID временного интервала курьерской доставки. Получение информации о временных интервалах курьерской доставки.
`comment`	string	Комментарий для службы доставки.
`commentForAssembly`	string	Комментарий для сборки заказа.
`documentsForWarehouse`	string \| null	Ссылка на документы для склада.
`tasks`	array	Массив задач на изменение подтверждённого нередактируемого заказа. Содержит объекты с полями: `date` – дата и время создания задачи; `status.code` – текущий статус задачи; `status.updateTime` – дата и время последнего изменения статуса задачи; `details` – массив объектов `{ field, newValue }`, где `field` содержит имя свойства модели `Order`, которое требуется изменить (например, `'deliveryAddress.street'`), а `newValue` содержит новое значение для этого поля. Только для GET-запросов.

Параметр	Тип	Описание
`id`	number	ID ПВЗ в системе SafeRoute.
`name`	string	Название ПВЗ. Только для GET-запросов.
`longitude`	number	Долгота. Только для GET-запросов.
`latitude`	number	Широта. Только для GET-запросов.
`type`	number \| null	Тип ПВЗ. Только для GET-запросов.
`description`	string \| null	Описание как пройти к ПВЗ. Только для GET-запросов.
`address`	string	Адрес. Только для GET-запросов.
`photos`	array \| null	Массив URL фотографий ПВЗ. Только для GET-запросов.
`schedule`	array \| null	График работы. Только для GET-запросов. Массив из 7 значений (пн-вс). `null` в массиве означает нерабочий день, для рабочего дня время задаётся объектом с полями `from` и `to`. Формат времени – `HH:MM`.
`zipCode`	string \| null	Почтовый индекс. Только для GET-запросов.
`isPost`	boolean	Является ли пункт выдачи почтовым отделением. Только для GET-запросов.
`isFar`	boolean	Содержит `true` в случаях, когда данный ПВЗ находится не в населённом пункте, который был передан при запросе в калькулятор, а в ближайшем к нему. Такие ПВЗ встречаются, когда в запрашиваемом населённом пункте нет ПВЗ. Только для GET-запросов.
`holdDays`	number	Количество дней, которое заказ будет храниться на ПВЗ. Только для GET-запросов.
`holdDate`	string	Дата, до которой заказ будет храниться на ПВЗ. Только для GET-запросов.
`storagingEnds`	boolean	Истекает срок хранения заказа на ПВЗ. Только для GET-запросов.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`list`	Да	number	Фильтр по состоянию заказов.
`deliveryType`	—	number	Фильтр по типу доставки.
`shopId`	—	number	Фильтр по ID магазина. Передайте `0`, если требуется получить заказы, созданные без магазина.
`warehouseId`	—	number	Фильтр по ID склада.
`dateFrom`	—	string	Фильтр по дате ОТ. Для разных списков (параметр `list`) `dateFrom` и `dateTo` фильтруют по разным типам дат: черновики – дата создания; подготовленные – дата подтверждения; доставляющиеся – дата начала доставки; на ПВЗ – дата поступления на ПВЗ; доставленные – дата вручения; возвраты – дата возврата; отменённые – дата отмены; проблемные – дата обнаружения ошибки/проблемы.
`dateTo`	—	string	Фильтр по дате ДО.
`statuses`	—	array	Фильтр по коду статуса.
`deliveryCompanies`	—	array	Фильтр по ID компании доставки.
`paymentMethods`	—	array	Фильтр по способу оплаты.
`stickerFormed`	—	number `0`, `1`	Только заказы со сформированными стикерами (для списка подготовленных заказов).
`wasInAct`	—	number `0`, `1`	Только заказы, попадавшие в акт (для списка подготовленных заказов).
`packed`	—	number `0`, `1`	Только скомплектованные заказы (для списка подготовленных заказов).
`storagingEnds`	—	number `0`, `1`	Только заказы с истекающим сроком хранения (для заказов на ПВЗ). Выводит заказы, у которых остался день до окончания хранения.
`withCod`	—	number `0`, `1`	Только заказы с наложенным платежом.
`codReceived`	—	number `0`, `1`	Только заказы, наложенный платёж за которые получен (для доставленных).
`search`	—	string	Поиск по параметрам заказа: `id` (полное совпадение); `cmsId` (полное совпадение); `recipient.fullName` (неполное совпадение); `recipient.phone` (неполное совпадение); `recipient.additionalPhone` (неполное совпадение); `recipient.email` (неполное совпадение); `deliveryAddress.city.name` (неполное совпадение).
`page`	—	number	Номер страницы.
`perPage`	—	number	Кол-во результатов на страницу.

Параметр	Тип	Описание
`id`	number	ID созданного заказа.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`ids`	Да	array	Массив ID заказов, которые необходимо подтвердить. В случае, если хотя бы один из заказов не удалось подтвердить, будет возвращена ошибка.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`ids`	Да	array	Массив ID заказов, которые необходимо отменить. В случае, если хотя бы один из заказов не удалось отменить, будет возвращена ошибка.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`ids`	Да	array	Массив ID заказов, которые необходимо продублировать. В случае, если хотя бы один из заказов не удалось продублировать, будет возвращена ошибка.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`ids`	Да	array	Массив ID заказов, которые необходимо продублировать для возврата. В случае, если хотя бы один из заказов не удалось продублировать, будет возвращена ошибка.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`ids`	Да	array	Массив ID заказов, для которых необходимо оформить возврат. В случае, если хотя бы для одного из заказов не удалось оформить возврат, будет возвращена ошибка.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`ids`	Да	array	Массив ID заказов, для которых необходимо продлить хранение.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`ids`	Да	array	Массив ID заказов, которые требуется скомплектовать.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`ids`	Да	array	Массив ID заказов, которые требуется раскомплектовать.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`countryCode`	—	string	Код страны забора. По умолчанию `'RU'`.
`region`	Да	string	Название региона.
`fias`	—	string	ФИАС населённого пункта.
`companyId`	Да	number	ID службы доставки.
`pickupType`	Да	number `1`, `4`	Тип забора.

Параметр	Тип	Описание
`pickupDate.from`	string	Дата забора ОТ.
`pickupDate.to`	string	Дата забора ДО.
`pricePickup`	number	Стоимость забора.
`pickupPointRequired`	boolean	Требуется ли при создании заказа указание конкретной точки сдачи груза в службу доставки (только при `pickupType` со значением `1`).
`points`	array	Массив точек для отгрузки заказа (только при `pickupType` со значением `1`). Точки выводятся в виде объектов с полями: `id` – ID точки в системе; `address` – адрес точки; `type` – тип пункта; `latitude` – широта; `longitude` – долгота; `photos` – массив фотографий пункта; `description` – описание как добраться до пункта; `schedule` – график работы, массив из 7 значений (пн-вс). `null` означает выходной.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`archive`	—	number `0`, `1`	Вывод архивных заборов вместо актуальных.
`page`	—	number	Номер страницы.
`perPage`	—	number	Кол-во результатов на страницу.

Параметр	Тип	Описание
`id`	number	ID забора.
`type`	number	Тип забора. Возможны только 2 варианта: единый забор и прямая отгрузка.
`status`	number	Статус забора.
`number`	number \| string \| null	Номер в транспортной компании.
`date`	string	Дата забора.
`time.from`	string	Интервал забора ОТ.
`time.to`	string	Интервал забора ДО.
`price`	number	Стоимость.
`file`	string \| null	Ссылка на акт передачи заказов.
`countOrders`	number	Число заказов.
`warehouse`	object	Склад отгрузки. Модель `Warehouse`.
`companyName`	string	Название транспортной компании.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`warehouseId`	Да	number	ID склада отгрузки.
`companyId`	Да	number	ID компании забора (получение компаний забора).
`type`	Да	number `3`, `4`	Тип забора: единый забор или прямая отгрузка.
`date`	Да	string	Дата отгрузки.

Параметр	Тип	Описание
`id`	number	ID созданного забора.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`id`	Да	number	ID забора.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`warehouseId`	Да	number	ID склада отгрузки.
`type`	Да	number `3`, `4`	Тип забора: единый забор или прямая отгрузка.

Параметр	Тип	Описание
`id`	number	ID компании в системе.
`name`	string	Название.
`price`	number	Стоимость забора.
`countFree`	number	Минимальное число заказов для бесплатного забора.

Параметр	Тип	Описание
id	number	ID. Только для GET-запросов.
name	string	Название. Обязательный параметр.
nameEn	string \| null	Название на английском (необходимо для международной доставки почтой).
vendorCode	string	Артикул (должен быть уникальным в рамках одного магазина). Обязательный параметр.
vat	number	НДС. Возможные значения: `0`, `10`, `20`.
priceDeclared	number \| null	Страховая стоимость в рублях.
priceCod	number \| null	Стоимость в рублях.
weight	number \| null	Вес в кг. Может быть дробным с точностью до грамма. Минимальное значение – 0,001 (1 грамм).
volume	number \| null	Объём в м³.
dimensions.width	number \| null	Ширина в см. Целое число от 1 до 999.
dimensions.height	number \| null	Высота в см. Целое число от 1 до 999.
dimensions.length	number \| null	Длина в см. Целое число от 1 до 999.
shopId	number \| null	ID магазина.
quantity	number \| null	Количество на складе. Только для GET-запросов.
photo	string \| null	URL фотографии товара.
tnved	string \| null	ТН ВЭД (необходим для международной доставки почтой).
barcodes	array	Массив штрих-кодов (строки).
brand	string \| null	Бренд.
producingCountry	string \| null	Код страны-производителя.
markCodeRequired	boolean	Флаг “Требуется код маркировки“. Используется, если товар подлежит обязательной маркировке “Честный знак”. Только для магазинов на фулфилменте.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`name`	—	string	Фильтр по названию по неполному совпадению.
`vendorCode`	—	string	Фильтр по артикулу по неполному совпадению.
`shopId`	—	number	Фильтр по ID магазина.
`tnved`	—	string	Фильтр по ТН ВЭД по неполному совпадению.
`ids`	—	array	Фильтр по массиву ID товаров.
`vendorCodes`	—	array	Фильтр по массиву артикулов (полное совпадение).
`barcode`	—	string	Фильтр по штрих-коду по неполному совпадению.
`page`	—	number	Номер страницы.
`perPage`	—	number	Кол-во результатов на страницу.

Параметр	Тип	Описание
`id`	number	ID созданного товара.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`file`	Да	string	base64-представление xlsx-файла со списком товаров. Образец файла. В 1 файле допускается до 2 000 наименований товаров, при превышении этого количества API вернёт ошибку. При совпадении артикулов импортируемых товаров с артикулами товаров, уже имеющихся в Личном кабинете, товары в Личном кабинете перезаписываются.
`shopId`	Да	number	ID магазина, для которого будут импортированы товары.

Параметр	Тип	Описание
`success`	number	Количество успешно импортированных товаров.
`total`	number	Общее количество товаров в файле.
`errors`	object	Ошибки импорта. Объект, в котором ключами выступают номера строк xlsx-файла, в которых содержатся ошибки. Значения – вложенные объекты с 2 полями: `param` – имя параметра, вызвавшего ошибку (`'name'` – название, `'nameEn'` – название на англ., `'vendorCode'` – артикул, `'price'` – стоимость, `'vat'` – НДС, `'barcode'` – штрих-код, `'width'` – ширина, `'height'` – высота, `'length'` – длина, `'volume'` – объём, `'weight'` – вес, `'productCode'` – ТН ВЭД, `'photo'` – ссылка на фото); `code` – код ошибки (`1` – отсутствует обязательное значение, `2` – некорректное значение).

Параметр	Тип	Описание
`id`	number	ID. Только для GET-запросов.
`name`	string	Название комплекта. Обязательный параметр.
`vendorCode`	string	Артикул комплекта (должен быть уникальным в рамках одного магазина). Обязательный параметр.
`shop`	object	Магазин комплекта. GET-запросы будут возвращать полную модель `Shop`. При создании и редактировании комплекта в `shop` достаточно передавать объект только с параметром `id`.
`discount`	number	Процент скидки по умолчанию.
`products`	array	Товары комплекта. В комплект могут быть добавлены только товары магазина, переданного в параметре `shop`. GET-запросы будут возвращать массив полных моделей `Product` с двумя дополнительными параметрами: `count` и `discount`. При создании и редактировании комплекта массив должен содержать объекты с полями: `id` – ID товара (обязательный параметр); `count` – количество единиц товара; `discount` – процент скидки.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`name`	—	string	Фильтр по названию комплекта по неполному совпадению.
`vendorCode`	—	string	Фильтр по артикулу комплекта по неполному совпадению.
`shopId`	—	number	Фильтр по магазину.
`search`	—	string	Поиск по названию и артикулу одновременно.
`page`	—	number	Номер страницы.
`perPage`	—	number	Кол-во результатов на страницу.

Параметр	Тип	Описание
`id`	number	ID созданного комплекта.

Параметр	Тип	Описание
`id`	number	ID. Только для GET-запросов.
`name`	string \| null	Название.
`dimensions.width`	number	Ширина в см. Целое число от 1 до 999.
`dimensions.height`	number	Высота с см. Целое число от 1 до 999.
`dimensions.length`	number	Длина в см. Целое число от 1 до 999.
`weight`	number \| null	Вес в кг. Может быть дробным с точностью до грамма. Минимальное значение – 0,001 (1 грамм).

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
name	—	string	Фильтр по названию коробки по неполному совпадению.
width	—	number	Фильтр по ширине.
height	—	number	Фильтр по высоте.
length	—	number	Фильтр по длине.
weight	—		Фильтр по весу.
page	—	number	Номер страницы.
perPage	—	number	Кол-во результатов на страницу.

Параметр	Тип	Описание
`id`	number	ID созданной коробки.

Параметр	Тип	Описание
`id`	number	ID. Только для GET-запросов.
`apiKey`	string	API-ключ для интеграций. Только для GET-запросов.
`name`	string	Название. Обязательный параметр.
`cmsProductsAutocomplete`	boolean	Флаг “На странице заказа брать товары из CMS”.
`emailNotifications`	boolean	Флаг “E-mail оповещение клиентов”.
`cdekCalling`	boolean	Флаг “Прозвон заказов CDEK”.
`disableQuantityControlInCheckout`	boolean	Флаг “Отключить контроль остатков в чекауте“. Играет роль только если платформой магазина является чекаут SafeRoute.
`sendQuantityToCMS`	boolean	Флаг “Отправлять остатки товаров в CMS”.
`brand`	string	Название бренда. Обязательный параметр.
`platform`	string \| null	Платформа. `null`, если нет CMS.
`warehouse`	object	Склад отгрузки. Обязательный параметр. GET-запросы будут возвращать полную модель `Warehouse`. При создании и редактировании магазина в `warehouse` достаточно передавать объект только с параметром `id`.
`notifications.events.ordersExpirationInPickupPoint`	boolean	Флаг оповещения о событии “У заказов на ПВЗ остался последний день хранения”.
`notifications.events.ordersSentForReturn`	boolean	Флаг оповещения о событии “Заказы направлены на возврат”.
`notifications.events.newOrder`	boolean	Флаг оповещения о событии “Пришёл новый заказ”.
`notifications.events.newProblemOrder`	boolean	Флаг оповещения о событии “Заказ попал в список проблемных”.
`notifications.events.fulfillmentReceivedReturns`	boolean	Флаг оповещения о событии “Возвраты поступили на фулфилмент”.
`notifications.events.productEndsInFulfilment.enabled`	boolean	Флаг оповещения о событии “На складе фулфилмента заканчивается товар”.
`notifications.events.productEndsInFulfilment.border`	number \| null	Количество единиц товара для оповещения о заканчивающемся товаре.
`notifications.events.orderProductsNotAvailableInFulfilment`	boolean	Флаг оповещения о событии “На складе фулфилмента отсутствует товар для отправки заказа”.
`notifications.events.deliveryAcceptedForFulfillment`	boolean	Флаг оповещения о событии “Поставка по акту принята на склад фулфилмента”.
`notifications.currentAccount.enabled`	boolean	Флаг оповещения о событиях пользователя текущего аккаунта.
`notifications.employees.enabled`	boolean	Флаг оповещения о событиях сотрудников.
`notifications.employees.ids`	array	ID сотрудников, которых требуется оповещать о событиях. Если ID не заданы, будут оповещаться все сотрудники, имеющие доступ к магазину.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`name`	—	string	Фильтр по названию по неполному совпадению.
`brand`	—	string	Фильтр по бренду по неполному совпадению.
`warehouseId`	—	number	Фильтр по складу.
`onlyFulfilment`	—	number `0`, `1`	Выводить только магазины с фулфилмент-складом.
`onlyMergedPickup`	—	number `0`, `1`	Выводить только магазины со складом с единым забором (тип `2` и `3`).
`page`	—	number	Номер страницы.
`perPage`	—	number	Кол-во результатов на страницу.

Параметр	Тип	Описание
`id`	number	ID созданного магазина.

Параметр	Тип	Описание
`id`	number	ID. Только для GET-запросов.
`name`	string	Название. Обязательный параметр.
`type`	number	Тип склада. Обязательный параметр. Склады с типом “Фулфилмент” после создания нельзя отредактировать. ID привязанного фулфилмент-склада передаётся в параметре `fulfilmentWarehouseId`, все остальные параметры (`name`, `address`, `contact`, `holidays`, `schedule`, `markCompletedOrders`) можно не передавать – их значения будут загружены из привязанного склада.
`fulfilmentWarehouseId`	number \| null	ID склада фулфилмента. Только для складов, у которых в `type` установлен тип “Фулфилмент”. К одному и тому же фулфилмент-складу может быть привязан только один склад на аккаунте. Чтобы получить список доступных фулфилмент-складов, воспользуйтесь параметром `hold` при запросе `GET /v2/warehouses`.
`address.street`	string	Улица. Обязательный параметр.
`address.house`	string	Дом.
`address.bulk`	string	Корпус.
`address.flat`	string	Помещение.
`address.city.countryCode`	string	Код страны. Обязательный параметр.
`address.city.name`	string	Название города / населённого пункта. Обязательный параметр.
`address.city.fias`	string	ФИАС населённого пункта.
`address.city.type`	string	Тип населённого пункта (`'г'`, `'д'`, `'пос'` и т.п.).
`address.city.region`	string	Регион.
`address.city.area`	string	Район в регионе.
`contact.name`	string	ФИО контактного лица. Обязательный параметр.
`contact.position`	string \| null	Должность контактного лица.
`contact.phone`	string	Телефон контактного лица. Обязательный параметр.
`holidays`	array	Массив дат праздничных (нерабочих) дней склада. Прошедшие даты удаляются автоматически.
`schedule`	array	График приезда курьера. Обязательный параметр. Массив из 7 значений (пн-вс). `null` в массиве означает нерабочий день, для рабочего дня время задаётся объектом с полями from и to. Формат времени – `HH:MM`.
`markCompletedOrders`	boolean	Флаг “Отмечать скомплектованные заказы”.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`name`	—	string	Фильтр по названию по неполному совпадению.
`onlyMergedPickup`	—	number `0`, `1`	Вывести только склады с единым забором (тип `2` и `3`).
`hold`	—	number `0`, `1`	Вывести доступные склады фулфилмент. ID полученных складов можно передавать в `fulfilmentWarehouseId` при создании склада.
`page`	—	number	Номер страницы.
`perPage`	—	number	Кол-во результатов на страницу.

Параметр	Тип	Описание
`id`	number	ID созданного склада.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`shopId`	—	number	Фильтр по магазину.
`page`	—	number	Номер страницы.
`perPage`	—	number	Кол-во результатов на страницу.

Параметр	Тип	Описание
`date`	string	Дата и время формирования набора стикеров.
`deliveryCompanySticker`	string \| null	URL стикера службы доставки.
`postSticker`	string \| null	URL почтового стикера.
`stickers`	array	Массив стикеров разного размера, от одного до нескольких на одном листе А4. Содержит объекты с полями `file` (URL файла стикера) и `perPage` (количество размещённых на листе стикеров).

Параметр	Тип	Описание
`id`	number	ID акта.
`date`	string	Дата поставки.
`type`	string	Тип поставки.
`shop`	object	Магазин.
`countOrders`	number	Число заказов.
`countPlaces`	number	Число мест.
`file`	string	URL файла акта (PDF-файл).

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`date.from`	Да	string	Интервал движения ОТ.
`date.to`	Да	string	Интервал движения ДО.
`ids`	Да	array	ID товаров.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`from`	—	string	Интервал ОТ.
`to`	—	string	Интервал ДО.
`page`	—	number	Номер страницы.
`perPage`	—	number	Кол-во результатов на страницу.

Параметр	Тип	Описание
`id`	number	ID счёта.
`date`	string	Дата выставления счёта.
`sum`	number	Сумма счёта.
`payStatus`	number	Статус.
`paySum`	number	Сумма, которая была оплачена.
`file`	string	Ссылка на файл со счётом на оплату.

Параметр	Тип	Описание
`id`	number	ID отчёта.
`date`	string	Дата.
`type`	number	Тип отчёта.
`sum`	number	Сумма.
`file`	string	Ссылка на файл с отчётом.

Параметр	Тип	Описание
`delivery`	array	Список услуг по доставке (ID услуг и их названия).
`packing`	array	Список услуг по упаковке (ID услуг и их названия).

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`cityFias`	Да	string	ФИАС города доставки.
`companyId`	Да	number	ID компании доставки.
`date`	Да	string	Дата.

Параметр	Тип	Описание
`id`	number	ID интервала.
`timeFrom`	string	Интервал доставки ОТ.
`timeTo`	string	Интервал доставки ДО.
`isDefault`	boolean	Интервал со значением `true` устанавливается в заказе по умолчанию, если при сохранении заказа в параметр `clientCourierTime` не был передан ID интервала.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`id`	—	number	Фильтр по ID ПВЗ в системе.
`companyId`	—	number	Фильтр по ID компании доставки в системе.
`cityFias`	—	string	Фильтр по ФИАС города.
`country`	—	string	Фильтр по стране (передаётся код страны).
`types`	—	array	Фильтр по типу ПВЗ.
`page`	—	number	Номер страницы.
`perPage`	—	number	Кол-во результатов на страницу.

Параметр	Тип	Описание
`id`	number	ID ПВЗ в системе.
`name`	string	Название ПВЗ.
`deliveryCompanyId`	number	ID компании доставки в системе.
`longitude`	string	Долгота.
`latitude`	string	Широта.
`type`	number	Тип ПВЗ.
`description`	string \| null	Описание как пройти к ПВЗ.
`address`	string	Адрес.
`zipCode`	string	Почтовый индекс.
`schedule`	array	График работы. Массив из 7 значений (пн-вс). `null` в массиве означает нерабочий день, для рабочего дня время задаётся объектом с полями `from` и `to`. Формат времени – `HH:MM`.
`district`	string \| null	Район города.
`metro`	array \| null	Ближайшие станции метро (до 3-х). Выводятся в виде объектов с полями: `name` – название станции; `line` – название линии метро; `distance` – расстояние в км.
`photos`	array \| null	Массив URL фотографий ПВЗ.
`fittingAvailable`	boolean	Доступна ли услуга “Примерка”.
`checkupAvailable`	boolean	Доступна ли услуга “Осмотр вложения”.
`partialBuyoutAvailable`	boolean	Доступна ли услуга “Частичная выдача”.
`cashPaymentAvailable`	boolean	Доступна ли оплата наличными.
`cardPaymentAvailable`	boolean	Доступна ли оплата картой.
`limits.maxSizeA`	number \| null	Максимальная длина стороны А в см.
`limits.maxSizeB`	number \| null	Максимальная длина стороны B в см.
`limits.maxSizeC`	number \| null	Максимальная длина стороны C в см.
`limits.maxSizeSum`	number \| null	Максимальная сумма длин всех сторон в см.
`limits.minWeight`	number \| null	Минимальный вес в кг.
`limits.maxWeight`	number \| null	Максимальный вес в кг.
`limits.maxCod`	number \| null	Максимальная сумма наложенного платежа в руб.
`limits.maxVolume`	number \| null	Максимальный объём в м³.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`warehouseType`	—	number	Фильтр по типу отгрузки.
`page`	—	number	Номер страницы.
`perPage`	—	number	Кол-во результатов на страницу.

Имя параметра	Обязательный	Тип данных и возможные значения	Описание
`id`	—	string	ID заказа в SafeRoute.
`trackNumber`	—	string	Трек-номер в службе доставки.
`cmsId`	—	string	Номер заказа на сайте интернет-магазина.

Параметр	Тип	Описание
`id`	number	ID компании.
`name`	string	Название компании.
Следующие параметры присутствуют только в подвозе в службы доставки и в компаниях для настройки исключений:
`directPickupAvailable`	boolean	Доступен ли прямой забор.
`directTransportAvailable`	boolean	Доступен ли прямой подвоз.
`directTransportPoints`	array	Точки прямого подвоза. Массив объектов с полями: `id` – ID точки; `address` – адрес точки; `type` – тип точки (`'warehouse'` – склад, `'pickup-point'` – ПВЗ); `latitude` – широта; `longitude` – долгота; `photos` – массив URL фотографий точки; `description` – описание как пройти к точке; `schedule` – график работы, массив из 7 значений (пн-вс). `null` в массиве означает нерабочий день, для рабочего дня время задаётся объектом с полями `from` и `to`.

Параметр	Тип	Описание
`id`	number	ID склада.
`address`	string	Адрес.
`type`	string	Тип. `'warehouse'` – склад; `'pickup-point'` – ПВЗ.
`latitude`	number	Широта.
`longitude`	number	Долгота.
`photos`	array \| null	Массив URL фотографий точки.
`description`	array \| null	Описание как пройти к точке.
`schedule`	array	График работы, массив из 7 значений (пн-вс). `null` в массиве означает нерабочий день, для рабочего дня время задаётся объектом с полями `from` и `to`.
`sortingPrice`	number	Стоимость сортировки в рублях.

¶ Авторизация, профиль и настройки.

¶ Авторизация по E-mail и паролю с получением токена, данных профиля и настроек аккаунта.

¶ Получение данных и настроек пользователя по токену.

¶ Работа с калькулятором доставки.

¶ Описание моделей данных.

¶ Модель компании доставки DeliveryCompany.

¶ Модель точки самовывоза PickupPoint.

¶ Модель дополнительной услуги DeliveryService.

¶ Расчёт стоимости доставки.

¶ Расчёт стоимости доставки для отдельной транспортной компании.

¶ Получение списка ID транспортных компаний, доставка которыми доступна в выбранный населённый пункт.

¶ Работа с заказами.

¶ Описание моделей данных.

¶ Описание модели Order.

¶ Описание модели OrderDeliveryPickupPoint.

¶ Получение списка заказов.

¶ Получение отдельного заказа.

¶ Создание заказа.

¶ Редактирование заказа.

¶ Частичное редактирование заказа.

¶ Подтверждение заказов.

¶ Отмена заказов.

¶ Дублирование заказов.

¶ Дублирование заказа для возврата.

¶ Возврат заказов.

¶ Продление хранения на ПВЗ.

¶ Комплектация заказов.

¶ Раскомплектация заказов.

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

¶ Работа с заборами.

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

¶ Создание забора.

¶ Отмена забора.

¶ Получение списка компаний забора.

¶ Товары.

¶ Описание модели Product.

¶ Получение списка товаров.

¶ Получение отдельного товара.

¶ Создание нового товара.

¶ Редактирование товара.

¶ Частичное редактирование товара.

¶ Удаление товара.

¶ Импорт товаров.

¶ Комплекты товаров.

¶ Описание модели Kit.

¶ Получение списка комплектов.

¶ Получение отдельного комплекта.

¶ Создание нового комплекта.

¶ Редактирование комплекта.

¶ Удаление комплекта.

¶ Коробки.

¶ Описание модели Box.

¶ Получение списка коробок.

¶ Получение отдельной коробки.

¶ Создание новой коробки.

¶ Редактирование коробки.

¶ Частичное редактирование коробки.

¶ Удаление коробки.

¶ Магазины.

¶ Описание модели Shop.

¶ Получение списка магазинов.

¶ Получение отдельного магазина.

¶ Создание нового магазина.

¶ Редактирование магазина.

¶ Удаление магазина.

¶ Склады.

¶ Описание модели Warehouse.

¶ Получение списка складов.

¶ Получение отдельного склада.

¶ Создание нового склада.

¶ Редактирование склада.

¶ Документы.

¶ Список актов приёма товаров.

¶ Формирование акта приёма товаров.

¶ Список актов передачи заказов.

¶ Создание актов передачи заказов.

¶ Генерация сборочной ведомости.

¶ Формирование отчёта по движению товаров.

¶ Список стикеров.

¶ Формирование стикеров.

¶ Модель компании доставки `DeliveryCompany`.

¶ Модель точки самовывоза `PickupPoint`.

¶ Модель дополнительной услуги `DeliveryService`.

¶ Описание модели `Order`.

¶ Описание модели `OrderDeliveryPickupPoint`.

¶ Описание модели `Product`.

¶ Описание модели `Kit`.

¶ Описание модели `Box`.

¶ Описание модели `Shop`.

¶ Описание модели `Warehouse`.

¶ Модель компании забора `PickupCompany`.

¶ Модель склада единого забора `MergedWarehouse`.