Utwórz zadanie załadunku
Waliduje zapytanie, rezerwuje z Twoich kredytów maksymalną możliwą cenę i dodaje zadanie do kolejki.
Odpowiada kodem 202 i zwraca zadanie; odpytuj GET /v1/jobs/{id} albo przekaż ?wait=, aby wstrzymać odpowiedź do jego zakończenia. Błędy walidacji (422) są bezpłatne i nie tworzą zadania.
Uwierzytelnianie
Parametry zapytania
waitintegerIle sekund wstrzymać odpowiedź w oczekiwaniu na zakończenie zadania. Zakończone na czas: 200 z wynikiem w odpowiedzi. W przeciwnym razie: 202.
00–60Parametry nagłówka
Idempotency-KeystringDowolny unikalny ciąg znaków, np. UUID lub numer Twojego zamówienia. Ten sam klucz w ciągu 24 h zwraca pierwotne zadanie zamiast tworzyć i rozliczać nowe.
Parametry treści
application/jsonreferencestringTwój własny numer referencyjny (numer zamówienia, ID przesyłki…). Zwracany w zadaniu.
vehiclesVehicle[]wymaganeDefinicje pojazdów. Każda może mieć quantity > 1. Co najmniej jedna.
idstringTwój identyfikator, unikalny w obrębie zapytania. Wyniki odwołują się do niego jako vehicle_id. Domyślnie vehicle_id.
vehicle_idstringID pojazdu z GET /v1/vehicles: preset lub pojazd Twojej organizacji (veh_…). Dostarcza typ, nazwę, wymiary, ładowność i wszystkie inne zapisane wartości.
typestringTyp pojazdu. Wymagany, jeśli nie podano vehicle_id. Akceptowane są tylko typy wymienione w GET /v1/limits (allowed_vehicle_types).
trucktrailerflatbedcontainerpalletaircraftshipnamestringWyświetlana nazwa (domyślnie nazwa zapisanego pojazdu lub ID).
lengthnumber · cmWewnętrzna długość przestrzeni ładunkowej, wzdłuż osi x (od przedniej ściany w stronę drzwi). Wymagana, jeśli nie podano vehicle_id.
widthnumber · cmWewnętrzna szerokość przestrzeni ładunkowej, wzdłuż osi z. Wymagana, jeśli nie podano vehicle_id.
heightnumber · cmWewnętrzna wysokość przestrzeni ładunkowej, wzdłuż osi y. Wymagana, jeśli nie podano vehicle_id.
max_weightnumber · kgMaksymalna ładowność. Wymagana, jeśli nie podano vehicle_id.
quantityintegerLiczba dostępnych identycznych pojazdów tej definicji.
11–100floor_load_capacitynumber · kg/m²Nośność podłogi: 0 lub więcej (0 = bez limitu).
aux_deckbooleanPojazd ma drugi pokład (dwupoziomowy).
falseaux_deck_heightnumber · cmWysokość drugiego pokładu nad podłogą. Wymagana, gdy aux_deck ma wartość true.
aux_deck_max_weightnumber · kgLimit obciążenia drugiego pokładu. Wymagany, gdy aux_deck ma wartość true.
blocked_areasRect[]Obszary podłogi, na których nic nie może stać (nadkola, uszkodzenia, zarezerwowane miejsce). Każdy musi leżeć na podłodze pojazdu.
xnumber · cmwymaganeOdległość od przedniej ściany do bliższej krawędzi prostokąta.
znumber · cmwymaganeOdległość od prawej ściany (z = 0; prawej, patrząc od drzwi do wnętrza) do bliższej krawędzi prostokąta.
lengthnumber · cmwymaganeRozmiar wzdłuż osi x.
widthnumber · cmwymaganeRozmiar wzdłuż osi z.
axle_positionsWymaga dostępunumber[] · cmPołożenia osi (punktów podparcia) liczone od przodu przestrzeni ładunkowej; ujemne = przed nią. Tyle samo elementów co axle_max_loads. Każda wartość od −300 (oś przed przestrzenią ładunkową, np. przednia oś pod kabiną w ciężarówce solo) do długości pojazdu.
axle_max_loadsWymaga dostępunumber[] · kgMaksymalny nacisk ładunku na każdą oś, w kolejności z axle_positions. Każda wartość większa od 0 i nie większa niż 100000.
cog_range_xWymaga dostępunumber · cmDopuszczalne odchylenie środka ciężkości od środka długości: od 0 do length / 2.
cog_range_yWymaga dostępunumber · cmDopuszczalne odchylenie środka ciężkości od środka szerokości: od 0 do width / 2.
tractor_weightWymaga dostępunumber · kgModel osi naczepy: masa ciągnika.
empty_trailer_weightWymaga dostępunumber · kgModel osi naczepy: masa pustej naczepy.
front_axle_to_middle_axleWymaga dostępunumber · cmModel osi naczepy: od osi przedniej ciągnika do osi napędowej (środkowej).
front_axle_to_tractor_cogWymaga dostępunumber · cmModel osi naczepy: od osi przedniej do środka ciężkości ciągnika.
front_axle_to_kingpinWymaga dostępunumber · cmModel osi naczepy: od osi przedniej do sworznia królewskiego (siodła).
kingpin_to_rear_axleWymaga dostępunumber · cmModel osi naczepy: od sworznia królewskiego do grupy osi tylnych naczepy.
trailer_cog_to_rear_axleWymaga dostępunumber · cmModel osi naczepy: od środka ciężkości naczepy do grupy osi tylnych.
trailer_start_to_kingpinWymaga dostępunumber · cmModel osi naczepy: od przodu naczepy do sworznia królewskiego.
max_middle_axle_weightWymaga dostępunumber · kgModel osi naczepy: dopuszczalny nacisk na oś napędową (środkową).
max_rear_axle_weightWymaga dostępunumber · kgModel osi naczepy: dopuszczalny nacisk na grupę osi tylnych.
itemsItem[]wymaganeDefinicje pozycji. Każda może mieć quantity > 1. Co najmniej jedna.
idstringTwój identyfikator, unikalny w obrębie zapytania. Wyniki odwołują się do niego jako item_id. Domyślnie template_id.
template_idstringID szablonu (tpl_…) z GET /v1/templates. Dostarcza wszystkie pola pozycji; pola wysłane obok niego je nadpisują.
labelstringWyświetlana etykieta (domyślnie ID).
shapestringKształt pozycji. cylinder i drum używają radius + height zamiast length + width; pallet i drum zawsze stoją pionowo.
boxcylinderpalletbagdrumDomyślnie "box"lengthnumber · cmDługość. Wymagana, chyba że shape to cylinder lub drum.
widthnumber · cmSzerokość. Wymagana, chyba że shape to cylinder lub drum.
heightnumber · cmwymaganeWysokość (bok pionowy, gdy pozycja stoi zgodnie z definicją).
radiusnumber · cmPromień. Wymagany, gdy shape to cylinder lub drum.
weightnumber · kgwymaganeWaga JEDNEJ sztuki.
quantityintegerLiczba identycznych sztuk.
11–10000stackablebooleanNa tej pozycji można stawiać inne pozycje.
truemax_stack_weightnumber · kgMaksymalna waga, która może spoczywać na jednej sztuce. 0 = bez limitu.
0rotationstringall = dowolna z sześciu orientacji; upright = obrót tylko wokół osi pionowej (tą stroną do góry); fixed = bez obracania.
alluprightfixedDomyślnie "all"hazardousbooleanTowary niebezpieczne: umieszczane nisko i z dala od innych towarów niebezpiecznych.
falsepriorityintegerPriorytet załadunku. Wyższy = ładowana wcześniej i zachowywana, gdy brakuje miejsca. 0 = brak.
0groupstringNazwa grupy, do której należy pozycja (zob. groups i options.group_routing).
colorstringKolor wyświetlania w formacie #rrggbb (tylko podgląd i PDF).
nesting_heightnumber · cmGłębokość, na jaką identyczne sztuki wsuwają się w siebie przy piętrowaniu (skrzynki, wiadra).
0groupsGroup[]Opcjonalne grupy (klienci, punkty dostawy, zamówienia). Wymagane dla każdej grupy wskazanej przez pozycję, gdy options.group_routing jest inne niż "none"; w przeciwnym razie grupy są tworzone z nazw grup pozycji w kolejności wystąpienia.
namestringwymaganeNazwa grupy, do której odwołuje się Item.group.
orderintegerKolejność załadunku (niższa = ładowana wcześniej). Domyślnie miejsce na liście.
colorstringKolor wyświetlania w formacie #rrggbb.
optionsOptionsOpcje załadunku. Wszystkie pola są opcjonalne.
packing_modestringauto = gdy podane pojazdy są pełne, dodawane są kolejne egzemplarze najlepiej pasującego pojazdu (do limitu pojazdów zadania); fleet_only = używane są tylko podane pojazdy, a wszystko, co się nie zmieści, jest zgłaszane jako nierozmieszczone.
autofleet_onlyDomyślnie "auto"group_routingstringnone = grupy mają charakter informacyjny; wall = każda grupa dostaje własną sekcję pojazdu; routing = grupy są ładowane po kolei, a późniejsza grupa może stać na wcześniejszej lub obok niej, ale nigdy pod nią (dostawy do wielu punktów); no_stack = grupy są ładowane po kolei obok siebie, nigdy jedna na drugiej.
nonewallroutingno_stackDomyślnie "none"allow_overweightbooleanIgnoruj limity ładowności pojazdów.
falsemax_stack_itemsintegerMaksymalna liczba sztuk w jednym stosie. 0 = bez limitu.
0max_stack_density_kg_m2number · kg/m²Maksymalna waga stosu na jednostkę powierzchni podłogi. 0 = bez limitu.
0lock_rotationsbooleanZachowaj pierwszą orientację, która mieści się w wysokości pojazdu.
falsegroup_identical_binsbooleanTraktuj identyczne pojazdy jako jedną pulę.
falsetime_limitnumber · sGórny limit czasu obliczeń dla całego zadania. 0 = automatycznie (maks. max_time_limit_seconds z GET /v1/limits). Po osiągnięciu limitu zwracany jest najlepszy dotąd znaleziony plan. Płacisz tylko za faktycznie zużyty czas obliczeń.
0enforce_axleWymaga dostępubooleanOdrzucaj rozmieszczenia przeciążające grupę osi w pojazdach, które mają wypełnione wszystkie dziesięć pól modelu osi.
falsePrzykładowe zapytanie
curl -X POST "https://runner.cargoduo.com/v1/pack" \
-H "Authorization: Bearer $CARGODUO_API_KEY" \
-H "Idempotency-Key: order-1042-v1" \
-H "Content-Type: application/json" \
-d '{
"reference": "order-1042",
"vehicles": [
{
"id": "trailer",
"type": "trailer",
"name": "13.6 m trailer",
"length": 1360,
"width": 245,
"height": 270,
"max_weight": 24000
}
],
"items": [
{
"id": "pallet-eu",
"label": "Euro pallet",
"length": 120,
"width": 80,
"height": 140,
"weight": 450,
"quantity": 18,
"stackable": false
},
{
"id": "carton-a",
"label": "Carton A",
"length": 60,
"width": 40,
"height": 40,
"weight": 12,
"quantity": 40,
"rotation": "upright"
}
],
"options": {
"packing_mode": "auto"
}
}'const res = await fetch("https://runner.cargoduo.com/v1/pack", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CARGODUO_API_KEY}`,
"Idempotency-Key": "order-1042-v1",
"Content-Type": "application/json",
},
body: JSON.stringify({
"reference": "order-1042",
"vehicles": [
{
"id": "trailer",
"type": "trailer",
"name": "13.6 m trailer",
"length": 1360,
"width": 245,
"height": 270,
"max_weight": 24000
}
],
"items": [
{
"id": "pallet-eu",
"label": "Euro pallet",
"length": 120,
"width": 80,
"height": 140,
"weight": 450,
"quantity": 18,
"stackable": false
},
{
"id": "carton-a",
"label": "Carton A",
"length": 60,
"width": 40,
"height": 40,
"weight": 12,
"quantity": 40,
"rotation": "upright"
}
],
"options": {
"packing_mode": "auto"
}
}),
});
const data = await res.json();
console.log(res.status, data);import os
import requests
response = requests.post(
"https://runner.cargoduo.com/v1/pack",
headers={"Authorization": f"Bearer {os.environ['CARGODUO_API_KEY']}", "Idempotency-Key": "order-1042-v1"},
json={
"reference": "order-1042",
"vehicles": [
{
"id": "trailer",
"type": "trailer",
"name": "13.6 m trailer",
"length": 1360,
"width": 245,
"height": 270,
"max_weight": 24000,
},
],
"items": [
{
"id": "pallet-eu",
"label": "Euro pallet",
"length": 120,
"width": 80,
"height": 140,
"weight": 450,
"quantity": 18,
"stackable": False,
},
{
"id": "carton-a",
"label": "Carton A",
"length": 60,
"width": 40,
"height": 40,
"weight": 12,
"quantity": 40,
"rotation": "upright",
},
],
"options": {
"packing_mode": "auto",
},
},
)
print(response.status_code, response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"reference": "order-1042",
"vehicles": [
{
"id": "trailer",
"type": "trailer",
"name": "13.6 m trailer",
"length": 1360,
"width": 245,
"height": 270,
"max_weight": 24000
}
],
"items": [
{
"id": "pallet-eu",
"label": "Euro pallet",
"length": 120,
"width": 80,
"height": 140,
"weight": 450,
"quantity": 18,
"stackable": false
},
{
"id": "carton-a",
"label": "Carton A",
"length": 60,
"width": 40,
"height": 40,
"weight": 12,
"quantity": 40,
"rotation": "upright"
}
],
"options": {
"packing_mode": "auto"
}
}`)
req, err := http.NewRequest("POST", "https://runner.cargoduo.com/v1/pack", body)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CARGODUO_API_KEY"))
req.Header.Set("Idempotency-Key", "order-1042-v1")
req.Header.Set("Content-Type", "application/json")
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 {
String body = """
{
"reference": "order-1042",
"vehicles": [
{
"id": "trailer",
"type": "trailer",
"name": "13.6 m trailer",
"length": 1360,
"width": 245,
"height": 270,
"max_weight": 24000
}
],
"items": [
{
"id": "pallet-eu",
"label": "Euro pallet",
"length": 120,
"width": 80,
"height": 140,
"weight": 450,
"quantity": 18,
"stackable": false
},
{
"id": "carton-a",
"label": "Carton A",
"length": 60,
"width": 40,
"height": 40,
"weight": 12,
"quantity": 40,
"rotation": "upright"
}
],
"options": {
"packing_mode": "auto"
}
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://runner.cargoduo.com/v1/pack"))
.header("Authorization", "Bearer " + System.getenv("CARGODUO_API_KEY"))
.header("Idempotency-Key", "order-1042-v1")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(body))
.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"));
client.DefaultRequestHeaders.Add("Idempotency-Key", "order-1042-v1");
var json = """
{
"reference": "order-1042",
"vehicles": [
{
"id": "trailer",
"type": "trailer",
"name": "13.6 m trailer",
"length": 1360,
"width": 245,
"height": 270,
"max_weight": 24000
}
],
"items": [
{
"id": "pallet-eu",
"label": "Euro pallet",
"length": 120,
"width": 80,
"height": 140,
"weight": 450,
"quantity": 18,
"stackable": false
},
{
"id": "carton-a",
"label": "Carton A",
"length": 60,
"width": 40,
"height": 40,
"weight": 12,
"quantity": 40,
"rotation": "upright"
}
],
"options": {
"packing_mode": "auto"
}
}
""";
var request = new HttpRequestMessage(HttpMethod.Post, "https://runner.cargoduo.com/v1/pack")
{
Content = new StringContent(json, Encoding.UTF8, "application/json"),
};
var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");<?php
$payload = <<<'JSON'
{
"reference": "order-1042",
"vehicles": [
{
"id": "trailer",
"type": "trailer",
"name": "13.6 m trailer",
"length": 1360,
"width": 245,
"height": 270,
"max_weight": 24000
}
],
"items": [
{
"id": "pallet-eu",
"label": "Euro pallet",
"length": 120,
"width": 80,
"height": 140,
"weight": 450,
"quantity": 18,
"stackable": false
},
{
"id": "carton-a",
"label": "Carton A",
"length": 60,
"width": 40,
"height": 40,
"weight": 12,
"quantity": 40,
"rotation": "upright"
}
],
"options": {
"packing_mode": "auto"
}
}
JSON;
$ch = curl_init('https://runner.cargoduo.com/v1/pack');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('CARGODUO_API_KEY'),
'Idempotency-Key: order-1042-v1',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => $payload,
]);
$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/pack")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("CARGODUO_API_KEY")}"
request["Idempotency-Key"] = "order-1042-v1"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
{
"reference": "order-1042",
"vehicles": [
{
"id": "trailer",
"type": "trailer",
"name": "13.6 m trailer",
"length": 1360,
"width": 245,
"height": 270,
"max_weight": 24000
}
],
"items": [
{
"id": "pallet-eu",
"label": "Euro pallet",
"length": 120,
"width": 80,
"height": 140,
"weight": 450,
"quantity": 18,
"stackable": false
},
{
"id": "carton-a",
"label": "Carton A",
"length": 60,
"width": 40,
"height": 40,
"weight": 12,
"quantity": 40,
"rotation": "upright"
}
],
"options": {
"packing_mode": "auto"
}
}
JSON
response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.code, response.bodyPrzykładowa odpowiedź
{
"id": "job_4bK9mT2xQe7LpW1zRc8VdN3f",
"object": "job",
"status": "queued",
"reference": "order-1042",
"source": "api",
"created_at": "2026-10-19T09:12:03Z",
"started_at": null,
"finished_at": null,
"progress": {
"stage": "queued",
"vehicles_done": 0,
"placed_items": 0
},
"summary": {
"items_requested": 58,
"items_placed": 0,
"items_unplaced": 0,
"vehicles_used": 0,
"total_weight": 0,
"volume_utilization": 0,
"queue_ms": 0,
"compute_ms": 0
},
"cost": {
"credits": 0,
"reserved_credits": 1.11,
"rate_card_version": 1,
"breakdown": {
"base": 0,
"vehicles": 0,
"compute": 0,
"large_load": 0
}
},
"error": null,
"warnings": [],
"result_url": "https://runner.cargoduo.com/v1/jobs/job_4bK9mT2xQe7LpW1zRc8VdN3f/result",
"pdf_url": "",
"expires_at": "2026-11-02T09:12:03Z"
}Odpowiedzi
200OKZadanie zakończyło się w czasie ?wait, wynik jest w odpowiedzi. Także idempotentne powtórzenie zakończonego zadania.
NazwaTypWymaganyOpisidstringwymaganestringTakID zadania (job_…).
objectstringwymaganestringTakZawsze
job.jobstatusstringwymaganestringTakqueued→running→succeeded|failed|canceled.queuedrunningsucceededfailedcanceledreferencestringstringNieTwój numer referencyjny z zapytania.
sourcestringstringNieGdzie utworzono zadanie.
apiplaygroundproject_idstringstringNieProjekt (prj_…), w którym zadanie POST /v1/projects/{id}/pack zapisuje swój plan. Brak w innych zadaniach.
created_atstringwymaganestringTakZnacznik czasu RFC 3339.
started_atstring | nullstring | nullNieKiedy rozpoczęły się obliczenia (RFC 3339), albo
null.finished_atstring | nullstring | nullNieKiedy zadanie się zakończyło (RFC 3339), albo
null.progressJobProgressJobProgressNieBieżący postęp, gdy zadanie czeka w kolejce lub jest w toku.
stagestringstringNieBieżący etap, np.
queued,running,finalizinglubdone. Tylko informacyjnie: logikę opieraj naJob.status.vehicles_doneintegerintegerNieDotychczas załadowane pojazdy.
placed_itemsintegerintegerNieDotychczas rozmieszczone sztuki.
summaryJobSummaryJobSummaryNieLiczniki i czasy.
items_requestedintegerintegerNieŁączna liczba sztuk (suma ilości).
items_placedintegerintegerNieRozmieszczone sztuki.
items_unplacedintegerintegerNieSztuki, których nie udało się rozmieścić.
vehicles_usedintegerintegerNiePojazdy z co najmniej jedną pozycją.
total_weightnumber · kgnumber · kgNieZaładowana waga.
volume_utilizationnumbernumberNieŚrednie wykorzystanie objętości użytych pojazdów, 0–1.
queue_msintegerintegerNieCzas oczekiwania na zasoby obliczeniowe (bezpłatny).
compute_msintegerintegerNieCzas obliczeń (płatny).
costJobCostJobCostNiePobrane kredyty (ostateczne po zakończeniu zadania) i rezerwacja utrzymywana w trakcie jego trwania.
creditsnumber · creditsnumber · creditsNiePobrane kredyty (0 do zakończenia zadania). Za zadania zakończone błędem nie pobieramy opłat, z wyjątkiem time_limit_exceeded, rozliczanego jak anulowane zadanie.
reserved_creditsnumber · creditsnumber · creditsNieKredyty zablokowane, gdy zadanie czekało w kolejce lub było w toku (maksymalna możliwa cena). Zwalniane po jego zakończeniu.
rate_card_versionintegerintegerNieCennik, według którego wyceniono zadanie.
breakdownCostBreakdownCostBreakdownNieCena w rozbiciu na składniki.
basenumber · creditsnumber · creditsNieOpłata za zadanie.
vehiclesnumber · creditsnumber · creditsNieZa każdy załadowany pojazd (nie jest pobierana w zadaniach anulowanych ani zakończonych z time_limit_exceeded).
computenumber · creditsnumber · creditsNieZa sekundę obliczeń, naliczane proporcjonalnie co do milisekundy.
large_loadnumber · creditsnumber · creditsNieDopłata za każde rozpoczęte 100 sztuk powyżej progu dużego ładunku.
errorJobError | nullJobError | nullNieDlaczego zadanie zakończyło się błędem lub zostało anulowane; w przeciwnym razie
null.codestringstringNieKod maszynowy (zob. Błędy).
messagestringstringNieWyjaśnienie po angielsku.
warningsWarning[]Warning[]NieUwagi do zapytania, które nie blokują zadania (powtórzone także w wyniku).
codestringstringNieKod maszynowy.
messagestringstringNieWyjaśnienie po angielsku.
result_urlstringstringNieWywołaj GET na ten URL, aby pobrać pełny wynik, gdy
statusma wartośćsucceeded.pdf_urlstringstringNieLink otwierany w przeglądarce, który generuje plan załadunku jako PDF (widoki 3D + kroki załadunku). Ważny do expires_at. Po wygaśnięciu pusty.
expires_atstringstringNieKiedy treści zapytania i wyniku oraz link do PDF zostaną usunięte (RFC 3339). Metadane zadania i opłaty są zachowywane.
resultResultResultNiePełny wynik, dołączany tylko na żądanie (?include=result) lub gdy POST /v1/pack?wait= zakończy się na czas.
job_idstringstringNieZadanie.
vehiclesResultVehicle[]ResultVehicle[]NieZaładowane pojazdy w kolejności załadunku (puste pojazdy są pomijane).
indexintegerintegerNieIndeks w planie, liczony od 0.
vehicle_idstringstringNieID Twojej definicji pojazdu (w zadaniu projektu: ID slotu, pv_…).
copyintegerintegerNieNumer egzemplarza tej definicji, liczony od 1 (quantity > 1 lub dodany w trybie auto).
auto_addedbooleanbooleanNieDodany przez
packing_modeautoponad podanąquantity.namestringstringNieNazwa pojazdu.
typestringstringNieTyp pojazdu.
lengthnumber · cmnumber · cmNieDługość przestrzeni ładunkowej.
widthnumber · cmnumber · cmNieSzerokość przestrzeni ładunkowej.
heightnumber · cmnumber · cmNieWysokość przestrzeni ładunkowej.
max_weightnumber · kgnumber · kgNieLimit ładowności.
items_placedintegerintegerNieSztuki w tym pojeździe.
total_weightnumber · kgnumber · kgNieWaga ładunku w tym pojeździe.
volume_utilizationnumbernumberNieWykorzystana objętość / objętość przestrzeni ładunkowej, 0–1.
weight_utilizationnumbernumberNietotal_weight / max_weight, 0–1 (może przekroczyć 1 przy allow_overweight).
center_of_gravityPointPointNieŚrodek ciężkości ładunku (cm).
xnumber · cmnumber · cmNieynumber · cmnumber · cmNieznumber · cmnumber · cmNieplacementsPlacement[]Placement[]NieWszystkie sztuki w tym pojeździe.
item_idstringstringNieID Twojej definicji pozycji (w zadaniu projektu: ID pozycji, item_…).
instanceintegerintegerNieNumer sztuki w obrębie definicji pozycji, liczony od 1 (unikalny w całym planie).
labelstringstringNieEtykieta pozycji.
xnumber · cmnumber · cmNiePołożenie narożnika minimalnego wzdłuż długości.
ynumber · cmnumber · cmNieWysokość narożnika minimalnego nad podłogą.
znumber · cmnumber · cmNiePołożenie narożnika minimalnego w poprzek szerokości.
lengthnumber · cmnumber · cmNieWymiar wzdłuż osi x po rozmieszczeniu.
widthnumber · cmnumber · cmNieWymiar wzdłuż osi z po rozmieszczeniu.
heightnumber · cmnumber · cmNieWymiar wzdłuż osi y po rozmieszczeniu.
rotatedbooleanbooleanNieUmieszczona w innej orientacji niż zdefiniowana.
orientationstringstringNieKtóry zdefiniowany bok leży wzdłuż osi x, z i y:
lwh= zgodnie z definicją,wlh= obrócona o 90° wokół osi pionowej,lhw,hwl,whl,hlw= przewrócona na bok.stepintegerintegerNieKrok załadunku w pojeździe, liczony od 1 (ładuj w kolejności rosnącej).
weightnumber · kgnumber · kgNieWaga sztuki.
axle_loadsWymaga dostępuAxleLoad[]AxleLoad[]NieNacisk na każdą oś (tylko pojazdy z danymi osi).
namestringstringNieAxle 1,Axle 2… w kolejności zaxle_positions.positionnumber · cmnumber · cmNiePołożenie osi liczone od przodu przestrzeni ładunkowej.
loadnumber · kgnumber · kgNieNacisk ładunku na oś.
maxnumber · kgnumber · kgNieSkonfigurowane maksimum (0 = brak).
okbooleanbooleanNieload≤max(zawszetrue, gdy nie ustawiono maksimum).unplacedUnplacedItem[]UnplacedItem[]NieSztuki, których nie udało się rozmieścić, wraz z przyczyną.
item_idstringstringNieID Twojej definicji pozycji.
instanceintegerintegerNieNumer sztuki, liczony od 1.
labelstringstringNieEtykieta pozycji.
reasonstringstringNieDlaczego nie udało się jej rozmieścić.
warningsWarning[]Warning[]NieUwagi do planu.
codestringstringNieKod maszynowy.
messagestringstringNieWyjaśnienie po angielsku.
pdf_urlstringstringNieLink otwierany w przeglądarce, który generuje plan jako PDF.
expires_atstringstringNieKiedy ten wynik zostanie usunięty (RFC 3339).
202AcceptedZadanie przyjęte (w kolejce lub w toku).
NazwaTypWymaganyOpisidstringwymaganestringTakID zadania (job_…).
objectstringwymaganestringTakZawsze
job.jobstatusstringwymaganestringTakqueued→running→succeeded|failed|canceled.queuedrunningsucceededfailedcanceledreferencestringstringNieTwój numer referencyjny z zapytania.
sourcestringstringNieGdzie utworzono zadanie.
apiplaygroundproject_idstringstringNieProjekt (prj_…), w którym zadanie POST /v1/projects/{id}/pack zapisuje swój plan. Brak w innych zadaniach.
created_atstringwymaganestringTakZnacznik czasu RFC 3339.
started_atstring | nullstring | nullNieKiedy rozpoczęły się obliczenia (RFC 3339), albo
null.finished_atstring | nullstring | nullNieKiedy zadanie się zakończyło (RFC 3339), albo
null.progressJobProgressJobProgressNieBieżący postęp, gdy zadanie czeka w kolejce lub jest w toku.
stagestringstringNieBieżący etap, np.
queued,running,finalizinglubdone. Tylko informacyjnie: logikę opieraj naJob.status.vehicles_doneintegerintegerNieDotychczas załadowane pojazdy.
placed_itemsintegerintegerNieDotychczas rozmieszczone sztuki.
summaryJobSummaryJobSummaryNieLiczniki i czasy.
items_requestedintegerintegerNieŁączna liczba sztuk (suma ilości).
items_placedintegerintegerNieRozmieszczone sztuki.
items_unplacedintegerintegerNieSztuki, których nie udało się rozmieścić.
vehicles_usedintegerintegerNiePojazdy z co najmniej jedną pozycją.
total_weightnumber · kgnumber · kgNieZaładowana waga.
volume_utilizationnumbernumberNieŚrednie wykorzystanie objętości użytych pojazdów, 0–1.
queue_msintegerintegerNieCzas oczekiwania na zasoby obliczeniowe (bezpłatny).
compute_msintegerintegerNieCzas obliczeń (płatny).
costJobCostJobCostNiePobrane kredyty (ostateczne po zakończeniu zadania) i rezerwacja utrzymywana w trakcie jego trwania.
creditsnumber · creditsnumber · creditsNiePobrane kredyty (0 do zakończenia zadania). Za zadania zakończone błędem nie pobieramy opłat, z wyjątkiem time_limit_exceeded, rozliczanego jak anulowane zadanie.
reserved_creditsnumber · creditsnumber · creditsNieKredyty zablokowane, gdy zadanie czekało w kolejce lub było w toku (maksymalna możliwa cena). Zwalniane po jego zakończeniu.
rate_card_versionintegerintegerNieCennik, według którego wyceniono zadanie.
breakdownCostBreakdownCostBreakdownNieCena w rozbiciu na składniki.
basenumber · creditsnumber · creditsNieOpłata za zadanie.
vehiclesnumber · creditsnumber · creditsNieZa każdy załadowany pojazd (nie jest pobierana w zadaniach anulowanych ani zakończonych z time_limit_exceeded).
computenumber · creditsnumber · creditsNieZa sekundę obliczeń, naliczane proporcjonalnie co do milisekundy.
large_loadnumber · creditsnumber · creditsNieDopłata za każde rozpoczęte 100 sztuk powyżej progu dużego ładunku.
errorJobError | nullJobError | nullNieDlaczego zadanie zakończyło się błędem lub zostało anulowane; w przeciwnym razie
null.codestringstringNieKod maszynowy (zob. Błędy).
messagestringstringNieWyjaśnienie po angielsku.
warningsWarning[]Warning[]NieUwagi do zapytania, które nie blokują zadania (powtórzone także w wyniku).
codestringstringNieKod maszynowy.
messagestringstringNieWyjaśnienie po angielsku.
result_urlstringstringNieWywołaj GET na ten URL, aby pobrać pełny wynik, gdy
statusma wartośćsucceeded.pdf_urlstringstringNieLink otwierany w przeglądarce, który generuje plan załadunku jako PDF (widoki 3D + kroki załadunku). Ważny do expires_at. Po wygaśnięciu pusty.
expires_atstringstringNieKiedy treści zapytania i wyniku oraz link do PDF zostaną usunięte (RFC 3339). Metadane zadania i opłaty są zachowywane.
resultResultResultNiePełny wynik, dołączany tylko na żądanie (?include=result) lub gdy POST /v1/pack?wait= zakończy się na czas.
job_idstringstringNieZadanie.
vehiclesResultVehicle[]ResultVehicle[]NieZaładowane pojazdy w kolejności załadunku (puste pojazdy są pomijane).
indexintegerintegerNieIndeks w planie, liczony od 0.
vehicle_idstringstringNieID Twojej definicji pojazdu (w zadaniu projektu: ID slotu, pv_…).
copyintegerintegerNieNumer egzemplarza tej definicji, liczony od 1 (quantity > 1 lub dodany w trybie auto).
auto_addedbooleanbooleanNieDodany przez
packing_modeautoponad podanąquantity.namestringstringNieNazwa pojazdu.
typestringstringNieTyp pojazdu.
lengthnumber · cmnumber · cmNieDługość przestrzeni ładunkowej.
widthnumber · cmnumber · cmNieSzerokość przestrzeni ładunkowej.
heightnumber · cmnumber · cmNieWysokość przestrzeni ładunkowej.
max_weightnumber · kgnumber · kgNieLimit ładowności.
items_placedintegerintegerNieSztuki w tym pojeździe.
total_weightnumber · kgnumber · kgNieWaga ładunku w tym pojeździe.
volume_utilizationnumbernumberNieWykorzystana objętość / objętość przestrzeni ładunkowej, 0–1.
weight_utilizationnumbernumberNietotal_weight / max_weight, 0–1 (może przekroczyć 1 przy allow_overweight).
center_of_gravityPointPointNieŚrodek ciężkości ładunku (cm).
xnumber · cmnumber · cmNieynumber · cmnumber · cmNieznumber · cmnumber · cmNieplacementsPlacement[]Placement[]NieWszystkie sztuki w tym pojeździe.
item_idstringstringNieID Twojej definicji pozycji (w zadaniu projektu: ID pozycji, item_…).
instanceintegerintegerNieNumer sztuki w obrębie definicji pozycji, liczony od 1 (unikalny w całym planie).
labelstringstringNieEtykieta pozycji.
xnumber · cmnumber · cmNiePołożenie narożnika minimalnego wzdłuż długości.
ynumber · cmnumber · cmNieWysokość narożnika minimalnego nad podłogą.
znumber · cmnumber · cmNiePołożenie narożnika minimalnego w poprzek szerokości.
lengthnumber · cmnumber · cmNieWymiar wzdłuż osi x po rozmieszczeniu.
widthnumber · cmnumber · cmNieWymiar wzdłuż osi z po rozmieszczeniu.
heightnumber · cmnumber · cmNieWymiar wzdłuż osi y po rozmieszczeniu.
rotatedbooleanbooleanNieUmieszczona w innej orientacji niż zdefiniowana.
orientationstringstringNieKtóry zdefiniowany bok leży wzdłuż osi x, z i y:
lwh= zgodnie z definicją,wlh= obrócona o 90° wokół osi pionowej,lhw,hwl,whl,hlw= przewrócona na bok.stepintegerintegerNieKrok załadunku w pojeździe, liczony od 1 (ładuj w kolejności rosnącej).
weightnumber · kgnumber · kgNieWaga sztuki.
axle_loadsWymaga dostępuAxleLoad[]AxleLoad[]NieNacisk na każdą oś (tylko pojazdy z danymi osi).
namestringstringNieAxle 1,Axle 2… w kolejności zaxle_positions.positionnumber · cmnumber · cmNiePołożenie osi liczone od przodu przestrzeni ładunkowej.
loadnumber · kgnumber · kgNieNacisk ładunku na oś.
maxnumber · kgnumber · kgNieSkonfigurowane maksimum (0 = brak).
okbooleanbooleanNieload≤max(zawszetrue, gdy nie ustawiono maksimum).unplacedUnplacedItem[]UnplacedItem[]NieSztuki, których nie udało się rozmieścić, wraz z przyczyną.
item_idstringstringNieID Twojej definicji pozycji.
instanceintegerintegerNieNumer sztuki, liczony od 1.
labelstringstringNieEtykieta pozycji.
reasonstringstringNieDlaczego nie udało się jej rozmieścić.
warningsWarning[]Warning[]NieUwagi do planu.
codestringstringNieKod maszynowy.
messagestringstringNieWyjaśnienie po angielsku.
pdf_urlstringstringNieLink otwierany w przeglądarce, który generuje plan jako PDF.
expires_atstringstringNieKiedy ten wynik zostanie usunięty (RFC 3339).
400Bad request
invalid_jsonidempotency_key_invalidinvalid_jsonTreść nie jest prawidłowym JSON-em lub pole ma niewłaściwy typ.idempotency_key_invalidNagłówek Idempotency-Key jest dłuższy niż 128 zn.
Wszystkie kody błędówNazwaTypWymaganyOpiserrorErrorBodywymaganeErrorBodyTakcodestringwymaganestringTakKod maszynowy (snake_case). Na nim opieraj logikę, nigdy na
message.messagestringwymaganestringTakWyjaśnienie po angielsku.
request_idstringwymaganestringTakTo samo co nagłówek X-Request-Id. Podaj je, kontaktując się z pomocą techniczną.
detailsErrorDetail[]ErrorDetail[]NieProblemy z poszczególnymi polami (
validation_failed).pathstringstringNieŚcieżka JSON błędnego pola, np. items[3].length.
codestringstringNierequired,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.messagestringstringNieWyjaśnienie po angielsku.
401Unauthorized
unauthorizedkey_revokedkey_expiredunauthorizedBrak klucza API, nieprawidłowy format klucza lub nieznany klucz.key_revokedKlucz został unieważniony.key_expiredKlucz utracił ważność.
Wszystkie kody błędówNazwaTypWymaganyOpiserrorErrorBodywymaganeErrorBodyTakcodestringwymaganestringTakKod maszynowy (snake_case). Na nim opieraj logikę, nigdy na
message.messagestringwymaganestringTakWyjaśnienie po angielsku.
request_idstringwymaganestringTakTo samo co nagłówek X-Request-Id. Podaj je, kontaktując się z pomocą techniczną.
detailsErrorDetail[]ErrorDetail[]NieProblemy z poszczególnymi polami (
validation_failed).pathstringstringNieŚcieżka JSON błędnego pola, np. items[3].length.
codestringstringNierequired,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.messagestringstringNieWyjaśnienie po angielsku.
402Payment required
insufficient_creditsinsufficient_creditsDostępne kredyty nie pokrywają najtańszego możliwego przebiegu tego zadania.
Wszystkie kody błędówNazwaTypWymaganyOpiserrorErrorBodywymaganeErrorBodyTakcodestringwymaganestringTakKod maszynowy (snake_case). Na nim opieraj logikę, nigdy na
message.messagestringwymaganestringTakWyjaśnienie po angielsku.
request_idstringwymaganestringTakTo samo co nagłówek X-Request-Id. Podaj je, kontaktując się z pomocą techniczną.
detailsErrorDetail[]ErrorDetail[]NieProblemy z poszczególnymi polami (
validation_failed).pathstringstringNieŚcieżka JSON błędnego pola, np. items[3].length.
codestringstringNierequired,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.messagestringstringNieWyjaśnienie po angielsku.
403Forbidden
ip_not_allowedsubscription_inactiveaccount_inactivescope_missingip_not_allowedAdresu IP, z którego przyszło wywołanie, nie ma na liście dozwolonych adresów klucza.subscription_inactiveOrganizacja nie ma aktywnej subskrypcji obejmującej API.account_inactiveOrganizacja jest zawieszona albo nie ma właściciela z aktywnym kontem.scope_missingKlucz nie ma zakresu wymaganego przez ten endpoint.
Wszystkie kody błędówNazwaTypWymaganyOpiserrorErrorBodywymaganeErrorBodyTakcodestringwymaganestringTakKod maszynowy (snake_case). Na nim opieraj logikę, nigdy na
message.messagestringwymaganestringTakWyjaśnienie po angielsku.
request_idstringwymaganestringTakTo samo co nagłówek X-Request-Id. Podaj je, kontaktując się z pomocą techniczną.
detailsErrorDetail[]ErrorDetail[]NieProblemy z poszczególnymi polami (
validation_failed).pathstringstringNieŚcieżka JSON błędnego pola, np. items[3].length.
codestringstringNierequired,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.messagestringstringNieWyjaśnienie po angielsku.
413Payload too large
payload_too_largepayload_too_largeTreść zapytania przekracza 10 MB.
Wszystkie kody błędówNazwaTypWymaganyOpiserrorErrorBodywymaganeErrorBodyTakcodestringwymaganestringTakKod maszynowy (snake_case). Na nim opieraj logikę, nigdy na
message.messagestringwymaganestringTakWyjaśnienie po angielsku.
request_idstringwymaganestringTakTo samo co nagłówek X-Request-Id. Podaj je, kontaktując się z pomocą techniczną.
detailsErrorDetail[]ErrorDetail[]NieProblemy z poszczególnymi polami (
validation_failed).pathstringstringNieŚcieżka JSON błędnego pola, np. items[3].length.
codestringstringNierequired,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.messagestringstringNieWyjaśnienie po angielsku.
422Unprocessable entity
validation_failedvalidation_failedZapytanie to poprawny składniowo JSON, ale opisuje nieprawidłowe zadanie. details[] zawiera wszystkie problemy.
Wszystkie kody błędówNazwaTypWymaganyOpiserrorErrorBodywymaganeErrorBodyTakcodestringwymaganestringTakKod maszynowy (snake_case). Na nim opieraj logikę, nigdy na
message.messagestringwymaganestringTakWyjaśnienie po angielsku.
request_idstringwymaganestringTakTo samo co nagłówek X-Request-Id. Podaj je, kontaktując się z pomocą techniczną.
detailsErrorDetail[]ErrorDetail[]NieProblemy z poszczególnymi polami (
validation_failed).pathstringstringNieŚcieżka JSON błędnego pola, np. items[3].length.
codestringstringNierequired,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.messagestringstringNieWyjaśnienie po angielsku.
429Too many requests
too_many_jobsrate_limitedtoo_many_jobsOrganizacja ma już maksymalną liczbę zadań w kolejce i w toku.rate_limitedZa dużo zapytań w bieżącej minucie, godzinie lub dobie (na klucz lub na organizację) albo przekroczony limit nieudanych uwierzytelnień z Twojego adresu IP (60 na minutę).
Wszystkie kody błędówNazwaTypWymaganyOpiserrorErrorBodywymaganeErrorBodyTakcodestringwymaganestringTakKod maszynowy (snake_case). Na nim opieraj logikę, nigdy na
message.messagestringwymaganestringTakWyjaśnienie po angielsku.
request_idstringwymaganestringTakTo samo co nagłówek X-Request-Id. Podaj je, kontaktując się z pomocą techniczną.
detailsErrorDetail[]ErrorDetail[]NieProblemy z poszczególnymi polami (
validation_failed).pathstringstringNieŚcieżka JSON błędnego pola, np. items[3].length.
codestringstringNierequired,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.messagestringstringNieWyjaśnienie po angielsku.
500Internal server error
internal_errorinternal_errorWystąpił błąd po naszej stronie.
Wszystkie kody błędówNazwaTypWymaganyOpiserrorErrorBodywymaganeErrorBodyTakcodestringwymaganestringTakKod maszynowy (snake_case). Na nim opieraj logikę, nigdy na
message.messagestringwymaganestringTakWyjaśnienie po angielsku.
request_idstringwymaganestringTakTo samo co nagłówek X-Request-Id. Podaj je, kontaktując się z pomocą techniczną.
detailsErrorDetail[]ErrorDetail[]NieProblemy z poszczególnymi polami (
validation_failed).pathstringstringNieŚcieżka JSON błędnego pola, np. items[3].length.
codestringstringNierequired,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.messagestringstringNieWyjaśnienie po angielsku.
503Service unavailable
api_disabledapi_disabledAPI jest tymczasowo wyłączone (prace konserwacyjne) lub wyłączone dla organizacji.
Wszystkie kody błędówNazwaTypWymaganyOpiserrorErrorBodywymaganeErrorBodyTakcodestringwymaganestringTakKod maszynowy (snake_case). Na nim opieraj logikę, nigdy na
message.messagestringwymaganestringTakWyjaśnienie po angielsku.
request_idstringwymaganestringTakTo samo co nagłówek X-Request-Id. Podaj je, kontaktując się z pomocą techniczną.
detailsErrorDetail[]ErrorDetail[]NieProblemy z poszczególnymi polami (
validation_failed).pathstringstringNieŚcieżka JSON błędnego pola, np. items[3].length.
codestringstringNierequired,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.messagestringstringNieWyjaśnienie po angielsku.