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 | — | number | Кол-во результатов на страницу. |
Данные ответа: массив моделей 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} Требуется авторизация