Рассчитать загрузку проекта
Рассчитывает загрузку транспортных средств и позиций проекта точно так же, как POST /v1/pack: та же стоимость, резервирование кредитов, лимиты, Idempotency-Key, ?wait= и задание.
Когда задание выполнено, его план сохраняется в проект, и проект открывается в приложении с этим планом. Если проект изменили во время выполнения задания, план остаётся только в задании (предупреждение project_not_saved). ID в результате берутся из проекта: vehicle_id — это ID слота (pv_…), item_id — ID позиции (item_…).
Аутентификация
Параметры пути
idstringобязательноID проекта (prj_…).
Параметры запроса
waitintegerСколько секунд ждать завершения задания, прежде чем ответить. Если задание успело завершиться — 200 с результатом в теле ответа, иначе — 202.
00–60Параметры заголовков
Idempotency-KeystringЛюбая уникальная строка, например UUID или номер вашего заказа. Повторный запрос с тем же ключом в течение 24 ч вернёт исходное задание — новое не создаётся и не оплачивается.
Параметры тела
application/jsonreferencestringВаш идентификатор, возвращается в задании. По умолчанию — название проекта.
optionsProjectPackOptionsПараметры запуска. Все поля необязательны.
packing_modestringauto = когда указанные транспортные средства заполнены, добавляются копии наиболее подходящего (в пределах лимита транспортных средств задания); fleet_only = используются только указанные транспортные средства, всё, что не поместилось, попадает в неразмещённые.
autofleet_onlyallow_overweightbooleanИгнорировать ограничения грузоподъёмности транспортных средств.
max_stack_itemsintegerМаксимум единиц в одном штабеле. 0 = без ограничений.
0max_stack_density_kg_m2number · kg/m²Максимальный вес штабеля на единицу площади пола. 0 = без ограничений.
0lock_rotationsbooleanСохранять первую ориентацию, которая проходит по высоте транспортного средства.
falsegroup_identical_binsbooleanСчитать одинаковые транспортные средства одним пулом.
falsetime_limitnumber · sВерхняя граница времени вычислений для всего задания. 0 = автоматически (не больше max_time_limit_seconds из GET /v1/limits). При достижении лимита возвращается лучший план, найденный к этому моменту. Вы платите только за фактически использованное время вычислений.
0enforce_axleНужен доступbooleanОтклонять размещения, которые перегружают группу осей, — для транспортных средств, у которых заполнены все десять полей модели осей.
falseПример запроса
curl -X POST "https://runner.cargoduo.com/v1/projects/prj_3051/pack" \
-H "Authorization: Bearer $CARGODUO_API_KEY" \
-H "Idempotency-Key: order-1042-v1" \
-H "Content-Type: application/json" \
-d '{
"reference": "order-1042"
}'const res = await fetch("https://runner.cargoduo.com/v1/projects/prj_3051/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"
}),
});
const data = await res.json();
console.log(res.status, data);import os
import requests
response = requests.post(
"https://runner.cargoduo.com/v1/projects/prj_3051/pack",
headers={"Authorization": f"Bearer {os.environ['CARGODUO_API_KEY']}", "Idempotency-Key": "order-1042-v1"},
json={
"reference": "order-1042",
},
)
print(response.status_code, response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"reference": "order-1042"
}`)
req, err := http.NewRequest("POST", "https://runner.cargoduo.com/v1/projects/prj_3051/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"
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://runner.cargoduo.com/v1/projects/prj_3051/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"
}
""";
var request = new HttpRequestMessage(HttpMethod.Post, "https://runner.cargoduo.com/v1/projects/prj_3051/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"
}
JSON;
$ch = curl_init('https://runner.cargoduo.com/v1/projects/prj_3051/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/projects/prj_3051/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"
}
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": "job_4bK9mT2xQe7LpW1zRc8VdN3f",
"object": "job",
"status": "queued",
"reference": "order-1042",
"source": "api",
"project_id": "prj_3051",
"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"
}Ответы
200OKЗадание завершилось в пределах ?wait, результат встроен в ответ. Так же отвечает идемпотентный повтор завершённого задания.
ИмяТипОбязательноОписаниеidstringобязательноstringДаID задания (job_…).
objectstringобязательноstringДаВсегда
job.jobstatusstringобязательноstringДаqueued→running→succeeded|failed|canceled.queuedrunningsucceededfailedcanceledreferencestringstringНетВаш идентификатор из запроса.
sourcestringstringНетГде создано задание.
apiplaygroundproject_idstringstringНетПроект (prj_…), в который задание POST /v1/projects/{id}/pack сохраняет свой план. У других заданий отсутствует.
created_atstringобязательноstringДаМетка времени RFC 3339.
started_atstring | nullstring | nullНетКогда начались вычисления (RFC 3339), или
null.finished_atstring | nullstring | nullНетКогда задание завершилось (RFC 3339), или
null.progressJobProgressJobProgressНетТекущий прогресс, пока задание в очереди или выполняется.
stagestringstringНетТекущий этап, например
queued,running,finalizingилиdone. Только для информации: ветвите логику поJob.status.vehicles_doneintegerintegerНетСколько транспортных средств уже рассчитано.
placed_itemsintegerintegerНетСколько единиц груза уже размещено.
summaryJobSummaryJobSummaryНетСчётчики и время.
items_requestedintegerintegerНетВсего единиц груза (сумма количеств).
items_placedintegerintegerНетРазмещено единиц.
items_unplacedintegerintegerНетЕдиницы, которые не удалось разместить.
vehicles_usedintegerintegerНетТранспортные средства, в которых есть хотя бы одна единица груза.
total_weightnumber · kgnumber · kgНетЗагруженный вес.
volume_utilizationnumbernumberНетСредняя заполненность по объёму задействованных транспортных средств, 0–1.
queue_msintegerintegerНетВремя ожидания слота вычислений (не оплачивается).
compute_msintegerintegerНетВремя вычислений (оплачивается).
costJobCostJobCostНетСписанные кредиты (окончательные после завершения задания) и резерв, удерживаемый во время выполнения.
creditsnumber · creditsnumber · creditsНетСписанные кредиты (0 до завершения задания). Задания с ошибкой не оплачиваются, кроме time_limit_exceeded: такое задание оплачивается как отменённое.
reserved_creditsnumber · creditsnumber · creditsНетКредиты, удерживаемые, пока задание ждало в очереди или выполнялось (максимально возможная стоимость). Освобождаются по завершении.
rate_card_versionintegerintegerНетТарифная сетка, по которой рассчитана стоимость задания.
breakdownCostBreakdownCostBreakdownНетДетализация стоимости.
basenumber · creditsnumber · creditsНетПлата за задание.
vehiclesnumber · creditsnumber · creditsНетЗа каждое загруженное транспортное средство (не взимается для отменённых заданий и заданий с time_limit_exceeded).
computenumber · creditsnumber · creditsНетЗа секунду вычислений, пропорционально, с точностью до миллисекунды.
large_loadnumber · creditsnumber · creditsНетНадбавка за каждую начатую сотню единиц сверх порога крупной загрузки.
errorJobError | nullJobError | nullНетПочему задание завершилось ошибкой или было отменено; иначе
null.codestringstringНетМашиночитаемый код (см. «Ошибки»).
messagestringstringНетПояснение на английском.
warningsWarning[]Warning[]НетНекритичные замечания к запросу (дублируются в результате).
codestringstringНетМашиночитаемый код.
messagestringstringНетПояснение на английском.
result_urlstringstringНетВыполните GET по этому URL, чтобы получить полный результат, когда
statusстанетsucceeded.pdf_urlstringstringНетСсылка, по которой браузер формирует PDF с планом загрузки (3D-виды + шаги загрузки). Действует до expires_at. После истечения срока пустая.
expires_atstringstringНетКогда удаляются тела запроса и результата и ссылка на PDF (RFC 3339). Метаданные задания и списания сохраняются.
resultResultResultНетПолный результат; встраивается, только если запрошен (?include=result) или если POST /v1/pack?wait= успел завершиться.
job_idstringstringНетЗадание.
vehiclesResultVehicle[]ResultVehicle[]НетЗагруженные транспортные средства в порядке загрузки (пустые не включаются).
indexintegerintegerНетПозиция в плане, начиная с 0.
vehicle_idstringstringНетID вашего описания транспортного средства (для задания проекта — ID слота, pv_…).
copyintegerintegerНетНомер копии этого описания, начиная с 1 (при quantity > 1 или при добавлении в режиме auto).
auto_addedbooleanbooleanНетДобавлено режимом
packing_modeautoсверх указанного вамиquantity.namestringstringНетНазвание транспортного средства.
typestringstringНетТип транспортного средства.
lengthnumber · cmnumber · cmНетДлина грузового пространства.
widthnumber · cmnumber · cmНетШирина грузового пространства.
heightnumber · cmnumber · cmНетВысота грузового пространства.
max_weightnumber · kgnumber · kgНетГрузоподъёмность.
items_placedintegerintegerНетЕдиниц в этом транспортном средстве.
total_weightnumber · kgnumber · kgНетВес груза в этом транспортном средстве.
volume_utilizationnumbernumberНетЗанятый объём / объём грузового пространства, 0–1.
weight_utilizationnumbernumberНетtotal_weight / max_weight, 0–1 (с allow_overweight может быть больше 1).
center_of_gravityPointPointНетЦентр тяжести груза (cm).
xnumber · cmnumber · cmНетynumber · cmnumber · cmНетznumber · cmnumber · cmНетplacementsPlacement[]Placement[]НетВсе единицы в этом транспортном средстве.
item_idstringstringНетID вашего описания позиции (для задания проекта — ID позиции, item_…).
instanceintegerintegerНетНомер единицы внутри описания позиции, начиная с 1 (уникален во всём плане).
labelstringstringНетМетка позиции.
xnumber · cmnumber · cmНетПоложение минимального угла по длине.
ynumber · cmnumber · cmНетВысота минимального угла над полом.
znumber · cmnumber · cmНетПоложение минимального угла по ширине.
lengthnumber · cmnumber · cmНетРазмер по x после размещения.
widthnumber · cmnumber · cmНетРазмер по z после размещения.
heightnumber · cmnumber · cmНетРазмер по y после размещения.
rotatedbooleanbooleanНетРазмещено в ориентации, отличной от описанной.
orientationstringstringНетКакая из описанных сторон лежит вдоль x, z и y:
lwh= как описано,wlh= повёрнуто на 90° вокруг вертикальной оси,lhw,hwl,whl,hlw= положено на бок.stepintegerintegerНетШаг загрузки в этом транспортном средстве, начиная с 1 (загружайте по возрастанию).
weightnumber · kgnumber · kgНетВес единицы.
axle_loadsНужен доступAxleLoad[]AxleLoad[]НетНагрузка на каждую ось (только для транспортных средств с данными об осях).
namestringstringНетAxle 1,Axle 2… в порядкеaxle_positions.positionnumber · cmnumber · cmНетПоложение оси от передней границы грузового пространства.
loadnumber · kgnumber · kgНетНагрузка груза на ось.
maxnumber · kgnumber · kgНетЗаданный максимум (0 = не задан).
okbooleanbooleanНетload≤max(без максимума всегдаtrue).unplacedUnplacedItem[]UnplacedItem[]НетЕдиницы, которые не удалось разместить, с причиной.
item_idstringstringНетID вашего описания позиции.
instanceintegerintegerНетНомер единицы, начиная с 1.
labelstringstringНетМетка позиции.
reasonstringstringНетПочему единицу не удалось разместить.
warningsWarning[]Warning[]НетЗамечания к плану.
codestringstringНетМашиночитаемый код.
messagestringstringНетПояснение на английском.
pdf_urlstringstringНетСсылка, по которой браузер формирует PDF с планом.
expires_atstringstringНетКогда этот результат будет удалён (RFC 3339).
202AcceptedЗадание принято (в очереди или выполняется).
ИмяТипОбязательноОписаниеidstringобязательноstringДаID задания (job_…).
objectstringобязательноstringДаВсегда
job.jobstatusstringобязательноstringДаqueued→running→succeeded|failed|canceled.queuedrunningsucceededfailedcanceledreferencestringstringНетВаш идентификатор из запроса.
sourcestringstringНетГде создано задание.
apiplaygroundproject_idstringstringНетПроект (prj_…), в который задание POST /v1/projects/{id}/pack сохраняет свой план. У других заданий отсутствует.
created_atstringобязательноstringДаМетка времени RFC 3339.
started_atstring | nullstring | nullНетКогда начались вычисления (RFC 3339), или
null.finished_atstring | nullstring | nullНетКогда задание завершилось (RFC 3339), или
null.progressJobProgressJobProgressНетТекущий прогресс, пока задание в очереди или выполняется.
stagestringstringНетТекущий этап, например
queued,running,finalizingилиdone. Только для информации: ветвите логику поJob.status.vehicles_doneintegerintegerНетСколько транспортных средств уже рассчитано.
placed_itemsintegerintegerНетСколько единиц груза уже размещено.
summaryJobSummaryJobSummaryНетСчётчики и время.
items_requestedintegerintegerНетВсего единиц груза (сумма количеств).
items_placedintegerintegerНетРазмещено единиц.
items_unplacedintegerintegerНетЕдиницы, которые не удалось разместить.
vehicles_usedintegerintegerНетТранспортные средства, в которых есть хотя бы одна единица груза.
total_weightnumber · kgnumber · kgНетЗагруженный вес.
volume_utilizationnumbernumberНетСредняя заполненность по объёму задействованных транспортных средств, 0–1.
queue_msintegerintegerНетВремя ожидания слота вычислений (не оплачивается).
compute_msintegerintegerНетВремя вычислений (оплачивается).
costJobCostJobCostНетСписанные кредиты (окончательные после завершения задания) и резерв, удерживаемый во время выполнения.
creditsnumber · creditsnumber · creditsНетСписанные кредиты (0 до завершения задания). Задания с ошибкой не оплачиваются, кроме time_limit_exceeded: такое задание оплачивается как отменённое.
reserved_creditsnumber · creditsnumber · creditsНетКредиты, удерживаемые, пока задание ждало в очереди или выполнялось (максимально возможная стоимость). Освобождаются по завершении.
rate_card_versionintegerintegerНетТарифная сетка, по которой рассчитана стоимость задания.
breakdownCostBreakdownCostBreakdownНетДетализация стоимости.
basenumber · creditsnumber · creditsНетПлата за задание.
vehiclesnumber · creditsnumber · creditsНетЗа каждое загруженное транспортное средство (не взимается для отменённых заданий и заданий с time_limit_exceeded).
computenumber · creditsnumber · creditsНетЗа секунду вычислений, пропорционально, с точностью до миллисекунды.
large_loadnumber · creditsnumber · creditsНетНадбавка за каждую начатую сотню единиц сверх порога крупной загрузки.
errorJobError | nullJobError | nullНетПочему задание завершилось ошибкой или было отменено; иначе
null.codestringstringНетМашиночитаемый код (см. «Ошибки»).
messagestringstringНетПояснение на английском.
warningsWarning[]Warning[]НетНекритичные замечания к запросу (дублируются в результате).
codestringstringНетМашиночитаемый код.
messagestringstringНетПояснение на английском.
result_urlstringstringНетВыполните GET по этому URL, чтобы получить полный результат, когда
statusстанетsucceeded.pdf_urlstringstringНетСсылка, по которой браузер формирует PDF с планом загрузки (3D-виды + шаги загрузки). Действует до expires_at. После истечения срока пустая.
expires_atstringstringНетКогда удаляются тела запроса и результата и ссылка на PDF (RFC 3339). Метаданные задания и списания сохраняются.
resultResultResultНетПолный результат; встраивается, только если запрошен (?include=result) или если POST /v1/pack?wait= успел завершиться.
job_idstringstringНетЗадание.
vehiclesResultVehicle[]ResultVehicle[]НетЗагруженные транспортные средства в порядке загрузки (пустые не включаются).
indexintegerintegerНетПозиция в плане, начиная с 0.
vehicle_idstringstringНетID вашего описания транспортного средства (для задания проекта — ID слота, pv_…).
copyintegerintegerНетНомер копии этого описания, начиная с 1 (при quantity > 1 или при добавлении в режиме auto).
auto_addedbooleanbooleanНетДобавлено режимом
packing_modeautoсверх указанного вамиquantity.namestringstringНетНазвание транспортного средства.
typestringstringНетТип транспортного средства.
lengthnumber · cmnumber · cmНетДлина грузового пространства.
widthnumber · cmnumber · cmНетШирина грузового пространства.
heightnumber · cmnumber · cmНетВысота грузового пространства.
max_weightnumber · kgnumber · kgНетГрузоподъёмность.
items_placedintegerintegerНетЕдиниц в этом транспортном средстве.
total_weightnumber · kgnumber · kgНетВес груза в этом транспортном средстве.
volume_utilizationnumbernumberНетЗанятый объём / объём грузового пространства, 0–1.
weight_utilizationnumbernumberНетtotal_weight / max_weight, 0–1 (с allow_overweight может быть больше 1).
center_of_gravityPointPointНетЦентр тяжести груза (cm).
xnumber · cmnumber · cmНетynumber · cmnumber · cmНетznumber · cmnumber · cmНетplacementsPlacement[]Placement[]НетВсе единицы в этом транспортном средстве.
item_idstringstringНетID вашего описания позиции (для задания проекта — ID позиции, item_…).
instanceintegerintegerНетНомер единицы внутри описания позиции, начиная с 1 (уникален во всём плане).
labelstringstringНетМетка позиции.
xnumber · cmnumber · cmНетПоложение минимального угла по длине.
ynumber · cmnumber · cmНетВысота минимального угла над полом.
znumber · cmnumber · cmНетПоложение минимального угла по ширине.
lengthnumber · cmnumber · cmНетРазмер по x после размещения.
widthnumber · cmnumber · cmНетРазмер по z после размещения.
heightnumber · cmnumber · cmНетРазмер по y после размещения.
rotatedbooleanbooleanНетРазмещено в ориентации, отличной от описанной.
orientationstringstringНетКакая из описанных сторон лежит вдоль x, z и y:
lwh= как описано,wlh= повёрнуто на 90° вокруг вертикальной оси,lhw,hwl,whl,hlw= положено на бок.stepintegerintegerНетШаг загрузки в этом транспортном средстве, начиная с 1 (загружайте по возрастанию).
weightnumber · kgnumber · kgНетВес единицы.
axle_loadsНужен доступAxleLoad[]AxleLoad[]НетНагрузка на каждую ось (только для транспортных средств с данными об осях).
namestringstringНетAxle 1,Axle 2… в порядкеaxle_positions.positionnumber · cmnumber · cmНетПоложение оси от передней границы грузового пространства.
loadnumber · kgnumber · kgНетНагрузка груза на ось.
maxnumber · kgnumber · kgНетЗаданный максимум (0 = не задан).
okbooleanbooleanНетload≤max(без максимума всегдаtrue).unplacedUnplacedItem[]UnplacedItem[]НетЕдиницы, которые не удалось разместить, с причиной.
item_idstringstringНетID вашего описания позиции.
instanceintegerintegerНетНомер единицы, начиная с 1.
labelstringstringНетМетка позиции.
reasonstringstringНетПочему единицу не удалось разместить.
warningsWarning[]Warning[]НетЗамечания к плану.
codestringstringНетМашиночитаемый код.
messagestringstringНетПояснение на английском.
pdf_urlstringstringНетСсылка, по которой браузер формирует PDF с планом.
expires_atstringstringНетКогда этот результат будет удалён (RFC 3339).
400Bad request
invalid_jsonidempotency_key_invalidinvalid_jsonТело запроса — невалидный JSON, или у поля неверный тип.idempotency_key_invalidДлина заголовка Idempotency-Key превышает 128 симв.
Все коды ошибокИмяТипОбязательноОписание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НетПояснение на английском.
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НетПояснение на английском.
402Payment required
insufficient_creditsinsufficient_creditsДоступных кредитов не хватает даже на минимально возможный расчёт этого задания.
Все коды ошибокИмяТипОбязательноОписание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НетПояснение на английском.
409Conflict
project_busyproject_busyЗагрузка проекта прямо сейчас рассчитывается (в приложении или другим заданием).
Все коды ошибокИмяТипОбязательноОписание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НетПояснение на английском.
413Payload too large
payload_too_largepayload_too_largeТело запроса превышает 10 MB.
Все коды ошибокИмяТипОбязательноОписание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НетПояснение на английском.
422Unprocessable entity
validation_failedvalidation_failedЗапрос — корректный JSON, но описывает недопустимое задание. В details[] перечислены все проблемы.
Все коды ошибокИмяТипОбязательноОписание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
too_many_jobsrate_limitedtoo_many_jobsУ организации уже максимальное число заданий в очереди и в работе.rate_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НетПояснение на английском.