Перейти к содержимому
CargoDuo logoCargoDuo
Цены
Документация для разработчиковСправочник APIЗадания

Получить задание

Статус, прогресс, сводка и стоимость задания.

GEThttps://runner.cargoduo.com/v1/jobs/{id}

Опрашивайте каждые 1–2 s, пока status не станет succeeded, failed или canceled.

Аутентификация

Bearer-ключ API с правомjobs:readПодробнее

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

ИмяТипОбязательноОписание
idstringобязательно
string
Да

ID задания (job_…).

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

ИмяТипОбязательноОписание
includestring
string
Нет

result встраивает в ответ план загрузки, когда задание выполнено успешно.

result

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

curl -X GET "https://runner.cargoduo.com/v1/jobs/job_4bK9mT2xQe7LpW1zRc8VdN3f" \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

Пример ответа

200 OK · Job
{
  "id": "job_4bK9mT2xQe7LpW1zRc8VdN3f",
  "object": "job",
  "status": "succeeded",
  "reference": "order-1042",
  "source": "api",
  "created_at": "2026-10-19T09:12:03Z",
  "started_at": "2026-10-19T09:12:03Z",
  "finished_at": "2026-10-19T09:12:07Z",
  "progress": {
    "stage": "done",
    "vehicles_done": 1,
    "placed_items": 58
  },
  "summary": {
    "items_requested": 58,
    "items_placed": 58,
    "items_unplaced": 0,
    "vehicles_used": 1,
    "total_weight": 8580,
    "volume_utilization": 0.3116,
    "queue_ms": 12,
    "compute_ms": 4210
  },
  "cost": {
    "credits": 0.28105,
    "reserved_credits": 1.11,
    "rate_card_version": 1,
    "breakdown": {
      "base": 0.06,
      "vehicles": 0.2,
      "compute": 0.02105,
      "large_load": 0
    }
  },
  "error": null,
  "warnings": [],
  "result_url": "https://runner.cargoduo.com/v1/jobs/job_4bK9mT2xQe7LpW1zRc8VdN3f/result",
  "pdf_url": "https://app.cargoduo.com/r/Xq7Lm2Vt9KbR4cN8wZp1Hs6Yd3Fg5Jk0Ta2Ue7Wn4Ci",
  "expires_at": "2026-11-02T09:12:03Z"
}

Ответы

  • 200OKЗадание.
    ИмяТипОбязательноОписание
    idstringобязательно
    string
    Да

    ID задания (job_…).

    objectstringобязательно
    string
    Да

    Всегда job.

    job
    statusstringобязательно
    string
    Да

    queued → running → succeeded | failed | canceled.

    queuedrunningsucceededfailedcanceled
    referencestring
    string
    Нет

    Ваш идентификатор из запроса.

    sourcestring
    string
    Нет

    Где создано задание.

    apiplayground
    project_idstring
    string
    Нет

    Проект (prj_…), в который задание POST /v1/projects/{id}/pack сохраняет свой план. У других заданий отсутствует.

    created_atstringобязательно
    string
    Да

    Метка времени RFC 3339.

    started_atstring | null
    string | null
    Нет

    Когда начались вычисления (RFC 3339), или null.

    finished_atstring | null
    string | null
    Нет

    Когда задание завершилось (RFC 3339), или null.

    progressJobProgress
    JobProgress
    Нет

    Текущий прогресс, пока задание в очереди или выполняется.

    summaryJobSummary
    JobSummary
    Нет

    Счётчики и время.

    costJobCost
    JobCost
    Нет

    Списанные кредиты (окончательные после завершения задания) и резерв, удерживаемый во время выполнения.

    errorJobError | null
    JobError | null
    Нет

    Почему задание завершилось ошибкой или было отменено; иначе null.

    warningsWarning[]
    Warning[]
    Нет

    Некритичные замечания к запросу (дублируются в результате).

    result_urlstring
    string
    Нет

    Выполните GET по этому URL, чтобы получить полный результат, когда status станет succeeded.

    pdf_urlstring
    string
    Нет

    Ссылка, по которой браузер формирует PDF с планом загрузки (3D-виды + шаги загрузки). Действует до expires_at. После истечения срока пустая.

    expires_atstring
    string
    Нет

    Когда удаляются тела запроса и результата и ссылка на PDF (RFC 3339). Метаданные задания и списания сохраняются.

    resultResult
    Result
    Нет

    Полный результат; встраивается, только если запрошен (?include=result) или если POST /v1/pack?wait= успел завершиться.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedAPI-ключ отсутствует, имеет неверный формат или неизвестен.
    • key_revokedКлюч отозван.
    • key_expiredСрок действия ключа истёк.
    ИмяТипОбязательноОписание
    errorErrorBodyобязательно
    ErrorBody
    Да
    Все коды ошибок
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedIP-адреса вызывающей стороны нет в списке разрешённых IP для этого ключа.
    • subscription_inactiveУ организации нет активной подписки, включающей API.
    • account_inactiveРабота организации приостановлена, или у неё нет владельца с активной учётной записью.
    • scope_missingУ ключа нет области доступа, необходимой для этого endpoint.
    ИмяТипОбязательноОписание
    errorErrorBodyобязательно
    ErrorBody
    Да
    Все коды ошибок
  • 404Not foundjob_not_found
    • job_not_foundВ вашей организации нет задания с таким ID.
    ИмяТипОбязательноОписание
    errorErrorBodyобязательно
    ErrorBody
    Да
    Все коды ошибок
  • 429Too many requestsrate_limited
    • rate_limitedСлишком много запросов за текущую минуту, час или сутки (на ключ или на организацию) либо число неудачных попыток аутентификации с вашего IP-адреса превысило 60 в минуту.
    ИмяТипОбязательноОписание
    errorErrorBodyобязательно
    ErrorBody
    Да
    Все коды ошибок
  • 500Internal server errorinternal_error
    • internal_errorСбой на нашей стороне.
    ИмяТипОбязательноОписание
    errorErrorBodyобязательно
    ErrorBody
    Да
    Все коды ошибок
  • 503Service unavailableapi_disabled
    • api_disabledAPI временно отключён (техническое обслуживание) или выключен для организации.
    ИмяТипОбязательноОписание
    errorErrorBodyобязательно
    ErrorBody
    Да
    Все коды ошибок