Create a project
Creates a project that opens in the app: a name, and optionally vehicles (saved vehicles by vehicle_id), items and groups in the /v1/pack shapes and the stored options.
Pack it with POST /v1/projects/{id}/pack. Free: no credits are charged.
認証
ボディパラメーター
application/jsonnamestring必須vehiclesProjectVehicle[]Vehicle slots.
idstringSlot id (pv_…). Results of the project's jobs refer to it as vehicle_id. Read-only.
vehicle_idstring必須A vehicle id from GET /v1/vehicles (preset or veh_…).
namestringThe saved vehicle's name. Read-only.
typestringThe saved vehicle's type. Read-only.
trucktrailerflatbedcontainerpalletaircraftshiplengthnumber · cmThe size the slot packs with; sent, an override of the saved vehicle's.
widthnumber · cmThe size the slot packs with; sent, an override of the saved vehicle's.
heightnumber · cmThe size the slot packs with; sent, an override of the saved vehicle's.
max_weightnumber · kgThe size the slot packs with; sent, an override of the saved vehicle's.
quantityintegerHow many identical vehicles of this definition are available.
11–100aux_deckbooleanThe vehicle has a second deck (double-decker).
falseaux_deck_heightnumber · cmSecond deck height above the floor. Required when aux_deck is true.
aux_deck_max_weightnumber · kgLoad limit of the second deck. Required when aux_deck is true.
blocked_areasRect[]Floor zones nothing may stand on (wheel arches, damage, reserved space). Each must lie on the vehicle floor.
xnumber · cm必須Distance from the front wall to the rectangle's near edge.
znumber · cm必須Distance from the right wall (z = 0; right as seen from the door looking in) to the rectangle's near edge.
lengthnumber · cm必須Extent along x.
widthnumber · cm必須Extent along z.
tractor_weight利用申請が必要number · kgSemi-trailer axle model: tractor unit mass.
empty_trailer_weight利用申請が必要number · kgSemi-trailer axle model: unladen trailer mass.
front_axle_to_middle_axle利用申請が必要number · cmSemi-trailer axle model: tractor front axle to drive (middle) axle.
front_axle_to_tractor_cog利用申請が必要number · cmSemi-trailer axle model: front axle to tractor centre of gravity.
front_axle_to_kingpin利用申請が必要number · cmSemi-trailer axle model: front axle to kingpin (fifth wheel).
kingpin_to_rear_axle利用申請が必要number · cmSemi-trailer axle model: kingpin to trailer rear axle group.
trailer_cog_to_rear_axle利用申請が必要number · cmSemi-trailer axle model: trailer centre of gravity to rear axle group.
trailer_start_to_kingpin利用申請が必要number · cmSemi-trailer axle model: trailer front to kingpin.
max_middle_axle_weight利用申請が必要number · kgSemi-trailer axle model: legal drive (middle) axle limit.
max_rear_axle_weight利用申請が必要number · kgSemi-trailer axle model: legal rear axle group limit.
itemsItem[]Cargo items (at most 500 definitions).
idstringYour identifier, unique within the request. Results refer to it as item_id. Defaults to template_id.
template_idstringA template id (tpl_…) from GET /v1/templates. Supplies every item field; fields sent next to it override them.
labelstringDisplay label (defaults to the id).
shapestringItem shape. cylinder and drum use radius + height instead of length + width; pallet and drum always stay upright.
boxcylinderpalletbagdrumデフォルト "box"lengthnumber · cmLength. Required unless shape is cylinder or drum.
widthnumber · cmWidth. Required unless shape is cylinder or drum.
heightnumber · cm必須Height (the vertical side when the item stands as defined).
radiusnumber · cmRadius. Required when shape is cylinder or drum.
weightnumber · kg必須Weight of ONE unit.
quantityintegerNumber of identical units.
11–10000stackablebooleanOther items may be placed on top of this one.
truemax_stack_weightnumber · kgMaximum weight that may rest on one unit. 0 = unlimited.
0rotationstringall = any of the six orientations; upright = may only turn around the vertical axis (this side up); fixed = never rotated.
alluprightfixedデフォルト "all"hazardousbooleanDangerous goods: kept low and separated from other hazardous items.
falsepriorityintegerLoad priority. Higher = loaded first and kept when space runs out. 0 = none.
0groupstringName of the group this item belongs to (see groups and options.group_routing).
colorstringDisplay colour as #rrggbb (viewer and PDF only).
nesting_heightnumber · cmTelescoping overlap when identical units stack (nested crates, buckets).
0groupsGroup[]Groups, with their loading order.
namestring必須Group name, referenced by Item.group.
orderintegerLoading order (lower = loaded first). Defaults to the position in the list.
colorstringDisplay colour as #rrggbb.
optionsProjectOptionsThe pack options a project stores.
packing_modestringauto = when the listed vehicles are full, more copies of the most suitable vehicle are added (up to the job's vehicle limit); fleet_only = only the listed vehicles are used, anything that does not fit is reported as unplaced.
autofleet_onlyデフォルト "auto"group_routingstringnone = groups are informational; wall = each group gets its own section of the vehicle; routing = groups load in order and a later group may sit on or beside an earlier one but never below it (multi-stop delivery); no_stack = groups load in order side by side, never on top of each other.
nonewallroutingno_stackデフォルト "none"allow_overweightbooleanIgnore vehicle payload limits.
falseリクエストの例
curl -X POST "https://runner.cargoduo.com/v1/projects" \
-H "Authorization: Bearer $CARGODUO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Order 1042",
"vehicles": [
{
"vehicle_id": "standard-trailer-13-6m"
}
],
"items": [
{
"template_id": "tpl_42",
"quantity": 18
},
{
"template_id": "tpl_43",
"quantity": 40
}
]
}'const res = await fetch("https://runner.cargoduo.com/v1/projects", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CARGODUO_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Order 1042",
"vehicles": [
{
"vehicle_id": "standard-trailer-13-6m"
}
],
"items": [
{
"template_id": "tpl_42",
"quantity": 18
},
{
"template_id": "tpl_43",
"quantity": 40
}
]
}),
});
const data = await res.json();
console.log(res.status, data);import os
import requests
response = requests.post(
"https://runner.cargoduo.com/v1/projects",
headers={"Authorization": f"Bearer {os.environ['CARGODUO_API_KEY']}"},
json={
"name": "Order 1042",
"vehicles": [
{
"vehicle_id": "standard-trailer-13-6m",
},
],
"items": [
{
"template_id": "tpl_42",
"quantity": 18,
},
{
"template_id": "tpl_43",
"quantity": 40,
},
],
},
)
print(response.status_code, response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"name": "Order 1042",
"vehicles": [
{
"vehicle_id": "standard-trailer-13-6m"
}
],
"items": [
{
"template_id": "tpl_42",
"quantity": 18
},
{
"template_id": "tpl_43",
"quantity": 40
}
]
}`)
req, err := http.NewRequest("POST", "https://runner.cargoduo.com/v1/projects", body)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CARGODUO_API_KEY"))
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 = """
{
"name": "Order 1042",
"vehicles": [
{
"vehicle_id": "standard-trailer-13-6m"
}
],
"items": [
{
"template_id": "tpl_42",
"quantity": 18
},
{
"template_id": "tpl_43",
"quantity": 40
}
]
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://runner.cargoduo.com/v1/projects"))
.header("Authorization", "Bearer " + System.getenv("CARGODUO_API_KEY"))
.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"));
var json = """
{
"name": "Order 1042",
"vehicles": [
{
"vehicle_id": "standard-trailer-13-6m"
}
],
"items": [
{
"template_id": "tpl_42",
"quantity": 18
},
{
"template_id": "tpl_43",
"quantity": 40
}
]
}
""";
var request = new HttpRequestMessage(HttpMethod.Post, "https://runner.cargoduo.com/v1/projects")
{
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'
{
"name": "Order 1042",
"vehicles": [
{
"vehicle_id": "standard-trailer-13-6m"
}
],
"items": [
{
"template_id": "tpl_42",
"quantity": 18
},
{
"template_id": "tpl_43",
"quantity": 40
}
]
}
JSON;
$ch = curl_init('https://runner.cargoduo.com/v1/projects');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('CARGODUO_API_KEY'),
'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/projects")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("CARGODUO_API_KEY")}"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
{
"name": "Order 1042",
"vehicles": [
{
"vehicle_id": "standard-trailer-13-6m"
}
],
"items": [
{
"template_id": "tpl_42",
"quantity": 18
},
{
"template_id": "tpl_43",
"quantity": 40
}
]
}
JSON
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": "draft",
"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:10:03Z",
"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": null
}レスポンス
201The new project.
名前型必須説明idstringstringいいえProject id (prj_…).
objectstringstringいいえprojectnamestringstringいいえstatusstringstringいいえdraft= never packed or inputs replaced;calculated= has a current plan;stale= a setting changed since the plan was made.draftcalculatedstaleerroritem_countintegerintegerいいえItem units (sum of quantities).
vehicle_countintegerintegerいいえVehicles (sum of quantities).
app_urlstringstringいいえOpens the project in the app's 3D editor.
created_byUserRef | nullUserRef | nullいいえThe member who created it (for API calls: the member who created the key).
nullwhen unknown.idstringstringいいえMember id (usr_…). Filter lists with ?created_by=.
namestringstringいいえupdated_byUserRef | nullUserRef | nullいいえThe member who last changed it.
idstringstringいいえMember id (usr_…). Filter lists with ?created_by=.
namestringstringいいえcreated_atstringstringいいえRFC 3339.
updated_atstringstringいいえRFC 3339.
optionsProjectOptionsProjectOptionsいいえThe pack options a project stores.
packing_modestringstringいいえauto= when the listed vehicles are full, more copies of the most suitable vehicle are added (up to the job's vehicle limit);fleet_only= only the listed vehicles are used, anything that does not fit is reported as unplaced.autofleet_onlyデフォルト"auto"group_routingstringstringいいえnone= groups are informational;wall= each group gets its own section of the vehicle;routing= groups load in order and a later group may sit on or beside an earlier one but never below it (multi-stop delivery);no_stack= groups load in order side by side, never on top of each other.nonewallroutingno_stackデフォルト"none"allow_overweightbooleanbooleanいいえIgnore vehicle payload limits.
デフォルトfalsevehiclesProjectVehicle[]ProjectVehicle[]いいえidstringstringいいえSlot id (pv_…). Results of the project's jobs refer to it as vehicle_id. Read-only.
vehicle_idstring必須stringはいA vehicle id from GET /v1/vehicles (preset or veh_…).
namestringstringいいえThe saved vehicle's name. Read-only.
typestringstringいいえThe saved vehicle's type. Read-only.
trucktrailerflatbedcontainerpalletaircraftshiplengthnumber · cmnumber · cmいいえThe size the slot packs with; sent, an override of the saved vehicle's.
widthnumber · cmnumber · cmいいえThe size the slot packs with; sent, an override of the saved vehicle's.
heightnumber · cmnumber · cmいいえThe size the slot packs with; sent, an override of the saved vehicle's.
max_weightnumber · kgnumber · kgいいえThe size the slot packs with; sent, an override of the saved vehicle's.
quantityintegerintegerいいえHow many identical vehicles of this definition are available.
デフォルト11–100aux_deckbooleanbooleanいいえThe vehicle has a second deck (double-decker).
デフォルトfalseaux_deck_heightnumber · cmnumber · cmいいえSecond deck height above the floor. Required when
aux_deckistrue.aux_deck_max_weightnumber · kgnumber · kgいいえLoad limit of the second deck. Required when
aux_deckistrue.blocked_areasRect[]Rect[]いいえFloor zones nothing may stand on (wheel arches, damage, reserved space). Each must lie on the vehicle floor.
≤ 32 itemsxnumber · cm必須number · cmはいDistance from the front wall to the rectangle's near edge.
znumber · cm必須number · cmはいDistance from the right wall (z = 0; right as seen from the door looking in) to the rectangle's near edge.
lengthnumber · cm必須number · cmはいExtent along x.
widthnumber · cm必須number · cmはいExtent along z.
tractor_weight利用申請が必要number · kgnumber · kgいいえSemi-trailer axle model: tractor unit mass.
empty_trailer_weight利用申請が必要number · kgnumber · kgいいえSemi-trailer axle model: unladen trailer mass.
front_axle_to_middle_axle利用申請が必要number · cmnumber · cmいいえSemi-trailer axle model: tractor front axle to drive (middle) axle.
front_axle_to_tractor_cog利用申請が必要number · cmnumber · cmいいえSemi-trailer axle model: front axle to tractor centre of gravity.
front_axle_to_kingpin利用申請が必要number · cmnumber · cmいいえSemi-trailer axle model: front axle to kingpin (fifth wheel).
kingpin_to_rear_axle利用申請が必要number · cmnumber · cmいいえSemi-trailer axle model: kingpin to trailer rear axle group.
trailer_cog_to_rear_axle利用申請が必要number · cmnumber · cmいいえSemi-trailer axle model: trailer centre of gravity to rear axle group.
trailer_start_to_kingpin利用申請が必要number · cmnumber · cmいいえSemi-trailer axle model: trailer front to kingpin.
max_middle_axle_weight利用申請が必要number · kgnumber · kgいいえSemi-trailer axle model: legal drive (middle) axle limit.
max_rear_axle_weight利用申請が必要number · kgnumber · kgいいえSemi-trailer axle model: legal rear axle group limit.
itemsItem[]Item[]いいえCargo in the /v1/pack Item shape; ids are item_….
idstringstringいいえYour identifier, unique within the request. Results refer to it as item_id. Defaults to template_id.
≤ 128 charstemplate_idstringstringいいえA template id (tpl_…) from GET /v1/templates. Supplies every item field; fields sent next to it override them.
labelstringstringいいえDisplay label (defaults to the id).
≤ 255 charsshapestringstringいいえItem shape.
cylinderanddrumuseradius+heightinstead oflength+width;palletanddrumalways stay upright.boxcylinderpalletbagdrumデフォルト"box"lengthnumber · cmnumber · cmいいえLength. Required unless
shapeiscylinderordrum.widthnumber · cmnumber · cmいいえWidth. Required unless
shapeiscylinderordrum.heightnumber · cm必須number · cmはいHeight (the vertical side when the item stands as defined).
radiusnumber · cmnumber · cmいいえRadius. Required when
shapeiscylinderordrum.weightnumber · kg必須number · kgはいWeight of ONE unit.
quantityintegerintegerいいえNumber of identical units.
デフォルト11–10000stackablebooleanbooleanいいえOther items may be placed on top of this one.
デフォルトtruemax_stack_weightnumber · kgnumber · kgいいえMaximum weight that may rest on one unit. 0 = unlimited.
デフォルト0rotationstringstringいいえall= any of the six orientations;upright= may only turn around the vertical axis (this side up);fixed= never rotated.alluprightfixedデフォルト"all"hazardousbooleanbooleanいいえDangerous goods: kept low and separated from other hazardous items.
デフォルトfalsepriorityintegerintegerいいえLoad priority. Higher = loaded first and kept when space runs out. 0 = none.
デフォルト0groupstringstringいいえName of the group this item belongs to (see
groupsandoptions.group_routing).colorstringstringいいえDisplay colour as #rrggbb (viewer and PDF only).
nesting_heightnumber · cmnumber · cmいいえTelescoping overlap when identical units stack (nested crates, buckets).
デフォルト0groupsGroup[]Group[]いいえnamestring必須stringはいGroup name, referenced by Item.group.
≤ 128 charsorderintegerintegerいいえLoading order (lower = loaded first). Defaults to the position in the list.
colorstringstringいいえDisplay colour as #rrggbb.
planProjectPlan | nullProjectPlan | nullいいえThe current plan;
nullwhen the project has none.items_placedintegerintegerいいえUnits placed.
items_unplacedintegerintegerいいえUnits that could not be placed.
vehicles_usedintegerintegerいいえVehicles carrying at least one item.
total_weightnumber · kgnumber · kgいいえWeight loaded.
volume_utilizationnumbernumberいいえAverage volume utilization of the used vehicles, 0–1.
job_idstringstringいいえThe API job whose plan this is, while nothing changed it since. Empty for a plan made or edited in the app.
pdf_urlstringstringいいえThat job's PDF link (until its expires_at). Empty otherwise.
400Bad request
invalid_jsoninvalid_jsonThe body is not valid JSON or a field has the wrong type.
すべてのエラーコード名前型必須説明errorErrorBody必須ErrorBodyはいcodestring必須stringはいMachine code (snake_case). Branch on this, never on
message.messagestring必須stringはいEnglish explanation.
request_idstring必須stringはいSame as the X-Request-Id header. Quote it when contacting support.
detailsErrorDetail[]ErrorDetail[]いいえPer-field problems (
validation_failed).pathstringstringいいえJSON path of the offending field, e.g. 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いいえEnglish explanation.
401Unauthorized
unauthorizedkey_revokedkey_expiredunauthorizedMissing, malformed or unknown API key.key_revokedThe key was revoked.key_expiredThe key passed its expiry date.
すべてのエラーコード名前型必須説明errorErrorBody必須ErrorBodyはいcodestring必須stringはいMachine code (snake_case). Branch on this, never on
message.messagestring必須stringはいEnglish explanation.
request_idstring必須stringはいSame as the X-Request-Id header. Quote it when contacting support.
detailsErrorDetail[]ErrorDetail[]いいえPer-field problems (
validation_failed).pathstringstringいいえJSON path of the offending field, e.g. 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いいえEnglish explanation.
403Forbidden
plan_limit_reachedip_not_allowedsubscription_inactiveaccount_inactivescope_missingplan_limit_reachedThe organization's plan allows no more projects or cargo items.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はいcodestring必須stringはいMachine code (snake_case). Branch on this, never on
message.messagestring必須stringはいEnglish explanation.
request_idstring必須stringはいSame as the X-Request-Id header. Quote it when contacting support.
detailsErrorDetail[]ErrorDetail[]いいえPer-field problems (
validation_failed).pathstringstringいいえJSON path of the offending field, e.g. 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いいえEnglish explanation.
413Payload too large
payload_too_largepayload_too_largeThe request body exceeds 10 MB.
すべてのエラーコード名前型必須説明errorErrorBody必須ErrorBodyはいcodestring必須stringはいMachine code (snake_case). Branch on this, never on
message.messagestring必須stringはいEnglish explanation.
request_idstring必須stringはいSame as the X-Request-Id header. Quote it when contacting support.
detailsErrorDetail[]ErrorDetail[]いいえPer-field problems (
validation_failed).pathstringstringいいえJSON path of the offending field, e.g. 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いいえEnglish explanation.
422Unprocessable entity
validation_failedvalidation_failedThe request is well-formed JSON but describes an invalid job. details[] lists every problem.
すべてのエラーコード名前型必須説明errorErrorBody必須ErrorBodyはいcodestring必須stringはいMachine code (snake_case). Branch on this, never on
message.messagestring必須stringはいEnglish explanation.
request_idstring必須stringはいSame as the X-Request-Id header. Quote it when contacting support.
detailsErrorDetail[]ErrorDetail[]いいえPer-field problems (
validation_failed).pathstringstringいいえJSON path of the offending field, e.g. 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いいえEnglish explanation.
429Too many requests
rate_limitedrate_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はいcodestring必須stringはいMachine code (snake_case). Branch on this, never on
message.messagestring必須stringはいEnglish explanation.
request_idstring必須stringはいSame as the X-Request-Id header. Quote it when contacting support.
detailsErrorDetail[]ErrorDetail[]いいえPer-field problems (
validation_failed).pathstringstringいいえJSON path of the offending field, e.g. 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いいえEnglish explanation.
500Internal server error
internal_errorinternal_errorSomething failed on our side.
すべてのエラーコード名前型必須説明errorErrorBody必須ErrorBodyはいcodestring必須stringはいMachine code (snake_case). Branch on this, never on
message.messagestring必須stringはいEnglish explanation.
request_idstring必須stringはいSame as the X-Request-Id header. Quote it when contacting support.
detailsErrorDetail[]ErrorDetail[]いいえPer-field problems (
validation_failed).pathstringstringいいえJSON path of the offending field, e.g. 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いいえEnglish explanation.
503Service unavailable
api_disabledapi_disabledThe API is temporarily disabled (maintenance) or switched off for the organization.
すべてのエラーコード名前型必須説明errorErrorBody必須ErrorBodyはいcodestring必須stringはいMachine code (snake_case). Branch on this, never on
message.messagestring必須stringはいEnglish explanation.
request_idstring必須stringはいSame as the X-Request-Id header. Quote it when contacting support.
detailsErrorDetail[]ErrorDetail[]いいえPer-field problems (
validation_failed).pathstringstringいいえJSON path of the offending field, e.g. 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いいえEnglish explanation.