Etiket oluştur

POST /openapi/Document/CreateLabel — TMS API · Etiket

Kayıtlı gönderilerin kolileri için taşıyıcı etiketi oluşturur ve etiket içeriğini döner.

  • Her koli customerSpecificCode (sizin koli numaranız) ile tanımlanır.
  • format boş ya da tanınmayan bir değerse etiket ZPL üretilir; PDF ya da görüntü formatı için ilgili format kodunu gönderin.
  • Çok koli tek etikete bağlanıyorsa labelSequenceNumber ve isLastSequence ile sırayı belirtin (isLastSequence boşsa true kabul edilir).
  • Koli desi/ağırlığı gönderilirse gönderi kaydındaki değerler güncellenir.
  • Yanıttaki barcodeLabel etiket içeriğidir (ZPL metni ya da formatına göre kodlanmış içerik).

İstek gövdesi

  • clientCode (string, zorunlu): Organizasyon kodu.
  • accountCode (string, zorunlu): Hesap kodu.
  • createLabels (object[], zorunlu): Etiketi oluşturulacak gönderiler.
    • createLabels.parcels (object[]): Etiket alınacak koliler.
      • createLabels.parcels.data (any[]): Taşıyıcıya özel ek veri.
      • createLabels.parcels.lines (object[]): Kolideki sipariş satırları.
      • createLabels.parcels.format (string): Etiket formatı kodu (ör. ZPL, PDF). Boş ya da tanınmayan değerde ZPL üretilir.
      • createLabels.parcels.weight (number): Koli ağırlığı (kg).
      • createLabels.parcels.isFragile (boolean): Kırılabilir koli mi.
      • createLabels.parcels.isLastSequence (boolean): Son koli mi; boşsa true kabul edilir.
      • createLabels.parcels.volumetricWeight (number): Koli desisi.
      • createLabels.parcels.labelSequenceNumber (string): Çok koli tek etiket akışında sıra numarası.
      • createLabels.parcels.customerSpecificCode (string): Koli numarası (sizin tekil koli kodunuz).
    • createLabels.locationCode (string): Gönderinin çıkış lokasyonu kodu.
    • createLabels.consignmentNumber (string): Gönderi numarası.

Yanıtlar

  • 200: Oluşturulan etiketler
  • 400: Gönderi bulunamadı, gönderi tipi uygun değil ya da taşıyıcı hata döndü
  • 401: Token yok, geçersiz ya da süresi dolmuş (gövdesiz yanıt).
  • 429: İstek sınırı aşıldı.

200 yanıt alanları

  • format (string): Etiket formatı.
  • carrierCode (string): Taşıyıcı kodu.
  • barcodeLabel (string): Etiket içeriği (ZPL metni ya da formatına göre kodlanmış içerik).
  • barcodeValue (string): Etiketteki barkod değeri.
  • trackingLink (string): Takip bağlantısı.
  • trackingNumber (string): Taşıyıcı takip numarası.
  • consignmentNumber (string): Gönderi numarası.
  • customerSpecificCode (string): Koli numarası.
  • barcodeLabelIntegrationTypeCode (string): Etiketin hangi entegrasyon tipiyle üretildiği.