請注意:-由亞太地區寄往美國或波多黎各的FedEx 國際電商易(FICP)服務貨件,如關稅和稅額由收件人支付,必須提供FedEx帳號:
- 如有任何貨件商品的產地為中國/香港
此 API 可讓您建立公開貨件並允許在一段時間內將包裹新增至貨件中,而非一次性輸入全部貨件和包裹資料。貨件於五日期內維持可供填寫資料的狀態,且在該期間內接受新增及修改包裹。貨件一經確認,即可生成如標籤、空運提單或報告等託運文件。於第五日結束時,貨件則必須獲確認,否則會被刪除。
備註:如果在貨件建立起第五日結束前未獲確認,公開貨件將被刪除。
Open Ship API 在您想於一段時間內新增多件包裹至貨件中,且您不確定自己打算新增多少件包裹或何時完成貨件時使用。這會為您提供一種靈活方式,可於全天準備貨件,直至準備好託運為止。
Open Ship 貨件通常是多件包裹貨件,但也可以是單件包裹貨件,亦稱為單件貨件。
要託運多件包裹貨件 (MPS) 至單一收件人,請使用 Open Ship API 並新增個別包裹至貨件中,或新增多件包裹 (如果要寄給同一名收件人)。
以下是與公開貨件相關的服務:
以下是與 Open Ship API 相關的功能:
管理公開貨件
此功能可讓寄件人建立、修改、刪除公開貨件,並檢索已經建立的公開貨件以作審查或驗證用途。透過該功能可確認已完成的貨件來轉移 FedEx 貨件數據給 FedEx,並生成適當的貨件文件。該功能亦可識別並報告交易中的任何錯誤,並提供適當的狀態。
此功能的關鍵資料為 accountNumber、Shipment Data、groupPackageCount、index,以表示貨件的主包裹。此功能的結果將確保貨件數據上載至 FedEx 系統,以及生成了適當的查詢號碼、標籤和貨件報告。
管理公開貨件包裹
此功能可讓您在已建立的公開貨件中新增、修改及刪除包裹。另外亦可以檢索現有公開貨件的現有包裹。
取得公開貨件結果 (非同步)
透過此功能可非同步地檢索已確認的貨件結果。當確認了有 40 件或以上包裹的公開貨件後,API 會以非同步方式處理貨件。
當以非同步方式處理貨件時,此要求的回覆只能確認要求已成功排序,但貨件不一定能成功處理。在回應時,它會輸出 jobId 以便稍後擷取結果。此功能會使用 jobId 來擷取 OpenShipment 結果 (建立、修改及確認),例如標籤、貨件報告。該功能亦可識別並報告貨件中的任何錯誤,並提供適當的狀態。
備註:如果非同步貨件回應中存在錯誤,請修正錯誤並提交新的貨件請求。
此部分詳細說明 Open Ship API 的具體工作流程。Open Ship 工作流程會以兩種方式管理或使用兩種處理選項:
40 件或以下包裹的工作流程
此確認公開貨件端點是此流程的最終端點,負責驗證貨件和包裹資料,並成功生成標籤和該貨件的所有其他報告。該端點亦會提供驗證期間發回的錯誤詳情。這些錯誤可使用端點修改公開貨件或修改公開貨件包裹來修正,並為成功請求再次確認貨件。
40 件包裹以上的工作流程
取得公開貨件結果端點是此流程的最終端點,負責檢索已確認的公開貨件結果,例如已確認公開貨件的標籤和所有其他報告。如果回應中發回了錯誤詳情,則這些錯誤可使用端點修改公開貨件或修改公開貨件包裹予以修正,並使用端點確認公開貨件來確認貨件,最後使用端點取得公開貨件結果來就成功請求檢索已確認公開貨件的結果。
以下是與 Open Ship API 相關的功能:
建立公開貨件
使用此端點來建立公開貨件,並提供所需的貨件資料,以及至少定義貨件中的一件包裹。
以下是建立公開貨件時必要的輸入資料:
對此請求的成功回應將處理貨件並生成查詢號碼,該號碼即為第一件包裹的主查詢號碼。請注意:回應中不會生成標籤。
新增公開貨件包裹
使用此端點,在貨件確認前,新增一件或以上包裹至現有的公開貨件請求中。在日間準備貨件時,您可以為每件包裹發送單獨的「新增包裹」請求您亦可以在「新增包裹」請求內發送多件包裹。
備註:貨件的包裹總數不得超過公開託運包裹上限。
以下是新增包裹至公開貨件時必要的輸入資料:
對此請求的成功回應將為最新加入的包裹生成查詢號碼。
修改公開貨件包裹
使用此端點,在貨件確認前,修改現有 Open Ship 貨件中一件或以上包裹的詳情。這亦包括主包裹,即第一件新增至公開貨件中的包裹。
與此請求相關的必填輸入資料如下:
成功請求將更新目標包裹並發回更新後的貨件詳情。
刪除公開貨件包裹
使用此端點,在貨件確認前,從已建立公開貨件中刪除一件或以上的包裹。
與此請求相關的必填輸入資料如下:
成功請求將刪除目標包裹並在輸出中將 deletedPackagesFromOpenshipment 元素的狀態發回為正確。
備註:如果貨件中的主包裹被刪除,隊列中的下一件包裹將成為主包裹,並獲得重新分配的主查詢號碼,號碼隊列會隨著被刪除包裹的數量減少而減少。
檢索公開貨件包裹
使用此端點來從已建立公開貨件中檢索一件或以上的包裹,以作審查或驗證用途。
與此請求相關的必填輸入資料如下:
成功請求將檢索目標包裹。
修改公開貨件
使用此端點,在貨件確認前,使用所需託運資料修改公開貨件請求。
與此請求相關的必填輸入資料如下:
成功請求將更新貨件詳情至已建立的公開貨件,並在輸出中發回已修改包裹的查詢號碼及更新後的交易貨件詳情。
檢索公開貨件
使用此端點來檢索已建立的公開貨件以審核或驗證。
與此請求相關的必填輸入資料如下:
成功請求將檢索目標公開貨件詳情。
刪除公開貨件
使用此端點,在貨件確認前,刪除公開貨件請求。
與此請求相關的必填輸入資料如下:
成功請求將刪除公開貨件及所有相關包裹,並在輸出中將 deletedOpenshipment 元素的狀態發回為正確。
確認公開貨件
使用此端點,在所有包裹均已新增至貨件請求中後,驗證及上載 Open Ship 貨件數據至 FedEx 系統。
與此請求相關的必填輸入資料如下:
對 40 件或以下包裹的成功確認回應將上載貨件數據至 FedEx 系統,並生成包裹標籤及所有其他貨件報告。
對 40 件以上包裹的成功確認回應則會確認請求已成功加入隊列並發回 jobId 以供稍後檢索結果。
備註:公開貨件中應包含至少一件包裹,然後您方可確認貨件。
取得公開貨件結果
使用此端點來取得已確認的 Open Ship 貨件數據。此端點只應在存在超過 40 件包裹且公開貨件確認中發回 jobId 時使用。
與此請求相關的必填輸入資料如下:
對此請求的成功回應將發回已確認的公開貨件結果,例如已確認公開貨件的包裹標籤和所有其他貨件報告。如果回應中發回了錯誤詳情,則這些錯誤可使用端點修改公開貨件或修改公開貨件包裹予以修正,並使用端點確認公開貨件來確認貨件,最後使用端點取得公開貨件結果來就成功請求檢索已確認公開貨件的結果。
多件包裹公開貨件 (MPS) 由兩件或以上寄送至相同收件人地址的包裹組成。託運請求中的第一件包裹即視為主包裹。
要建立多件包裹貨件:
貨件確認後,將使用以下其中一個處理選項:
同步貨件處理
同步處理是最理想的處理方法之一,可於貨件含有 40 件或以下的包裹 (包裹總數量/grouppackagecount<=40),且貨件中商品數量有限時在內部使用。
有 40 件或以下包裹的貨件請求確認時,將以同步方式處理,並會即時生成標籤、貨件文件/報告。如果設有時間限制以及貨件確認後必須立即列印標籤,則此流程對寄件人而言是最理想的選擇。
備註:包裹上限 40 件僅供指示之用,非固定上限。上限亦取決於貨件中包裹和商品數量的總和。如需更多資訊,請聯絡您的 FedEx 支援團隊。
例子:您的公開貨件請求共有 10 件包裹。當您新增全部 10 件包裹後確認貨件時,貨件將以同步方式處理。回應中會建立 10 張標籤,並且回應中會按要求提供標籤網址或已加密的標籤。
以下高層級工作流程會展示同步公開貨件處理:
請注意:
非同步貨件處理
當包裹總數超過 40 件時 (即:totalPackageCount>40),API 會在內部以非同步方式處理貨件。當您的包裹量很大,希望定期提交大量貨件時,這是一種非常簡便的方法。進行一次性提交時,此大量貨件提交會使用各種昂貴的 FedEx 資源和操作。有了此處理選項,FedEx 可在內部確保這些大量貨件輕鬆得到處理,而您亦可以定期取得標籤資料。
以非同步方式處理貨件時,對此請求的回應只會確認請求已成功加入隊列,但貨件可能會或可能不會成功處理,並會發回 jobId 以供稍後檢索結果。
請注意:此流程需要一定時間,方可成功處理貨件,然後您才可以檢索結果。
如要檢索非同步貨件結果,請使用端點取得公開貨件結果,並在請求中提供 jobId 和 accountNumber 詳情。對此請求的回應將發回貨件結果資料及標籤詳情,或者貨件錯誤詳情。
例子:您的貨件共有 45 件包裹,確認後將進行非同步處理。回應中將發回 jobId。然後您應使用端點取得公開貨件結果來檢索貨件結果和標籤數據。
以下高層級工作流程會展示非同步託運處理:
請注意:
Print As You Go (PASGO)
您可利用 Print As You Go (PASGO)功能,以多件包裹公開貨件形式建立及新增包裹,當您新增每個包裹時,可即時列印標籤。這表示您可即時列印標籤,無需等待貨件關閉。
重要備註:
FedEx API 支援一系列不同的標籤。FedEx API 支援三種標籤選項,包括熱感應、一般紙張和自訂標籤。您可以使用 Open Ship API 端點來製作一系列不同的標籤。
FedEx 提供 2 種標籤格式以支援託運服務:
熱感應標籤
FedEx API 讓您可以使用一系列不同的熱感應標籤打印機,為所有類型的託運列印託運標籤,例如 FedEx Express®、FedEx Ground® 及 FedEx International Ground®。
FedEx API 支援以下熱感應標籤尺寸:
標籤庫類型 4" x 8.5” 和 4" x 10.5” 包含具相同條碼的附加文件標籤。主標籤上會顯示一個條碼,另一個則顯示在文件標籤上。此標籤庫類型值特別適合輪胎包裹,因為可將一個標籤放在輪胎的胎面上,另一個文件標籤則印有條碼的複本,以及輪胎邊的操作指示。使用這些標籤庫類型能減少輪胎重新標籤的次數,而增加尺寸掃描則能優化輪胎維修。有關標籤庫的更多資訊,請參閱標籤庫類型。
備註:Doc-Tab 是可移除的黏性索引標籤,上面列有更多的託運資料,在使用熱敏打印機列印託運標籤時,可為標籤庫選擇此選項。
熱感應標籤元素
熱感應託運標籤含有三項基本元素:
生成熱感應標籤的關鍵資料
以下是生成熱感應標籤所需的關鍵資料:
有效值:
ImageType:為您所使用的打印機格式化熱感應標籤所必需;提供數據流類型或要發回的位元圖。
有效值:
備註:貨件所需的所有標籤都會在單次緩衝中生成並發回。
支援的熱敏打印機
建議 FedEx API 使用以下熱敏打印機:
備註:這些打印機均兼容 ASCII Eltron 編程語言 (EPL2) 頁面模式。熱敏打印機可直接寫入連接至系統序列埠的打印機,或作為 LPT、序列或 USB 連接的原生 Windows 安裝打印機。FedEx 提供的打印機韌體版本可能視乎地區而有所不同。
每項服務所打印的熱感應標籤數量
以下表格標示了每種特別服務所需的每類標籤數量。所有必要標籤都會在呼叫 FedEx 通用標籤伺服器 (CLS) 後生成,CLS 將發回單次緩衝,惟貨到付款除外。退件標籤。
每項美國服務所列印的熱感應標籤數量
服務類型 |
熱感應標籤 (FedEx CLS 將在回應中發回適當數量的標籤) |
FedEx Express 美國 |
1 張託運標籤 |
FedEx Ground 美國/FedEx Home Delivery |
1 張託運標籤 |
每項美國出口國際服務所列印的熱感應標籤數量
服務類型 |
熱感應標籤 (FedEx CLS 將在回應中發回適當數量的標籤) |
FedEx Express 美國出口國際 |
1 張託運標籤 2 張收件人標籤 |
FedEx Express 美國出口指定清關代理人選項 |
1 張託運標籤 2 張收件人標籤 |
FedEx Ground 美國出口國際 |
1 張託運標籤 |
FedEx Ground 美國出口國際貨到付款 |
1 張託運標籤 2 張貨到付款退件標籤 |
每項加拿大境內服務所列印的熱感應標籤數量
服務類型 |
熱感應標籤 (FedEx CLS 將在回應中發回適當數量的標籤) |
FedEx Express 加拿大境內 |
非 DG (危險品)/乾冰貨件: 1 張託運標籤 |
FedEx Ground 加拿大境內 |
1 張託運標籤 |
FedEx Ground 加拿大境內貨到付款 |
1 張託運標籤 2 張貨到付款退件標籤 |
每項加拿大出口國際服務所列印的熱感應標籤數量
服務類型 |
熱感應標籤 (FedEx CLS 將在回應中發回適當數量的標籤) |
FedEx Express 加拿大出口國際 |
非 DG/乾冰貨件: 1 張託運標籤 2 張收件人標籤 |
FedEx Express 加拿大出口指定清關代理人選項 |
非 DG/乾冰貨件: 1 張託運標籤 2 張收件人標籤 |
FedEx Ground 加拿大 (CA) 出口國際 |
1 張託運標籤 |
每項菲律賓和泰國入境貨件所列印的熱感應標籤數量
服務類型 |
熱感應標籤 (FedEx CLS 將在回應中發回適當數量的標籤) |
菲律賓入境貨件 |
2 張託運標籤,印上帳戶號碼 1 張收件人標籤,不會印上帳戶號碼 3 份商業發票副本 |
泰國入境商品類貨件 |
3 張託運標籤,印上帳戶號碼 1 張收件人標籤,不會印上帳戶號碼 |
泰國入境文件類貨件 |
2 張託運標籤,印上帳戶號碼 1 張收件人標籤,不會印上帳戶號碼 |
Doc-Tab
如果您使用熱敏打印機來列印託運標籤,您可選擇包含 Doc-Tab 的標籤庫;Doc-Tab 是一張可移除的黏性索引標籤,上面列有額外的託運資料。您可以從託運數據中配置這些託運資料,或選擇列印您的託運需要專屬的可配置數據。
鐳射標籤
FedEx API 支援使用鐳射打印機列印標籤。這些標籤通常列印在美國信件或 A4 紙上,並對摺一半,以放入標準 FedEx 標籤郵包內。使用鐳射打印機列印的標籤會以 PDF 格式生成,無須調整比例或更改尺寸。有關標籤庫的更多資訊,請參閱標籤庫類型。
先決條件
以下要求適用於 PDF 標籤:
有了 PDF 標籤選項便無須再指明圖片方向參數 (寬度和高度) 或螢幕解像度,以在瀏覽器中正確顯示標籤。
鐳射標籤元素
鐳射託運標籤含有三項基本元素:
生成鐳射標籤的關鍵資料
以下是生成鐳射標籤所需的 FedEx API 元素:
有效值為:
請注意:如果您索取的是一般紙張標籤,所發回的數據將為 Base64 加密標籤圖片,必須經過 Base64 解密程序,方可顯示標籤檔案。
支援的鐳射打印機
大部分鐳射打印機均支援此標籤類型;然而,恕不接受以噴墨打印機列印的標籤。
請注意:如果您使用彩色鐳射打印機,即使該打印機只安裝了黑色墨盒,顏色定義亦應設定為黑色。
每項服務所需的鐳射標籤數量
以下表格標示了每種特別服務所需的每類標籤數量。所有必要標籤都會在呼叫 FedEx 通用標籤伺服器 (CLS) 後生成,CLS 將發回單次緩衝,惟貨到付款除外。退件標籤。
每項美國服務所列印的鐳射標籤數量
服務類型 |
鐳射標籤 - PDF 格式 |
FedEx Ground/FedEx Home Delivery 美國 |
1 張託運標籤 |
每項美國出口國際服務所列印的鐳射標籤數量
服務類型 |
鐳射標籤 - PDF 格式 |
FedEx Express 美國出口國際 |
回應中有 1 張託運標籤;必須列印至少 3 張標籤 – 包裹上 1 張標籤,文件郵包上 2 張。 |
FedEx Express 美國出口指定清關代理人選項 |
回應中有 1 張託運標籤;必須列印至少 3 張標籤 – 包裹上 1 張標籤,文件郵包上 2 張。 |
FedEx Ground 美國出口國際 |
1 張託運標籤 |
FedEx Ground 美國出口國際貨到付款 |
1 張託運標籤 2 張貨到付款退件標籤 |
每項墨西哥境內服務所列印的鐳射標籤數量
服務類型 |
鐳射標籤 - PDF 格式 |
FedEx Express 墨西哥境內 |
FedEx Express 墨西哥境內 非 DG (危險品)/乾冰貨件: 1 張託運標籤 |
每項加拿大境內服務所列印的鐳射標籤數量
服務類型 |
鐳射標籤 - PDF 格式 |
FedEx Express 加拿大境內 |
FedEx Express 加拿大境內 非 DG (危險品)/乾冰貨件: 1 張託運標籤 |
FedEx Ground 加拿大境內 |
1 張託運標籤 |
FedEx Ground 加拿大境內貨到付款 |
1 張託運標籤 2 張貨到付款退件標籤 |
每項加拿大出口國際服務所列印的鐳射標籤數量
服務類型 |
鐳射標籤 - PDF 格式 |
FedEx Express 加拿大出口國際 |
FedEx Express 加拿大出口國際 非 DG/乾冰貨件: 1 張託運標籤 2 張收件人標籤 |
FedEx Express 加拿大出口指定清關代理人選項 |
FedEx Express 加拿大出口指定清關代理人選項 非 DG/乾冰貨件: 1 張託運標籤 2 張收件人標籤 |
FedEx Ground 加拿大 (CA) 出口國際 |
1 張託運標籤 |
每項加拿大出口國際服務所列印的鐳射標籤數量
服務類型 |
鐳射標籤 - PDF 格式 |
FedEx Express 加拿大出口國際 |
FedEx Express 加拿大出口國際 非 DG/乾冰貨件: 1 張託運標籤 2 張收件人標籤 |
FedEx Express 加拿大出口指定清關代理人選項 |
FedEx Express 加拿大出口指定清關代理人選項 非 DG/乾冰貨件: 1 張託運標籤 2 張收件人標籤 |
FedEx Ground 加拿大 (CA) 出口國際 |
1 張託運標籤 |
每項菲律賓和泰國入境貨件所列印的鐳射標籤數量
服務類型 |
熱感應標籤 (FedEx CLS 將在回應中發回適當數量的標籤) |
菲律賓入境貨件 |
2 張託運標籤,印上帳戶號碼 1 張收件人標籤,不會印上帳戶號碼 3 份商業發票副本 |
泰國入境商品類貨件 |
3 張託運標籤,印上帳戶號碼 1 張收件人標籤,不會印上帳戶號碼 |
泰國入境文件類貨件 |
2 張託運標籤,印上帳戶號碼 1 張收件人標籤,不會印上帳戶號碼 |
自訂標籤
FedEx 允許自訂由 FedEx 生成的標籤。您可根據您的業務來新增文字,並選擇 FedEx 文件和熱感應標籤之自訂部分所使用的條碼類型 (符號系統)。
為支援您的託運應用程式,FedEx Open Ship API 提供兩個選項,讓您自訂託運標籤:
請注意:標籤的人類可讀內容和標籤共用部分的條碼不得修改。
自訂驗證器標籤
您可於包裝層級和貨件層級建立非託運自訂標籤,方法是指明您想要哪些自訂資料、如何調整該等資料的格式,以及將該等資料置於自訂標籤上的哪個位置。自訂標籤限於熱感應標籤格式。
自訂熱感應標籤
FedEx APi 提供兩種熱感應標籤格式,讓您透過圖像或文字檔案來進行自訂,以免需要建立自訂標籤。這些標籤支援所有 FedEx 託運服務。這些格式是:
這些標籤類型提供2吋的可自訂部分。此功能適用於設定為203 DPI或300 DPI之熱敏打印機所列印的熱感應標籤。
自訂標籤的規則
使用標籤格式的規則為:
請注意:只可以加入單位元彩色圖片,因為標籤會以黑白列印。
自訂標籤圖像條目元素
API 為 FedEx Express 和 FedEx Ground 標籤提供 PNG (可攜網絡圖像) 圖片。PNG 標籤圖像是 API 所支援之熱感應或一般紙張標籤的複製品。此標籤選項可讓您將 PNG 標籤圖像置入您的標籤庫中,以防止需要建立自訂標籤。
使用託運文件中內嵌的 4 吋 x 6 吋 PNG 圖像時,需遵守以下要求:
標籤庫
4 吋 x 6 吋 PNG 標籤僅應用於一撕即貼的標籤庫。FedEx Ground和FedEx Express標籤驗證團隊會拒絕非列印於一撕即貼標籤庫的4吋x6吋PNG標籤,包括任何列印於一般紙張上的標籤。
打印機
建議使用鐳射打印機來列印標籤。不應使用噴墨打印機,因為它們在建立可掃描條碼方面的表現不一致。即使打印機只安裝了黑色墨盒,4 吋 x 6 吋 PNG 標籤亦不得使用彩色打印機列印,除非顏色定義已設定為黑色。此設定很有必要,有助於在 FedEx 樞紐正確定義條碼,以便進行掃描。
比例調整
您的託運交易中發回的圖片為每吋 200 點 (DPI),尺寸為 4 吋 (寬) x 6 吋 (高) 或 800 x 1200 像素。此標籤以垂直方式定位,專門設計用來列印於 4 吋 x 6 吋的標籤區域上。列印出來後,標籤的尺寸應為 4 吋 x 6 吋。
要根據所需的 DPI 來列印標籤和條碼,您必須在列印前調整圖片比例 (或改變大小)。調整圖片比例的方式取決於您用於檢視及列印標籤的應用程式。要以吋為單位為 4 吋 x 6 吋標籤調整 PNG 圖片的比例:請使用 4 吋寬和 6 吋長的確切比例。
標籤查看核對清單
所有條碼
驗證必需:
列印質素
導致標籤被拒的常見問題:
Ground 標籤的人類可讀詳情
對於 FedEx Ground 標籤的人類可讀內容,以下事項為驗證所必需:
Express 標籤的人類可讀詳情
以下元素必須列印在標籤上,方可通過驗證:
以下規定適用於 Open Ship API:
Response