本文へスキップ
CargoDuo logoCargoDuo
料金

このドキュメントは現在、英語版のみです。

開発者向けドキュメントAPI referenceTemplates

Update a template

Changes a template.

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

Items already in projects keep their own copy. Free: no credits are charged.

認証

Bearer API キー(必要なスコープ)resources:write詳細を見る

パスパラメーター

名前型必須説明
idstring必須
string
はい

Template id (tpl_…).

ボディパラメーター

application/json
名前型必須説明
labelstring
string
いいえ

Display label.

≤ 255 chars
shapestring
string
いいえ

Item shape. cylinder and drum use radius + height instead of length + width; pallet and drum always stay upright.

boxcylinderpalletbagdrumデフォルト "box"
lengthnumber · cm
number · cm
いいえ

Length. Required unless shape is cylinder or drum.

widthnumber · cm
number · cm
いいえ

Width. Required unless shape is cylinder or drum.

heightnumber · cm
number · cm
いいえ

Height (the vertical side when the item stands as defined).

radiusnumber · cm
number · cm
いいえ

Radius. Required when shape is cylinder or drum.

weightnumber · kg
number · kg
いいえ

Weight of ONE unit.

stackableboolean
boolean
いいえ

Other items may be placed on top of this one.

デフォルト true
max_stack_weightnumber · kg
number · kg
いいえ

Maximum weight that may rest on one unit. 0 = unlimited.

デフォルト 0
rotationstring
string
いいえ

all = any of the six orientations; upright = may only turn around the vertical axis (this side up); fixed = never rotated.

alluprightfixedデフォルト "all"
hazardousboolean
boolean
いいえ

Dangerous goods: kept low and separated from other hazardous items.

デフォルト false
priorityinteger
integer
いいえ

Load priority. Higher = loaded first and kept when space runs out. 0 = none.

デフォルト 0
colorstring
string
いいえ

Display colour as #rrggbb (viewer and PDF only).

nesting_heightnumber · cm
number · cm
いいえ

Telescoping overlap when identical units stack (nested crates, buckets).

デフォルト 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
  }'

レスポンスの例

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

レスポンス

  • 200OKThe template after the change.
    名前型必須説明
    idstring
    string
    いいえ

    Template id (tpl_…).

    objectstring
    string
    いいえ
    template
    labelstring
    string
    いいえ

    Display label.

    shapestring
    string
    いいえ

    Item shape. cylinder and drum use radius + height instead of length + width; pallet and drum always stay upright.

    boxcylinderpalletbagdrum
    lengthnumber · cm
    number · cm
    いいえ

    Length. Required unless shape is cylinder or drum.

    widthnumber · cm
    number · cm
    いいえ

    Width. Required unless shape is cylinder or drum.

    heightnumber · cm
    number · cm
    いいえ

    Height (the vertical side when the item stands as defined).

    radiusnumber · cm
    number · cm
    いいえ

    Radius. Required when shape is cylinder or drum.

    weightnumber · kg
    number · kg
    いいえ

    Weight of ONE unit.

    stackableboolean
    boolean
    いいえ

    Other items may be placed on top of this one.

    max_stack_weightnumber · kg
    number · kg
    いいえ

    Maximum weight that may rest on one unit. 0 = unlimited.

    rotationstring
    string
    いいえ

    all = any of the six orientations; upright = may only turn around the vertical axis (this side up); fixed = never rotated.

    alluprightfixed
    hazardousboolean
    boolean
    いいえ

    Dangerous goods: kept low and separated from other hazardous items.

    priorityinteger
    integer
    いいえ

    Load priority. Higher = loaded first and kept when space runs out. 0 = none.

    colorstring
    string
    いいえ

    Display colour as #rrggbb (viewer and PDF only).

    nesting_heightnumber · cm
    number · cm
    いいえ

    Telescoping overlap when identical units stack (nested crates, buckets).

    created_byUserRef | null
    UserRef | null
    いいえ

    The member who created it (for API calls: the member who created the key). null when unknown.

    updated_byUserRef | null
    UserRef | null
    いいえ

    The member who last changed it.

    created_atstring
    string
    いいえ

    RFC 3339.

    updated_atstring
    string
    いいえ

    RFC 3339.

  • 400Bad requestinvalid_json
    • invalid_jsonThe body is not valid JSON or a field has the wrong type.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedMissing, malformed or unknown API key.
    • key_revokedThe key was revoked.
    • key_expiredThe key passed its expiry date.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • 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
    はい
    すべてのエラーコード
  • 404Not foundtemplate_not_found
    • template_not_foundNo template with this id in your organization.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 422Unprocessable entityvalidation_failed
    • validation_failedThe request is well-formed JSON but describes an invalid job. details[] lists every problem.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 429Too many requestsrate_limited
    • rate_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
    はい
    すべてのエラーコード
  • 500Internal server errorinternal_error
    • internal_errorSomething failed on our side.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 503Service unavailableapi_disabled
    • api_disabledThe API is temporarily disabled (maintenance) or switched off for the organization.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード