Zum Inhalt springen
EntwicklerdokumentationAPI-ReferenzVorlagen

Vorlage erstellen

Speichert einen Artikel als Vorlage (sie erscheint auch in der App).

POSThttps://runner.cargoduo.com/v1/templates

Dieselben Felder und Prüfungen wie für Artikel in /v1/pack gelten auch hier. Kostenlos: Es werden keine Credits abgebucht.

Authentifizierung

Bearer-API-Schlüssel mit Berechtigungresources:writeMehr erfahren

Body-Parameter

application/json
NameTypErforderlichBeschreibung
labelstringerforderlich
string
Ja

Bezeichnung.

≤ 255 chars
shapestring
string
Nein

Form des Artikels. cylinder und drum verwenden radius + height statt length + width; pallet und drum stehen immer aufrecht.

boxcylinderpalletbagdrumStandard "box"
lengthnumber · cm
number · cm
Nein

Länge. Erforderlich, sofern shape nicht cylinder oder drum ist.

widthnumber · cm
number · cm
Nein

Breite. Erforderlich, sofern shape nicht cylinder oder drum ist.

heightnumber · cmerforderlich
number · cm
Ja

Höhe (die senkrechte Seite, wenn der Artikel wie definiert steht).

radiusnumber · cm
number · cm
Nein

Radius. Erforderlich, wenn shape cylinder oder drum ist.

weightnumber · kgerforderlich
number · kg
Ja

Gewicht EINER Einheit.

stackableboolean
boolean
Nein

Andere Artikel dürfen auf diesen gestellt werden.

Standard true
max_stack_weightnumber · kg
number · kg
Nein

Maximales Gewicht, das auf einer Einheit lasten darf. 0 = unbegrenzt.

Standard 0
rotationstring
string
Nein

all = jede der sechs Ausrichtungen; upright = darf nur um die senkrechte Achse gedreht werden (diese Seite oben); fixed = wird nie gedreht.

alluprightfixedStandard "all"
hazardousboolean
boolean
Nein

Gefahrgut: wird niedrig und getrennt von anderem Gefahrgut platziert.

Standard false
priorityinteger
integer
Nein

Ladepriorität. Höher = wird zuerst geladen und bei Platzmangel bevorzugt mitgenommen. 0 = keine.

Standard 0
colorstring
string
Nein

Anzeigefarbe als #rrggbb (nur 3D-Ansicht und PDF).

nesting_heightnumber · cm
number · cm
Nein

Überlappung, wenn identische Einheiten ineinander gestapelt werden (verschachtelte Kisten, Eimer).

Standard 0

Beispielanfrage

curl -X POST "https://runner.cargoduo.com/v1/templates" \
  -H "Authorization: Bearer $CARGODUO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Euro pallet",
    "length": 120,
    "width": 80,
    "height": 140,
    "weight": 450,
    "stackable": false,
    "color": "#3b82f6"
  }'

Beispielantwort

201 · Template
{
  "id": "tpl_42",
  "object": "template",
  "label": "Euro pallet",
  "shape": "box",
  "length": 120,
  "width": 80,
  "height": 140,
  "radius": 0,
  "weight": 450,
  "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-09-28T14:05:52Z"
}

Antworten

  • 201Die neue Vorlage.
    NameTypErforderlichBeschreibung
    idstring
    string
    Nein

    Vorlagen-ID (tpl_…).

    objectstring
    string
    Nein
    template
    labelstring
    string
    Nein

    Bezeichnung.

    shapestring
    string
    Nein

    Form des Artikels. cylinder und drum verwenden radius + height statt length + width; pallet und drum stehen immer aufrecht.

    boxcylinderpalletbagdrum
    lengthnumber · cm
    number · cm
    Nein

    Länge. Erforderlich, sofern shape nicht cylinder oder drum ist.

    widthnumber · cm
    number · cm
    Nein

    Breite. Erforderlich, sofern shape nicht cylinder oder drum ist.

    heightnumber · cm
    number · cm
    Nein

    Höhe (die senkrechte Seite, wenn der Artikel wie definiert steht).

    radiusnumber · cm
    number · cm
    Nein

    Radius. Erforderlich, wenn shape cylinder oder drum ist.

    weightnumber · kg
    number · kg
    Nein

    Gewicht EINER Einheit.

    stackableboolean
    boolean
    Nein

    Andere Artikel dürfen auf diesen gestellt werden.

    max_stack_weightnumber · kg
    number · kg
    Nein

    Maximales Gewicht, das auf einer Einheit lasten darf. 0 = unbegrenzt.

    rotationstring
    string
    Nein

    all = jede der sechs Ausrichtungen; upright = darf nur um die senkrechte Achse gedreht werden (diese Seite oben); fixed = wird nie gedreht.

    alluprightfixed
    hazardousboolean
    boolean
    Nein

    Gefahrgut: wird niedrig und getrennt von anderem Gefahrgut platziert.

    priorityinteger
    integer
    Nein

    Ladepriorität. Höher = wird zuerst geladen und bei Platzmangel bevorzugt mitgenommen. 0 = keine.

    colorstring
    string
    Nein

    Anzeigefarbe als #rrggbb (nur 3D-Ansicht und PDF).

    nesting_heightnumber · cm
    number · cm
    Nein

    Überlappung, wenn identische Einheiten ineinander gestapelt werden (verschachtelte Kisten, Eimer).

    created_byUserRef | null
    UserRef | null
    Nein

    Das Mitglied, das es erstellt hat (bei API-Aufrufen: das Mitglied, das den Schlüssel erstellt hat). null, wenn unbekannt.

    updated_byUserRef | null
    UserRef | null
    Nein

    Das Mitglied, das es zuletzt geändert hat.

    created_atstring
    string
    Nein

    RFC 3339.

    updated_atstring
    string
    Nein

    RFC 3339.

  • 400Bad requestinvalid_json
    • invalid_jsonDer Body ist kein gültiges JSON, oder ein Feld hat den falschen Typ.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedAPI-Schlüssel fehlt, ist fehlerhaft oder unbekannt.
    • key_revokedDer Schlüssel wurde widerrufen.
    • key_expiredDer Schlüssel ist abgelaufen.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedDie aufrufende IP-Adresse steht nicht auf der Allowlist des Schlüssels.
    • subscription_inactiveDie Organisation hat kein aktives Abonnement, das die API enthält.
    • account_inactiveDie Organisation ist gesperrt oder hat keinen Inhaber mit aktivem Konto.
    • scope_missingDem Schlüssel fehlt eine Berechtigung, die dieser Endpoint benötigt.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 413Payload too largepayload_too_large
    • payload_too_largeDer Anfrage-Body ist größer als 10 MB.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 422Unprocessable entityvalidation_failed
    • validation_failedDie Anfrage ist wohlgeformtes JSON, beschreibt aber einen ungültigen Job. details[] listet alle Probleme auf.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 429Too many requestsrate_limited
    • rate_limitedZu viele Anfragen in der aktuellen Minute, Stunde oder am aktuellen Tag (pro Schlüssel oder pro Organisation) oder mehr als 60 fehlgeschlagene Authentifizierungen pro Minute von Ihrer IP-Adresse.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 500Internal server errorinternal_error
    • internal_errorAuf unserer Seite ist ein Fehler aufgetreten.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 503Service unavailableapi_disabled
    • api_disabledDie API ist vorübergehend deaktiviert (Wartung) oder für die Organisation abgeschaltet.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes