跳轉到主要內容
此頁面由英文翻譯而成。英文版為官方權威來源。如翻譯內容有任何不一致之處,請以英文版為準。

取得標籤文件

建立配送標籤後,使用 GET /labels/{id} 取得可列印的航空提單文件。傳入單一識別碼或以逗號分隔的多個識別碼即可進行批次取得。本指南涵蓋取得流程、批次請求、文件格式及實務注意事項。

取得文件 URL

使用標籤建立回應中的 id。{id} 可接受標籤 UUID,或建立標籤時提供的 customerOrderNumber:

回應

200 OK

下載並列印

從回傳的 url 下載文件:

文件行為

  • 時限性 URL — url 為短期下載連結(目前約 1 小時有效,未來可能調整)。請勿保存此連結。需要下載時,請重新呼叫 GET /labels/{id} 以取得新的 URL。
  • 格式 — 建立標籤時將 label.format 設為 "PDF" 或 "PNG",省略時使用 PDF。GET /labels/{id} 會以小寫 labelFormat: "pdf" 或 "png" 回傳所選格式;此呼叫不會變更格式。本頁範例取得 PDF 標籤。
  • 重新取得 — 每次呼叫都會為同一份文件回傳新的 URL。文件內容不變,但 URL 字串會改變。

批次取得

透過傳入以逗號分隔的識別碼,即可在單一請求中取得多個標籤文件。您可以混合使用標籤 UUID 和客戶訂單編號。 識別碼清單的處理方式:
  • 路徑參數會以逗號分割。每個片段會去除前後空白,空片段會被丟棄,重複的會合併,因此 a,,a, b 會被視為 a,b。
  • 只剩一個識別碼時,回傳單一標籤的回應(不存在則為 404,物流業者提交失敗的標籤則為 422)。兩個以上則回傳下方說明的 labels 陣列格式。
  • 不存在的標籤與物流業者提交失敗的標籤會從 labels 中省略,不會有錯誤項目。若所有識別碼都無法解析,請求回傳 404。
  • 目前沒有強制的上限。請將批次保持在較小規模(數十個而非數百個);每個識別碼都需要向物流業者解析一份文件。
新的標籤請求會拒絕 customerOrderNumber 中包含逗號;目前的限制請參閱客戶訂單編號。若舊版記錄的訂單編號中含有逗號,由於此端點會以逗號分割識別碼,請改用標籤 UUID 取得該記錄。

批次回應

200 OK
找不到或失敗的標籤會從回應中被靜默省略。請將回傳的 labels 陣列與您請求的識別碼進行比對,以偵測未成功解析的項目。

錯誤處理

後續步驟

追蹤出貨

列印並貼附標籤後,監控出貨進度。

錯誤處理

所有 HTTP 狀態碼和錯誤回應格式的完整參考。