Zum Inhalt springen
EntwicklerdokumentationAPI-ReferenzJobs

Job abrufen

Status, Fortschritt, Zusammenfassung und Kosten eines Jobs.

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

Fragen Sie ihn alle 1–2 s ab, bis status den Wert succeeded, failed oder canceled hat.

Authentifizierung

Bearer-API-Schlüssel mit Berechtigungjobs:readMehr erfahren

Pfadparameter

NameTypErforderlichBeschreibung
idstringerforderlich
string
Ja

Job-ID (job_…).

Query-Parameter

NameTypErforderlichBeschreibung
includestring
string
Nein

result bettet den Ladeplan ein, sobald der Job erfolgreich war.

result

Beispielanfrage

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

Beispielantwort

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

Antworten

  • 200OKDer Job.
    NameTypErforderlichBeschreibung
    idstringerforderlich
    string
    Ja

    Job-ID (job_…).

    objectstringerforderlich
    string
    Ja

    Immer job.

    job
    statusstringerforderlich
    string
    Ja

    queued → running → succeeded | failed | canceled.

    queuedrunningsucceededfailedcanceled
    referencestring
    string
    Nein

    Ihre Referenz aus der Anfrage.

    sourcestring
    string
    Nein

    Wo der Job angelegt wurde.

    apiplayground
    project_idstring
    string
    Nein

    Das Projekt (prj_…), in dem ein Job von POST /v1/projects/{id}/pack seinen Plan speichert. Fehlt bei anderen Jobs.

    created_atstringerforderlich
    string
    Ja

    Zeitstempel nach RFC 3339.

    started_atstring | null
    string | null
    Nein

    Beginn der Berechnung (RFC 3339) oder null.

    finished_atstring | null
    string | null
    Nein

    Ende des Jobs (RFC 3339) oder null.

    progressJobProgress
    JobProgress
    Nein

    Live-Fortschritt, solange der Job wartet oder läuft.

    summaryJobSummary
    JobSummary
    Nein

    Anzahlen und Zeiten.

    costJobCost
    JobCost
    Nein

    Berechnete Credits (endgültig, sobald der Job beendet ist) und die Reservierung während der Laufzeit.

    errorJobError | null
    JobError | null
    Nein

    Warum der Job fehlgeschlagen ist oder abgebrochen wurde; sonst null.

    warningsWarning[]
    Warning[]
    Nein

    Nicht blockierende Hinweise zur Anfrage (auch im Ergebnis wiederholt).

    result_urlstring
    string
    Nein

    Rufen Sie diese URL per GET ab, um das vollständige Ergebnis zu erhalten, sobald status den Wert succeeded hat.

    pdf_urlstring
    string
    Nein

    Ein Browser-Link, der den Ladeplan als PDF erzeugt (3D-Ansichten + Ladeschritte). Gültig bis expires_at. Danach leer.

    expires_atstring
    string
    Nein

    Zeitpunkt, zu dem Anfrage- und Ergebnis-Bodies sowie der PDF-Link gelöscht werden (RFC 3339). Job-Metadaten und Abbuchungen bleiben erhalten.

    resultResult
    Result
    Nein

    Das vollständige Ergebnis, nur eingebettet, wenn angefordert (?include=result) oder wenn POST /v1/pack?wait= rechtzeitig fertig wurde.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedAPI-Schlüssel fehlt, ist fehlerhaft oder unbekannt.
    • key_revokedDer Schlüssel wurde widerrufen.
    • key_expiredDer Schlüssel ist abgelaufen.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedDie aufrufende IP-Adresse steht nicht auf der Allowlist des Schlüssels.
    • subscription_inactiveDie Organisation hat kein aktives Abonnement, das die API enthält.
    • account_inactiveDie Organisation ist gesperrt oder hat keinen Inhaber mit aktivem Konto.
    • scope_missingDem Schlüssel fehlt eine Berechtigung, die dieser Endpoint benötigt.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 404Not foundjob_not_found
    • job_not_foundKein Job mit dieser ID in Ihrer Organisation.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 429Too many requestsrate_limited
    • rate_limitedZu viele Anfragen in der aktuellen Minute, Stunde oder am aktuellen Tag (pro Schlüssel oder pro Organisation) oder mehr als 60 fehlgeschlagene Authentifizierungen pro Minute von Ihrer IP-Adresse.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 500Internal server errorinternal_error
    • internal_errorAuf unserer Seite ist ein Fehler aufgetreten.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 503Service unavailableapi_disabled
    • api_disabledDie API ist vorübergehend deaktiviert (Wartung) oder für die Organisation abgeschaltet.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes