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. |
sendQuantityToCMS |
boolean | Флаг “Отправлять остатки товаров в CMS”. |
brand |
string | Название бренда. Обязательный параметр. |
platform |
string | null |
|
warehouse |
object |
Склад отгрузки. Обязательный параметр. GET-запросы будут возвращать полную модель |
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 не заданы, будут оповещаться все сотрудники, имеющие доступ к магазину. |
GET https://api.saferoute.ru/v2/shops Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
name |
— | string | Фильтр по названию по неполному совпадению. |
brand |
— | string | Фильтр по бренду по неполному совпадению. |
warehouseId |
— | number | Фильтр по складу. |
onlyFulfilment |
— | number0, 1 |
Выводить только магазины с фулфилмент-складом. |
onlyMergedPickup |
— | number0, 1 |
Выводить только магазины со складом с единым забором (тип 2 и 3). |
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} Требуется авторизация