Все API принимают и возвращают данные в формате JSON.
YYYY-MM-DD
(только дата), YYYY-MM-DDThh:mm:ss±hh
(дата и время);Авторизация происходит посредством заголовка Authorization: Bearer {TOKEN}
, где {TOKEN}
– токен аккаунта, который можно получить в Личном кабинете или через API по E-mail и паролю.
В случае успеха возвращается ответ со статусом 200, 201 или 204. Если в запросе отсутствует заголовок авторизации или в заголовке передан некорректный токен, будет возвращёт ответ со статусом 401. Если переданы некорректные параметры, либо возникла ошибка иного рода, из-за которой невозможно обработать запрос, API вернёт ответ с 400 статусом и кодом ошибки.
Для постраничной навигации в API списков используются параметры page
и perPage
. По умолчанию выводится 20 результатов на страницу, максимально допустимое количество результатов на страницу – 1 000. Для получения полного списка результатов (но не больше максимально допустимого числа), без постраничной навигации, передавайте perPage
со значением 0
.
Заголовки ответа для постраничной навигации:
X-Pagination-Current-Page
– номер текущей запрошенной страницы;X-Pagination-Page-Count
– общее количество страниц в списке;X-Pagination-Per-Page
– количество выводимых результатов на страницу;X-Pagination-Total-Count
– общее количество результатов в списке.Ссылка на Swagger.
Расшифровка кодов ошибок.
POST https://api.saferoute.ru/v2/auth/login
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
email |
Да | string | E-mail. |
password |
Да | string | Пароль. |
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
id |
number | ID пользователя в системе. |
token |
string | Токен пользователя для авторизации в API. |
role |
string |
Роль пользователя. Существует 4 типа ролей:
|
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 всех складов аккаунта. |
Если передан неправильный E-mail или пароль, будет возвращён 401 статус.
POST https://api.saferoute.ru/v2/auth/get-user
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
token |
Да | string | Токен аккаунта. |
Ответ полностью идентичен ответу предыдущего API.
Особенности работы калькулятора доставки.
При запросах в калькулятор в ответе будет содержаться заголовок с именем x-log-id
– ID лога, который потребуется сообщить в техподдержку при возникновении проблем.
DeliveryCompany
.Параметр | Тип | Описание |
---|---|---|
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 услуг. |
priceDelivery |
number | Чистая стоимость доставки. |
totalPrice |
number | Итоговая стоимость доставки, включающая в себя стоимость доп. услуг и комиссии. |
priceCommissionDeclared |
number | Стоимость страховки в рублях. |
percentCommissionDeclared |
number | Процентная ставка страховки. |
priceCommissionCod |
number | Комиссия наложенного платежа наличными в рублях. |
percentCommissionCod |
number | Процентная ставка наложенного платежа наличными. |
priceCommissionCodCard |
number | Комиссия наложенного платежа картой в рублях. |
percentCommissionCodCard |
number | Процентная ставка наложенного платежа картой. |
priceCommissionAcquiring |
number | Комиссия за эквайринг в рублях. |
percentCommissionAcquiring |
number | Процентная ставка за эквайринг. |
isPost |
boolean | Является ли данная доставка доставкой почтой. |
specificity |
array | Особенности службы доставки. |
Только для доставки Почтой России и компаний курьерской доставки: | ||
cashPaymentAvailable |
boolean | Доступна ли оплата наличными при получении. |
cardPaymentAvailable |
boolean | Доступна ли оплата картой при получении. |
Только для компаний курьерской доставки: | ||
isExpress |
boolean | Является ли данная доставка экспресс-доставкой. |
Только для компаний, доставляющих в пункт выдачи: | ||
points |
array | Массив точек самовывоза. |
PickupPoint
.Параметр | Тип | Описание |
---|---|---|
id |
number | ID точки самовывоза. |
name |
string | Название. |
longitude |
string | Долгота. |
latitude |
string | Широта. |
type |
number | Тип ПВЗ. |
description |
string | null | Описание как пройти к ПВЗ. |
address |
string | Адрес. |
schedule |
array | null |
График работы. Массив из 7 значений (пн-вс). |
metro |
array | null |
Ближайшие станции метро (до 3-х). Выводятся в виде объектов с полями:
|
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 | Комиссия наложенного платежа наличными в рублях. |
totalPrice |
number | Итоговая стоимость доставки, включающая в себя стоимость доп. услуг и комиссии. |
isFar |
boolean |
Содержит Такие ПВЗ выводятся, если в запрашиваемом населённом пункте нет ПВЗ. |
zipCode |
string | null | Почтовый индекс. |
DeliveryService
.Параметр | Тип | Описание |
---|---|---|
id |
number | ID услуги. |
name |
string | Название услуги. |
price |
number | Стоимость услуги в рублях. |
checked |
boolean |
Является ли данная услуга “выбранной” по умолчанию. Стоимость услуг, у которых этот параметр равен Стоимость услуг со значением |
required |
boolean |
Является ли данная услуга обязательной. Стоимость обязательных услуг содержится в общей сумме |
POST https://api.saferoute.ru/v2/calculator
Требуется авторизация
Заголовки запроса.
Имя заголовка | Обязательный | Описание |
---|---|---|
Shop-Id |
Нет |
ID магазина. Если не передан, в запросе требуется задать адрес отправителя в параметре |
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
reception.countryCode |
— | string |
Код страны получателя. По умолчанию |
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 |
Код страны получателя. По умолчанию |
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 |
— | number1 , 4 |
Требуется передавать только если не был задан магазин через заголовок |
products |
— | array |
Товары заказа. Передаются в виде объектов со следующими полями (все параметры передаются за единицу товара):
|
kits |
— | array |
Комплекты товаров заказа. Передаются в виде объектов со следующими полями:
|
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 дополнительных услуг, которые необходимо вывести в данные транспортных компаний (свойство Стоимость этих услуг не будет добавлена в общую стоимость доставки |
servicesRequired |
— | array |
Обязательные дополнительные услуги. Компании, не поддерживающие эти услуги, не будут включены в список результатов. Стоимость этих услуг добавляется в общую стоимость доставки |
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 |
Использовать ли габариты из настроек виджетов в качестве габаритов по умолчанию. По умолчанию При использовании |
timeout |
— | number | Время ожидания ответа от серверов транспортных компаний (в миллисекундах). Компании, данные от которых не были получены за указанное время, не попадут в выдачу. По умолчанию 20 000 мс. |
Габариты по местам: | |||
places |
— | array |
Места. Передаются в виде объектов со следующими полями:
|
Общие габариты: | |||
weight |
— | number | Общий вес заказа в кг. |
dimensions.width |
— | number | Общая ширина заказа в см. |
dimensions.height |
— | number | Общая высота заказа в см. |
dimensions.length |
— | number | Общая длина заказа в см. |
itemCount |
— | number | Общее количество мест. По умолчанию 1. |
volume |
— | number | Общий объём в м3. |
Пример ответа.
{
"1": [...], // Массив моделей DeliveryCompany (доставка в пункты выдачи)
"2": [...], // Массив моделей DeliveryCompany (доставка курьером)
"3": [...] // Массив моделей DeliveryCompany (доставка Почтой России)
}
В случае полного отсутствия вариантов доставки API вернёт 3 пустых массива.
POST https://api.saferoute.ru/v2/calculator/one
Требуется авторизация
Заголовки запроса.
Имя заголовка | Обязательный | Описание |
---|---|---|
Shop-Id |
Да | ID магазина. |
Type |
Да | Тип доставки. |
Company-Id |
Да | ID компании, доставку которой нужно посчитать. |
Параметры запроса идентичны параметрам предыдущего запроса для расчёта стоимости доставки, за исключением параметров type
и companyIds
– эти значения берутся из заголовков Type
и Company-Id
.
В ответ приходит отдельная модель DeliveryCompany
, либо пустой массив (если доставка невозможна).
POST https://api.saferoute.ru/v2/calculator/company
Требуется авторизация
Заголовки запроса.
Имя заголовка | Обязательный | Описание |
---|---|---|
Shop-Id |
Да | ID магазина. |
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
type | — | number | Тип доставки. Если передан, будут получены только доставки указанного типа. |
reception.cityFias | — | string | ФИАС населённого пункта. |
reception.zipCode | — | string | Почтовый индекс населённого пункта. |
reception.cityName | — | string | Название населённого пункта. |
reception.countryCode | — | string | Код страны. |
reception.addressString | — | string | Адрес доставки одной строкой (страна, тип и название населённого пункта). |
applyWidgetSettings | — | boolean | Если передано true , при определении списка доступных компаний будут применяться настройки и правила виджетов. |
Пример ответа (ключи соответствуют типам доставок).
{
"1": [4, 15, 36], // ID компаний с доставкой в пункты выдачи
"2": [7, 10, 22, 54], // ID компаний с курьерской доставкой
"3": [] // ID компаний доставки Почтой России (пустой массив - отсутствие вариантов)
}
ID собственных способов доставки имеют формат не чисел, а строк вида '{ID аккаунта}_{ID способа}'
.
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 | Оценочная стоимость заказа. Применяется, если нет потоварной. |
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.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 |
Массив дополнительных услуг. Содержит объекты с полями:
При создании/редактировании заказа необходимо передавать массив вида |
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-запросов. |
isFar |
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 |
Только заказы, наложенный платёж за которые получен (для доставленных). |
search |
— | string |
Поиск по параметрам заказа:
|
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.fullName
recipient.phone
recipient.additionalPhone
recipient.email
recipient.legalEntity.name
recipient.legalEntity.TIN
cmsId
comment
commentForAssembly
documentsForWarehouse
POST https://api.saferoute.ru/v2/orders/confirm
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
ids |
Да | array |
Массив ID заказов, которые необходимо подтвердить. В случае, если хотя бы один из заказов не удалось подтвердить, будет возвращена ошибка. |
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 лишь отправляет заявку на возврат, даже в случае получения 204 ответа от сервера возврат заказа не гарантирован.
POST https://api.saferoute.ru/v2/orders/extend-hold
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
ids |
Да | array | Массив ID заказов, для которых необходимо продлить хранение. |
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 |
Массив точек для отгрузки заказа (только при
|
GET https://api.saferoute.ru/v2/pickups
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
archive |
— | number0 , 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 | Название транспортной компании. |
POST https://api.saferoute.ru/v2/pickups
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
warehouseId |
Да | number | ID склада отгрузки. |
companyId |
Да | number | ID компании забора (получение компаний забора). |
type |
Да | number3 , 4 |
Тип забора: единый забор или прямая отгрузка. |
date |
Да | string | Дата отгрузки. |
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
id |
number | ID созданного забора. |
Нельзя создать несколько одинаковых заборов на один и тот же день.
POST https://api.saferoute.ru/v2/pickups/cancel
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
id |
Да | number | ID забора. |
GET https://api.saferoute.ru/v2/pickups/companies
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
warehouseId |
Да | number | ID склада отгрузки. |
type |
Да | number3 , 4 |
Тип забора: единый забор или прямая отгрузка. |
Данные ответа (массив).
Параметр | Тип | Описание |
---|---|---|
id |
number | ID компании в системе. |
name |
string | Название. |
price |
number | Стоимость забора. |
countFree |
number | Минимальное число заказов для бесплатного забора. |
GET
, POST
, PUT
и PATCH
-запросы работают с моделью Product
.
Product
.Параметр | Тип | Описание |
---|---|---|
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 | Объём в м3. |
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 |
Флаг “Требуется код маркировки“. Используется, если товар подлежит обязательной маркировке “Честный знак”. Только для магазинов на фулфилменте. |
GET https://api.saferoute.ru/v2/products
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
name |
— | string | Фильтр по названию по неполному совпадению. |
vendorCode |
— | string | Фильтр по артикулу по неполному совпадению. |
shopId |
— | number | Фильтр по ID магазина. |
tnved |
— | string | Фильтр по ТН ВЭД по неполному совпадению. |
ids |
— | array | Фильтр по массиву ID товаров. |
vendorCodes |
— | array | Фильтр по массиву артикулов (полное совпадение). |
barcode |
— | string | Фильтр по штрих-коду по неполному совпадению. |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
Данные ответа: массив моделей Product
.
GET https://api.saferoute.ru/v2/products/{id}
Требуется авторизация
Данные ответа: отдельная модель Product
.
POST https://api.saferoute.ru/v2/products
Требуется авторизация
Параметры запроса: модель Product
.
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
id |
number | ID созданного товара. |
PUT https://api.saferoute.ru/v2/products/{id}
Требуется авторизация
Параметры запроса: модель Product
.
PATCH https://api.saferoute.ru/v2/products/{id}
Требуется авторизация
Параметры запроса: часть модели Product
, которую требуется изменить.
DELETE https://api.saferoute.ru/v2/products/{id}
Требуется авторизация
POST https://api.saferoute.ru/v2/products/import
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
file |
Да | string |
base64-представление xlsx-файла со списком товаров. Образец файла. В 1 файле допускается до 2 000 наименований товаров, при превышении этого количества API вернёт ошибку. При совпадении артикулов импортируемых товаров с артикулами товаров, уже имеющихся в Личном кабинете, товары в Личном кабинете перезаписываются. |
shopId |
Да | number | ID магазина, для которого будут импортированы товары. |
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
success |
number | Количество успешно импортированных товаров. |
total |
number | Общее количество товаров в файле. |
errors |
object |
Ошибки импорта. Объект, в котором ключами выступают номера строк xlsx-файла, в которых содержатся ошибки. Значения – вложенные объекты с 2 полями:
|
GET
, POST
и PUT
-запросы работают с моделью Kit
.
Kit
.Параметр | Тип | Описание |
---|---|---|
id |
number | ID. Только для GET-запросов. |
name |
string | Название комплекта. Обязательный параметр. |
vendorCode |
string | Артикул комплекта (должен быть уникальным в рамках одного магазина). Обязательный параметр. |
shop |
object |
Магазин комплекта. GET-запросы будут возвращать полную модель |
discount |
number | Процент скидки по умолчанию. |
products |
array |
Товары комплекта. В комплект могут быть добавлены только товары магазина, переданного в параметре GET-запросы будут возвращать массив полных моделей
|
GET https://api.saferoute.ru/v2/kits
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
name |
— | string | Фильтр по названию комплекта по неполному совпадению. |
vendorCode |
— | string | Фильтр по артикулу комплекта по неполному совпадению. |
shopId |
— | number | Фильтр по магазину. |
search |
— | string | Поиск по названию и артикулу одновременно. |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
Данные ответа: массив моделей Kit
.
GET https://api.saferoute.ru/v2/kits/{id}
Требуется авторизация
Данные ответа: отдельная модель Kit
.
POST https://api.saferoute.ru/v2/kits
Требуется авторизация
Параметры запроса: модель Kit
.
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
id |
number | ID созданного комплекта. |
PUT https://api.saferoute.ru/v2/kits/{id}
Требуется авторизация
Параметры запроса: модель Kit
.
DELETE https://api.saferoute.ru/v2/kits/{id}
Требуется авторизация
GET
, POST
, PUT
и PATCH
-запросы работают с моделью Box
.
Box
.Параметр | Тип | Описание |
---|---|---|
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 грамм). |
GET https://api.saferoute.ru/v2/boxes
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
name | — | string | Фильтр по названию коробки по неполному совпадению. |
width | — | number | Фильтр по ширине. |
height | — | number | Фильтр по высоте. |
length | — | number | Фильтр по длине. |
weight | — | Фильтр по весу. | |
page | — | number | Номер страницы. |
perPage | — | numbernumber | Кол-во результатов на страницу. |
Данные ответа: массив моделей Box
.
GET https://api.saferoute.ru/v2/boxes/{id}
Требуется авторизация
Данные ответа: отдельная модель Box
.
POST https://api.saferoute.ru/v2/boxes
Требуется авторизация
Параметры запроса: модель Box
.
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
id |
number | ID созданной коробки. |
PUT https://api.saferoute.ru/v2/boxes/{id}
Требуется авторизация
Параметры запроса: модель Box
.
PATCH https://api.saferoute.ru/v2/boxes/{id}
Требуется авторизация
Параметры запроса: часть модели Box
, которую требуется изменить.
DELETE https://api.saferoute.ru/v2/boxes/{id}
Требуется авторизация
GET
, POST
и PUT
-запросы работают с единой моделью Shop
.
Shop
.Параметр | Тип | Описание |
---|---|---|
id |
number | ID. Только для GET-запросов. |
apiKey |
string | API-ключ для интеграций. Только для GET-запросов. |
name |
string | Название. Обязательный параметр. |
cmsProductsAutocomplete |
boolean | Флаг “На странице заказа брать товары из CMS”. |
emailNotifications |
boolean | Флаг “E-mail оповещение клиентов”. |
cdekCalling |
boolean | Флаг “Прозвон заказов CDEK”. |
disableQuantityControlInCheckout |
boolean | Флаг “Отключить контроль остатков в чекауте“. Играет роль только если платформой магазина является чекаут SafeRoute. |
brand |
string | Название бренда. Обязательный параметр. |
platform |
string | null |
|
warehouse |
object |
Склад отгрузки. Обязательный параметр. GET-запросы будут возвращать полную модель |
GET https://api.saferoute.ru/v2/shops
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
name |
— | string | Фильтр по названию по неполному совпадению. |
brand |
— | string | Фильтр по бренду по неполному совпадению. |
warehouseId |
— | number | Фильтр по складу. |
onlyFulfilment |
— | number0 , 1 |
Выводить только магазины с фулфилмент-складом. |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
Данные ответа: массив моделей Shop
.
GET https://api.saferoute.ru/v2/shops/{id}
Требуется авторизация
Данные ответа: отдельная модель Shop
.
POST https://api.saferoute.ru/v2/shops
Требуется авторизация
Параметры запроса: модель Shop
.
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
id |
number | ID созданного магазина. |
PUT https://api.saferoute.ru/v2/shops/{id}
Требуется авторизация
Параметры запроса: модель Shop
.
DELETE https://api.saferoute.ru/v2/shops/{id}
Требуется авторизация
GET
, POST
и PUT
-запросы работают с моделью Warehouse
.
Warehouse
.Параметр | Тип | Описание |
---|---|---|
id |
number | ID. Только для GET-запросов. |
name |
string | Название. Обязательный параметр. |
type |
number |
Тип склада. Обязательный параметр. Склады с типом “Фулфилмент” после создания нельзя отредактировать. ID привязанного фулфилмент-склада передаётся в параметре |
fulfilmentWarehouseId |
number | null |
ID склада фулфилмента. Только для складов, у которых в Чтобы получить список доступных фулфилмент-складов, воспользуйтесь параметром |
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 значений (пн-вс). |
markCompletedOrders |
boolean | Флаг “Отмечать скомплектованные заказы”. |
GET https://api.saferoute.ru/v2/warehouses
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
name |
— | string | Фильтр по названию по неполному совпадению. |
hold |
— | number0 , 1 |
Вывести доступные склады фулфилмент. ID полученных складов можно передавать в |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
Данные ответа: массив моделей Warehouse
.
GET https://api.saferoute.ru/v2/warehouses/{id}
Требуется авторизация
Данные ответа: отдельная модель Warehouse
.
POST https://api.saferoute.ru/v2/warehouses
Требуется авторизация
Параметры запроса: модель Warehouse
.
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
id |
number | ID созданного склада. |
PUT https://api.saferoute.ru/v2/warehouses/{id}
Требуется авторизация
Параметры запроса: модель Warehouse
.
Удаление склада.
DELETE https://api.saferoute.ru/v2/warehouses/{id}
Требуется авторизация
GET https://api.saferoute.ru/v2/products/waybills
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
shopId |
— | number | Фильтр по магазину. |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
Данные ответа (массив).
Параметр | Тип | Описание |
---|---|---|
id |
number | ID акта. |
date |
string | Дата поставки. |
type |
string | Тип поставки. |
shop |
object | Магазин. |
countOrders |
number | Число заказов. |
countPlaces |
number | Число мест. |
file |
string | URL файла акта (PDF-файл). |
POST https://api.saferoute.ru/v2/products/waybills
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
date |
Да | string | Дата. |
shopId |
Да | number | ID магазина. |
places |
Да | number | Количество мест. |
type |
Да | string | Тип поставки. |
products |
Да | array |
Массив товаров. Каждый товар передаётся в виде объекта с полями:
|
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
file |
string | URL сформированного акта (PDF-файл). |
GET https://api.saferoute.ru/v2/orders/waybills
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
warehouseId |
— | number | Фильтр по складу. |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
Данные ответа (массив).
Параметр | Тип | Описание |
---|---|---|
id |
number | ID акта. |
date |
string | Дата. |
company |
string | Компания забора. |
countOrders |
number | Число заказов. |
file |
string | URL файла акта (PDF-файл). |
warehouse |
object | Склад отгрузки. |
POST https://api.saferoute.ru/v2/orders/waybills
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
date |
Да | string | Дата отгрузки. |
ids |
Да | array | ID заказов. |
Пример ответа.
{
// Успешно сформированные акты
"success": [{
"file": "https://file.saferoute.ru/download/1592527?key=c17189b41d1202b6509175b46971b78f",
"orderIds": [10218257]
}],
// Заказы, с которыми возникли проблемы
"error": [{
"orderId": 10218256,
"message": "Заказ должен быть в статусе «Подготовленный»"
}]
}
POST https://api.saferoute.ru/v2/orders/act-assembly
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
ids |
Да | array | ID заказов. |
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
file |
string | Ссылка на PDF с ведомостью. |
POST https://api.saferoute.ru/v2/products/movement-report
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
date.from |
Да | string | Интервал движения ОТ. |
date.to |
Да | string | Интервал движения ДО. |
ids |
Да | array | ID товаров. |
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
file |
string |
Ссылка на файл. Если отчёт один, ссылка будет на отдельный xlsx-файл. Если отчётов несколько, ссылка будет вести на архив, содержащий xlsx-файлы. |
GET https://api.saferoute.ru/v2/orders/stickers
Требуется авторизация
Данные ответа (массив).
Параметр | Тип | Описание |
---|---|---|
date |
string | Дата и время формирования набора стикеров. |
deliveryCompanySticker |
string | null | URL стикера службы доставки. |
postSticker |
string | null | URL почтового стикера. |
stickers |
array |
Массив стикеров разного размера, от одного до нескольких на одном листе А4. Содержит объекты с полями |
Данное API выводит только стикеры, сформированные в текущий день.
POST https://api.saferoute.ru/v2/orders/stickers
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
ids |
Да | array | ID заказов. |
type |
— | number | Размер/формат стикеров, которые требуется сгенерировать. Если значение не передано, сгенерируются стикеры всех форматов. |
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
file |
string | Ссылка на PDF со стикерами определённого формата или на архив со стикерами всех форматов (если не был передан type ). |
GET https://api.saferoute.ru/v2/reports/bill
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
from |
— | string | Интервал ОТ. |
to |
— | string | Интервал ДО. |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
Данные ответа (массив).
Параметр | Тип | Описание |
---|---|---|
id |
number | ID счёта. |
date |
string | Дата выставления счёта. |
sum |
number | Сумма счёта. |
payStatus |
number | Статус. |
paySum |
number | Сумма, которая была оплачена. |
file |
string | Ссылка на файл со счётом на оплату. |
GET https://api.saferoute.ru/v2/reports/agent
Требуется авторизация
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
from |
— | string | Интервал ОТ. |
to |
— | string | Интервал ДО. |
type |
— | number | Тип отчёта. |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
Данные ответа (массив).
Параметр | Тип | Описание |
---|---|---|
id |
number | ID отчёта. |
date |
string | Дата. |
type |
number | Тип отчёта. |
sum |
number | Сумма. |
file |
string | Ссылка на файл с отчётом. |
GET https://api.saferoute.ru/v2/reports/analytical
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
from |
— | string | Интервал ОТ. |
to |
— | string | Интервал ДО. |
type |
— | number | Тип отчёта. |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
Данные ответа (массив).
Параметр | Тип | Описание |
---|---|---|
id |
number | ID отчёта. |
date |
string | Дата. |
type |
number | Тип отчёта. |
file |
string | Ссылка на файл с отчётом. |
POST https://api.saferoute.ru/v2/reports/analytical
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
date.from |
Да | string | Интервал генерации ОТ. |
date.to |
Да | string | Интервал генерации ДО. |
type |
Да | number | Тип отчёта. |
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
file |
string | Ссылка на файл с отчётом. |
GET https://api.saferoute.ru/v2/lists/services
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
shopId |
Нет | number |
ID магазина. Нужен для получения списка услуг фулфилмента (если магазин привязан к фулфилмент-складу). |
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
delivery |
array | Список услуг по доставке (ID услуг и их названия). |
packing |
array | Список услуг по упаковке (ID услуг и их названия). |
GET https://api.saferoute.ru/v2/couriers/schedule
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
cityFias |
Да | string | ФИАС города доставки. |
companyId |
Да | number | ID компании доставки. |
date |
Да | string | Дата. |
Данные ответа (массив).
Параметр | Тип | Описание |
---|---|---|
id |
number | ID интервала. |
timeFrom |
string | Интервал доставки ОТ. |
timeTo |
string | Интервал доставки ДО. |
isDefault |
boolean | Интервал со значением true устанавливается в заказе по умолчанию, если при сохранении заказа в параметр clientCourierTime не был передан ID интервала. |
GET https://api.saferoute.ru/v2/lists/delivery-companies
Требуется авторизация
Данные ответа (массив).
Параметр | Тип | Описание |
---|---|---|
id |
number | ID компании в системе. |
name |
string | Название компании. |
logo |
string | Логотип компании. |
GET https://api.saferoute.ru/v2/lists/points
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
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 значений (пн-вс). |
district |
string | null | Район города. |
metro |
array | null |
Ближайшие станции метро (до 3-х). Выводятся в виде объектов с полями:
|
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 | Максимальный объём в м3. |
GET https://api.saferoute.ru/v2/lists/marketplaces
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
warehouseType |
— | number | Фильтр по типу отгрузки. |
page |
— | number | Номер страницы. |
perPage |
— | number | Кол-во результатов на страницу. |
Данные ответа (массив).
Параметр | Тип | Описание |
---|---|---|
id |
number | ID маркетплейса. |
name |
string | Название маркетплейса. |
warehouses |
array |
Склады маркетплейса. Массив объектов с полями:
|
legalEntity.name |
string | Название юр. лица. |
legalEntity.TIN |
string | ИНН. |
GET https://api.saferoute.ru/v2/lists/order-statuses
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
lang |
— | string'ru' , 'en' |
Язык описаний статусов. По умолчанию – русский. |
Пример ответа.
{
"1": "Unknown status",
"10": "Canceled by sender",
"11": "Draft",
"12": "Confirmed",
...
"462": "Refusal upon delivery"
}
Ключами выступают ID статусов в системе.
GET https://api.saferoute.ru/v2/tracking
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
id |
— | string | ID заказа в SafeRoute. |
trackNumber |
— | string | Трек-номер в службе доставки. |
cmsId |
— | string | Номер заказа на сайте интернет-магазина. |
Передайте один из описанных выше параметров в зависимости от того, по какому номеру или ID необходимо произвести трекинг.
Данные ответа.
Параметр | Тип | Описание |
---|---|---|
id |
number | ID заказа в SafeRoute. |
cmsId |
string | null | ID заказа в CMS (на сайте интернет-магазина). |
brand |
string | Бренд интернет-магазина. |
statusHistory |
array |
История статусов от последнего к самому первому. Массив объектов с полями:
|
trackNumber |
string | null | Трек-номер в службе доставки. |
trackingUrl |
string | null | URL для трекинга в службе доставки. |
isPost |
boolean | Является ли доставка доставкой почтой. |
withCod |
boolean | Наличие наложенного платежа. |
delivery.type |
number | Тип доставки. |
delivery.totalPrice |
number | Итоговая стоимость доставки. |
delivery.company |
string | Название службы доставки. |
delivery.holdDays |
string | null | Срок хранения в пункте выдачи в днях. |
delivery.logo |
string | Логотип службы доставки в base64. |
delivery.date.from |
string | Минимальная дата доставки. |
delivery.date.to |
string | Максимальная дата доставки. |
address |
string | null | Адрес курьерской доставки одной строкой. |
cityPhoto |
string | null | URL фото города доставки. |
Только для заказов с доставкой в пункт выдачи: | ||
point.id |
number | ID ПВЗ. |
point.name |
string | Название ПВЗ. |
point.longitude |
number | Долгота. |
point.latitude |
number | Широта. |
point.type |
number | Тип ПВЗ. |
point.description |
string | null | Описание как пройти к ПВЗ. |
point.photos |
array | Массив URL фотографий ПВЗ. |
point.address |
string | Адрес ПВЗ. |
point.schedule |
array | null |
График работы. Массив из 7 значений (пн-вс). |
point.district |
string | null | Район города. |
point.metro |
array |
Ближайшие станции метро (до 3-х). Выводятся в виде объектов с полями:
|
point.cashPaymentAvailable |
boolean | Возможна ли оплата наличными при получении. |
point.cardPaymentAvailable |
boolean | Возможна ли оплата картой при получении. |
point.fittingAvailable |
boolean | Доступна ли услуга “Примерка”. |
point.checkupAvailable |
boolean | Доступна ли услуга “Осмотр вложения”. |
point.partialBuyoutAvailable |
boolean | Доступна ли услуга “Частичная выдача”. |
pointisDropOff |
boolean | Подвоз на ПВЗ. |
GET https://api.saferoute.ru/v2/warehouses/shipment
Требуется авторизация
Параметры запроса.
Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
---|---|---|---|
countryCode |
Да | string |
Код страны склада. Если передан только код страны, без |
region |
— | string |
Регион. Обязателен, если склад находится в России. Если регион передан без |
fias |
— | string |
ФИАС города, где расположен склад. Если передан, ПВЗ и склады будут выведены только в заданном городе. |
Данные ответа.
{
// Подвоз в службы доставки
"1": [
"available": true, // Доступен ли данный тип забора
"companies": [...] // Массив компаний забора (модель PickupCompany)
],
// Подвоз на склад Единого забора
"2": [
"available": true, // Доступен ли данный тип забора
"mergedWarehouses": [...] // Массив складов единого забора (модель MergedWarehouse)
],
// Единый забор
"3": [
"available": true, // Доступен ли данный тип забора
"companies": [...], // Массив компаний забора (модель PickupCompany)
"minPrice": 100, // Минимальная стоимость единого забора в рублях
"countForFree": 10 // Количество заказов для бесплатного забора
],
// Прямая отгрузка в службы доставки
"4": [
"available": true, // Доступен ли данный тип забора
"companies": [...], // Массив компаний забора (модель PickupCompany)
],
// Компании для настройки исключений
"companiesForExceptions": [...] // Массив моделей PickupCompany
}
PickupCompany
.Параметр | Тип | Описание |
---|---|---|
id |
number | ID компании. |
name |
string | Название компании. |
Следующие параметры присутствуют только в подвозе в службы доставки и в компаниях для настройки исключений: | ||
directPickupAvailable |
boolean | Доступен ли прямой забор. |
directTransportAvailable |
boolean | Доступен ли прямой подвоз. |
directTransportPoints |
array |
Точки прямого подвоза. Массив объектов с полями:
|
MergedWarehouse
.Параметр | Тип | Описание |
---|---|---|
id |
number | ID склада. |
address |
string | Адрес. |
type |
string |
Тип.
|
latitude |
number | Широта. |
longitude |
number | Долгота. |
photos |
array | null | Массив URL фотографий точки. |
description |
array | null | Описание как пройти к точке. |
schedule |
array | График работы, массив из 7 значений (пн-вс). null в массиве означает нерабочий день, для рабочего дня время задаётся объектом с полями from и to . |
sortingPrice |
number | Стоимость сортировки в рублях. |