開発者向けドキュメントAPI referenceProjects

Get a project

A project with its vehicles, items, groups, options and a summary of its current plan (with the PDF link while the plan is the one an API job saved).

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

Free: no credits are charged.

認証

Bearer API キー（必要なスコープ）resources:read詳細を見る

パスパラメーター

名前型必須説明

idstring必須

string

はい

Project id (prj_…).

リクエストの例

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

レスポンスの例

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

レスポンス

200OKThe project.Project
名前型必須説明
idstring
string
いいえ
Project id (prj_…).
objectstring
string
いいえ
project
namestring
string
いいえ
statusstring
string
いいえ
draft = never packed or inputs replaced; calculated = has a current plan; stale = a setting changed since the plan was made.
draftcalculatedstaleerror
item_countinteger
integer
いいえ
Item units (sum of quantities).
vehicle_countinteger
integer
いいえ
Vehicles (sum of quantities).
app_urlstring
string
いいえ
Opens the project in the app's 3D editor.
created_byUserRef | null
UserRef | null
いいえ
The member who created it (for API calls: the member who created the key). null when unknown.
updated_byUserRef | null
UserRef | null
いいえ
The member who last changed it.
created_atstring
string
いいえ
RFC 3339.
updated_atstring
string
いいえ
RFC 3339.
optionsProjectOptions
ProjectOptions
いいえ
The pack options a project stores.
vehiclesProjectVehicle[]
ProjectVehicle[]
いいえ
itemsItem[]
Item[]
いいえ
Cargo in the /v1/pack Item shape; ids are item_….
groupsGroup[]
Group[]
いいえ
planProjectPlan | null
ProjectPlan | null
いいえ
The current plan; null when the project has none.
401Unauthorizedunauthorizedkey_revokedkey_expiredError
- unauthorizedMissing, malformed or unknown API key.
- key_revokedThe key was revoked.
- key_expiredThe key passed its expiry date.
名前型必須説明
errorErrorBody必須
ErrorBody
はい
すべてのエラーコード
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.
名前型必須説明
errorErrorBody必須
ErrorBody
はい
すべてのエラーコード
404Not foundproject_not_foundError
- project_not_foundNo project with this id in your organization.
名前型必須説明
errorErrorBody必須
ErrorBody
はい
すべてのエラーコード
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.
名前型必須説明
errorErrorBody必須
ErrorBody
はい
すべてのエラーコード
500Internal server errorinternal_errorError
- internal_errorSomething failed on our side.
名前型必須説明
errorErrorBody必須
ErrorBody
はい
すべてのエラーコード
503Service unavailableapi_disabledError
- api_disabledThe API is temporarily disabled (maintenance) or switched off for the organization.
名前型必須説明
errorErrorBody必須
ErrorBody
はい
すべてのエラーコード

POSTPack a projectPacks the project's vehicles and items exactly like POST /v1/pack: same price, credit reservation, limits, Idempotency-Key, ?wait= and job.PATCHUpdate a projectRenames a project, changes its options, or replaces its vehicles or its items (with groups).

認証

パスパラメーター

リクエストの例

レスポンスの例

レスポンス

関連項目