2.4 列印標籤
此章節將會說明如何使用我們的 API 來列印貨物標籤。 API 回傳的標籤內容是編碼后的 base64 字串,使用者需要將該字串解碼成 byte[] 並儲存為 *.pdf 檔案使用。用戶可以將多個 Hawb 號碼傳入 API,以獲取多個標籤。
參數
列印標籤配置
序號 | 參數 | 資料形態 | 必填項 | 說明 |
---|---|---|---|---|
1 | LabelSize | Enum | 是 | 選擇標籤尺寸大小 |
2 | LabelFormat | Enum | 是 | 選擇標籤檔案格式 |
// Values of LabelSize
// 若你使用 SOAP,可使用列舉
// 若你使用 JSON,使用數字即可
// 若你不確定該使用什麼,那就選 Inch_6x4
public enum LabelSize {
Cm_10x10 = 0,
Inch_6x4 = 1, // 此 API 目前只支持使用 6x4 英吋大小的標籤
A4 = 2
}
// Values of LabelFormat
// 若你使用 SOAP,可使用列舉
// 若你使用 JSON,使用數字即可
// 若你不確定該使用什麼,那就選 Pdf
public enum LabelFormat {
Pdf = 0, // 此 API 目前只支持 PDF 格式標籤
Zpl = 1
}
備註:
- 此 API 目前只支持使用 6x4 英吋大小的標籤
- 此 API 目前只支持 PDF 格式標籤
範例:
標籤參數
序號 | 參數 | 資料形態 | 長度 | 必填項 | 說明 |
---|---|---|---|---|---|
1 | ShipmentsCredentials | ShipmentsCredentials | 是 | 參考1.2章節 | |
2 | ShipmentsConfiguration | ShipmentsConfiguration | 是 | 參考列印標籤配置 | |
3 | TrackReport | Enum | 是 | API 提供的報告類型 | |
4 | LabelType | Enum | 是 | 選擇標籤類型 | |
5 | HawbNo | String[] | 50 | 是 | 貨物 Hawb 號碼 |
// Values of LabelSize
// 若你使用 SOAP,可使用列舉
// 若你使用 JSON,使用數字即可
// 若你不確定該使用什麼,那就選 Label
public enum TrackReport {
Label = 0,
CheckList = 1,
CommercialInvoice = 2,
ShipmentsSummary = 3,
ShipmentsSummary_CSV = 4,
ShipmentsSummary_Excel = 5,
AUPostManifest = 6
}
// Values of LabelFormat
// 若你使用 SOAP,可使用列舉
// 若你使用 JSON,使用數字即可
// 若你不確定該使用什麼,那就選 LWELabel
public enum LabelType {
BothLabel = 0,
LWELabel = 1,
CarrierLabel = 2
}
範例:
LabelParameter _par = new LabelParameter();
_par.ShipmentsCredentials = _credentials;
_par.ShipmentsConfiguration = _config;
_par.TrackReport = TrackReport.Label;
_par.LabelType = LabelType.BothLabel;
_par.HawbNo = new string[2]
_par.HawbNo[0] = "344010500000151";
_par.HawbNo[1] = "344010500000125";