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 | ФИАС населённого пункта. |
cityType |
Да | string | Тип населённого пункта ('г', 'д', 'пос' и т.п.) |
cityName |
Да | string | Название населённого пункта. |
cityArea |
Да | string | Название района в регионе населённого пункта. |
cityRegion |
Да | string | Название региона населённого пункта. |
shopId |
Да | number | ID магазина. |
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 | Логотип компании. |
deliveryTypes |
array | Поддерживаемые типы доставки. |
GET https://api.saferoute.ru/v2/lists/return-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/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 | Доступна ли услуга “Частичная выдача”. |
point.isDropOff |
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 | Стоимость сортировки в рублях. |