تخطَّ إلى المحتوى

هذه الوثائق متاحة حاليًا باللغة الإنجليزية فقط.

وثائق المطورينAPI referenceTemplates

Create a template

Saves an item as a template (it shows in the app too).

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

Same fields and checks as a /v1/pack item. Free: no credits are charged.

المصادقة

مفتاح API من نوع Bearer بالصلاحيةresources:writeاعرف المزيد

معاملات المحتوى

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

مثال على الاستجابة

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

الاستجابات

  • 201The new template.
    الاسمالنوعمطلوبالوصف
    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
    نعم
    كل رموز الأخطاء
  • 413Payload too largepayload_too_large
    • payload_too_largeThe request body exceeds 10 MB.
    الاسمالنوعمطلوبالوصف
    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
    نعم
    كل رموز الأخطاء