Documentación para desarrolladoresReferencia de la APIProyectos

Consultar un proyecto

Un proyecto con sus vehículos, artículos, grupos, opciones y un resumen de su plan actual (con el enlace al PDF mientras el plan sea el que guardó un trabajo de la API).

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

Gratis: no se cobran créditos.

Autenticación

Clave de API Bearer con el permisoresources:readMás información

Parámetros de ruta

NombreTipoObligatorioDescripción

idstringobligatorio

string

Sí

ID del proyecto (prj_…).

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Respuestas

200OKEl proyecto.Project
NombreTipoObligatorioDescripción
idstring
string
No
ID del proyecto (prj_…).
objectstring
string
No
project
namestring
string
No
statusstring
string
No
draft = nunca calculado o con los datos sustituidos; calculated = tiene un plan actual; stale = algún ajuste ha cambiado desde que se creó el plan.
draftcalculatedstaleerror
item_countinteger
integer
No
Unidades de artículos (suma de cantidades).
vehicle_countinteger
integer
No
Vehículos (suma de cantidades).
app_urlstring
string
No
Abre el proyecto en el editor 3D de la aplicación.
created_byUserRef | null
UserRef | null
No
El miembro que lo creó (en las llamadas a la API: el miembro que creó la clave). null si se desconoce.
updated_byUserRef | null
UserRef | null
No
El último miembro que lo modificó.
created_atstring
string
No
RFC 3339.
updated_atstring
string
No
RFC 3339.
optionsProjectOptions
ProjectOptions
No
Las opciones de carga que guarda un proyecto.
vehiclesProjectVehicle[]
ProjectVehicle[]
No
itemsItem[]
Item[]
No
Carga con la estructura Item de /v1/pack; los ID son item_….
groupsGroup[]
Group[]
No
planProjectPlan | null
ProjectPlan | null
No
El plan actual; null si el proyecto no tiene ninguno.
401Unauthorizedunauthorizedkey_revokedkey_expiredError
- unauthorizedClave de API ausente, mal formada o desconocida.
- key_revokedLa clave se ha revocado.
- key_expiredLa clave ha superado su fecha de caducidad.
NombreTipoObligatorioDescripción
errorErrorBodyobligatorio
ErrorBody
Sí
Todos los códigos de error
403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missingError
- ip_not_allowedLa IP de origen no está en la lista de IP permitidas de la clave.
- subscription_inactiveLa organización no tiene ninguna suscripción activa que incluya la API.
- account_inactiveLa organización está suspendida o no tiene ningún propietario con la cuenta activa.
- scope_missingA la clave le falta un permiso que requiere este endpoint.
NombreTipoObligatorioDescripción
errorErrorBodyobligatorio
ErrorBody
Sí
Todos los códigos de error
404Not foundproject_not_foundError
- project_not_foundNo hay ningún proyecto con este ID en tu organización.
NombreTipoObligatorioDescripción
errorErrorBodyobligatorio
ErrorBody
Sí
Todos los códigos de error
429Too many requestsrate_limitedError
- rate_limitedDemasiadas solicitudes en el minuto, la hora o el día en curso (por clave o por organización), o más de 60 autenticaciones fallidas por minuto desde tu dirección IP.
NombreTipoObligatorioDescripción
errorErrorBodyobligatorio
ErrorBody
Sí
Todos los códigos de error
500Internal server errorinternal_errorError
- internal_errorAlgo ha fallado por nuestra parte.
NombreTipoObligatorioDescripción
errorErrorBodyobligatorio
ErrorBody
Sí
Todos los códigos de error
503Service unavailableapi_disabledError
- api_disabledLa API está desactivada temporalmente (mantenimiento) o deshabilitada para la organización.
NombreTipoObligatorioDescripción
errorErrorBodyobligatorio
ErrorBody
Sí
Todos los códigos de error

POSTCalcular la carga de un proyectoCalcula la carga de los vehículos y artículos del proyecto exactamente igual que POST /v1/pack: mismo precio, reserva de créditos, límites, Idempotency-Key, ?wait= y trabajo.PATCHActualizar un proyectoCambia el nombre de un proyecto, modifica sus opciones o sustituye sus vehículos o sus artículos (con los grupos).

Autenticación

Parámetros de ruta

Ejemplo de solicitud

Ejemplo de respuesta

Respuestas

Relacionado