Fedex Logo
Developer Portal

Global Trade API

Giới thiệu

API Thương mại toàn cầu cho phép bạn truy xuất danh sách các chứng từ theo quy định cần thiết cho lô hàng trước khi lô hàng được gửi đi. Cần phải có chứng từ theo quy định để tránh các vấn đề về tuân thủ quy định thường dẫn đến tình trạng trì hoãn thông quan hải quan, các khoản tiền phạt và khiến khách hàng không hài lòng về chuyến giao hàng.

API này còn cung cấp:

  • Thông tin quan trọng từ FedEx, thông tin về quy định của chính quyền, cũng như các khuyến cáo cụ thể cho lô hàng của bạn, chẳng hạn như:
    • Tình huống hiện tại ảnh hưởng đến lô hàng
    • Thời tiết và những tình trạng gián đoạn khác
    • Tin tức và cập nhật về quy định
  • Khả năng xác định xem lô hàng của bạn có yêu cầu kê khai Thông tin xuất khẩu điện tử (EEI) cho Hải quan Hoa Kỳ hay không.
  • Khả năng sử dụng FedEx làm đại lý để kê khai EEI cho Hải quan Hoa Kỳ.
  • Lấy Số giao dịch nội bộ (ITN), rồi bạn có thể sử dụng trong giao dịch vận chuyển tiếp theo để liên kết với EEI tương ứng.

Để biết thêm thông tin về EEI, hãy truy cập các trang bên dưới:

Chi tiết về API Thương mại toàn cầu

Với API này, bạn có thể lấy được danh sách các chứng từ bắt buộc theo quy định và các khuyến cáo được áp dụng với lô hàng. API này không chỉ hỗ trợ bạn xác định xem lô hàng của bạn có cần kê khai EEI hay không mà nếu cần, API còn giúp bạn kê khai EEI cho Hải quan Hoa Kỳ, cũng như lấy số ITN cho lô hàng của bạn.

Sau đây là các tính năng gắn với API Thương mại toàn cầu:

Truy xuất chi tiết về quy định

Tính năng này giúp bạn truy xuất danh sách các chứng từ phải đi kèm với các lô hàng quốc tế, từ đó giúp quá trình thông quan hải quan diễn ra suôn sẻ.

Tất cả các hồ sơ, tài liệu, đơn đăng ký, yêu cầu sửa đổi, đơn xin sửa đổi, tờ khai bổ sung, bản sửa đổi, báo cáo, bản đệ trình, giấy ủy quyền, giấy phê duyệt và bất kỳ báo cáo hoặc sửa đổi nào cần thiết để duy trì sự phê duyệt theo quy định được chỉ định ở giai đoạn đầu của quá trình gửi hàng quốc tế.

Sau đây là các loại chứng từ theo quy định được hỗ trợ: 

  • FEDEX_GENERATED - Cho biết rằng chứng từ được cấu hình và tạo bởi hệ thống FedEx nội bộ. Khách hàng không thể cấu hình hoặc sửa đổi chứng từ này. Ví dụ: Hóa đơn thương mại do FedEx tạo, Hóa đơn chiếu lệ do FedEx tạo.
  • FILLABLE- Cho biết các biểu mẫu và chứng từ có thể được điền trực tuyến hoặc sau khi tải xuống từ các trang của FedEx. Bạn cũng có thể lấy các biểu mẫu này tại các trung tâm vận chuyển FedEx và điền vào. Ví dụ: Biểu mẫu tờ khai hải quan bưu chính CN 22.
  • PRINT_ONLY- Cho biết các chứng từ và biểu mẫu chỉ được chấp nhận ở dạng bản in. Ví dụ: Hóa đơn
  • SAMPLE- Cho biết các chứng từ mẫu do FedEx tạo. Ví dụ: Hóa đơn thương mại mẫu

Nhận thông tin tư vấn

Tính năng này giúp bạn truy xuất thông tin quan trọng về quy định hoặc thông tin tư vấn của FedEx hay thông tin tư vấn của chính quyền áp dụng cho lô hàng của bạn. Thông tin tư vấn có thể liên quan đến thời tiết và tình trạng gián đoạn dịch vụ, hoặc tuyên bố cảnh báo chính thức do cơ quan chính quyền đưa ra, chẳng hạn như để cung cấp thông tin về sự an toàn tương đối khi đi đến/ghé thăm một hoặc nhiều quốc gia/điểm đến cụ thể ở nước ngoài.

Sau đây là các loại văn bản tư vấn khác nhau được FedEx hỗ trợ: 

  • APPLICATION 
  • DOCUMENT_SPECIFIC 
  • FEDEX 
  • GOVERNMENT 
  • INSPECTION 
  • LICENSE_OR_PERMIT 
  • MAYBE_DOCUMENT 
  • MAYBE_STATEMENT 
  • PROHIBIT 
  • UNIT_OF_MEASURE 
  • WAIVER

Thông tin xuất khẩu điện tử (EEI)

Thông tin xuất khẩu điện tử (EEI) là chứng từ bắt buộc khi giá trị hàng hóa, được phân loại theo từng mã số riêng trong Danh mục B vượt quá 2.500 USD hoặc nếu phải có giấy phép xuất khẩu đã xác thực để xuất khẩu hàng hóa.

EEI là dữ liệu phải được kê khai thông qua Hệ thống xuất khẩu tự động (AES) đối với hàng hóa vận chuyển từ Hoa Kỳ ra nước ngoài. Nội dung kê khai bao gồm thông tin về người gửi, người nhận hàng hóa và về hàng hóa được xuất khẩu. Cục Thống kê Dân số sử dụng những nội dung kê khai này để tính toán số liệu thống kê thương mại của Hoa Kỳ, còn Cục Hải quan và Biên phòng (CBP), Cục Công nghiệp và An ninh (BIS) sử dụng dữ liệu này để góp phần đảm bảo việc tuân thủ các quy định xuất khẩu của Hoa Kỳ.

Nhà xuất khẩu chịu trách nhiệm chuẩn bị EEI và hãng vận tải kê khai EEI cho Cục Hải quan và Biên phòng Hoa Kỳ (CBP) thông qua AES Direct trong Môi trường thương mại tự động (ACE). Với mỗi hồ sơ EEI, AES tạo một số ITN duy nhất, xác nhận giao dịch EEI đã được chấp nhận và có trong hồ sơ của AES.

Yêu cầu

Khách hàng phải sử dụng số tài khoản đăng ký tại Hoa Kỳ.

Yêu cầu vận chuyển:

  • Từ Hoa Kỳ, Puerto Rico hoặc Quần đảo Virgin thuộc Hoa Kỳ đến những nơi nhận hàng ở nước ngoài,
  • Giữa Hoa Kỳ và Puerto Rico, và
  • Từ Hoa Kỳ hoặc Puerto Rico đến Quần đảo Virgin thuộc Hoa Kỳ.

Có cùng mã thuế quan hài hòa hoặc mã số hàng hóa theo Danh mục B với giá trị lớn hơn 2.500 USD và được gửi từ cùng một nhà xuất khẩu đến cùng một người nhận trong cùng một ngày.
(Lưu ý: Các lô hàng từ Hoa Kỳ đến Canada được miễn yêu cầu này.)

  • Là kim cương thô được phân loại vào danh mục 7102.10, 7102.21 và 7102.31 theo biểu thuế quan hài hòa.
  • Yêu cầu phải có cấp phép hoặc giấy phép xuất khẩu của chính phủ Hoa Kỳ.
  • Tuân theo Quy định về buôn bán vũ khí quốc tế của Hoa Kỳ (ITAR) hoặc
  • Tuân theo các yêu cầu về hàng hóa, người dùng cuối hoặc nơi nhận hàng trong Quy định về ngoại thương của Hoa Kỳ.

Cách hoạt động của API Thương mại toàn cầu

Truy xuất chi tiết về quy định

Sử dụng điểm cuối này để nhận chứng từ theo quy định cần thiết cũng như thông tin tư vấn trước lô hàng.

Sau đây là các thông tin cần thiết gắn với điểm cuối này. 

  • Địa chỉ nơi gửi hàng – Cho biết chi tiết về nơi gửi hàng như mã Quốc gia, mã bưu chính và mã Tỉnh/tiểu bang, nếu có.
  • Địa chỉ nơi nhận hàng – Cho biết chi tiết về nơi nhận hàng như mã Quốc gia, mã bưu chính và mã Tỉnh/tiểu bang, nếu có.
  • Chi tiết thông quan hải quan – Cho biết phí thông quan hải quan, mã áp thuế và số đo bổ sung của lô hàng.
  • Mã hãng vận tải – Cho biết hãng vận tải FedEx cần thiết cho lô hàng.
  • Tổng trọng lượng – Cho biết tổng trọng lượng của lô hàng kèm theo đơn vị đo thích hợp.

Phản hồi thành công cho yêu cầu sẽ trả về danh sách tất cả các chứng từ có thể cần dùng theo quy định và thông tin tư vấn dựa trên thông tin đầu vào được cung cấp. Nếu xảy ra lỗi trong yêu cầu thì thông báo lỗi và mã lỗi sẽ được cung cấp trong đối tượng lỗi.

Tra cứu tuân thủ quy định

Sử dụng điểm cuối này để xác định xem có bất kỳ quy định tuân thủ nào trong hoạt động xuất khẩu và/hoặc nhập khẩu áp dụng với lô hàng hay không

Sau đây là các quy định tuân thủ hiện được hỗ trợ:

Xuất khẩu:

  • Phải kê khai EEI cho Hải quan Hoa Kỳ khi vận chuyển hàng hóa.

Nhập khẩu:

  • Không có

Sau đây là những thông tin cần thiết gắn với điểm cuối này:

  • shipDate: Cho biết ngày gửi hàng.
  • carrierCode: Cho biết Mã hãng vận tải FedEx. Ví dụ: FXE.
  • originAddress:
    • countryCode: Cho biết mã quốc gia gửi hàng của lô hàng.
  • destinationAddress:
    • countryCode: Cho biết mã quốc gia nhận hàng của lô hàng.
  • serviceType: Cho biết loại dịch vụ được công ty kinh doanh thuộc tập đoàn FedEx chọn. Ví dụ: IP, SG, PO, v.v.
  • serviceOptionTypes: Cho biết tính năng của loại dịch vụ. Ví dụ: FICE, ITAR.
  • totalWeight: Cho biết tổng trọng lượng của lô hàng.
    • units: Cho biết đơn vị đo trọng lượng. Ví dụ: KG, LB, v.v.
    • value: Cho biết trọng lượng của lô hàng. Ví dụ: 68,50.
  • consolidationType: Cho biết kiểu gom hàng. Ví dụ: IPD
  • consolidationRole: Cho biết vai trò của lô hàng trong quá trình gom. Ví dụ: CRN_SHIPMENT
  • totalCommodityValue: Cho biết tổng giá trị của lô hàng.
  • regulatoryCustomsClearanceDetail: Cho biết các chi tiết hải quan theo quy định.

Phản hồi thành công đối với yêu cầu này sẽ cho biết lô hàng của bạn có cần kê khai EEI hay không.

Kê khai EEI

Sử dụng điểm cuối này để kê khai EEI cho Hải quan Hoa Kỳ, cập nhật hoặc hủy EEI hiện có.

Sau đây là những thông tin cần thiết gắn với điểm cuối này:

  • processingOption: Chỉ định phương án xử lý đối với yêu cầu EEI của bạn. Ví dụ: ADD, UDPATE, CANCEL
  • eeiControlDetail:
    • shipDate: Cho biết ngày gửi hàng.
    • accountNumber: Cho biết số tài khoản FedEx của bạn.
  • eeiPartyDetails: Cho biết các chi tiết về bên vận chuyển
    • eeiShipmentPartyType
    • eeiContactAndAddress
      • contact:
        • companyName: Cho biết tên công ty.
      • address:
        • streetlines: Ghi rõ địa chỉ cụ thể của công ty. Ví dụ: TÒA NHÀ
        • city: Cho biết thành phố nơi công ty hoạt động. Ví dụ: PARIS
        • countryCode: Cho biết mã quốc gia. Ví dụ: US
  • eeiCommodities
    • commodity: Ghi dòng chi tiết về hàng hóa trong lô hàng.
      • description: Cung cấp nội dung mô tả về hàng hóa.
      • harmonizedCode: Cho biết mã HS.
      • quantityUnits: Cho biết mã đơn vị đo lường dựa trên mã số báo cáo theo Danh mục B/HTS.
      • Weight: Cho biết trọng lượng của hàng hóa.
        • Units: Ghi rõ đơn vị đo trọng lượng. Ví dụ: KG
    • HarmonizedCode: Cho biết mã HS
    • quantityUnits: Cho biết mã đơn vị đo lường dựa trên mã số báo cáo theo Danh mục B/HTS.
    • weight: Cho biết trọng lượng của hàng hóa
      • Units: Ghi rõ đơn vị đo trọng lượng. Ví dụ: KG
    • exportInformationCode: Ghi rõ Mã thông tin xuất khẩu: Ví dụ: GP
    • eeiCommodityLicenseDetail:
      • licenseCode: Ghi rõ mã giấy phép

Phản hồi thành công đối với yêu cầu này sẽ kê khai EEI cho lô hàng của bạn đến Hải quan Hoa Kỳ và trả về Số tham chiếu lô hàng (SRN). Bắt buộc phải có ShipmentReferenceNumber (SRN) trong phản hồi để lấy được Số giao dịch nội bộ (ITN).

Lấy ITN

Sử dụng điểm cuối này để lấy Số giao dịch nội bộ (ITN) cho EEI đã được kê khai cho Hải quan Hoa Kỳ. 

Sau đây là những thông tin cần thiết gắn với điểm cuối này:

  • shipmentReferenceNumber: Cho biết Số tham chiếu lô hàng nhận được từ giao dịch FileEEI.

Phản hồi thành công đối với yêu cầu này sẽ trả về số ITN cho EEI đã kê khai. Số ITN này phải được ghi rõ trong yêu cầu giao dịch lô hàng tương ứng.

Ví dụ: Trong Ship API, bạn cần điền các yếu tố sau để gửi số miễn trừ EEI hoặc ITN cho FedEx.

Phần tử Mô tả

Sender/Tins/TinType

Nếu là người gửi, bạn phải tải thông tin mã số thuế lên FedEx đối với các lô hàng yêu cầu EEI. Ghi rõ Số đăng ký của công ty (EIN). Giá trị hợp lệ:

  • BUSINESS_NATIONAL
  • BUSINESS_STATE
  • BUSINESS_UNION
  • PERSONAL_NATIONAL
  • PERSONAL_STATE

Sender/Tins/Number

Nêu rõ Mã số/Số nhận dạng người nộp thuế cùng với số ID tương ứng cho TinType.

CustomsClearanceDetail/ExportDetail/ExportComplianceStatement

Đối với những lô hàng yêu cầu EEI, hãy nhập số ITN nhận được từ AES khi bạn kê khai lô hàng, số miễn trừ theo FTR (Quy định về ngoại thương) hoặc số ITN nhận được khi kê khai EEI bằng/thông qua FedEx. Định dạng đúng của số ITN là AES XYYYYMMDDNNNNNN, trong đó YYYYMMDD là ngày và NNNNNN là các số do AES tạo ra.

Lưu ý: Số ITN hoặc số miễn trừ FTR mà bạn ghi trong yêu cầu Vận chuyển sẽ được in trên nhãn vận chuyển quốc tế.

Chứng từ lô hàng

Chứng từ chính xác là một phần quan trọng của lô hàng nội địa cũng như quốc tế để tránh bị giữ gói hàng trong kho hoặc bị trì hoãn và đảm bảo việc giao hàng diễn ra suôn sẻ. 

Sau đây là các loại chứng từ gửi hàng và hải quan khác nhau có sẵn thông qua API FedEx Global Trade Manager.

Lưu ý:         

  • Tùy tính chất chính xác của hàng hóa, lô hàng của bạn có thể cần đến các chứng từ thương mại khác không được liệt kê tại đây. Nếu không chắc chắn, hãy liên hệ với bộ phận Dịch vụ khách hàng của FedEx để được hướng dẫn về những chứng từ phải có nhằm đảm bảo lô hàng của bạn được thông quan suôn sẻ.

Giấy chứng nhận xuất xứ (COO)

COO là chứng từ quốc tế xác minh quốc gia/vùng lãnh thổ nơi sản xuất sản phẩm. Một vài quốc gia hạn chế hàng hóa nhập khẩu từ một số quốc gia nhất định, nhiều quốc gia giới hạn số lượng hàng hóa nhập khẩu và một số quốc gia có chính sách ưu đãi cho hàng hóa được sản xuất ở một quốc gia nhất định.

[ENUM dịch vụ: CERTIFICATE_OF_ORIGIN]

Hóa đơn thương mại (CI)

Đây là chứng từ do người bán/nhà xuất khẩu cung cấp, mô tả các bên liên quan đến giao dịch vận chuyển và hàng hóa được vận chuyển. Đây là chứng từ chính được cơ quan Hải quan sử dụng. Chứng từ này cần được tạo bằng ngôn ngữ chính thức của quốc gia/vùng lãnh thổ mà hàng hóa được xuất khẩu đến, nếu có thể. (Hóa đơn do FedEx tạo không có tùy chọn này.) Hóa đơn thương mại phải liệt kê chi tiết tất cả các mặt hàng có trong lô hàng, bao gồm: mô tả đúng quy cách về hàng hóa (là hàng hóa gì? hàng hóa được làm từ gì? mục đích sử dụng là gì?), số lượng, quốc gia/vùng lãnh thổ sản xuất, giá cả hoặc chi phí, đơn vị tiền tệ được sử dụng, mã HS cho từng hàng hóa và điều khoản giao hàng. Một số quốc gia yêu cầu lập hóa đơn gốc trên giấy tiêu đề của người gửi. Hóa đơn phải luôn được nhà xuất khẩu ký và ghi ngày nhằm xác nhận rằng các chi tiết được cung cấp đã thể hiện đúng và chính xác nội dung được nêu trong Hóa đơn thương mại. [ENUM dịch vụ: COMMERCIAL_INVOICE] 

Để biết thêm thông tin, hãy truy cập FedEx Global Trade Manager.

Tờ khai của người gửi về hàng hóa nguy hiểm

Đây là tờ khai của người gửi đối với các lô hàng được phân loại là hàng hóa nguy hiểm theo Bảng chỉ dẫn an toàn (SDG), Hiệp hội Vận tải Hàng không Quốc tế (IATA) và Tổ chức Hàng không Dân dụng Quốc tế (ICAO). Biểu mẫu FX 18 yêu cầu các nhà cung cấp được FedEx công nhận xuất trình biểu mẫu Tờ khai của người gửi về Hàng hóa nguy hiểm đối với các lô hàng được phân loại là Hàng hóa nguy hiểm có xuất xứ từ Hoa Kỳ.

[ENUM dịch vụ: DANGEROUS_GOODS_SHIPPERS_DECLARATION]

Tờ khai xuất khẩu

Thông tin xuất khẩu điện tử (EEI) trước đây được gọi là Tờ khai xuất khẩu của người gửi (SED) được Cục Điều tra Dân số Hoa Kỳ yêu cầu nhằm thu thập dữ liệu thống kê và Cục Công nghiệp và An ninh (BIS) yêu cầu nhằm hỗ trợ thực thi việc kiểm soát xuất khẩu. SED/EEI được yêu cầu khi tổng giá trị hàng hóa được phân loại theo bất kỳ số nào trong Danh mục B vượt quá 2.500 USD hoặc hàng hóa cần có giấy phép xuất khẩu. Nhà xuất khẩu hoặc đại lý có thể hoàn thành thông tin này bằng hình thức điện tử. Thông tin này bắt buộc phải được gửi bằng hình thức điện tử thông qua Hệ thống xuất khẩu tự động (AES) dành cho hàng hóa được liệt kê trong Danh sách kiểm soát thương mại (CCL) hoặc Danh sách súng đạn của Hoa Kỳ (USML). 

Lưu ý: Yêu cầu này chỉ áp dụng cho các Lô hàng xuất khẩu của Hoa Kỳ.

[ENUM dịch vụ: EXPORT_DECLARATION]

Hợp đồng đại lý chung

Thỏa thuận đại lý hay Giấy ủy quyền (POA) là chứng từ pháp lý được nhà nhập khẩu cung cấp cho một nhà môi giới hải quan để cho phép họ làm thủ tục thông quan và/hoặc khai báo về các lô hàng với Cơ quan Doanh thu Canada (CRA) thay mặt cho công ty của nhà nhập khẩu. Nhà nhập khẩu thường trú tại Canada muốn Federal Express thường xuyên đóng vai trò nhà môi giới hải quan ở Canada phải hoàn thành và gửi trả lại các biểu mẫu này theo phiếu hướng dẫn trước khi gửi hàng vào Canada. Biểu mẫu này là Thỏa thuận đại lý giới hạn và sẽ chỉ áp dụng cho các lô hàng Federal Express. Biểu mẫu này ở định dạng có thể dễ dàng điền thông tin và dễ sử dụng, có trong phần thư viện chứng từ trên trang web này. 

[ENUM dịch vụ: GENERAL_AGENCY_AGREEMENT]

OP900

Bộ Giao thông Hoa Kỳ yêu cầu biểu mẫu này để vận chuyển các vật liệu nguy hiểm. Tùy lô hàng, khách hàng sẽ được cung cấp biểu mẫu OP-900 cụ thể để điền.

Ví dụ:

  • OP-900LL nếu lô hàng là máy in laze.
  • OP-900LG nếu lô hàng là máy in kim.

Lưu ý: Biểu mẫu viết tay không còn được chấp nhận, do đó bạn phải điền vào biểu mẫu và gửi cho chúng tôi bản sao kỹ thuật số của biểu mẫu đó.

 [ENUM dịch vụ: OP_900]

Hóa đơn chiếu lệ

Hóa đơn chiếu lệ được xuất trước khi việc bán hàng diễn ra. Sau khi nhận được hóa đơn chiếu lệ từ nhà cung cấp, người mua sẽ gửi đơn đặt hàng hoặc mở thư tín dụng cho nhà cung cấp. Theo ngày gửi hàng đã thoả thuận, người bán sẽ sắp xếp vận chuyển hàng hoá. 

[ENUM dịch vụ: PRO_FORMA_INVOICE]

Vận đơn VICS

Biểu mẫu vận đơn VICS do VICS (Tiêu chuẩn thương mại liên ngành tự nguyện) tạo ra, chủ yếu sử dụng cho các lô hàng trong ngành bán lẻ hàng hóa nói chung. 

[ENUM dịch vụ: VICS_BILL_OF_LADING]

Hóa đơn thương mại và Giấy chứng nhận xuất xứ theo USMCA

Hóa đơn thương mại kiêm giấy chứng nhận xuất xứ theo USMCA/T-MEC/CUSMA là một chứng từ kết hợp hóa đơn thương mại với các yếu tố dữ liệu của giấy chứng nhận xuất xứ bắt buộc. Chứng từ này bao gồm nội dung khai báo cung cấp cách thức vận chuyển và yêu cầu hưởng ưu đãi thuế quan đối với hàng hóa đủ điều kiện theo thỏa thuận Hoa Kỳ-Mexico-Canada. Hàng hóa đủ điều kiện hưởng ưu đãi thuế quan phải có xuất xứ và được xuất khẩu từ Hoa Kỳ, Mexico hoặc Canada. [ENUM dịch vụ: USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN]

Giấy chứng nhận xuất xứ theo USMCA

Giấy chứng nhận xuất xứ theo USMCA/T-MEC/CUSMA là biểu mẫu được sử dụng để yêu cầu hưởng ưu đãi thuế quan theo Thỏa thuận Hoa Kỳ-Mexico-Canada. Giấy chứng nhận này chứa một tập hợp yếu tố dữ liệu, trong đó bao gồm nội dung khai báo cần được nhà xuất khẩu, nhà sản xuất hoặc nhà nhập khẩu chứng nhận đối với hàng hóa đủ điều kiện. Hàng hóa nhập khẩu phải có xuất xứ và được xuất khẩu từ Hoa Kỳ, Mexico hoặc Canada. Biểu mẫu này có thể được sử dụng cho một lô hàng đơn lẻ hoặc trong "thời hạn" tối đa mười hai tháng. 

[ENUM dịch vụ: USMCA_CERTIFICATION_OF_ORIGIN]

Quy tắc kinh doanh

  • Hóa đơn thương mại cần được tạo bằng ngôn ngữ chính thức của quốc gia/vùng lãnh thổ mà hàng hóa được xuất khẩu đến. Hóa đơn do FedEx tạo không cung cấp tùy chọn này, nên khách hàng tự chịu trách nhiệm in Hóa đơn thương mại.
  • FedEx chỉ chấp nhận các bản sao kỹ thuật số của biểu mẫu OP-900. Biểu mẫu viết tay không được chấp nhận.

Bộ sưu tập API JSON

Global Trade - API (1.0)

Retrieve Regulatory Details

Use this endpoint to retrieve regulatory document and advisories for your shipment.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters
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.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema
  • MinimumSamplePayload
serviceType
string

Specify the type of service that is used to ship the package.
click here to see Service Types

totalCommodityValue
object

Specify the total commodity value. Either customsClearenceDetail or totalCommodityValue is required.

originAddress
required
object

Provide the shipment origin address details.

destinationAddress
required
object

Provide the shipment destination address details.

serviceOptionType
Array of strings
Items Enum: "FEDEX_ONE_RATE" "FREIGHT_GUARANTEE" "SATURDAY_DELIVERY" "SMART_POST_ALLOWED_INDICIA" "SMART_POST_HUB_ID"

Specify attributes to filter location types. If more than one value is specified, only those locations that have all the specified attributes will be returned.

customsClearanceDetail
object

Specify the Customs clearance details.Either customsClearenceDetail or totalCommodityValue is required.

shipDate
string

Specify shipment date.

Note : Default value is current date in case the date is not provided or a past date is provided.
Format [YYYY-MM-DD].
Example: 2021-08-05'

carrierCode
required
string

Specify the four letter code of a FedEx operating company that meets your requirements.

Valid values are:

  • FDXE - FedEx Express
  • FDXG - FedEx Ground

  • Example: FDXE

totalWeight
object

Provide the total weight for the shipment.

includeURLReferences
boolean

Specify if the url references to be included in the output. These are regulatory reference data urls specific to document, agency.

consolidationType
string

Specify the type of consolidation that contains this shipment.

Valid values are:

  • INTERNATIONAL_DISTRIBUTION_FREIGHT
  • INTERNATIONAL_ECONOMY_DISTRIBUTION
  • INTERNATIONAL_GROUND_DISTRIBUTION
  • INTERNATIONAL_PRIORITY_DISTRIBUTION
  • TRANSBORDER_DISTRIBUTION

consolidationRole
string

Specify the role this shipment plays within the consolidation.

Valid values are:

  • CONSOLIDATION_DOCUMENTS_SHIPMENT – Shipment contains clearance documents for the corresponding consolidation.
  • CRN_SHIPMENT – Shipment is a Child Reference Number(individual shipment within consolidation).
  • MASTER_AIRWAYBILL_SHIPMENT – Shipment represents entire consolidation, moving as a unit.

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found

422

UnProcessable Entity

500

Failure

post /globaltrade/v1/shipments/regulatorydetails/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/shipments/regulatorydetails/retrieve

Production Server

https://apis.fedex.com/globaltrade/v1/shipments/regulatorydetails/retrieve

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "serviceType": "FEDEX_FREIGHT_ECONOMY",
  • "totalCommodityValue":
    {
    },
  • "originAddress":
    {
    },
  • "destinationAddress":
    {
    },
  • "serviceOptionType":
    [
    ],
  • "customsClearanceDetail":
    {
    },
  • "shipDate": "2019-10-14",
  • "carrierCode": "FDXE",
  • "totalWeight":
    {
    },
  • "includeURLReferences": true,
  • "consolidationType": "INTERNATIONAL_DISTRIBUTION_FREIGHT",
  • "consolidationRole": "CONSOLIDATION_DOCUMENTS_SHIPMENT"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Retrieve ITN

Use this endpoint to retrieve the ITN(internal tracking number) of an EEI(Electronic Export Information) which was already filed with US Customs.

header Parameters
x-locale
string
Example: en_US

This indicates the combination of language code and country code.

content-type
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

authorization
required
string
Example: Bearer XXXXX

This indicates the authorization token for the input request

x-customer-transaction-id
string
Example: 0e671149-016f-1000-941f-ef4dbabadd2e

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
version
object (version)
shipmentReferenceNumber
required
string

This is the shipment reference number which is needed in order to retrieve the ITN (Internal Tracking Number).

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /globaltrade/v1/shipments/itn/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/shipments/itn/retrieve

Production Server

https://apis.fedex.com/globaltrade/v1/shipments/itn/retrieve

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "version":
    {
    },
  • "shipmentReferenceNumber": "24091060018"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "customerTransactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "output":
    {
    }
}

File EEI

Use this endpoint to file an Electronic Export Information(EEI) with US Customs.

header Parameters
x-locale
string
Example: en_US

This indicates the combination of language code and country code.

authorization
required
string
Example: Bearer XXXXX

This indicates the authorization token for the input request.

x-customer-transaction-id
string
Example: 0e671149-016f-1000-941f-ef4dbabadd2e

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.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

Request Body schema: application/json
One of
  • FullSchema_FileEEIInputVO
  • SamplePayload_CancelFiling
  • SamplePayload_UpdateFiling
  • Minimum_Payload
version
object (version)
processingOption
required
Array of strings
Items Enum: "ADD" "CANCEL" "UPDATE"

processingOption for ADD Cancel Update

eeiControlDetail
object (FullSchema_FileEEIInputVO_eeiControlDetail)

Object of EEIControlDetail

eeiPartyDetails
required
Array of objects (FullSchema_FileEEIInputVO_eeiPartyDetails)

Both USPPI and ULTIMATE_CONSIGNEE are mandatory.

eeiCommodities
Array of objects (FullSchema_FileEEIInputVO_eeiCommodities)

commodity US Customs code, a high level explanation of type of export.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /globaltrade/v1/shipments/eei/file

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/shipments/eei/file

Production Server

https://apis.fedex.com/globaltrade/v1/shipments/eei/file

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "version":
    {
    },
  • "processingOption": "ADD",
  • "eeiControlDetail":
    {
    },
  • "eeiPartyDetails":
    [
    ],
  • "eeiCommodities":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "customerTransactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "output":
    {
    }
}

RegulatoryComplianceLookup V1

This endpoint is to determine the compliance regulations applied for Shipment for EEI Filings.

cookie Parameters
fdx_login
string
Example: fdx_login=fdx_login%3Dssoxdev2.df9e.6b52a541

It is the login cookie.It is required for online clients.

header Parameters
X-clientid
string
Example: MAGS

Registered client ids with FedEx API. i.e. MAGS, CAFE , INET, ISHP, etc.

X-locale
string
Example: en_US

ISO locale

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

Authorization
required
string
Example: Bearer XXX

Specifies the authorization token.

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

Contains the Materials Input object to be applied.

version
object (version_optional)
shipDate
required
string <YYYY-MM-DD>

String date format to indicate the date to be used for importing. Default to next day if not present in the request. This date can’t be greater than 120 days this includes weekends. The date format should be ISO8601Date, YYYY-MM-DD.

carrierCode
required
string

The shipment type abbreviation for a FedEx operating company. EX: FXE for FedEx Express. Supported Values: FXE, FXG, FXF or any value supported in the DOM element CarrierCodeType.

originAddress
required
object (RegulatoryAddressVO)

AddressVO V3 Model

destinationAddress
required
object (RegulatoryAddressVO)

AddressVO V3 Model

serviceType
required
string

String value to indicate a FedEx operating company’s type of service. Valid values from the authoritative data source (ADS) are listed in the example. Default value is “IP” if not present in the request. Valid values are also DOM ServiceType values.

serviceOptionTypes
required
Array of strings
totalWeight
required
object (Weight)

Specify the Dry Ice weight details.

Note:

  • Dry Ice is a Package level service for Domestic shipments.
  • Dry Ice must be declared at both Shipment and Package level for International MPS shipments to print the compliance statement on Airway Bill labels.

consolidationType
required
string

String value to identify the type of consolidation containing this shipment.

consolidationRole
required
string

A String value to identify the role of this shipment within the consolidation.

totalCommodityValue
required
object (Money_2)
regulatoryCustomsClearanceDetail
required
object (RegulatoryCustomsClearanceDetail)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /globaltrade/v1/regulatorycompliance/lookup

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/regulatorycompliance/lookup

Production Server

https://apis.fedex.com/globaltrade/v1/regulatorycompliance/lookup

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "version":
    {
    },
  • "shipDate": "2022-10-05",
  • "carrierCode": "FXE",
  • "originAddress":
    {
    },
  • "destinationAddress":
    {
    },
  • "serviceType": "[\"IP\",\"SG\",\"PO\",\"XS\",\"FR\",\"FL\"]",
  • "serviceOptionTypes":
    [
    ],
  • "totalWeight":
    {
    },
  • "consolidationType": "INTERNATIONAL_PRIORITY_DISTRIBUTION",
  • "consolidationRole": "CRN_SHIPMENT",
  • "totalCommodityValue":
    {
    },
  • "regulatoryCustomsClearanceDetail":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}
CLOSE

Response

Copy