Geliştirici dokümanlarıAPI referansıProjeler

Projeyi getir

Araçları, öğeleri, grupları, seçenekleri ve güncel planının özetiyle birlikte bir proje (plan bir API işinin kaydettiği plan olduğu sürece PDF bağlantısı da gelir).

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

Ücretsiz: kredi harcanmaz.

Kimlik doğrulama

Bearer API anahtarı, gereken yetki:resources:readDaha fazla bilgi

Yol parametreleri

AdTürZorunluAçıklama

idstringzorunlu

string

Evet

Proje ID'si (prj_…).

Örnek istek

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

Örnek yanıt

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

Yanıtlar

200OKProje.Project
AdTürZorunluAçıklama
idstring
string
Hayır
Proje ID'si (prj_…).
objectstring
string
Hayır
project
namestring
string
Hayır
statusstring
string
Hayır
draft = hiç hesaplanmamış ya da girdileri değiştirilmiş; calculated = güncel bir planı var; stale = plan oluşturulduktan sonra bir ayar değişmiş.
draftcalculatedstaleerror
item_countinteger
integer
Hayır
Öğe adedi (quantity değerlerinin toplamı).
vehicle_countinteger
integer
Hayır
Araç sayısı (quantity değerlerinin toplamı).
app_urlstring
string
Hayır
Projeyi uygulamanın 3B düzenleyicisinde açar.
created_byUserRef | null
UserRef | null
Hayır
Projeyi oluşturan üye (API çağrılarında: anahtarı oluşturan üye). Bilinmiyorsa null.
updated_byUserRef | null
UserRef | null
Hayır
Projeyi en son değiştiren üye.
created_atstring
string
Hayır
RFC 3339.
updated_atstring
string
Hayır
RFC 3339.
optionsProjectOptions
ProjectOptions
Hayır
Bir projenin sakladığı yükleme seçenekleri.
vehiclesProjectVehicle[]
ProjectVehicle[]
Hayır
itemsItem[]
Item[]
Hayır
/v1/pack Item biçiminde yük; ID'ler item_… şeklindedir.
groupsGroup[]
Group[]
Hayır
planProjectPlan | null
ProjectPlan | null
Hayır
Güncel plan; projenin planı yoksa null.
401Unauthorizedunauthorizedkey_revokedkey_expiredError
- unauthorizedAPI anahtarı eksik, hatalı biçimde ya da tanınmıyor.
- key_revokedAnahtar iptal edildi.
- key_expiredAnahtarın geçerlilik süresi doldu.
AdTürZorunluAçıklama
errorErrorBodyzorunlu
ErrorBody
Evet
Tüm hata kodları
403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missingError
- ip_not_allowedİsteği gönderen IP, anahtarın izin listesinde değil.
- subscription_inactiveOrganizasyonun API'yi içeren etkin bir aboneliği yok.
- account_inactiveOrganizasyon askıya alınmış ya da hesabı etkin olan bir organizasyon sahibi yok.
- scope_missingAnahtarda bu endpoint'in gerektirdiği bir yetki eksik.
AdTürZorunluAçıklama
errorErrorBodyzorunlu
ErrorBody
Evet
Tüm hata kodları
404Not foundproject_not_foundError
- project_not_foundOrganizasyonunuzda bu ID'ye sahip bir proje yok.
AdTürZorunluAçıklama
errorErrorBodyzorunlu
ErrorBody
Evet
Tüm hata kodları
429Too many requestsrate_limitedError
- rate_limitedGeçerli dakika, saat ya da gün içinde çok fazla istek gönderildi (anahtar ya da organizasyon başına) veya IP adresinizden gelen başarısız kimlik doğrulama denemeleri dakikada 60 sınırını aştı.
AdTürZorunluAçıklama
errorErrorBodyzorunlu
ErrorBody
Evet
Tüm hata kodları
500Internal server errorinternal_errorError
- internal_errorBizim tarafımızda bir hata oluştu.
AdTürZorunluAçıklama
errorErrorBodyzorunlu
ErrorBody
Evet
Tüm hata kodları
503Service unavailableapi_disabledError
- api_disabledAPI geçici olarak devre dışı (bakım) ya da organizasyon için kapatılmış.
AdTürZorunluAçıklama
errorErrorBodyzorunlu
ErrorBody
Evet
Tüm hata kodları

POSTProjeyi hesaplaProjenin araçları ve öğeleri için yükleme planını tıpkı POST /v1/pack gibi hesaplar: aynı fiyat, kredi rezervasyonu, limitler, Idempotency-Key, ?wait= ve iş.PATCHProjeyi güncelleProjeyi yeniden adlandırır, seçeneklerini değiştirir ya da araçlarını veya öğelerini (gruplarıyla birlikte) baştan değiştirir.

Kimlik doğrulama

Yol parametreleri

Örnek istek

Örnek yanıt

Yanıtlar

İlgili