Documentação para desenvolvedoresAPI referenceJobs

Get a job result

The load plan of a succeeded job: every vehicle used, every placement, what did not fit and the PDF link.

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

Autenticação

Chave de API Bearer com a permissãojobs:readSaber mais

Parâmetros de caminho

NomeTipoObrigatórioDescrição

idstringobrigatório

string

Sim

Job id (job_…).

Exemplo de pedido

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

const res = await fetch("https://runner.cargoduo.com/v1/jobs/job_4bK9mT2xQe7LpW1zRc8VdN3f/result", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.CARGODUO_API_KEY}`,
  },
});

const data = await res.json();
console.log(res.status, data);

import os
import requests

response = requests.get(
    "https://runner.cargoduo.com/v1/jobs/job_4bK9mT2xQe7LpW1zRc8VdN3f/result",
    headers={"Authorization": f"Bearer {os.environ['CARGODUO_API_KEY']}"},
)
print(response.status_code, response.json())

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://runner.cargoduo.com/v1/jobs/job_4bK9mT2xQe7LpW1zRc8VdN3f/result", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("CARGODUO_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://runner.cargoduo.com/v1/jobs/job_4bK9mT2xQe7LpW1zRc8VdN3f/result"))
            .header("Authorization", "Bearer " + System.getenv("CARGODUO_API_KEY"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("CARGODUO_API_KEY"));

var request = new HttpRequestMessage(HttpMethod.Get, "https://runner.cargoduo.com/v1/jobs/job_4bK9mT2xQe7LpW1zRc8VdN3f/result");
var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

<?php

$ch = curl_init('https://runner.cargoduo.com/v1/jobs/job_4bK9mT2xQe7LpW1zRc8VdN3f/result');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('CARGODUO_API_KEY'),
    ],
]);

$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), ' ', $response, PHP_EOL;

require "net/http"
require "uri"

uri = URI("https://runner.cargoduo.com/v1/jobs/job_4bK9mT2xQe7LpW1zRc8VdN3f/result")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("CARGODUO_API_KEY")}"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts response.code, response.body

Exemplo de resposta

200 OK · Result

{
  "job_id": "job_4bK9mT2xQe7LpW1zRc8VdN3f",
  "vehicles": [
    {
      "index": 0,
      "vehicle_id": "trailer",
      "copy": 1,
      "auto_added": false,
      "name": "13.6 m trailer",
      "type": "trailer",
      "length": 1360,
      "width": 245,
      "height": 270,
      "max_weight": 24000,
      "items_placed": 58,
      "total_weight": 8580,
      "volume_utilization": 0.3116,
      "weight_utilization": 0.3575,
      "center_of_gravity": {
        "x": 452.6,
        "y": 68.4,
        "z": 121.8
      },
      "axle_loads": [],
      "placements": [
        {
          "item_id": "pallet-eu",
          "instance": 1,
          "label": "Euro pallet",
          "x": 0,
          "y": 0,
          "z": 0,
          "length": 80,
          "width": 120,
          "height": 140,
          "rotated": true,
          "orientation": "wlh",
          "step": 1,
          "weight": 450
        },
        {
          "item_id": "pallet-eu",
          "instance": 2,
          "label": "Euro pallet",
          "x": 0,
          "y": 0,
          "z": 120,
          "length": 80,
          "width": 120,
          "height": 140,
          "rotated": true,
          "orientation": "wlh",
          "step": 2,
          "weight": 450
        },
        {
          "item_id": "carton-a",
          "instance": 1,
          "label": "Carton A",
          "x": 720,
          "y": 0,
          "z": 0,
          "length": 60,
          "width": 40,
          "height": 40,
          "rotated": false,
          "orientation": "lwh",
          "step": 19,
          "weight": 12
        }
      ]
    }
  ],
  "unplaced": [],
  "warnings": [],
  "pdf_url": "https://app.cargoduo.com/r/Xq7Lm2Vt9KbR4cN8wZp1Hs6Yd3Fg5Jk0Ta2Ue7Wn4Ci",
  "expires_at": "2026-11-02T09:12:03Z"
}

Abridged: 3 of the 58 placements are shown.

Respostas

200OKThe load plan.Result
NomeTipoObrigatórioDescrição
job_idstring
string
Não
The job.
vehiclesResultVehicle[]
ResultVehicle[]
Não
Loaded vehicles in loading order (empty vehicles are left out).
unplacedUnplacedItem[]
UnplacedItem[]
Não
Units that could not be placed, with the reason.
warningsWarning[]
Warning[]
Não
Remarks about the plan.
pdf_urlstring
string
Não
Browser link that renders the plan as a PDF.
expires_atstring
string
Não
When this result is deleted (RFC 3339).
401Unauthorizedunauthorizedkey_revokedkey_expiredError
- unauthorizedMissing, malformed or unknown API key.
- key_revokedThe key was revoked.
- key_expiredThe key passed its expiry date.
NomeTipoObrigatórioDescrição
errorErrorBodyobrigatório
ErrorBody
Sim
Todos os códigos de erro
403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missingError
- 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.
NomeTipoObrigatórioDescrição
errorErrorBodyobrigatório
ErrorBody
Sim
Todos os códigos de erro
404Not foundjob_not_foundError
- job_not_foundNo job with this id in your organization.
NomeTipoObrigatórioDescrição
errorErrorBodyobrigatório
ErrorBody
Sim
Todos os códigos de erro
409Conflictjob_not_finishedjob_failedjob_canceledError
- job_not_finishedThe job is still queued or running.
- job_failedThe job failed; it has no result.
- job_canceledThe job was canceled; it has no result.
NomeTipoObrigatórioDescrição
errorErrorBodyobrigatório
ErrorBody
Sim
Todos os códigos de erro
410Goneresult_expiredError
- result_expiredThe result passed the retention window and was deleted.
NomeTipoObrigatórioDescrição
errorErrorBodyobrigatório
ErrorBody
Sim
Todos os códigos de erro
429Too many requestsrate_limitedError
- 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.
NomeTipoObrigatórioDescrição
errorErrorBodyobrigatório
ErrorBody
Sim
Todos os códigos de erro
500Internal server errorinternal_errorError
- internal_errorSomething failed on our side.
NomeTipoObrigatórioDescrição
errorErrorBodyobrigatório
ErrorBody
Sim
Todos os códigos de erro
503Service unavailableapi_disabledError
- api_disabledThe API is temporarily disabled (maintenance) or switched off for the organization.
NomeTipoObrigatórioDescrição
errorErrorBodyobrigatório
ErrorBody
Sim
Todos os códigos de erro

Results & coordinatesWhere every item sits, in which orientation and loading order.PDF reportsA shareable link that builds the loading plan PDF.GETGet a jobA job's status, progress, summary and cost.

Autenticação

Parâmetros de caminho

Exemplo de pedido

Exemplo de resposta

Respostas

Relacionados