Bỏ qua đến nội dung
CargoDuo logoCargoDuo
Bảng giá
Tài liệu cho nhà phát triểnTham chiếu APITác vụ

Xem tác vụ

Trạng thái, tiến độ, tóm tắt và chi phí của một tác vụ.

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

Gọi định kỳ mỗi 1–2 giây cho đến khi status là succeeded, failed hoặc canceled.

Xác thực

Khóa API dạng Bearer, phạm vi quyềnjobs:readTìm hiểu thêm

Tham số đường dẫn

TênKiểuBắt buộcMô tả
idstringbắt buộc
string
Có

ID tác vụ (job_…).

Tham số truy vấn

TênKiểuBắt buộcMô tả
includestring
string
Không

result đưa sơ đồ xếp hàng vào phản hồi khi tác vụ đã thành công.

result

Yêu cầu mẫu

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

Phản hồi mẫu

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"
}

Phản hồi

  • 200OKTác vụ.
    TênKiểuBắt buộcMô tả
    idstringbắt buộc
    string
    Có

    ID tác vụ (job_…).

    objectstringbắt buộc
    string
    Có

    Luôn là job.

    job
    statusstringbắt buộc
    string
    Có

    queued → running → succeeded | failed | canceled.

    queuedrunningsucceededfailedcanceled
    referencestring
    string
    Không

    Mã tham chiếu của bạn từ yêu cầu.

    sourcestring
    string
    Không

    Nơi tạo tác vụ.

    apiplayground
    project_idstring
    string
    Không

    Dự án (prj_…) mà tác vụ POST /v1/projects/{id}/pack lưu sơ đồ vào. Không có ở các tác vụ khác.

    created_atstringbắt buộc
    string
    Có

    Mốc thời gian RFC 3339.

    started_atstring | null
    string | null
    Không

    Thời điểm bắt đầu tính toán (RFC 3339) hoặc null.

    finished_atstring | null
    string | null
    Không

    Thời điểm tác vụ kết thúc (RFC 3339) hoặc null.

    progressJobProgress
    JobProgress
    Không

    Tiến độ trực tiếp khi tác vụ đang chờ/đang chạy.

    summaryJobSummary
    JobSummary
    Không

    Số liệu và thời gian.

    costJobCost
    JobCost
    Không

    Credit đã bị trừ (chốt khi tác vụ kết thúc) và khoản tạm giữ trong lúc tác vụ chạy.

    errorJobError | null
    JobError | null
    Không

    Lý do tác vụ thất bại hoặc bị hủy; nếu không thì là null.

    warningsWarning[]
    Warning[]
    Không

    Ghi chú về yêu cầu, không chặn tác vụ (cũng được lặp lại trong kết quả).

    result_urlstring
    string
    Không

    Gọi GET tới URL này để lấy toàn bộ kết quả khi status là succeeded.

    pdf_urlstring
    string
    Không

    Liên kết mở trên trình duyệt để tạo PDF sơ đồ xếp hàng (góc nhìn 3D + các bước xếp hàng). Có hiệu lực đến expires_at. Rỗng sau khi hết hạn.

    expires_atstring
    string
    Không

    Thời điểm nội dung yêu cầu/kết quả và liên kết PDF bị xóa (RFC 3339). Siêu dữ liệu và khoản phí của tác vụ vẫn được giữ.

    resultResult
    Result
    Không

    Toàn bộ kết quả, chỉ được đưa vào khi được yêu cầu (?include=result) hoặc khi POST /v1/pack?wait= xong kịp thời gian.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedThiếu khóa API, khóa sai định dạng hoặc không xác định.
    • key_revokedKhóa đã bị thu hồi.
    • key_expiredKhóa đã quá ngày hết hạn.
    TênKiểuBắt buộcMô tả
    errorErrorBodybắt buộc
    ErrorBody
    Có
    Tất cả mã lỗi
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedIP gọi đến không nằm trong danh sách IP được phép của khóa.
    • subscription_inactiveTổ chức không có gói đăng ký đang hoạt động nào bao gồm API.
    • account_inactiveTổ chức bị tạm ngưng, hoặc không có chủ sở hữu nào có tài khoản đang hoạt động.
    • scope_missingKhóa thiếu phạm vi quyền mà endpoint này yêu cầu.
    TênKiểuBắt buộcMô tả
    errorErrorBodybắt buộc
    ErrorBody
    Có
    Tất cả mã lỗi
  • 404Not foundjob_not_found
    • job_not_foundTổ chức của bạn không có tác vụ nào với ID này.
    TênKiểuBắt buộcMô tả
    errorErrorBodybắt buộc
    ErrorBody
    Có
    Tất cả mã lỗi
  • 429Too many requestsrate_limited
    • rate_limitedQuá nhiều yêu cầu trong phút, giờ hoặc ngày hiện tại (theo khóa hoặc theo tổ chức), hoặc có hơn 60 lần xác thực thất bại mỗi phút từ địa chỉ IP của bạn.
    TênKiểuBắt buộcMô tả
    errorErrorBodybắt buộc
    ErrorBody
    Có
    Tất cả mã lỗi
  • 500Internal server errorinternal_error
    • internal_errorĐã xảy ra lỗi ở phía chúng tôi.
    TênKiểuBắt buộcMô tả
    errorErrorBodybắt buộc
    ErrorBody
    Có
    Tất cả mã lỗi
  • 503Service unavailableapi_disabled
    • api_disabledAPI tạm thời bị tắt (bảo trì) hoặc đã bị tắt cho tổ chức.
    TênKiểuBắt buộcMô tả
    errorErrorBodybắt buộc
    ErrorBody
    Có
    Tất cả mã lỗi