Развезу

Тема

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

Получение списка пунктов назначения ​

Возвращает список транспортных компаний или распределительных центров маркетплейса в зависимости от типа.

Запрос ​

javascript
GET /destination?type={type}

Параметры запроса:

  • type (integer, required) — тип пункта назначения:

    • 2 — Пункты выдачи заказов
    • 3 — Распределяющий центр маркетплейса
    • 4 — Распределяющий центр транспортной компании
    • 5 — Пункт транспортной компании Заголовки:
javascript
X-API-Key: ваш_api_ключ

Ответ ​

javascript
{
  "ok": true,
  "result": [
    {
      "id": 1,
      "name": "OZON"
    },
    {
      "id": 2,
      "name": "Wildberries"
    },
    {
      "id": 3,
      "name": "Яндекс.Маркет"
    }
  ]
}

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

ПолеТипОписание
idintegerИдентификатор пункта назначения
namestringНазвание пункта назначения

Типы пунктов назначения ​

ТипОписаниеПримеры
2Пункты выдачи заказовПВЗ различных сервисов
3Распределяющий центр маркетплейсаOZON, Wildberries, Яндекс.Маркет
4Распределяющий центр транспортной компанииСДЭК, Boxberry
5Пункт транспортной компанииЛокальные пункты ТК

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

javascript
curl -X GET "https://api.razvezu.pro/integration/v2/destination?type=3" \
  -H "Cookie: session=ваша_сессия"
javascript
const params = new URLSearchParams({
  type: '3'
});

const response = await fetch(
  `https://api.razvezu.pro/integration/v2/destination?${params}`,
  {
    credentials: 'include', // для отправки cookies
    headers: {
      'Cookie': 'session=ваша_сессия'
    }
  }
);

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

cookies = {
    'session': 'ваша_сессия'
}

params = {
    'type': 3
}

response = requests.get(
    'https://api.razvezu.pro/integration/v2/destination',
    params=params,
    cookies=cookies
)

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

Пример ответа для маркетплейсов ​

javascript
{
  "ok": true,
  "result": [
    {
      "id": 1,
      "name": "OZON"
    },
    {
      "id": 2,
      "name": "Wildberries"
    },
    {
      "id": 3,
      "name": "Яндекс.Маркет"
    },
    {
      "id": 4,
      "name": "СберМегаМаркет"
    }
  ]
}

Пример ответа для транспортных компаний ​

javascript
{
  "ok": true,
  "result": [
    {
      "id": 10,
      "name": "СДЭК"
    },
    {
      "id": 11,
      "name": "Boxberry"
    },
    {
      "id": 12,
      "name": "Почта России"
    }
  ]
}

Ошибки ​

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

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

Ошибка валидации параметров:

javascript
{
  "ok": false,
  "errors": {
    "type": [
      "Поле 'type' должно быть одним из: 2, 3, 4, 5"
    ]
  }
}

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

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

Использование в заказах ​

Полученный id пункта назначения используется в поле delivery_location_name при создании заказа:

javascript
{
  "destination": {
    "delivery_location_category": 3,
    "delivery_location_name": 1
  }
}

Где:

  • delivery_location_category — тип пункта назначения (2, 3, 4 или 5)
  • delivery_location_name — id из ответа этого эндпоинта

Совет

Если нужного пункта назначения нет в списке, обратитесь в поддержку Развезу для его добавления.