Получить проект
Проект с транспортными средствами, позициями, группами, параметрами и сводкой текущего плана (со ссылкой на PDF, пока это план, сохранённый заданием API).
Бесплатно: кредиты не списываются.
Аутентификация
Параметры пути
idstringобязательно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Пример ответа
{
"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"
}
}Ответы
200OKПроект.
ИмяТипОбязательноОписаниеidstringstringНетID проекта (prj_…).
objectstringstringНетprojectnamestringstringНетstatusstringstringНетdraft= ещё не рассчитывался или входные данные заменены;calculated= есть текущий план;stale= после расчёта плана изменились настройки.draftcalculatedstaleerroritem_countintegerintegerНетЕдиниц груза (сумма количеств).
vehicle_countintegerintegerНетТранспортных средств (сумма количеств).
app_urlstringstringНетОткрывает проект в 3D-редакторе приложения.
created_byUserRef | nullUserRef | nullНетУчастник, создавший проект (для вызовов API — участник, создавший ключ).
null, если неизвестно.idstringstringНетID участника (usr_…). Фильтруйте списки через ?created_by=.
namestringstringНетupdated_byUserRef | nullUserRef | nullНетУчастник, последним изменивший проект.
idstringstringНетID участника (usr_…). Фильтруйте списки через ?created_by=.
namestringstringНетcreated_atstringstringНетRFC 3339.
updated_atstringstringНетRFC 3339.
optionsProjectOptionsProjectOptionsНетПараметры расчёта, которые хранит проект.
packing_modestringstringНетauto= когда указанные транспортные средства заполнены, добавляются копии наиболее подходящего (в пределах лимита транспортных средств задания);fleet_only= используются только указанные транспортные средства, всё, что не поместилось, попадает в неразмещённые.autofleet_onlyПо умолчанию"auto"group_routingstringstringНетnone= группы только для информации;wall= каждая группа занимает свою секцию транспортного средства;routing= группы загружаются по порядку, и более поздняя группа может стоять на более ранней или рядом с ней, но не под ней (доставка по нескольким адресам);no_stack= группы загружаются по порядку рядом друг с другом, но не друг на друга.nonewallroutingno_stackПо умолчанию"none"allow_overweightbooleanbooleanНетИгнорировать ограничения грузоподъёмности транспортных средств.
По умолчаниюfalsevehiclesProjectVehicle[]ProjectVehicle[]НетidstringstringНетID слота (pv_…). В результатах заданий проекта — vehicle_id. Только для чтения.
vehicle_idstringобязательноstringДаID транспортного средства из GET /v1/vehicles (пресет или veh_…).
namestringstringНетНазвание сохранённого транспортного средства. Только для чтения.
typestringstringНетТип сохранённого транспортного средства. Только для чтения.
trucktrailerflatbedcontainerpalletaircraftshiplengthnumber · cmnumber · cmНетРазмер, с которым рассчитывается слот; если передать, переопределяет значение сохранённого транспортного средства.
widthnumber · cmnumber · cmНетРазмер, с которым рассчитывается слот; если передать, переопределяет значение сохранённого транспортного средства.
heightnumber · cmnumber · cmНетРазмер, с которым рассчитывается слот; если передать, переопределяет значение сохранённого транспортного средства.
max_weightnumber · kgnumber · kgНетРазмер, с которым рассчитывается слот; если передать, переопределяет значение сохранённого транспортного средства.
quantityintegerintegerНетСколько одинаковых транспортных средств с этим описанием доступно.
По умолчанию11–100aux_deckbooleanbooleanНетУ транспортного средства есть второй ярус (двухъярусная загрузка).
По умолчаниюfalseaux_deck_heightnumber · cmnumber · cmНетВысота второго яруса над полом. Обязательна, если
aux_deckравноtrue.aux_deck_max_weightnumber · kgnumber · kgНетДопустимая нагрузка на второй ярус. Обязательна, если
aux_deckравноtrue.blocked_areasRect[]Rect[]НетЗоны пола, где ничего нельзя ставить (колёсные арки, повреждения, зарезервированное место). Каждая должна лежать в пределах пола транспортного средства.
≤ 32 itemsxnumber · cmобязательноnumber · cmДаРасстояние от передней стенки до ближнего края прямоугольника.
znumber · cmобязательноnumber · cmДаРасстояние от правой стенки (z = 0; справа, если смотреть от дверей внутрь) до ближнего края прямоугольника.
lengthnumber · cmобязательноnumber · cmДаПротяжённость по x.
widthnumber · cmобязательноnumber · cmДаПротяжённость по z.
tractor_weightНужен доступnumber · kgnumber · kgНетМодель осей полуприцепа: масса тягача.
empty_trailer_weightНужен доступnumber · kgnumber · kgНетМодель осей полуприцепа: масса порожнего прицепа.
front_axle_to_middle_axleНужен доступnumber · cmnumber · cmНетМодель осей полуприцепа: от передней оси тягача до ведущей (средней) оси.
front_axle_to_tractor_cogНужен доступnumber · cmnumber · cmНетМодель осей полуприцепа: от передней оси до центра тяжести тягача.
front_axle_to_kingpinНужен доступnumber · cmnumber · cmНетМодель осей полуприцепа: от передней оси до шкворня (седельно-сцепного устройства).
kingpin_to_rear_axleНужен доступnumber · cmnumber · cmНетМодель осей полуприцепа: от шкворня до группы задних осей прицепа.
trailer_cog_to_rear_axleНужен доступnumber · cmnumber · cmНетМодель осей полуприцепа: от центра тяжести прицепа до группы задних осей.
trailer_start_to_kingpinНужен доступnumber · cmnumber · cmНетМодель осей полуприцепа: от передней части прицепа до шкворня.
max_middle_axle_weightНужен доступnumber · kgnumber · kgНетМодель осей полуприцепа: допустимая по закону нагрузка на ведущую (среднюю) ось.
max_rear_axle_weightНужен доступnumber · kgnumber · kgНетМодель осей полуприцепа: допустимая по закону нагрузка на группу задних осей.
itemsItem[]Item[]НетГруз в формате Item из /v1/pack; ID вида item_….
idstringstringНетВаш идентификатор, уникальный в пределах запроса. В результатах — item_id. По умолчанию — template_id.
≤ 128 charstemplate_idstringstringНетID шаблона (tpl_…) из GET /v1/templates. Задаёт все поля позиции; поля, переданные рядом с ним, их переопределяют.
labelstringstringНетОтображаемая метка (по умолчанию — id).
≤ 255 charsshapestringstringНетФорма позиции. Для
cylinderиdrumиспользуютсяradius+heightвместоlength+width;palletиdrumвсегда стоят вертикально.boxcylinderpalletbagdrumПо умолчанию"box"lengthnumber · cmnumber · cmНетДлина. Обязательна, если
shapeнеcylinderи неdrum.widthnumber · cmnumber · cmНетШирина. Обязательна, если
shapeнеcylinderи неdrum.heightnumber · cmобязательноnumber · cmДаВысота (вертикальная сторона, когда груз стоит в исходной ориентации).
radiusnumber · cmnumber · cmНетРадиус. Обязателен, если
shape—cylinderилиdrum.weightnumber · kgобязательноnumber · kgДаВес ОДНОЙ единицы.
quantityintegerintegerНетКоличество одинаковых единиц.
По умолчанию11–10000stackablebooleanbooleanНетСверху можно ставить другие грузы.
По умолчаниюtruemax_stack_weightnumber · kgnumber · kgНетМаксимальный вес, который можно поставить на одну единицу. 0 = без ограничений.
По умолчанию0rotationstringstringНетall= любая из шести ориентаций;upright= только поворот вокруг вертикальной оси (этой стороной вверх);fixed= без поворотов.alluprightfixedПо умолчанию"all"hazardousbooleanbooleanНетОпасный груз: размещается внизу и отдельно от других опасных грузов.
По умолчаниюfalsepriorityintegerintegerНетПриоритет загрузки. Позиции с более высоким приоритетом загружаются раньше и при нехватке места остаются в плане. 0 = без приоритета.
По умолчанию0groupstringstringНетНазвание группы, к которой относится позиция (см.
groupsиoptions.group_routing).colorstringstringНетЦвет отображения в формате #rrggbb (только в просмотрщике и PDF).
nesting_heightnumber · cmnumber · cmНетПерекрытие при вкладывании одинаковых единиц друг в друга (вкладываемые ящики, вёдра).
По умолчанию0groupsGroup[]Group[]НетnamestringобязательноstringДаНазвание группы, на которое ссылается Item.group.
≤ 128 charsorderintegerintegerНетПорядок загрузки (меньше — раньше). По умолчанию — место в списке.
colorstringstringНетЦвет отображения в формате #rrggbb.
planProjectPlan | nullProjectPlan | nullНетТекущий план;
null, если у проекта его нет.items_placedintegerintegerНетРазмещено единиц.
items_unplacedintegerintegerНетЕдиницы, которые не удалось разместить.
vehicles_usedintegerintegerНетТранспортные средства, в которых есть хотя бы одна единица груза.
total_weightnumber · kgnumber · kgНетЗагруженный вес.
volume_utilizationnumbernumberНетСредняя заполненность по объёму задействованных транспортных средств, 0–1.
job_idstringstringНетЗадание API, создавшее этот план, — пока план не менялся. Пусто для плана, созданного или отредактированного в приложении.
pdf_urlstringstringНетСсылка на PDF этого задания (до его expires_at). Иначе пусто.
401Unauthorized
unauthorizedkey_revokedkey_expiredunauthorizedAPI-ключ отсутствует, имеет неверный формат или неизвестен.key_revokedКлюч отозван.key_expiredСрок действия ключа истёк.
Все коды ошибокИмяТипОбязательноОписаниеerrorErrorBodyобязательноErrorBodyДаcodestringобязательноstringДаМашиночитаемый код (snake_case). Ветвите логику по нему, а не по
message.messagestringобязательноstringДаПояснение на английском.
request_idstringобязательноstringДаСовпадает с заголовком X-Request-Id. Указывайте его при обращении в поддержку.
detailsErrorDetail[]ErrorDetail[]НетПроблемы по отдельным полям (
validation_failed).pathstringstringНетJSON-путь к проблемному полю, например items[3].length.
codestringstringНетrequired,invalid_value,out_of_range,duplicate_id,unknown_vehicle,unknown_template,type_not_allowed,unknown_group,does_not_fit,too_many_items,too_many_vehicles,unknown_field,invalid_json.messagestringstringНетПояснение на английском.
403Forbidden
ip_not_allowedsubscription_inactiveaccount_inactivescope_missingip_not_allowedIP-адреса вызывающей стороны нет в списке разрешённых IP для этого ключа.subscription_inactiveУ организации нет активной подписки, включающей API.account_inactiveРабота организации приостановлена, или у неё нет владельца с активной учётной записью.scope_missingУ ключа нет области доступа, необходимой для этого endpoint.
Все коды ошибокИмяТипОбязательноОписаниеerrorErrorBodyобязательноErrorBodyДаcodestringобязательноstringДаМашиночитаемый код (snake_case). Ветвите логику по нему, а не по
message.messagestringобязательноstringДаПояснение на английском.
request_idstringобязательноstringДаСовпадает с заголовком X-Request-Id. Указывайте его при обращении в поддержку.
detailsErrorDetail[]ErrorDetail[]НетПроблемы по отдельным полям (
validation_failed).pathstringstringНетJSON-путь к проблемному полю, например items[3].length.
codestringstringНетrequired,invalid_value,out_of_range,duplicate_id,unknown_vehicle,unknown_template,type_not_allowed,unknown_group,does_not_fit,too_many_items,too_many_vehicles,unknown_field,invalid_json.messagestringstringНетПояснение на английском.
404Not found
project_not_foundproject_not_foundВ вашей организации нет проекта с таким ID.
Все коды ошибокИмяТипОбязательноОписаниеerrorErrorBodyобязательноErrorBodyДаcodestringобязательноstringДаМашиночитаемый код (snake_case). Ветвите логику по нему, а не по
message.messagestringобязательноstringДаПояснение на английском.
request_idstringобязательноstringДаСовпадает с заголовком X-Request-Id. Указывайте его при обращении в поддержку.
detailsErrorDetail[]ErrorDetail[]НетПроблемы по отдельным полям (
validation_failed).pathstringstringНетJSON-путь к проблемному полю, например items[3].length.
codestringstringНетrequired,invalid_value,out_of_range,duplicate_id,unknown_vehicle,unknown_template,type_not_allowed,unknown_group,does_not_fit,too_many_items,too_many_vehicles,unknown_field,invalid_json.messagestringstringНетПояснение на английском.
429Too many requests
rate_limitedrate_limitedСлишком много запросов за текущую минуту, час или сутки (на ключ или на организацию) либо число неудачных попыток аутентификации с вашего IP-адреса превысило 60 в минуту.
Все коды ошибокИмяТипОбязательноОписаниеerrorErrorBodyобязательноErrorBodyДаcodestringобязательноstringДаМашиночитаемый код (snake_case). Ветвите логику по нему, а не по
message.messagestringобязательноstringДаПояснение на английском.
request_idstringобязательноstringДаСовпадает с заголовком X-Request-Id. Указывайте его при обращении в поддержку.
detailsErrorDetail[]ErrorDetail[]НетПроблемы по отдельным полям (
validation_failed).pathstringstringНетJSON-путь к проблемному полю, например items[3].length.
codestringstringНетrequired,invalid_value,out_of_range,duplicate_id,unknown_vehicle,unknown_template,type_not_allowed,unknown_group,does_not_fit,too_many_items,too_many_vehicles,unknown_field,invalid_json.messagestringstringНетПояснение на английском.
500Internal server error
internal_errorinternal_errorСбой на нашей стороне.
Все коды ошибокИмяТипОбязательноОписаниеerrorErrorBodyобязательноErrorBodyДаcodestringобязательноstringДаМашиночитаемый код (snake_case). Ветвите логику по нему, а не по
message.messagestringобязательноstringДаПояснение на английском.
request_idstringобязательноstringДаСовпадает с заголовком X-Request-Id. Указывайте его при обращении в поддержку.
detailsErrorDetail[]ErrorDetail[]НетПроблемы по отдельным полям (
validation_failed).pathstringstringНетJSON-путь к проблемному полю, например items[3].length.
codestringstringНетrequired,invalid_value,out_of_range,duplicate_id,unknown_vehicle,unknown_template,type_not_allowed,unknown_group,does_not_fit,too_many_items,too_many_vehicles,unknown_field,invalid_json.messagestringstringНетПояснение на английском.
503Service unavailable
api_disabledapi_disabledAPI временно отключён (техническое обслуживание) или выключен для организации.
Все коды ошибокИмяТипОбязательноОписаниеerrorErrorBodyобязательноErrorBodyДаcodestringобязательноstringДаМашиночитаемый код (snake_case). Ветвите логику по нему, а не по
message.messagestringобязательноstringДаПояснение на английском.
request_idstringобязательноstringДаСовпадает с заголовком X-Request-Id. Указывайте его при обращении в поддержку.
detailsErrorDetail[]ErrorDetail[]НетПроблемы по отдельным полям (
validation_failed).pathstringstringНетJSON-путь к проблемному полю, например items[3].length.
codestringstringНетrequired,invalid_value,out_of_range,duplicate_id,unknown_vehicle,unknown_template,type_not_allowed,unknown_group,does_not_fit,too_many_items,too_many_vehicles,unknown_field,invalid_json.messagestringstringНетПояснение на английском.