Tài liệu cho nhà phát triểnTham chiếu APIDự án

Xem dự án

Một dự án cùng xe, kiện hàng, nhóm, tùy chọn và tóm tắt sơ đồ hiện tại (kèm liên kết PDF khi sơ đồ đó do một tác vụ API lưu).

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

Miễn phí: không trừ credit.

Xác thực

Khóa API dạng Bearer, phạm vi quyềnresources:readTìm hiểu thêm

Tham số đường dẫn

TênKiểuBắt buộcMô tả

idstringbắt buộc

string

Có

ID dự án (prj_…).

Yêu cầu mẫu

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

Phản hồi mẫu

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

Phản hồi

200OKDự án.Project
TênKiểuBắt buộcMô tả
idstring
string
Không
ID dự án (prj_…).
objectstring
string
Không
project
namestring
string
Không
statusstring
string
Không
draft = chưa từng xếp hoặc dữ liệu đầu vào đã bị thay; calculated = có sơ đồ hiện tại; stale = một cài đặt đã thay đổi sau khi lập sơ đồ.
draftcalculatedstaleerror
item_countinteger
integer
Không
Số kiện (tổng số lượng).
vehicle_countinteger
integer
Không
Số xe (tổng số lượng).
app_urlstring
string
Không
Mở dự án trong trình chỉnh sửa 3D của ứng dụng.
created_byUserRef | null
UserRef | null
Không
Thành viên đã tạo (với lệnh gọi API: thành viên đã tạo khóa). null nếu không xác định.
updated_byUserRef | null
UserRef | null
Không
Thành viên thay đổi gần nhất.
created_atstring
string
Không
RFC 3339.
updated_atstring
string
Không
RFC 3339.
optionsProjectOptions
ProjectOptions
Không
Các tùy chọn xếp hàng mà dự án lưu.
vehiclesProjectVehicle[]
ProjectVehicle[]
Không
itemsItem[]
Item[]
Không
Hàng hóa theo cấu trúc Item của /v1/pack; ID có dạng item_….
groupsGroup[]
Group[]
Không
planProjectPlan | null
ProjectPlan | null
Không
Sơ đồ hiện tại; null khi dự án chưa có sơ đồ.
401Unauthorizedunauthorizedkey_revokedkey_expiredError
- unauthorizedThiếu khóa API, khóa sai định dạng hoặc không xác định.
- key_revokedKhóa đã bị thu hồi.
- key_expiredKhóa đã quá ngày hết hạn.
TênKiểuBắt buộcMô tả
errorErrorBodybắt buộc
ErrorBody
Có
Tất cả mã lỗi
403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missingError
- ip_not_allowedIP gọi đến không nằm trong danh sách IP được phép của khóa.
- subscription_inactiveTổ chức không có gói đăng ký đang hoạt động nào bao gồm API.
- account_inactiveTổ chức bị tạm ngưng, hoặc không có chủ sở hữu nào có tài khoản đang hoạt động.
- scope_missingKhóa thiếu phạm vi quyền mà endpoint này yêu cầu.
TênKiểuBắt buộcMô tả
errorErrorBodybắt buộc
ErrorBody
Có
Tất cả mã lỗi
404Not foundproject_not_foundError
- project_not_foundTổ chức của bạn không có dự án nào với ID này.
TênKiểuBắt buộcMô tả
errorErrorBodybắt buộc
ErrorBody
Có
Tất cả mã lỗi
429Too many requestsrate_limitedError
- rate_limitedQuá nhiều yêu cầu trong phút, giờ hoặc ngày hiện tại (theo khóa hoặc theo tổ chức), hoặc có hơn 60 lần xác thực thất bại mỗi phút từ địa chỉ IP của bạn.
TênKiểuBắt buộcMô tả
errorErrorBodybắt buộc
ErrorBody
Có
Tất cả mã lỗi
500Internal server errorinternal_errorError
- internal_errorĐã xảy ra lỗi ở phía chúng tôi.
TênKiểuBắt buộcMô tả
errorErrorBodybắt buộc
ErrorBody
Có
Tất cả mã lỗi
503Service unavailableapi_disabledError
- api_disabledAPI tạm thời bị tắt (bảo trì) hoặc đã bị tắt cho tổ chức.
TênKiểuBắt buộcMô tả
errorErrorBodybắt buộc
ErrorBody
Có
Tất cả mã lỗi

POSTXếp hàng cho dự ánXếp xe và kiện hàng của dự án y hệt POST /v1/pack: cùng giá, cùng cơ chế tạm giữ credit, giới hạn, Idempotency-Key, ?wait= và tác vụ.PATCHCập nhật dự ánĐổi tên dự án, thay đổi tùy chọn, hoặc thay toàn bộ xe hay kiện hàng (kèm nhóm).

Xác thực

Tham số đường dẫn

Yêu cầu mẫu

Phản hồi mẫu

Phản hồi

Liên quan