Изменить шаблон
Изменяет шаблон.
Позиции, уже добавленные в проекты, сохраняют собственную копию. Бесплатно: кредиты не списываются.
Аутентификация
Параметры пути
idstringобязательноID шаблона (tpl_…).
Параметры тела
application/jsonlabelstringОтображаемая метка.
shapestringФорма позиции. Для cylinder и drum используются radius + height вместо length + width; pallet и drum всегда стоят вертикально.
boxcylinderpalletbagdrumПо умолчанию "box"lengthnumber · cmДлина. Обязательна, если shape не cylinder и не drum.
widthnumber · cmШирина. Обязательна, если shape не cylinder и не drum.
heightnumber · cmВысота (вертикальная сторона, когда груз стоит в исходной ориентации).
radiusnumber · cmРадиус. Обязателен, если shape — cylinder или drum.
weightnumber · kgВес ОДНОЙ единицы.
stackablebooleanСверху можно ставить другие грузы.
truemax_stack_weightnumber · kgМаксимальный вес, который можно поставить на одну единицу. 0 = без ограничений.
0rotationstringall = любая из шести ориентаций; upright = только поворот вокруг вертикальной оси (этой стороной вверх); fixed = без поворотов.
alluprightfixedПо умолчанию "all"hazardousbooleanОпасный груз: размещается внизу и отдельно от других опасных грузов.
falsepriorityintegerПриоритет загрузки. Позиции с более высоким приоритетом загружаются раньше и при нехватке места остаются в плане. 0 = без приоритета.
0colorstringЦвет отображения в формате #rrggbb (только в просмотрщике и PDF).
nesting_heightnumber · cmПерекрытие при вкладывании одинаковых единиц друг в друга (вкладываемые ящики, вёдра).
0Пример запроса
curl -X PATCH "https://runner.cargoduo.com/v1/templates/tpl_42" \
-H "Authorization: Bearer $CARGODUO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"weight": 480
}'const res = await fetch("https://runner.cargoduo.com/v1/templates/tpl_42", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.CARGODUO_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"weight": 480
}),
});
const data = await res.json();
console.log(res.status, data);import os
import requests
response = requests.patch(
"https://runner.cargoduo.com/v1/templates/tpl_42",
headers={"Authorization": f"Bearer {os.environ['CARGODUO_API_KEY']}"},
json={
"weight": 480,
},
)
print(response.status_code, response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"weight": 480
}`)
req, err := http.NewRequest("PATCH", "https://runner.cargoduo.com/v1/templates/tpl_42", 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 = """
{
"weight": 480
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://runner.cargoduo.com/v1/templates/tpl_42"))
.header("Authorization", "Bearer " + System.getenv("CARGODUO_API_KEY"))
.header("Content-Type", "application/json")
.method("PATCH", 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 = """
{
"weight": 480
}
""";
var request = new HttpRequestMessage(HttpMethod.Patch, "https://runner.cargoduo.com/v1/templates/tpl_42")
{
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'
{
"weight": 480
}
JSON;
$ch = curl_init('https://runner.cargoduo.com/v1/templates/tpl_42');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
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/templates/tpl_42")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("CARGODUO_API_KEY")}"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
{
"weight": 480
}
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": "tpl_42",
"object": "template",
"label": "Euro pallet",
"shape": "box",
"length": 120,
"width": 80,
"height": 140,
"radius": 0,
"weight": 480,
"stackable": false,
"max_stack_weight": 0,
"rotation": "all",
"hazardous": false,
"priority": 0,
"color": "#3b82f6",
"nesting_height": 0,
"created_by": {
"id": "usr_7",
"name": "Elif Kaya"
},
"updated_by": {
"id": "usr_7",
"name": "Elif Kaya"
},
"created_at": "2026-09-28T14:05:52Z",
"updated_at": "2026-10-19T09:12:03Z"
}Ответы
200OKШаблон после изменения.
ИмяТипОбязательноОписаниеidstringstringНетID шаблона (tpl_…).
objectstringstringНетtemplatelabelstringstringНетОтображаемая метка.
shapestringstringНетФорма позиции. Для
cylinderиdrumиспользуютсяradius+heightвместоlength+width;palletиdrumвсегда стоят вертикально.boxcylinderpalletbagdrumlengthnumber · cmnumber · cmНетДлина. Обязательна, если
shapeнеcylinderи неdrum.widthnumber · cmnumber · cmНетШирина. Обязательна, если
shapeнеcylinderи неdrum.heightnumber · cmnumber · cmНетВысота (вертикальная сторона, когда груз стоит в исходной ориентации).
radiusnumber · cmnumber · cmНетРадиус. Обязателен, если
shape—cylinderилиdrum.weightnumber · kgnumber · kgНетВес ОДНОЙ единицы.
stackablebooleanbooleanНетСверху можно ставить другие грузы.
max_stack_weightnumber · kgnumber · kgНетМаксимальный вес, который можно поставить на одну единицу. 0 = без ограничений.
rotationstringstringНетall= любая из шести ориентаций;upright= только поворот вокруг вертикальной оси (этой стороной вверх);fixed= без поворотов.alluprightfixedhazardousbooleanbooleanНетОпасный груз: размещается внизу и отдельно от других опасных грузов.
priorityintegerintegerНетПриоритет загрузки. Позиции с более высоким приоритетом загружаются раньше и при нехватке места остаются в плане. 0 = без приоритета.
colorstringstringНетЦвет отображения в формате #rrggbb (только в просмотрщике и PDF).
nesting_heightnumber · cmnumber · cmНетПерекрытие при вкладывании одинаковых единиц друг в друга (вкладываемые ящики, вёдра).
created_byUserRef | nullUserRef | nullНетУчастник, создавший проект (для вызовов API — участник, создавший ключ).
null, если неизвестно.idstringstringНетID участника (usr_…). Фильтруйте списки через ?created_by=.
namestringstringНетupdated_byUserRef | nullUserRef | nullНетУчастник, последним изменивший проект.
idstringstringНетID участника (usr_…). Фильтруйте списки через ?created_by=.
namestringstringНетcreated_atstringstringНетRFC 3339.
updated_atstringstringНетRFC 3339.
400Bad request
invalid_jsoninvalid_jsonТело запроса — невалидный JSON, или у поля неверный тип.
Все коды ошибокИмяТипОбязательноОписание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НетПояснение на английском.
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
template_not_foundtemplate_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НетПояснение на английском.
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
rate_limitedrate_limitedСлишком много запросов за текущую минуту, час или сутки (на ключ или на организацию) либо число неудачных попыток аутентификации с вашего IP-адреса превысило 60 в минуту.
Все коды ошибокИмяТипОбязательноОписаниеerrorErrorBodyобязательноErrorBodyДаcodestringобязательноstringДаМашиночитаемый код (snake_case). Ветвите логику по нему, а не по
message.messagestringобязательноstringДаПояснение на английском.
request_idstringобязательноstringДаСовпадает с заголовком X-Request-Id. Указывайте его при обращении в поддержку.
detailsErrorDetail[]ErrorDetail[]НетПроблемы по отдельным полям (
validation_failed).pathstringstringНетJSON-путь к проблемному полю, например items[3].length.
codestringstringНетrequired,invalid_value,out_of_range,duplicate_id,unknown_vehicle,unknown_template,type_not_allowed,unknown_group,does_not_fit,too_many_items,too_many_vehicles,unknown_field,invalid_json.messagestringstringНетПояснение на английском.
500Internal server error
internal_errorinternal_errorСбой на нашей стороне.
Все коды ошибокИмяТипОбязательноОписаниеerrorErrorBodyобязательноErrorBodyДаcodestringобязательноstringДаМашиночитаемый код (snake_case). Ветвите логику по нему, а не по
message.messagestringобязательноstringДаПояснение на английском.
request_idstringобязательноstringДаСовпадает с заголовком X-Request-Id. Указывайте его при обращении в поддержку.
detailsErrorDetail[]ErrorDetail[]НетПроблемы по отдельным полям (
validation_failed).pathstringstringНетJSON-путь к проблемному полю, например items[3].length.
codestringstringНетrequired,invalid_value,out_of_range,duplicate_id,unknown_vehicle,unknown_template,type_not_allowed,unknown_group,does_not_fit,too_many_items,too_many_vehicles,unknown_field,invalid_json.messagestringstringНетПояснение на английском.
503Service unavailable
api_disabledapi_disabledAPI временно отключён (техническое обслуживание) или выключен для организации.
Все коды ошибокИмяТипОбязательноОписаниеerrorErrorBodyобязательноErrorBodyДаcodestringобязательноstringДаМашиночитаемый код (snake_case). Ветвите логику по нему, а не по
message.messagestringобязательноstringДаПояснение на английском.
request_idstringобязательноstringДаСовпадает с заголовком X-Request-Id. Указывайте его при обращении в поддержку.
detailsErrorDetail[]ErrorDetail[]НетПроблемы по отдельным полям (
validation_failed).pathstringstringНетJSON-путь к проблемному полю, например items[3].length.
codestringstringНетrequired,invalid_value,out_of_range,duplicate_id,unknown_vehicle,unknown_template,type_not_allowed,unknown_group,does_not_fit,too_many_items,too_many_vehicles,unknown_field,invalid_json.messagestringstringНетПояснение на английском.