Documentation développeursRéférence de l'APIProjets

Consulter un projet

Un projet avec ses véhicules, articles, groupes, options et un résumé de son plan actuel (avec le lien du PDF tant que le plan est celui enregistré par une tâche API).

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

Gratuit : aucun crédit n'est débité.

Authentification

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

Paramètres de chemin

NomTypeObligatoireDescription

idstringobligatoire

string

Oui

ID du projet (prj_…).

Exemple de requête

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

const res = await fetch("https://runner.cargoduo.com/v1/projects/prj_3051", {
  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/projects/prj_3051",
    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/projects/prj_3051", 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/projects/prj_3051"))
            .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/projects/prj_3051");
var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

<?php

$ch = curl_init('https://runner.cargoduo.com/v1/projects/prj_3051');
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/projects/prj_3051")
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 · Project

{
  "id": "prj_3051",
  "object": "project",
  "name": "Order 1042",
  "status": "calculated",
  "item_count": 58,
  "vehicle_count": 1,
  "app_url": "https://app.cargoduo.com/projects/3051",
  "created_by": {
    "id": "usr_7",
    "name": "Elif Kaya"
  },
  "updated_by": {
    "id": "usr_7",
    "name": "Elif Kaya"
  },
  "created_at": "2026-10-19T09:10:03Z",
  "updated_at": "2026-10-19T09:12:07Z",
  "options": {
    "packing_mode": "auto",
    "group_routing": "none",
    "allow_overweight": false
  },
  "vehicles": [
    {
      "id": "pv_5120",
      "vehicle_id": "standard-trailer-13-6m",
      "name": "Standard Trailer (13.6m)",
      "type": "trailer",
      "quantity": 1,
      "length": 1362,
      "width": 248,
      "height": 270,
      "max_weight": 24000
    }
  ],
  "items": [
    {
      "id": "item_88410",
      "label": "Euro pallet",
      "shape": "box",
      "length": 120,
      "width": 80,
      "height": 140,
      "weight": 450,
      "quantity": 18,
      "stackable": false,
      "rotation": "all",
      "color": "#3b82f6"
    },
    {
      "id": "item_88411",
      "label": "Carton A",
      "shape": "box",
      "length": 60,
      "width": 40,
      "height": 40,
      "weight": 12,
      "quantity": 40,
      "stackable": true,
      "rotation": "upright",
      "color": "#f59e0b"
    }
  ],
  "groups": [],
  "plan": {
    "items_placed": 58,
    "items_unplaced": 0,
    "vehicles_used": 1,
    "total_weight": 8580,
    "volume_utilization": 0.3116,
    "job_id": "job_4bK9mT2xQe7LpW1zRc8VdN3f",
    "pdf_url": "https://app.cargoduo.com/r/Xq7Lm2Vt9KbR4cN8wZp1Hs6Yd3Fg5Jk0Ta2Ue7Wn4Ci"
  }
}

Réponses

200OKLe projet.Project
NomTypeObligatoireDescription
idstring
string
Non
ID du projet (prj_…).
objectstring
string
Non
project
namestring
string
Non
statusstring
string
Non
draft = jamais calculé ou données remplacées ; calculated = possède un plan actuel ; stale = un paramètre a changé depuis la création du plan.
draftcalculatedstaleerror
item_countinteger
integer
Non
Unités d'articles (somme des quantités).
vehicle_countinteger
integer
Non
Véhicules (somme des quantités).
app_urlstring
string
Non
Ouvre le projet dans l'éditeur 3D de l'application.
created_byUserRef | null
UserRef | null
Non
Le membre qui l'a créé (pour les appels API : le membre qui a créé la clé). null si inconnu.
updated_byUserRef | null
UserRef | null
Non
Le dernier membre à l'avoir modifié.
created_atstring
string
Non
RFC 3339.
updated_atstring
string
Non
RFC 3339.
optionsProjectOptions
ProjectOptions
Non
Les options de chargement enregistrées dans un projet.
vehiclesProjectVehicle[]
ProjectVehicle[]
Non
itemsItem[]
Item[]
Non
Fret au format Item de /v1/pack ; les ID sont de la forme item_….
groupsGroup[]
Group[]
Non
planProjectPlan | null
ProjectPlan | null
Non
Le plan actuel ; null si le projet n'en a pas.
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 foundproject_not_foundError
- project_not_foundAucun projet avec cet ID dans votre organisation.
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

POSTCalculer le chargement d'un projetCalcule le chargement des véhicules et articles du projet exactement comme POST /v1/pack : même prix, même réservation de crédits, mêmes limites, Idempotency-Key, ?wait= et tâche.PATCHMettre à jour un projetRenomme un projet, modifie ses options ou remplace ses véhicules ou ses articles (avec les groupes).

Authentification

Paramètres de chemin

Exemple de requête

Exemple de réponse

Réponses

Voir aussi