GET , POST , PUT и PATCH -запросы работают с моделью Order.
Order.| Параметр | Тип | Описание |
|---|---|---|
id |
number | ID. Только для GET-запросов. |
statusHistory |
array |
История статусов заказа от последнего к самому первому. Только для GET-запросов. Массив объектов с полями:
|
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 магазина. Если не передан, в заказе должен присутствовать адрес отправки в параметре Если же магазин был передан, значения в этих полях учитываться не будут и будут взяты из склада заданного магазина. |
products |
array |
Товары заказа. Массив объектов с полями:
Ширина, длина и высота товаров могут передаваться при создании заказа вместо общих габаритов заказа ( |
priceDeclared |
number | null | Оценочная стоимость заказа. Применяется, если нет потоварной. |
deliveryCostThresholds.deliveryCost |
number | null | Стоимость доставки с клиента при выкупе товара на сумму ниже пороговой. Только для GET-запросов. |
deliveryCostThresholds.threshold |
number | null | Пороговая сумма выкупа, ниже которой будет изменена стоимость доставки. Только для GET-запросов. |
reservationStatus.key |
number | Код статуса резервирования заказа. Только для GET-запросов. |
reservationStatus.date |
string | null | Дата обновления статуса резервирования заказа. Только для GET-запросов. |
places |
array |
Габариты по местам. Массив объектов с полями:
|
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.factWeight |
number | null | Фактический вес заказа в кг с точностью до грамма. Появляется в момент тарификации стоимости доставки. Только для GET-запросов. |
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.shippingMode |
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 |
Массив дополнительных услуг. Содержит объекты с полями:
При создании/редактировании заказа необходимо передавать массив вида |
delivery.point |
object | 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 |
Массив задач по заказу. Содержит объекты с полями:
Только для GET-запросов. |
OrderDeliveryPickupPoint.| Параметр | Тип | Описание |
|---|---|---|
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 значений (пн-вс). |
zipCode |
string | null | Почтовый индекс. Только для GET-запросов. |
isPost |
boolean | Является ли пункт выдачи почтовым отделением. Только для GET-запросов. |
holdDays |
number | Количество дней, которое заказ будет храниться на ПВЗ. Только для GET-запросов. |
holdDate |
string | Дата, до которой заказ будет храниться на ПВЗ. Только для GET-запросов. |
storagingEnds |
boolean | Истекает срок хранения заказа на ПВЗ. Только для GET-запросов. |
GET https://api.saferoute.ru/v2/orders Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
list |
Да | number | Фильтр по состоянию заказов. |
deliveryType |
— | number | Фильтр по типу доставки. |
shopId |
— | number |
Фильтр по ID магазина. Передайте |
warehouseId |
— | number | Фильтр по ID склада. |
dateFrom |
— | string |
Фильтр по дате ОТ. Для разных списков (параметр
|
dateTo |
— | string | Фильтр по дате ДО. |
statuses |
— | array | Фильтр по коду статуса. |
deliveryCompanies |
— | array | Фильтр по ID компании доставки. |
paymentMethods |
— | array | Фильтр по способу оплаты. |
stickerFormed |
— | number0, 1 |
Только заказы со сформированными стикерами (для списка подготовленных заказов). |
wasInAct |
— | number0, 1 |
Только заказы, попадавшие в акт (для списка подготовленных заказов). |
packed |
— | number0, 1 |
Только скомплектованные заказы (для списка подготовленных заказов). |
storagingEnds |
— | number0, 1 |
Только заказы с истекающим сроком хранения (для заказов на ПВЗ). Выводит заказы, у которых остался день до окончания хранения. |
withCod |
— | number0, 1 |
Только заказы с наложенным платежом. |
codReceived |
— | number0, 1 |
Только заказы, наложенный платёж за которые получен (для доставленных). |
recipientCountry |
— | string | Фильтр по коду страны получателя. |
recipientCity |
— | string | Фильтр по населённому пункту получателя (по неполному совпадению). |
search |
— | string |
Поиск по параметрам заказа:
|
reservationStatus |
— | number | Фильтр по статусу резервирования заказа. |
autoReservation |
— | number0, 1 |
Только заказы с авторезервом (автоматически переведённые из статуса “Предзаказ” в статус “В резерве” после поступления товаров на склад). |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
Данные ответа: массив моделей Order.
GET https://api.saferoute.ru/v2/orders/{id} Требуется авторизация
Данные ответа: отдельная модель Order.
POST https://api.saferoute.ru/v2/orders Требуется авторизация
Параметры запроса: модель Order.
Данные ответа.
| Параметр | Тип | Описание |
|---|---|---|
id |
number | ID созданного заказа. |
PUT https://api.saferoute.ru/v2/orders/{id} Требуется авторизация
Параметры запроса: модель Order.
PATCH https://api.saferoute.ru/v2/orders/{id} Требуется авторизация
Частичное редактирование разрешено лишь для некоторых параметров заказа:
recipient.fullNamerecipient.phonerecipient.additionalPhonerecipient.emailrecipient.legalEntity.namerecipient.legalEntity.TINcmsIdcommentcommentForAssemblydocumentsForWarehousePOST https://api.saferoute.ru/v2/orders/confirm Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
ids |
Да | array |
Массив ID заказов, которые необходимо подтвердить. В случае, если хотя бы один из заказов не удалось подтвердить, будет возвращена ошибка. |
preOrder |
— | boolean |
Флаг предзаказа. Если передано Если не передано, или передано |
POST https://api.saferoute.ru/v2/orders/check-rests Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
ids |
Да | array |
Массив ID заказов, для которых необходимо проверить остатки. Проверка будет производиться только для заказов в статусе “Черновик”, остальные заказы будут пропущены. |
Пример ответа.
[
// ID заказа
"id": 1563214,
// Список недостающих товаров
"missingProducts": [{
"id": 121512,
"name": "Плюшевый медведь",
"vendorCode": "1000336401",
"restCount": 10, // Текущий остаток
"missingCount": 2 // Количество, недостающее для оформления
}]
]Ответ содержит только те заказы, для подтверждения которых недостаточно товара. В случае, если товара хватает для подтверждения всех заказов, будет возвращён пустой массив.
POST https://api.saferoute.ru/v2/orders/cancel Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
ids |
Да | array |
Массив ID заказов, которые необходимо отменить. В случае, если хотя бы один из заказов не удалось отменить, будет возвращена ошибка. |
POST https://api.saferoute.ru/v2/orders/duplicate Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
ids |
Да | array |
Массив ID заказов, которые необходимо продублировать. В случае, если хотя бы один из заказов не удалось продублировать, будет возвращена ошибка. |
Создаёт копию заказа для отправки его в обратную сторону (меняются местами адреса и отправитель с получателем).
POST https://api.saferoute.ru/v2/orders/duplicate-back Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
ids |
Да | array |
Массив ID заказов, которые необходимо продублировать для возврата. В случае, если хотя бы один из заказов не удалось продублировать, будет возвращена ошибка. |
POST https://api.saferoute.ru/v2/orders/return Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
ids |
Да | array |
Массив ID заказов, для которых необходимо оформить возврат. В случае, если хотя бы для одного из заказов не удалось оформить возврат, будет возвращена ошибка. |
API лишь создаёт заявку на возврат, отправка данного запроса не гарантирует возврат заказа.
POST https://api.saferoute.ru/v2/orders/extend-hold Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
ids |
Да | array | Массив ID заказов, для которых необходимо продлить хранение. |
days |
— | number | Срок продления в днях. |
API лишь создаёт заявку на продление хранения, отправка данного запроса не гарантирует продление хранения.
POST https://api.saferoute.ru/v2/orders/pack Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
ids |
Да | array | Массив ID заказов, которые требуется скомплектовать. |
POST https://api.saferoute.ru/v2/orders/unpack Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
ids |
Да | array | Массив ID заказов, которые требуется раскомплектовать. |
GET https://api.saferoute.ru/v2/orders/shipment Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
countryCode |
— | string |
Код страны забора. По умолчанию |
region |
Да | string | Название региона. |
fias |
— | string | ФИАС населённого пункта. |
companyId |
Да | number | ID службы доставки. |
pickupType |
Да | number1, 4 |
Тип забора. |
Данные ответа (массив).
| Параметр | Тип | Описание |
|---|---|---|
pickupDate.from |
string | Дата забора ОТ. |
pickupDate.to |
string | Дата забора ДО. |
pricePickup |
number | Стоимость забора. |
pickupPointRequired |
boolean | Требуется ли при создании заказа указание конкретной точки сдачи груза в службу доставки (только при pickupType со значением 1). |
points |
array |
Массив точек для отгрузки заказа (только при
|
PUT https://api.saferoute.ru/v2/orders/reservation/{id} Требуется авторизация
PUT https://api.saferoute.ru/v2/orders/reservation-cancel/{id} Требуется авторизация