Карточка груза

Возвращает один груз по идентификатору.

Запрос

GET /v3/pb/cargos/{id}
Authorization: Bearer your_partner_token

Path-параметры

Параметр Тип Описание
id integer идентификатор груза

Query-параметры

Метод использует тот же набор filter[...], что и Список грузов:

  • filter[id]
  • filter[updated_at]
  • filter[system_assistant]
  • filter[owner_company]
  • filter[distance]
  • filter[source]
  • filter[price]
  • filter[price_per_km]
  • filter[weight]
  • filter[truck_types]
  • filter[load_type_ids]
  • filter[user_id]
  • filter[wv]
  • filter[start_point_id]
  • filter[finish_point_id]
  • filter[include]
  • filter[sort]
  • filter[offset]
  • filter[limit]

На практике для чтения карточки обычно достаточно path-параметра id.

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

curl -X GET "https://api.cargotech.pro/v3/pb/cargos/100245" \
  -H "Authorization: Bearer your_partner_token"

Ответ 200

{
  "success": true,
  "data": {
    "id": "8e8c4b2a-2b3e-4a09-8d32-1c7c4d53d4b1",
    "external_id": 100245,
    "status": "open",
    "type": "cargo",
    "price": 100000,
    "weight": 20000,
    "distance": 1000
  }
}

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

Поле Тип Описание
success boolean признак успешного ответа
data object карточка груза

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

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

Код Когда возникает
401 отсутствует или невалиден Bearer token
404 груз с таким идентификатором недоступен или не найден
422 нарушен контракт запроса

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