Fedex Logo
Developer Portal

Trade Documents Upload API

簡介

上載貿易文件 API 是一種上載國際 FedEx 託運文件解決方案，可簡化您的全球託運需求，並允許您以電子方式上載國際貨件所需的海關文件。您可以使用電子方式提交大部分貿易文件，從而無需列印或隨貨件附上貿易文件。

與隨貨件附上的紙質副本相比，海關和其他機構可更快收到電子發送的文件。清關流程也得以優化，因可在託運初期獲取及分享重要貿易資訊。

請注意：

  • 在某些情況下，仍需在包裹內附上特定國際文件正本。詳情請參考出口文件一節。
  • 為保證順利清關並避免延誤，請確保文件清晰易讀且沒有變形。

上載貿易文件 API 詳情

上載您的海關文件或使用 FedEx 編製的貿易文件。您也可以上載您的公司信頭／標誌和數碼簽名圖像，自訂由 FedEx 編製的電子貿易文件。以電子方式上載文件可省卻人手為每件貨件申報簽署、摺疊、整理和附貼報關文件的步驟。此外，您更可以節省紙張、能源和列印成本。

以下是與此 API 相關的功能：

上載文件

您可以在建立貨件之前 (託運前) 或在使用 Ship API 建立貨件後 (託運後) 一次上載一份文件。

注意：各內容所提及的建立貨件適用於 Ship API- 建立貨件、Open Ship API- 建立Open貨件和 Freight LTL API- 託運大貨 LTL 端點。

上載多份文件

對於每項上載請求，您可上載最多5份文件，這同時適用於託運前和託運後的情況。

上載多份編碼文件

您可以在建立貨件之前(託運前)或之後(託運後)一次性上載base64編碼文件(最多5份)。使用此選項上載的文件能在遭到攔截時為文件資料提供額外的安全保障。

上載圖片

此功能允許您上載可用於 FedEx 產生的文件或報告的自訂公司信頭/標誌和數碼簽名圖像。首先，將公司信頭/標誌和數碼簽名圖像上載至 FedEx 伺服器，然後在您的貨件請求 (建立貨件端點) 中使用 shippingDocumentSpecification 下的 customerImageUsages 元素，為個別文件提供上載參考。

數碼簽名或信頭/公司標誌印在以下 FedEx 產生的文件和報告上：

  • 商業發票
  • 原產地證明
  • OP900
  • 形式發票
  • USMCA 原產地證明
  • USMCA 商業發票和原產地證明

請注意：

  • 數碼簽名 – 簽名限制為 240x25 像素，圖像可以是 GIF、PNG 格式。
  • 公司信頭/標誌 – 標誌的限制為 700x50 像素，圖像可以是 GIF、PNG 格式。

貿易文件上載 API 工作流程

以下是按照託運前或託運後的情況上載文件的流程。

託運前文件上載：

託運前文件上載涉及在建立貨件前使用此API上載文件。成功上載文件後，您可以稍後在貨件請求中關聯已上載的文件參考。

這是在確認貨件前上載貿易文件的標準方法。

執行託運前文件上載的步驟如下：

  • 根據您的要求使用以下任何端點
    • 上載文件
    • 上載多份文件
    • 上載編碼文件
  • 提供workflowName值為ETDPreShipment，以指明託運前上載。
  • 提供要上載的實際檔案或base64編碼文件。
  • 提供文件詳情(商業發票、原產地證明、出口申報書等)，其中包括文件類型和與文件相關的貨件元數據。
  • 請求成功後，系統會將文件上載至FedEx伺服器，並傳回唯一標識符，即docId作為每份已上載文件的成功令牌。
  • 使用「建立貨件」/「建立Open貨件」/「託運大貨LTL」端點。
  • 在您選擇的託運端點中，提供shipmentSpecialService/specialServiceTypes為ELECTRONIC_TRADE_DOCUMENTS，並將docId值傳遞至SpecialServices/etdDetail/attachedDocuments/documentId元素。
    • 備註：如為多件包裹貨件(MPS)，請指明為貨件中所有包裹上載文件後所生成的docId。
  • 貨件請求成功後，將向FedEx確認電子貿易文件貨件，並產生查詢和標籤詳情，並且completedEtdDetail物件將發回已上載的文件類型和文件ID作為參考。
  • 如在託運前上載文件，您可以一次上載所有文件或同時上載最多5份文件，然後一次提供貨件的所有文件ID。

託運後文件上載 (PSDU)：

託運後文件上載 (PSDU) 允許您在提交貨件和完成查詢標籤後上載文件。在此情況下，當建立貨件並已編配查詢號碼後，請在您的文件上載要求時連繫此查詢號碼。

對於建立自己的商業發票，並且讓第三方或遠距辦公室建立海關文件的顧客來說，這種方法很方便。

使用此方法時要記住以下要點：

  • 您應在上載請求前準備好貨件查詢號碼和貨件日期。
  • 您應知道寄件人的地點截件時間，以便在適當時提交文件。

此 API 亦支援為未來日期託運貨件以及當日託運貨件提交海關文件。

執行託運後上載的步驟如下：

  • 使用建立貨件/建立Open貨件/託運大貨 LTL 端點。
  • 在「建立貨件」端點中，根據您的選擇指明以下詳情，
    • 提供shipmentSpecialServices/specialServiceTypes為ELECTRONIC_TRADE_DOCUMENTS。
    • 提供shipmentSpecialServices/etdDetail/attributes為POST_SHIPMENT_UPLOAD_REQUESTED。
  • 貨件請求成功後，將向 FedEx 確認貨件並產生查詢和標籤詳情。
  • 根據您的要求使用以下任何端點。
    • 上載文件
    • 上載多份文件
    • 上載多份編碼文件。
  • 提供 workflowName 值為 ETDPreShipment，以示託運後上載。
  • 提供要上載的實際檔案或base64編碼文件。
  • 提供文件詳情(商業發票、原產地證明、出口申報書等)。
  • 在document/meta/trackingNumber和document/meta/shipmentDate元素下提供已處理之貨件的trackingNumber和shipmentDate。
    如為多件包裹貨件(MPS)，請在上載文件時使用主貨件查詢號碼。為主貨件提供的電子貿易文件詳細資訊亦適用於子貨件。
  • 要求成功後，系統會將文件上載至 FedEx 伺服器並為貨件聯繫上載的文件。

以下是貿易文件上載 API 的功能，讓您上載與託運文件相關的文件和圖像。

貿易文件上載 API 的運作方式

以下是貿易文件上載API的功能，該API可讓您上載與託運文件相關的文件和圖像

上載文件

使用此端點上載託運前和託運後的貿易文件。

與此請求相關的必填輸入資料如下：

  • attachment – 要上載的實際檔案。
  • workFlowName – 提供託運前上載的 ETDPreShipment 和託運後上載的 ETDPostShipment。
  • document – 提供文件詳情和貨件元數據。
  • trackingNumber – 提供要為其上載文件的 PSDU 貨件查詢號碼。此為託運前上載的可選項。
  • shipmentDate – 此為貨件日期。此為託運前上載的可選項。

如在託運前上載，回應成功會將文件上載至FedEx伺服器並傳回docId。此docId將在實際貨件中用於提交貨件並產生標籤。

如在託運後上載，回應成功會將文件上載至 FedEx 伺服器，並就已確認的貨件聯繫上載的文件。

上載圖片

使用此端點上載自訂簽名和信頭圖像/公司標誌，然後可以將其應用於託運文件。

與此要求相關的必須輸入資料如下：

  • attachment – 此為圖像檔案。
  • document – 提供圖像詳情，例如檔案名稱、內容類型和檔案元數據。

要求成功後，系統會將簽名和／信頭圖像／公司標誌上載至 FedEx 伺服器並輸出 imageIndex。然後，此索引會在您的貨件要求中傳遞至 shippingDocumentSpecification 下的個別文件元素 customerImageUsages，以確保自訂圖像或信頭印在貨件文件上。

上載多份文件

使用此端點上載託運前和託運後的貿易文件(最多5份)。與此請求相關的必填輸入資料如下：

  • workFlowName – 提供託運前上載的ETDPreShipment和託運後上載的ETDPostShipment。
  • fileName – 提供更新文件或檔案的名稱，以及副檔名類型。範例：COD.PDF
  • contentType – 從可用選項中提供檔案類型和上載格式。
  • shipDocumentType – 提供要上載的文件類型。

    有關個別文件的更多資訊，請參閱本頁的上載文件部分。以下為可選文件類型清單：

    • CERTIFICATE_OF_ORIGIN COMMERCIAL_INVOICE
    • ETD_LABEL
    • USMCA_CERTIFICATION_OF_ORIGIN
    • USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN
    • 其他
    • PRO_FORMA_INVOICE
  • carrierCode – 提供FedEx營運公司的4位字母代碼。範例：FDXE
  • originCountryCode – 提供貨件的寄件國家／地區代碼。
  • destinationCountryCode – 提供貨件的目的地國家／地區代碼。
    • 備註：請參閱參考指南以搜尋國家／地區代碼。範例：US
  • shipmentDate – 如在託運後上載，請提供實際託運日期。
  • trackingNumber – 如在託運後上載，請提供貨件查詢號碼。範例：7825XXXXXXX。

如在託運前上載，回應成功會將文件上載至FedEx伺服器並傳回文件ID(docId)。此docId將在實際貨件中用於提交貨件及產生標籤。

如在託運後上載，回應成功會將文件上載至 FedEx 伺服器，並就已確認的貨件聯繫上載的文件。

上載多份編碼文件

使用此端點上載託運前和託運後的base64編碼貿易文件(最多5份)。

與此請求相關的必填輸入資料如下：

  • workFlowName – 提供託運前上載的 ETDPreShipment 和託運後上載的 ETDPostShipment。
  • carrierCode – 提供FedEx營運公司的4位字母代碼。範例：FDXE
  • contentType – 從可用選項中提供檔案類型和上載格式。
  • shipDocumentType – 提供要上載的文件類型。

    有關個別文件的更多資訊，請參閱本頁的上載文件部分。以下為可選文件類型清單：

    • CERTIFICATE_OF_ORIGIN COMMERCIAL_INVOICE
    • ETD_LABEL
    • USMCA_CERTIFICATION_OF_ORIGIN
    • USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN
    • 其他
    • PRO_FORMA_INVOICE
  • originCountryCode – 提供貨件的寄件地國家代碼。
  • destinationCountryCode – 提供貨件的目的地國家代碼。
    • 備註：請參閱參考指南以搜尋國家／地區代碼。範例：US
  • fileContentBase64 – 指明要上載之base64檔案的字節碼內容。

如在託運前上載，回應成功會將編碼文件上載至FedEx伺服器並傳回文件ID(docId)。此docId將在實際貨件中用於提交貨件並產生標籤。

如在託運後上載，回應成功會將編碼文件上載至FedEx伺服器，並就已確認的貨件關聯已上載的文件。

上載文件

以下是可以使用此 API 提交的文件：

原產地證明 (COO)

COO 是一份用於驗證製造產品之國家／地區的國際文件。某些國家／地區會限制從部分指定國家/地區的進口，許多國家／地區都會限制進口商品的數量，而一些國家／地區則會對部分指定國家／地區製造的商品提供優惠待遇。

商業發票 (CI)

這是由賣方／出口商提供的文件，用於描述參與託運交易的各方以及託運的貨品。它是供海關使用的主要文件。如果可能，應用出口貨品目的地國家／地區的官方語言擬備。商業發票應包含託運貨品所有項目的詳細明細，包括貨品的正確描述 (它是甚麼？它是由甚麼製成的？它的擬定用途是甚麼？)、數量、產地國家／地區、價格或成本、所用的貨幣、各商品的協調制度編號以及遞送條款。有些國家／地區要求發票正本需印有寄件人的信頭。發票應始終由出口商簽署並註明日期，證明提供的詳細資料真實、準確地反映了商業發票涵蓋的內容。

詳情請瀏覽 Global Trade Manager。

電子貿易文件標籤

這是電子貿易文件特別服務託運中生成的貨件標籤，條件為託運後文件上載。此標籤亦可以連同其他文書隨貨件一併上載。

形式發票

形式發票會在銷售交易前發出。當收到供應商提供的形式發票後，買家會傳送採購訂單或向供應商開立信用狀。在雙方協議的託運日期，賣家會安排託運該等貨物。

USMCA 商業發票和原產地證明

作為三個美國-墨西哥-加拿大協議 (USMCA/T-MEC/CUSMA) 參與者之一的產品，即：加拿大、墨西哥和美國，符合減免或免稅進口條件的商品需要 USMCA 寄件地證明 (COO)。認證是由貨物的出口商或製造商填妥。

USMCA 原產地證明

作為美國-墨西哥-加拿大協議(USMCA/T-MEC/CUSMA)三個參與者之一的產品，即：加拿大、墨西哥和美國，符合減免或免稅進口條件的商品需要USMCA寄件地證明(COO)。認證資料由貨品的出口商或製造商填妥，並需提供商業發票。

其他

以下部分描述了部分歸類於其他文件的常見文件。這些文件並非必須為貨件上載，但可能需要提供以作個別貨件的清關之用。這可能視乎貨件類型、起運地、目的地和其他因素而有所不同。

  • 包裝列表

    • 如果一張空運提單有超過一件包裹，或者貨件重量超過 100 公斤，則須提供包裝清單。請注意：取決於所託運的商品，此項要求在不同市場可能有所不同。清單上必須正確而清晰地描述您的貨物，以及貨物的數量和重量。

  • FCC 740 或致不良影響之進口無線射頻裝置聲明

    • 託運含可導致有害干擾之無線射頻儀的電子產品時，須提供聯邦通訊委員會 (FCC) 740 表格。此表格包含的詳細資料包括裝置型號/類型名稱、國際協調制度關稅號碼、製造商名稱和地址、收件人姓名和地址，以及進口商的姓名和地址。

  • 錄像/電影申報表

    • 錄像電影申報表：提交此文件以聲明所託運的電影/錄像不含淫褻或不道德行為內容，亦不包含任何提倡或敦促反對美國之起義的內容。文件包含的詳情包括電影/錄像長度、電影/錄像時間長度，以及內容簡述。

免責聲明：上述資料可能隨時變更。

其他文件僅視乎國家／地區、產品和其他特別海關文件要求上載。如要查看更多其他常用文件的列表，請點擊出口文件。

海關文件和要求

準確的文件是本地和國際託運的重要元素。每個國家/地區都對國際託運設有具體的法律和監管條例。對於美國出口託運，美國和目的地國家/地區需要不同類型的監管文件。

備註：若是需提供FedEx國際服務空運提單、FedEx International Next Flight空運提單或FedEx國際郵件服務空運提單(例如：商業發票)以外之文件的貨件，運送時間可能會有所延長。

受管制商品

在國際間託運下列商品時，請務必檢查以確保它們可以使用您所選的 FedEx 服務在目的地國家/地區和城市派送：

  • 危險品
  • 國際武器交易條例 (ITAR)
  • 例外數量的危險品。
    備註：如要託運例外數量的危險品，請使用特別服務選項 SMALL_QUANTITY_EXCEPTION。
  • 例外放射性包裹

免責聲明：以上資訊可能會有所更改，如需了解更多資訊，請瀏覽服務指南或聯繫您的 FedEx 代表。

加拿大出境貨件的出口申報

根據加拿大邊境服務局 (CBSA) 要求，必須提供出口申報來呈報由加拿大出口的項目，適用條件如下：

  • 所有載有非限制貨品的加拿大出境貨件，且商業貨品的價值為 2,000 加元或以上，而貨品目的地是美國、波多黎各或美屬維爾京群島以外的其他國家／地區。
  • 所有載有受管制、受限制或受監管貨品的加拿大出境貨件（不論價值多少）。

貨運公司必須向出口商取得報告證明號碼，然後貨品才能離開加拿大。向貨運公司提供報告證明號碼前，出口商必須先提交出口申報。

電子出口資料 (EEI)

電子出口資料 (EEI) 是於自動商業環境 (ACE) 中使用 AESDirect 在自動出口系統 (AES) 中歸檔的電子出口數據。ACE 安全數據門戶 (ACE 門戶) 是貿易社區與美國海關和邊境保護局 (CBP) 聯繫的集中存取點。

電子出口資料 (EEI) 是相當於寄件人出口申報書 (SED)電子版本的美國商務部 (人口普查局) 表格 7525-V，已不能再向美國政府提交。電子出口資料透過匯報國際貨件交易的所有相關出口數據以便提供出口統計和管制。

電子出口資料為必須提供的資料，出口商或代理必須針對商務管制清單 (CCL) 上列出的商品，透過自動出口系統 (AES) 以電子方式提交該資料。

如果貨件從美國、美屬維爾京群島或波多黎各寄往中國、俄羅斯、委內瑞拉和香港，無論貨件價值為何，均須提供以下資訊：

  • 電子出口資料存檔文件內部交易號碼 (ITN)
  • 每件商品的正確 Export Control Classification Number (ECCN) 或 EAR99 分類號碼，或
  • 適用的存檔文件豁免

如果貨件符合以下條件，則可獲得豁免。

  • 有資格獲得許可證例外 GOV
  • 符合《出口管理條例》和《對外貿易條例》(FTR) 中的例外情況，或
  • 僅包含分類為 EAR99 的貨品

備註：對於其他目的地，如果一種或多種商品 (附表 B 編號) 在任何指定日期的合併貨件中總價值超過 2,500 美元，則需要為所有美國出口貨件提交電子出口資料。

寄件人指示函 (SLI)

SLI 載有美國顧客的國際貨件資料。

請注意：

  • 我們的含代理服務已包含寄至加拿大之貨件的清關服務，需要收費。含代理服務可能不適用於所有電子託運解決方案。

FedEx International Ground® 包裹分送服務可讓 FedEx Ground® 將 FedEx International Ground® 貨件綜合為一組單位，可就一項海關進口形式清關及處理，並且只需一項清關代理費用。

貿易文件上載 API 的好處

以下是與貿易文件上載 API/功能相關的一些好處：

  • 更少出現清關問題，可減少海關延誤，從而提高託運的可靠度和賣家的聲譽。
  • 消除將多份文件列印和配對至個別包裹的需要，可騰出更多時間建立業務，從而提高公司的生產力和利潤。
  • 允許將公司信頭和簽名圖像添加至 FedEx 產生的商業發票或形式發票。
  • 在貨件抵達前獲得額外時間，以解決清關文件的相關問題，例如資料缺失。
  • 允許以電子方式提交運送至加拿大之 FedEx International Ground 貨件的商業發票。
  • 為未來日期託運的貨件或由即日起至未來 10 日內任何一日託運的貨件，提交清關文件給 FedEx 。
  • 包裹上沒有發票，不會向第三方透露商品資訊，令人安枕無憂。
  • 降低紙張、碳粉、託運材料的消耗和打印機的使用，從而減少碳足跡。
  • 包裹上沒有發票，不會向第三方透露商品資訊，因而可以減少貨件被盜的機會。
  • 海外寄件更快捷省時，又可減少資料出錯。
  • 進口和出口貨件均可使用此上載文件功能。查看可用國家/地區清單，了解您的寄件/目的地的國家/地區是否接受上載文件。
  • 您可以使用國際文件說明部分的 FedEx 文件準備中心，在網上準備、儲存和重複使用已上載的文件。

業務規則

以下是與上載文件 API/功能相關的一些重要業務規則：

  • 上載文件的有效文件類型為 PDF、TXT、PNG、JPG、GIF、BMP、TIF、RTF、DOC、DOCX、XLS 和 XLSX。
  • 文件最多可在託運前 10 天上載。
  • 每份上載的貿易文件或圖像不可超過 5 MB。
  • 數碼簽名圖像的限制為 240x25 像素，圖像可以是 GIF、PNG 格式。
  • 公司信頭/標誌的限制為 700x50 像素，圖像可以是 GIF、PNG 格式。
  • 根據海關條例，信頭圖像未必適用於所有寄件地/目的地。
  • 圖像將按原樣上載，FedEx 不會進行更正。
  • 可使用以下特殊處理和服務選項，以電子方式上載海關文件：
    • 乾冰
    • 危險品
    • 危險物料
  • 只要啟用上載，來自美國 (U.S.)、亞太區、加拿大 (CA) 和歐盟 (EU) 國家的 TPC (第三方收件人) 貨件需要此選項。
  • 所有備有電子文件的貨件，必須在要求的託運日建立、上載和取件。
  • 使用 PSDU (託運後文件上載) 時，請務必在收取包裹前上載文件。

 

 

 

 

Documentation Powered by ReDoc

Trade Documents Upload API (1.0.2)

Upload Document

Use this endpoint to upload the trade documents electronically before (pre-shipment) and after (post-shipment) the shipment is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters
Content-Type
required
string
Default: "multipart/form-data"

Indicates the type of content
Example: "multipart/form-data"

Authorization
required
string
Default: "Bearer ****"

Indicates the JWE token to be used for authorizing the client request.
Example: "Bearer ****"

x-customer-transaction-id
string
Example: 771407-1

This is the customer transaction identifier.
Example: 771407-1

Request Body schema: multipart/form-data
One of
  • FullSchema-DocumentUploadInputVO
attachment
required
string <file>

Input the actual document/file to be uploaded.

document
required
object (ETDUploadRequest)

Provide all the document details and shipment meta data.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /documents/v1/etds/upload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/etds/upload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/etds/upload

Request samples

Content type
multipart/form-data
Example
Full-Schema
Copy
document: {"workflowName":"ETDPreshipment","carrierCode":"FDXE","name":"file.txt","contentType":"text/plain","meta":{"shipDocumentType":"COMMERCIAL_INVOICE","formCode":"USMCA","trackingNumber":"794791292805","shipmentDate":"2021-02-17T00:00:00","originLocationCode":"GVTKK","originCountryCode":"US","destinationLocationCode":"DEL","destinationCountryCode":"IN"}}
attachment: file.txt

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "output":
    {
    },
  • "customerTransactionId": "XXXX_XXX123XXXXX"
}

Upload Images

Use this endpoint to upload customized Company Letterhead/Logo and Digital signature images which can be used in the FedEx generated paperwork or reports.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters
Authorization
required
string
Example: Bearer XXX

Specifies the authorization token.
Example: Bearer XXX

x-customer-transaction-id
required
string
Example: 771407-1

Identifies the transaction ID of the request.
Example: "771407-1"

Request Body schema: multipart/form-data
attachment
required
string <file>

Input the actual image file to be uploaded.

document
required
object (Document)

Indicate the image reference metadata details.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /documents/v1/lhsimages/upload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/lhsimages/upload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/lhsimages/upload

Request samples

Content type
multipart/form-data
Copy
document: {"document": {"referenceId": "1234", "name": "LH2.PNG",    "contentType": "image/png",    "meta": { "imageType": "SIGNATURE","imageIndex": "IMAGE_1"}},"rules": {"workflowName": "LetterheadSignature" }}
attachment: file.PNG

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "output":
    {
    },
  • "customerTransactionId": "XXXX_XXX123XXXXX"
}

Upload Multiple Documents

Use this endpoint to upload multiple trade documents electronically before (pre-shipment) and after (post-shipment) the shipment is created

header Parameters
Content-Type
required
string
Default: "multipart/form-data"
Example: multipart/form-data

Type of content

Authorization
required
string
Default: "Bearer XXXXXX"
Example: Bearer XXXXXX

This indicates the authorization token for the input request.

x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply

Request Body schema: multipart/form-data
One of
  • FullSchema-MultiDocumentRequest
  • MinimumSamplePayload-MultiPreShipment
  • MinimumSamplePayload-MultiPostShipment
documentInformation
object (MultiETDUploadRequest)

Provide all the documents' details and shipment meta data

fileAttachments
Array of strings <binary> <= 5 items

Input the actual document/file to be uploaded.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

INTERNAL.SERVER.ERROR

503

Service Unavailable

post /documents/v1/etds/multiupload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/etds/multiupload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/etds/multiupload

Request samples

Content type
multipart/form-data
Example
FullSchema-MultiDocumentRequest
Copy
documentInformation: {"workflowName": "ETDPreshipment","carrierCode": "FDXE","originCountryCode": "US","destinationCountryCode": "CA","shipmentDate": "2021-10-21T00:00:00","trackingNumber": "782514212510","metaData": [{"fileName":"file1.png","fileReferenceId":"inv_file1_ctx_02132021_5","contentType": "image/png","formCode": "USMCA","shipDocumentType":"COMMERCIAL_INVOICE"},{"fileName":"file2.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"},{"fileName":"file3.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"},{"fileName":"file4.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"},{"file5.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"}]
fileAttachments: 'file1.png'
fileAttachments: 'file2.txt'
fileAttachments: 'file3.txt'
fileAttachments: 'file4.txt'
fileAttachments: 'file5.txt'

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerTransactionId": "5678b975-ev0e-420b-8d7b-aa6ce65ec48n",
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "output":
    {
    }
}

Upload Multiple Encoded Documents

Use this endpoint to upload multiple trade documents as base64 electronically before (pre-shipment) and after (post-shipment) the shipment is created

header Parameters
Content-Type
required
string
Default: "application/json"
Example: application/json

Type of content

Authorization
required
string
Default: "Bearer XXXXXX"
Example: Bearer XXXXXX

This indicates the authorization token for the input request.

x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply

Request Body schema: application/json
One of
  • FullSchema-Base64MultiDocumentRequest
  • MinimumSamplePayload-Base64MultiPreShipment
  • MinimumSamplePayload-Base64MultiPostShipment
workflowName
required
string
Enum: "ETDPreshipment" "ETDPostshipment"

Indicate if the documents are being uploaded before or after shipment creation process

carrierCode
required
string
Enum: "FDXE" "FDXG"

Specify the four letter code of a FedEx operating company that meets your requirements
Examples of FedEx Operating Companies are:

  • FDXE - FedEx Express
  • FDXG - FedEx Ground

orginCountryCode
required
string

Origin country code for the shipment.

Example: US
Click here to see Country Codes

destinationCountryCode
required
string

Destination country code for the shipment.

Example: CA

shipmentDate
string

Specify the Shipment date. This is only required for Post Shipment document upload. This value is present in Create Shipment response & this should match the shipment date timestamp

trackingNumber
string

Specifies the tracking number of the shipment. This is only required for Post Shipment documentation upload.
Example: 782514212510

metaData
required
Array of objects (MultiMetaDataRequest_1) <= 5 items

Indicate the shipment metadata associated with the document to be uploaded

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

INTERNAL.SERVER.ERROR

503

Service Unavailable

post /documents/v1/etds/encodedmultiupload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/etds/encodedmultiupload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/etds/encodedmultiupload

Request samples

Content type
application/json
Example
FullSchema-Base64MultiDocumentRequest
Copy
 Expand all Collapse all
{
  • "workflowName": "ETDPreshipment",
  • "carrierCode": "FDXE",
  • "originCountryCode": "US",
  • "destinationCountryCode": "CA",
  • "shipmentDate": "2024-01-06T00:00:00",
  • "trackingNumber": "782514212510",
  • "metaData":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerTransactionId": "5678b975-ev0e-420b-8d7b-aa6ce65ec48n",
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "output":
    {
    }
}
CLOSE

Response

Copy