Список грузов

Возвращает список грузов, доступных текущей компании партнёра.

Запрос

GET /v3/pb/cargos
Authorization: Bearer your_partner_token

Когда использовать

  • для загрузки витрины грузов;
  • для инкрементальной синхронизации по дате обновления;
  • для поиска грузов по источнику, маршруту и параметрам перевозки.

Query-параметры

Параметр Тип Описание
filter[id] string поиск по связанному идентификатору груза
filter[updated_at] string вернуть грузы, обновлённые не раньше даты
filter[system_assistant] boolean исключение грузов с system assistant
filter[owner_company] string фильтр по имени компании-владельца
filter[distance] array диапазон дистанции
filter[source] integer фильтр по источнику груза
filter[price] array диапазон цены
filter[price_per_km] array диапазон цены за км
filter[weight] integer фильтр по весу
filter[truck_types] array фильтр по типам транспорта
filter[load_type_ids] array фильтр по типам погрузки
filter[user_id] string фильтр по связанному пользователю или контакту
filter[wv] string комбинированный фильтр по весу и объёму
filter[start_point_id] integer фильтр по точке погрузки
filter[finish_point_id] integer фильтр по точке выгрузки
filter[include] string дополнительное включение данных
filter[sort] string сортировка
filter[offset] integer смещение
filter[limit] integer размер выборки

Что важно учитывать

  • filter[updated_at] подходит для инкрементальной синхронизации;
  • диапазонные фильтры distance, price и price_per_km передаются как массив;
  • ответ содержит meta.total, поэтому метод подходит для постраничной загрузки.

Пример запроса

curl -G "https://api.cargotech.pro/v3/pb/cargos" \
  -H "Authorization: Bearer your_partner_token" \
  --data-urlencode "filter[source]=12" \
  --data-urlencode "filter[updated_at]=2026-04-01" \
  --data-urlencode "filter[limit]=50"

Ответ 200

{
  "success": true,
  "data": [
    {
      "id": "8e8c4b2a-2b3e-4a09-8d32-1c7c4d53d4b1",
      "external_id": 100245,
      "status": "open",
      "type": "cargo",
      "price": 100000,
      "weight": 20000,
      "distance": 1000
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 50,
    "total": 1
  }
}

Верхний уровень ответа

Поле Тип Описание
success boolean признак успешного ответа
data object[] список грузов
meta.offset integer текущее смещение
meta.limit integer размер страницы
meta.total integer общее количество записей

Элементы массива data описаны на странице Описание полей груза.

Типовые ошибки

Код Когда возникает
401 отсутствует или невалиден Bearer token
422 переданы некорректные фильтры или нарушены ограничения

Связанные страницы