Skip to content

Склады

Эндпоинты для получения информации о складах компании.

Получение списка складов

Получить список всех складов, привязанных к компании.

Запрос

http
GET /depots

Заголовки:

http
X-API-Key: ваш_api_ключ

Ответ

json
{
  "ok": true,
  "result": [
    {
      "number": "14",
      "address": "г. Тюмень, ул. Ленина, 10",
      "lat": 57.153033,
      "lon": 65.534328,
      "time_interval_start": "08:00",
      "time_interval_finish": "18:00",
      "time_zone": "Asia/Yekaterinburg",
      "service_duration_s": 1800,
      "finish_service_duration_s": 300,
      "dock_capacity": 2,
      "full_refund": true,
      "reloading": false,
      "callbacks_url": null,
      "city_name": "Тюмень"
    }
  ]
}

Пример использования

bash
curl -X GET "https://api.razvezu.pro/integration/v2/depots" \
  -H "X-API-Key: ваш_api_ключ"
javascript
const response = await fetch('https://api.razvezu.pro/integration/v2/depots', {
  headers: {
    'X-API-Key': 'ваш_api_ключ'
  }
});

const data = await response.json();
console.log(data.result);
python
import requests

headers = {
    'X-API-Key': 'ваш_api_ключ'
}

response = requests.get(
    'https://api.razvezu.pro/integration/v2/depots',
    headers=headers
)

data = response.json()
print(data['result'])

Получение информации о складе

Получить детальную информацию о конкретном складе по его номеру.

Запрос

http
GET /depots/{number}

Параметры пути:

  • number (string, required) — номер склада

Заголовки:

http
X-API-Key: ваш_api_ключ

Ответ

json
{
  "ok": true,
  "result": {
    "number": "14",
    "address": "г. Тюмень, ул. Ленина, 10",
    "lat": 57.153033,
    "lon": 65.534328,
    "time_interval_start": "08:00",
    "time_interval_finish": "18:00",
    "time_zone": "Asia/Yekaterinburg",
    "service_duration_s": 1800,
    "finish_service_duration_s": 300,
    "dock_capacity": 2,
    "full_refund": true,
    "reloading": false,
    "callbacks_url": "https://api.ru/status",
    "city_name": "Тюмень"
  }
}

Описание полей

ПолеТипОписание
numberstringНомер склада
addressstringАдрес склада
latfloatГеографическая широта
lonfloatГеографическая долгота
time_interval_startstringВремя начала работы (HH:mm)
time_interval_finishstringВремя окончания работы (HH:mm)
time_zonestringЧасовой пояс склада
service_duration_sintegerВремя на погрузку в секундах
finish_service_duration_sintegerВремя на выгрузку в секундах
dock_capacityintegerПропускная способность склада
full_refundbooleanЕдиновременный возврат
reloadingbooleanВозможность дозагрузки
callbacks_urlstring | nullURL для колбеков
city_namestringНазвание города

Примеры использования

bash
curl -X GET "https://api.razvezu.pro/integration/v2/depots/14" \
  -H "X-API-Key: ваш_api_ключ"
javascript
const response = await fetch('https://api.razvezu.pro/integration/v2/depots/14', {
  headers: {
    'X-API-Key': 'ваш_api_ключ'
  }
});

const data = await response.json();
console.log(data.result);
python
import requests

headers = {
    'X-API-Key': 'ваш_api_ключ'
}

response = requests.get(
    'https://api.razvezu.pro/integration/v2/depots/14',
    headers=headers
)

data = response.json()
print(data['result'])

Ошибки

404 Not Found

Склад не найден:

json
{
  "ok": false,
  "errors": {
    "message": "Склад не найден"
  }
}

401 Unauthorized

Ошибка аутентификации:

json
{
  "ok": false,
  "errors": {
    "message": "Неверные данные аутентификации"
  }
}

500 Internal Server Error

Внутренняя ошибка сервера:

json
{
  "ok": false,
  "errors": {
    "message": "Ошибка на стороне сервера, попробуйте позже"
  }
}