Przejdź do treści
Dokumentacja dla deweloperówDokumentacja APISzablony

Zaktualizuj szablon

Zmienia szablon.

PATCHhttps://runner.cargoduo.com/v1/templates/{id}

Pozycje, które są już w projektach, zachowują własną kopię. Bezpłatnie: nie pobieramy kredytów.

Uwierzytelnianie

Klucz API (Bearer) z zakresemresources:writeWięcej informacji

Parametry ścieżki

NazwaTypWymaganyOpis
idstringwymagane
string
Tak

ID szablonu (tpl_…).

Parametry treści

application/json
NazwaTypWymaganyOpis
labelstring
string
Nie

Wyświetlana etykieta.

≤ 255 chars
shapestring
string
Nie

Kształt pozycji. cylinder i drum używają radius + height zamiast length + width; pallet i drum zawsze stoją pionowo.

boxcylinderpalletbagdrumDomyślnie "box"
lengthnumber · cm
number · cm
Nie

Długość. Wymagana, chyba że shape to cylinder lub drum.

widthnumber · cm
number · cm
Nie

Szerokość. Wymagana, chyba że shape to cylinder lub drum.

heightnumber · cm
number · cm
Nie

Wysokość (bok pionowy, gdy pozycja stoi zgodnie z definicją).

radiusnumber · cm
number · cm
Nie

Promień. Wymagany, gdy shape to cylinder lub drum.

weightnumber · kg
number · kg
Nie

Waga JEDNEJ sztuki.

stackableboolean
boolean
Nie

Na tej pozycji można stawiać inne pozycje.

Domyślnie true
max_stack_weightnumber · kg
number · kg
Nie

Maksymalna waga, która może spoczywać na jednej sztuce. 0 = bez limitu.

Domyślnie 0
rotationstring
string
Nie

all = dowolna z sześciu orientacji; upright = obrót tylko wokół osi pionowej (tą stroną do góry); fixed = bez obracania.

alluprightfixedDomyślnie "all"
hazardousboolean
boolean
Nie

Towary niebezpieczne: umieszczane nisko i z dala od innych towarów niebezpiecznych.

Domyślnie false
priorityinteger
integer
Nie

Priorytet załadunku. Wyższy = ładowana wcześniej i zachowywana, gdy brakuje miejsca. 0 = brak.

Domyślnie 0
colorstring
string
Nie

Kolor wyświetlania w formacie #rrggbb (tylko podgląd i PDF).

nesting_heightnumber · cm
number · cm
Nie

Głębokość, na jaką identyczne sztuki wsuwają się w siebie przy piętrowaniu (skrzynki, wiadra).

Domyślnie 0

Przykładowe zapytanie

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
  }'

Przykładowa odpowiedź

200 OK · Template
{
  "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"
}

Odpowiedzi

  • 200OKSzablon po zmianie.
    NazwaTypWymaganyOpis
    idstring
    string
    Nie

    ID szablonu (tpl_…).

    objectstring
    string
    Nie
    template
    labelstring
    string
    Nie

    Wyświetlana etykieta.

    shapestring
    string
    Nie

    Kształt pozycji. cylinder i drum używają radius + height zamiast length + width; pallet i drum zawsze stoją pionowo.

    boxcylinderpalletbagdrum
    lengthnumber · cm
    number · cm
    Nie

    Długość. Wymagana, chyba że shape to cylinder lub drum.

    widthnumber · cm
    number · cm
    Nie

    Szerokość. Wymagana, chyba że shape to cylinder lub drum.

    heightnumber · cm
    number · cm
    Nie

    Wysokość (bok pionowy, gdy pozycja stoi zgodnie z definicją).

    radiusnumber · cm
    number · cm
    Nie

    Promień. Wymagany, gdy shape to cylinder lub drum.

    weightnumber · kg
    number · kg
    Nie

    Waga JEDNEJ sztuki.

    stackableboolean
    boolean
    Nie

    Na tej pozycji można stawiać inne pozycje.

    max_stack_weightnumber · kg
    number · kg
    Nie

    Maksymalna waga, która może spoczywać na jednej sztuce. 0 = bez limitu.

    rotationstring
    string
    Nie

    all = dowolna z sześciu orientacji; upright = obrót tylko wokół osi pionowej (tą stroną do góry); fixed = bez obracania.

    alluprightfixed
    hazardousboolean
    boolean
    Nie

    Towary niebezpieczne: umieszczane nisko i z dala od innych towarów niebezpiecznych.

    priorityinteger
    integer
    Nie

    Priorytet załadunku. Wyższy = ładowana wcześniej i zachowywana, gdy brakuje miejsca. 0 = brak.

    colorstring
    string
    Nie

    Kolor wyświetlania w formacie #rrggbb (tylko podgląd i PDF).

    nesting_heightnumber · cm
    number · cm
    Nie

    Głębokość, na jaką identyczne sztuki wsuwają się w siebie przy piętrowaniu (skrzynki, wiadra).

    created_byUserRef | null
    UserRef | null
    Nie

    Członek organizacji, który go utworzył (przy wywołaniach API: twórca klucza). null, gdy nieznany.

    updated_byUserRef | null
    UserRef | null
    Nie

    Członek organizacji, który ostatnio go zmienił.

    created_atstring
    string
    Nie

    RFC 3339.

    updated_atstring
    string
    Nie

    RFC 3339.

  • 400Bad requestinvalid_json
    • invalid_jsonTreść nie jest prawidłowym JSON-em lub pole ma niewłaściwy typ.
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów
  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedBrak klucza API, nieprawidłowy format klucza lub nieznany klucz.
    • key_revokedKlucz został unieważniony.
    • key_expiredKlucz utracił ważność.
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_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.
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów
  • 404Not foundtemplate_not_found
    • template_not_foundW Twojej organizacji nie ma szablonu o tym ID.
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów
  • 422Unprocessable entityvalidation_failed
    • validation_failedZapytanie to poprawny składniowo JSON, ale opisuje nieprawidłowe zadanie. details[] zawiera wszystkie problemy.
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów
  • 429Too many requestsrate_limited
    • 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ę).
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów
  • 500Internal server errorinternal_error
    • internal_errorWystąpił błąd po naszej stronie.
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów
  • 503Service unavailableapi_disabled
    • api_disabledAPI jest tymczasowo wyłączone (prace konserwacyjne) lub wyłączone dla organizacji.
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów