Documentation développeursRéférence de l'APITâches

Consulter le résultat d'une tâche

Le plan de chargement d'une tâche réussie : chaque véhicule utilisé, chaque placement, ce qui n'a pas pu être placé et le lien du PDF.

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

Authentification

Clé API Bearer avec l'autorisationjobs:readEn savoir plus

Paramètres de chemin

NomTypeObligatoireDescription

idstringobligatoire

string

Oui

ID de la tâche (job_…).

Exemple de requête

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

Exemple de réponse

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

Extrait : 3 des 58 placements sont affichés.

Réponses

200OKLe plan de chargement.Result
NomTypeObligatoireDescription
job_idstring
string
Non
La tâche.
vehiclesResultVehicle[]
ResultVehicle[]
Non
Véhicules chargés, dans l'ordre de chargement (les véhicules vides sont omis).
unplacedUnplacedItem[]
UnplacedItem[]
Non
Unités qui n'ont pas pu être placées, avec la raison.
warningsWarning[]
Warning[]
Non
Remarques sur le plan.
pdf_urlstring
string
Non
Lien à ouvrir dans un navigateur, qui génère le plan en PDF.
expires_atstring
string
Non
Date de suppression de ce résultat (RFC 3339).
401Unauthorizedunauthorizedkey_revokedkey_expiredError
- unauthorizedClé API absente, mal formée ou inconnue.
- key_revokedLa clé a été révoquée.
- key_expiredLa clé a dépassé sa date d'expiration.
NomTypeObligatoireDescription
errorErrorBodyobligatoire
ErrorBody
Oui
Tous les codes d'erreur
403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missingError
- ip_not_allowedL'adresse IP appelante ne figure pas dans la liste des adresses IP autorisées de la clé.
- subscription_inactiveL'organisation n'a aucun abonnement actif incluant l'API.
- account_inactiveL'organisation est suspendue ou n'a aucun propriétaire dont le compte est actif.
- scope_missingIl manque à la clé une autorisation requise par cet endpoint.
NomTypeObligatoireDescription
errorErrorBodyobligatoire
ErrorBody
Oui
Tous les codes d'erreur
404Not foundjob_not_foundError
- job_not_foundAucune tâche avec cet ID dans votre organisation.
NomTypeObligatoireDescription
errorErrorBodyobligatoire
ErrorBody
Oui
Tous les codes d'erreur
409Conflictjob_not_finishedjob_failedjob_canceledError
- job_not_finishedLa tâche est encore en file d'attente ou en cours.
- job_failedLa tâche a échoué ; elle n'a pas de résultat.
- job_canceledLa tâche a été annulée ; elle n'a pas de résultat.
NomTypeObligatoireDescription
errorErrorBodyobligatoire
ErrorBody
Oui
Tous les codes d'erreur
410Goneresult_expiredError
- result_expiredLe résultat a dépassé la durée de conservation et a été supprimé.
NomTypeObligatoireDescription
errorErrorBodyobligatoire
ErrorBody
Oui
Tous les codes d'erreur
429Too many requestsrate_limitedError
- rate_limitedTrop de requêtes dans la minute, l'heure ou la journée en cours (par clé ou par organisation), ou plus de 60 échecs d'authentification par minute depuis votre adresse IP.
NomTypeObligatoireDescription
errorErrorBodyobligatoire
ErrorBody
Oui
Tous les codes d'erreur
500Internal server errorinternal_errorError
- internal_errorUne erreur s'est produite de notre côté.
NomTypeObligatoireDescription
errorErrorBodyobligatoire
ErrorBody
Oui
Tous les codes d'erreur
503Service unavailableapi_disabledError
- api_disabledL'API est temporairement désactivée (maintenance) ou désactivée pour l'organisation.
NomTypeObligatoireDescription
errorErrorBodyobligatoire
ErrorBody
Oui
Tous les codes d'erreur

Résultats et coordonnéesOù se trouve chaque article, dans quelle orientation et dans quel ordre de chargement.Rapports PDFUn lien partageable qui génère le PDF du plan de chargement.GETConsulter une tâcheStatut, progression, résumé et coût d'une tâche.

Authentification

Paramètres de chemin

Exemple de requête

Exemple de réponse

Réponses

Voir aussi