تخطَّ إلى المحتوى

هذه الوثائق متاحة حاليًا باللغة الإنجليزية فقط.

وثائق المطورينAPI referenceJobs

Cancel a job

Stops a queued or running job.

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

A canceled job pays the per-job fee, any large-load surcharge and the compute used so far, never the per-vehicle fee. Canceling a canceled job returns it unchanged.

المصادقة

مفتاح API من نوع Bearer بالصلاحيةpack:writeاعرف المزيد

معاملات المسار

الاسمالنوعمطلوبالوصف
idstringمطلوب
string
نعم

Job id (job_…).

مثال على الطلب

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

مثال على الاستجابة

200 OK · Job
{
  "id": "job_2cR8vL4nXp6tQb1mZk9WsH5e",
  "object": "job",
  "status": "canceled",
  "reference": "order-1043",
  "source": "api",
  "created_at": "2026-10-19T09:15:03Z",
  "started_at": "2026-10-19T09:15:03Z",
  "finished_at": "2026-10-19T09:15:05Z",
  "progress": {
    "stage": "done",
    "vehicles_done": 0,
    "placed_items": 0
  },
  "summary": {
    "items_requested": 58,
    "items_placed": 0,
    "items_unplaced": 0,
    "vehicles_used": 0,
    "total_weight": 0,
    "volume_utilization": 0,
    "queue_ms": 15,
    "compute_ms": 2300
  },
  "cost": {
    "credits": 0.0715,
    "reserved_credits": 1.11,
    "rate_card_version": 1,
    "breakdown": {
      "base": 0.06,
      "vehicles": 0,
      "compute": 0.0115,
      "large_load": 0
    }
  },
  "error": {
    "code": "canceled",
    "message": "Canceled by request."
  },
  "warnings": [],
  "result_url": "https://runner.cargoduo.com/v1/jobs/job_2cR8vL4nXp6tQb1mZk9WsH5e/result",
  "pdf_url": "",
  "expires_at": "2026-11-02T09:15:03Z"
}

الاستجابات

  • 200OKThe canceled job.
    الاسمالنوعمطلوبالوصف
    idstringمطلوب
    string
    نعم

    Job id (job_…).

    objectstringمطلوب
    string
    نعم

    Always job.

    job
    statusstringمطلوب
    string
    نعم

    queued → running → succeeded | failed | canceled.

    queuedrunningsucceededfailedcanceled
    referencestring
    string
    لا

    Your reference from the request.

    sourcestring
    string
    لا

    Where the job was created.

    apiplayground
    project_idstring
    string
    لا

    The project (prj_…) a POST /v1/projects/{id}/pack job saves its plan into. Absent on other jobs.

    created_atstringمطلوب
    string
    نعم

    RFC 3339 timestamp.

    started_atstring | null
    string | null
    لا

    When computing started (RFC 3339) or null.

    finished_atstring | null
    string | null
    لا

    When the job ended (RFC 3339) or null.

    progressJobProgress
    JobProgress
    لا

    Live progress while queued/running.

    summaryJobSummary
    JobSummary
    لا

    Counts and timings.

    costJobCost
    JobCost
    لا

    Credits charged (final once the job ended) and the reservation held while it ran.

    errorJobError | null
    JobError | null
    لا

    Why the job failed or was canceled; null otherwise.

    warningsWarning[]
    Warning[]
    لا

    Non-blocking remarks about the request (also repeated in the result).

    result_urlstring
    string
    لا

    GET this URL for the full result once status is succeeded.

    pdf_urlstring
    string
    لا

    A browser link that renders the load plan as a PDF (3D views + loading steps). Valid until expires_at. Empty after expiry.

    expires_atstring
    string
    لا

    When the request/result bodies and the PDF link are deleted (RFC 3339). Job metadata and charges are kept.

    resultResult
    Result
    لا

    The full result, inlined only when requested (?include=result) or when POST /v1/pack?wait= finished in time.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedMissing, malformed or unknown API key.
    • key_revokedThe key was revoked.
    • key_expiredThe key passed its expiry date.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedThe calling IP is not on the key's allowlist.
    • subscription_inactiveThe organization has no active subscription that includes the API.
    • account_inactiveThe organization is suspended, or has no owner whose account is active.
    • scope_missingThe key lacks a scope this endpoint needs.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء
  • 404Not foundjob_not_found
    • job_not_foundNo job with this id in your organization.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء
  • 409Conflictjob_already_finished
    • job_already_finishedThe job already ended and cannot be canceled.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء
  • 429Too many requestsrate_limited
    • rate_limitedToo many requests in the current minute, hour or day (per key or per organization), or more than 60 failed authentications per minute from your IP address.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء
  • 500Internal server errorinternal_error
    • internal_errorSomething failed on our side.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء
  • 503Service unavailableapi_disabled
    • api_disabledThe API is temporarily disabled (maintenance) or switched off for the organization.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء