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 | Стоимость. |
weight |
number | Вес в кг. |
file |
string | null | Ссылка на акт передачи заказов. |
countOrders |
number | Число заказов. |
warehouse |
object | Склад отгрузки. Модель Warehouse. |
companyName |
string | Название транспортной компании. |
comment |
string | null | Комментарий для курьера. |
error |
string | null | Описание ошибки (когда забор в статусе “Ошибка”). |
POST https://api.saferoute.ru/v2/pickups Требуется авторизация
Параметры запроса.
| Имя параметра | Обязательный | Тип данных и возможные значения | Описание |
|---|---|---|---|
warehouseId |
Да | number | ID склада отгрузки. |
companyId |
Да | number | ID компании забора (получение компаний забора). |
type |
Да | number3, 4 |
Тип забора: единый забор или прямая отгрузка. |
weight |
— | number | null |
Вес в кг. По умолчанию - 1 кг. |
date |
Да | string | Дата отгрузки. |
comment |
— | string | null | Комментарий для курьера. |
Данные ответа.
| Параметр | Тип | Описание |
|---|---|---|
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 | Минимальное число заказов для бесплатного забора. |
commentAvailable |
boolean | Возможно ли передать комментарий для курьера. |