İçeriğe atla
Geliştirici dokümanlarıAPI referansıŞablonlar

Şablon oluştur

Bir öğeyi şablon olarak kaydeder (uygulamada da görünür).

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

Alanlar ve kontroller bir /v1/pack öğesiyle aynıdır. Ücretsiz: kredi harcanmaz.

Kimlik doğrulama

Bearer API anahtarı, gereken yetki:resources:writeDaha fazla bilgi

Gövde parametreleri

application/json
AdTürZorunluAçıklama
labelstringzorunlu
string
Evet

Görüntülenen etiket.

≤ 255 chars
shapestring
string
Hayır

Öğe şekli. cylinder ve drum, length + width yerine radius + height kullanır; pallet ve drum her zaman dik durur.

boxcylinderpalletbagdrumVarsayılan "box"
lengthnumber · cm
number · cm
Hayır

Uzunluk. shape değeri cylinder ya da drum değilse zorunludur.

widthnumber · cm
number · cm
Hayır

Genişlik. shape değeri cylinder ya da drum değilse zorunludur.

heightnumber · cmzorunlu
number · cm
Evet

Yükseklik (öğe tanımlandığı gibi dururken dikey kenar).

radiusnumber · cm
number · cm
Hayır

Yarıçap. shape değeri cylinder ya da drum ise zorunludur.

weightnumber · kgzorunlu
number · kg
Evet

TEK bir adedin ağırlığı.

stackableboolean
boolean
Hayır

Bu öğenin üzerine başka öğeler konabilir.

Varsayılan true
max_stack_weightnumber · kg
number · kg
Hayır

Tek bir adedin üzerine binebilecek en fazla ağırlık. 0 = sınırsız.

Varsayılan 0
rotationstring
string
Hayır

all = altı yönelimden herhangi biri; upright = yalnızca dikey eksen etrafında döndürülebilir (bu taraf yukarı); fixed = hiç döndürülmez.

alluprightfixedVarsayılan "all"
hazardousboolean
boolean
Hayır

Tehlikeli madde: alt seviyelerde tutulur ve diğer tehlikeli öğelerden ayrı yerleştirilir.

Varsayılan false
priorityinteger
integer
Hayır

Yükleme önceliği. Yüksek = önce yüklenir ve yer kalmadığında öncelikle korunur. 0 = yok.

Varsayılan 0
colorstring
string
Hayır

#rrggbb biçiminde görüntüleme rengi (yalnızca 3B görünüm ve PDF için).

nesting_heightnumber · cm
number · cm
Hayır

Özdeş adetler istiflendiğinde iç içe geçen yükseklik (iç içe geçen kasalar, kovalar).

Varsayılan 0

Örnek istek

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

Örnek yanıt

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

Yanıtlar

  • 201Yeni şablon.
    AdTürZorunluAçıklama
    idstring
    string
    Hayır

    Şablon ID'si (tpl_…).

    objectstring
    string
    Hayır
    template
    labelstring
    string
    Hayır

    Görüntülenen etiket.

    shapestring
    string
    Hayır

    Öğe şekli. cylinder ve drum, length + width yerine radius + height kullanır; pallet ve drum her zaman dik durur.

    boxcylinderpalletbagdrum
    lengthnumber · cm
    number · cm
    Hayır

    Uzunluk. shape değeri cylinder ya da drum değilse zorunludur.

    widthnumber · cm
    number · cm
    Hayır

    Genişlik. shape değeri cylinder ya da drum değilse zorunludur.

    heightnumber · cm
    number · cm
    Hayır

    Yükseklik (öğe tanımlandığı gibi dururken dikey kenar).

    radiusnumber · cm
    number · cm
    Hayır

    Yarıçap. shape değeri cylinder ya da drum ise zorunludur.

    weightnumber · kg
    number · kg
    Hayır

    TEK bir adedin ağırlığı.

    stackableboolean
    boolean
    Hayır

    Bu öğenin üzerine başka öğeler konabilir.

    max_stack_weightnumber · kg
    number · kg
    Hayır

    Tek bir adedin üzerine binebilecek en fazla ağırlık. 0 = sınırsız.

    rotationstring
    string
    Hayır

    all = altı yönelimden herhangi biri; upright = yalnızca dikey eksen etrafında döndürülebilir (bu taraf yukarı); fixed = hiç döndürülmez.

    alluprightfixed
    hazardousboolean
    boolean
    Hayır

    Tehlikeli madde: alt seviyelerde tutulur ve diğer tehlikeli öğelerden ayrı yerleştirilir.

    priorityinteger
    integer
    Hayır

    Yükleme önceliği. Yüksek = önce yüklenir ve yer kalmadığında öncelikle korunur. 0 = yok.

    colorstring
    string
    Hayır

    #rrggbb biçiminde görüntüleme rengi (yalnızca 3B görünüm ve PDF için).

    nesting_heightnumber · cm
    number · cm
    Hayır

    Özdeş adetler istiflendiğinde iç içe geçen yükseklik (iç içe geçen kasalar, kovalar).

    created_byUserRef | null
    UserRef | null
    Hayır

    Projeyi oluşturan üye (API çağrılarında: anahtarı oluşturan üye). Bilinmiyorsa null.

    updated_byUserRef | null
    UserRef | null
    Hayır

    Projeyi en son değiştiren üye.

    created_atstring
    string
    Hayır

    RFC 3339.

    updated_atstring
    string
    Hayır

    RFC 3339.

  • 400Bad requestinvalid_json
    • invalid_jsonGövde geçerli bir JSON değil ya da bir alanın türü yanlış.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları
  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedAPI anahtarı eksik, hatalı biçimde ya da tanınmıyor.
    • key_revokedAnahtar iptal edildi.
    • key_expiredAnahtarın geçerlilik süresi doldu.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedİsteği gönderen IP, anahtarın izin listesinde değil.
    • subscription_inactiveOrganizasyonun API'yi içeren etkin bir aboneliği yok.
    • account_inactiveOrganizasyon askıya alınmış ya da hesabı etkin olan bir organizasyon sahibi yok.
    • scope_missingAnahtarda bu endpoint'in gerektirdiği bir yetki eksik.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları
  • 413Payload too largepayload_too_large
    • payload_too_largeİstek gövdesi 10 MB sınırını aşıyor.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları
  • 422Unprocessable entityvalidation_failed
    • validation_failedİstek geçerli bir JSON ama geçersiz bir iş tanımlıyor. Tüm sorunlar details[] içinde listelenir.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları
  • 429Too many requestsrate_limited
    • rate_limitedGeçerli dakika, saat ya da gün içinde çok fazla istek gönderildi (anahtar ya da organizasyon başına) veya IP adresinizden gelen başarısız kimlik doğrulama denemeleri dakikada 60 sınırını aştı.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları
  • 500Internal server errorinternal_error
    • internal_errorBizim tarafımızda bir hata oluştu.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları
  • 503Service unavailableapi_disabled
    • api_disabledAPI geçici olarak devre dışı (bakım) ya da organizasyon için kapatılmış.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları