Developer Portal
Freight LTL API
Giới thiệu
API Freight LTL cho phép bạn tạo các lô hàng nhỏ hơn tải trọng xe tải (LTL). Hàng hóa LTL quá lớn để có thể vận chuyển dưới dạng bưu kiện nhưng lại nhỏ hơn tải trọng xe tải.
API này cho phép bạn nhận ước tính giá cước, tạo nhãn vận chuyển duy nhất cho các đơn vị xử lý riêng lẻ và Vận đơn (nếu cần), lên lịch lấy hàng và theo dõi trạng thái lô hàng, kiểm tra khả năng lấy hàng và lên lịch lấy hàng. Điều này giúp tăng hiệu quả cho các lô hàng lớn hơn và nặng hơn của bạn.
Vận chuyển LTL qua FedEx Freight cung cấp khả năng theo dõi ở cấp đơn vị xử lý và theo dõi các lô hàng nhiều đơn vị xử lý cũng như vận chuyển nội địa mà không cần Vận đơn (BOL) giấy trong hầu hết các trường hợp. Bạn có thể tạo Vận đơn khi cần. Mặc dù tất cả đơn vị xử lý đều có số theo dõi duy nhất, lô hàng sẽ được chuyển dựa trên một Vận đơn, Biên lai giao hàng và Sao kê hóa đơn.
Chi tiết về API Freight LTL
API Freight LTL cho phép gửi hàng LTL và tạo chứng từ cần thiết như Vận đơn (khi cần), nhãn gửi hàng FedEx Freight và nhiều chứng từ gửi hàng khác. Trong Lô hàng Freight LTL, nhãn chính được gán cho đơn vị xử lý đầu tiên và nhãn phụ được gán cho đơn vị xử lý thứ hai trở đi. Nhãn phụ có số theo dõi duy nhất riêng nhưng đều tham chiếu tới số theo dõi chính. Bạn có thể tạo một Vận đơn cho mỗi lô hàng, trong đó chứa tất cả đơn vị xử lý và kiện hàng.
Mỗi đơn vị xử lý có thể được liên kết với một số theo dõi. Nhãn cũng tương tự như nhãn FedEx Ground hoặc Bưu kiện Express, trừ việc có chữ F biểu thị lô hàng Freight.
Số lượng tối đa đơn vị xử lý và kiện hàng của mỗi đơn vị xử lý:
- Giới hạn số kiện hàng tối đa của mỗi đơn vị xử lý – 9.999
- Đơn vị xử lý tối đa – 200 (khi in lần lượt từng Nhãn đơn vị xử lý).
- Đơn vị xử lý tối đa – 40 (khi in một lúc nhiều Nhãn đơn vị xử lý)
Dịch vụ gửi hàng FedEx LTL Freight có tại tất cả 50 tiểu bang cũng như Puerto Rico, USVI, Canada và Mexico. Một số lô hàng cần Vận đơn ngoài nhãn vận chuyển. Một ví dụ về các lô hàng này là lô hàng chứa vật liệu nguy hiểm.
FedEx Freight® đang thay đổi ngành LTL bằng cách giúp bạn dễ dàng vận chuyển hàng nặng nhanh chóng và tiết kiệm trong một mạng lưới LTL được sắp xếp hợp lý.
Sau đây là các tính năng có sẵn với API này:
- Quản lý việc lấy hàng Freight LTL
Tính năng này cho phép bạn xem các địa điểm lấy hàng Freight LTL, lên lịch Lấy hàng Freight và hủy bất kỳ yêu cầu Lấy hàng nào đã được lên lịch.
- Xem báo giá giá cước Freight LTL
Tính năng này cho phép bạn xem báo giá giá cước của lô hàng Freight LTL dựa trên các địa điểm và tùy chọn dịch vụ đã chọn.
- Vận chuyển lô hàng Freight LTL
Tính năng này cho phép bạn tạo lô hàng Freight LTL.
Sau đây là các tính năng của API Freight LTL:
- Vận chuyển lô hàng một kiện hoặc lô hàng MPS cho tất cả loại dịch vụ, từ đó tạo (các) nhãn gửi hàng hoặc Vận đơn (nếu cần).
- Tạo lô hàng nhiều đơn vị xử lý và theo dõi riêng mỗi đơn vị xử lý.
- Tạo lô hàng LTL để sử dụng các dịch vụ FedEx Freight Priority và Freight Economy.
- Cung cấp thông tin về người nhận như số tài khoản, thông tin liên lạc và địa chỉ.
- Cung cấp dấu thời gian, loại bao bì, tổng trọng lượng và nhiều chi tiết cần thiết khác được đề cập trong lược đồ điểm cuối.
- Cung cấp Nhãn FedEx với cách thể hiện thương hiệu chuẩn và hỗ trợ các kích thước xác định cho nhãn nhiệt.
- Nhận thông báo qua email hoặc tin nhắn SMS trong quá trình giao dịch vận chuyển như:
- Thông báo gửi hàng
- Ngày giao hàng ước tính
- Thông báo lấy hàng
- Tạo chứng từ gửi hàng như:
- Nhãn vận chuyển của từng đơn vị xử lý
- Vận đơn
- Hóa đơn thương mại
- Hóa đơn hải quan Canada
- Tạo lô hàng và in nhãn từng đơn vị xử lý hoặc xử lý tất cả đơn vị xử lý cùng một lúc.
- Truy xuất giá cước của lô hàng một kiện hoặc lô hàng MPS cho tất cả các loại dịch vụ.
- Kiểm tra khả năng lấy hàng, lên lịch lấy hàng Freight và hủy yêu cầu lấy hàng.
- Tạo yêu cầu lấy hàng và lên lịch lấy hàng bằng tài khoản bên thứ ba với địa chỉ thanh toán thay thế.
Thu tiền khi giao hàng nặng: Dừng hỗ trợ
Hãng vận tải không cung cấp dịch vụ C.O.D (Thu tiền khi giao hàng) cho Khách hàng. Hãng vận tải sẽ không chịu trách nhiệm thu tiền khi giao hàng vì đây không phải là dịch vụ do Hãng vận tải cung cấp. Mọi chi phí lưu kho, gửi lại và vận chuyển hàng nặng sẽ áp dụng cho các lô hàng có dấu C.O.D.
Các dịch vụ vận chuyển Freight LTL
Chúng tôi cung cấp các dịch vụ vận chuyển Freight LTL sau:
FedEx Freight® Priority
Với khả năng đảm bảo đúng giờ hàng đầu trong ngành và thời gian vận chuyển nhanh chóng, FedEx Freight <® Priority phân phối các lô hàng của bạn một cách nhanh chóng và đáng tin cậy. Hãy tin tưởng vào dịch vụ trong khu vực của chúng tôi để có thể giao hàng rộng rãi trong ngày hôm sau và ngày thứ hai cho khách hàng của bạn, tất cả được hỗ trợ bởi chính sách đảm bảo hoàn tiền không tính phí. *
Các tính năng của dịch vụ FedEx Freight® Priority:
- Thời gian vận chuyển nhanh chóng với dịch vụ giao hàng vào hôm sau lên tới 600 dặm và giao hàng vào ngày thứ hai lên tới 1.600 dặm
- Vận chuyển trực tiếp đến hầu hết mọi mã ZIP ở Hoa Kỳ, Canada và Mexico.
- Ổn định, đảm bảo đúng giờ
- Đảm bảo hoàn tiền không tính phí*
- Công nghệ thông tin hiện đại với khả năng theo dõi lô hàng từ đầu đến cuối
- Đội ngũ chuyên gia tận tâm hỗ trợ mọi nhu cầu vận chuyển hàng nặng trong khu vực của bạn
*Tất cả dịch vụ đều tuân theo điều khoản và điều kiện của Biểu thuế theo các quy tắc sê-ri 100 của FXFR.
FedEx Freight Economy
FedEx Freight® Economy cung cấp dịch vụ giao hàng LTL (nhỏ hơn tải trọng xe tải) tiết kiệm, tập trung vào nhu cầu vận chuyển hàng nặng cơ bản của bạn. Với dịch vụ giao hàng LTL đảm bảo đúng giờ và xử lý cẩn thận của FedEx, dịch vụ khách hàng luôn được đáp ứng tốt.
FedEx Freight® Economy cung cấp:
- Các giải pháp vận chuyển hàng nặng tiết kiệm
- Tiết kiệm hơn cho các lô hàng không cần giao nhanh nhưng cần đảm bảo độ tin cậy
- Ổn định, đảm bảo đúng giờ
- Vận chuyển trực tiếp đến hầu hết mọi mã ZIP ở Hoa Kỳ, Canada, Mexico và Puerto Rico.
- Công nghệ thông tin hiện đại với khả năng theo dõi lô hàng từ đầu đến cuối
- Cải thiện khả năng quan sát với tính năng theo dõi lô hàng từ đầu đến cuối
FedEx International Deferred Freight (FDF)
FedEx International Deferred Freight (FDF) là dịch vụ vận chuyển hàng nặng bằng đường hàng không toàn cầu để vận chuyển các lô hàng nặng bằng đường hàng không quốc tế với thời gian giao hàng/vận chuyển kéo dài và giá cước tiết kiệm. FDF cũng áp dụng cho các dịch vụ giao hàng Từ sân bay đến sân bay, Từ kho đến sân bay, Từ sân bay đến kho và Từ kho gửi hàng đến kho nhận hàng
Lưu ý:
- Hiện tại, dịch vụ này chỉ áp dụng cho một số tuyến vận chuyển liên quốc gia.
- Không vận chuyển Hàng hóa nguy hiểm (DG) và Hàng hóa bị hạn chế. Ví dụ: Đá khô, pin lithium ion. Vui lòng liên hệ với bộ phận hỗ trợ khách hàng của FedEx để biết thêm thông tin.
- Không cho phép lô hàng nội địa Hoa Kỳ và lô hàng nội địa ngoài Hoa Kỳ.
Phương thức hoạt động của API Freight LTL
Phần này mô tả các điểm cuối và các phần tử chính cần thiết cho API Freight LTL của FedEx.
Lưu ý: Tài khoản FedEx Freight LTL của bạn phải được kích hoạt để sử dụng API Freight LTL của FedEx. Thông tin quan trọng cần thiết là (các) số tài khoản FedEx Freight và địa chỉ gửi thư chính xác của tài khoản để xử lý các lô hàng LTL.
Sau đây là các điểm cuối có sẵn với API này:
Vận chuyển lô hàng Freight LTL
Sử dụng điểm cuối này để xác thực và tạo lô hàng FedEx Freight LTL.
Thông tin đầu vào cần thiết liên kết với yêu cầu này là:
- Số tài khoản Freight
- Địa chỉ gửi thư của tài khoản
- Lô hàng được yêu cầu dịch vụ Freight
- Tùy chọn phản hồi về nhãn – Các nhãn sẽ được trả về dưới dạng mã hóa hoặc dưới dạng URL.
- Chi tiết chính để Theo dõi – Chỉ trong trường hợp lô hàng MPS phải xử lý và các nhãn phải được in từng cái một chứ không phải tất cả cùng một lúc (khi phần tử singleShotMPS không được cung cấp hoặc được thêm giá trị sai).
Phản hồi thành công cho yêu cầu này sẽ tạo ra Lô hàng LTL, cung cấp chi tiết Theo dõi và chi tiết cảnh báo trong phản hồi. Phản hồi cũng trả về các lỗi và phần mô tả trong trường hợp có lỗi.
Lưu ý: Địa chỉ gửi thư có thể khác với địa chỉ giao hàng thực tế.
Kiểm tra khả năng lấy hàng Freight LTL
Sử dụng điểm cuối này để yêu cầu danh sách tất cả địa điểm lấy hàng hiện có kèm theo chi tiết về lịch lấy hàng, chẳng hạn như hãng vận tải, thời gian muộn nhất có thể lấy hàng, thời gian muộn nhất có thể lấy hàng theo mặc định, khả năng lấy hàng, thời gian gói hàng sẵn sàng để lấy, dấu hiệu cho biết địa chỉ có phải là nơi cư trú không, thời gian chốt sổ lấy hàng và quá trình tài xế đến lấy gói hàng.
Thông tin đầu vào cần thiết liên kết với yêu cầu này là:
- Địa chỉ lấy hàng/chi tiết thông tin bưu chính.
- Loại yêu cầu lấy hàng (ví dụ: trong ngày/ngày trong tương lai).
- Yêu cầu lấy hàng này là nội địa/quốc tế.
Lưu ý: Sử dụng địa chỉ lấy hàng chính xác và hợp lệ.
Phản hồi thành công cho yêu cầu này sẽ cung cấp danh sách tất cả các địa điểm lấy hàng có sẵn, ngày giao hàng, tình trạng có sẵn (cờ), ngày lấy hàng, thời gian chốt sổ lấy hàng, thời gian tiếp cận, khả năng lấy hàng cho nơi cư trú (cờ), thời gian chốt sổ (cờ), thời gian chốt sổ và giờ địa phương trong phản hồi. Phản hồi cũng trả về các lỗi và phần mô tả trong trường hợp có lỗi.
Tạo yêu cầu lấy hàng Freight LTL
Sử dụng điểm cuối này để tạo và lên lịch lấy hàng Freight LTL.
Thông tin đầu vào cần thiết liên kết với yêu cầu này là:
- Số tài khoản Freight sẽ được lập hóa đơn cho yêu cầu lấy hàng.
- Chi tiết về nơi gửi hàng (địa chỉ, địa điểm và loại địa chỉ lấy hàng, chẳng hạn tài khoản/người gửi/khác).
- Chi tiết địa chỉ của tài khoản liên kết.
Yêu cầu lấy hàng thành công sẽ trả về số xác nhận lấy hàng, thông báo lấy hàng và mã địa điểm cho lần lấy hàng đang được lên lịch. Phản hồi cũng trả về các lỗi và phần mô tả trong trường hợp có lỗi.
Lưu ý: Sử dụng địa chỉ chính xác và hợp lệ cho yêu cầu lấy hàng, đồng thời cung cấp địa chỉ tài khoản chính xác trong hồ sơ để lên lịch lấy hàng. Bạn không nên nhập thời gian sẵn sàng trong quá khứ, ngày trong quá khứ hay ngày quá xa trong tương lai để lên lịch lấy hàng. Không cho phép lấy hàng ẩn danh. Bạn có thể lên lịch lấy hàng cho các tài khoản bên thứ ba bằng cách cung cấp chi tiết địa chỉ thay thế hợp lệ.
Hủy yêu cầu lấy hàng Freight LTL
Sử dụng điểm cuối này để hủy yêu cầu lấy hàng đã lên lịch cho gói hàng LTL. Yêu cầu hủy lấy hàng thành công sẽ trả về số xác nhận và lời nhắn xác nhận hủy lấy hàng.
Thông tin đầu vào cần thiết liên kết với yêu cầu này là:
- Mã xác nhận lấy hàng (nhận được khi gửi yêu cầu lấy hàng)
- Ngày được lên lịch (Ngày điều phối lấy hàng)
- Địa điểm (Địa điểm FedEx Express chịu trách nhiệm xử lý yêu cầu lấy hàng)
Yêu cầu thành công sẽ trả về số xác nhận lấy hàng, thông báo lấy hàng và mã địa điểm cho lần lấy hàng đang được lên lịch. Phản hồi cũng trả về các lỗi và phần mô tả trong trường hợp có lỗi.
Lưu ý: Gửi số xác nhận lấy hàng và mã địa điểm tương ứng (chỉ áp dụng cho FDXE) để hủy yêu cầu lấy hàng đã lên lịch. Bạn nhận được thông tin về số xác nhận lấy hàng và mã địa điểm tương ứng (chỉ áp dụng cho FDXE) khi gửi yêu cầu lấy hàng. Đồng thời, hãy dùng địa chỉ tài khoản chính xác trong hồ sơ để hủy yêu cầu lấy hàng. Thông báo thất bại sẽ được gửi nếu bạn tìm cách hủy yêu cầu lấy hàng sau khi nhân viên chuyển phát của FedEx đã được điều phối đến địa điểm lấy hàng
Giá cước vận chuyển Freight LTL
Sử dụng điểm cuối này để yêu cầu danh sách tất cả các báo giá cước dịch vụ Freight khả thi và thông tin vận chuyển tùy chọn dựa trên chi tiết đầu vào. Giá cước được truy xuất dựa trên nơi gửi hàng, nơi nhận hàng và nhiều thông tin đầu vào khác trong lô hàng. Bạn cũng có thể sử dụng các thông tin như mã hãng vận tải, loại dịch vụ hoặc tùy chọn dịch vụ để có kết quả chính xác hơn.
Thông tin đầu vào cần thiết liên kết với yêu cầu này là:
- Số tài khoản Freight
- Lô hàng được yêu cầu dịch vụ Freight.
Phản hồi thành công cho yêu cầu này sẽ trả về danh sách tất cả các giá cước khả thi và mã địa điểm cho yêu cầu nhận hàng được lên lịch. Phản hồi cũng trả về các lỗi và phần mô tả trong trường hợp có lỗi.
Lô hàng nhiều kiện (MPS) Freight LTL
Lô hàng nhiều kiện (MPS) bao gồm hai hoặc nhiều đơn vị xử lý được gửi đến cùng một địa chỉ người nhận. Đơn vị xử lý đầu tiên trong yêu cầu lô hàng được coi là đơn vị chính.
Để tạo lô hàng nhiều kiện:
- Bao gồm thông tin cấp độ lô hàng, chẳng hạn như chi tiết về serviceType, packagingType, totalWeight, totalPackageCount, freightShipmentDetail và requestedPackageLineItems. [Lưu ý: sequenceNumber đối với gói hàng chính phải bằng 1.]
- Đối với nhãn in cho mỗi đơn vị xử lý, hãy đưa chi tiết theo dõi Chính vào phần tử masterTrackingId cho tất cả các đơn vị xử lý tiếp theo.
Sau đây là các tùy chọn Xử lý vận chuyển nhiều kiện có sẵn với API này:
In lần lượt từng nhãn đơn vị xử lý
API này cho phép bạn xử lý các lô hàng nhiều kiện và nhận từng nhãn một.
Khi bạn cần khả năng này cho các lô hàng của mình, cùng với tất cả các phần tử MPS cần thiết, hãy cung cấp phần tử oneLabelAtATime dưới dạng đúng trong yêu cầu.
Đầu ra của yêu cầu đầu tiên phải tạo nhãn và số theo dõi là số theo dõi chính. Cung cấp số theo dõi chính này trong phần tử masterTrackingId để xử lý yêu cầu giao hàng tiếp theo và tạo nhãn có số theo dõi (số theo dõi phụ) cho tổng số gói hàng đã xác định (totalPackageCount).
Lưu ý: Số đơn vị xử lý tối đa được phép là 200.
In tất cả các nhãn đơn vị xử lý cùng một lúc
API này cho phép bạn xử lý các lô hàng nhiều kiện và nhận hết nhãn trong một lần. Đây là một trong những phương pháp xử lý lý tưởng, được sử dụng khi lô hàng có từ 40 đơn vị xử lý trở xuống (totalPackageCount<=40) được gửi đến cùng một địa chỉ người nhận trong lô hàng.
Đặt oneLabelAtATime là sai trong yêu cầu Gửi hàng với 40 đơn vị xử lý trở xuống và tạo các nhãn ngay lập tức.
Lưu ý: Giới hạn tối đa 40 đơn vị xử lý là chỉ báo và không phải là giới hạn cố định. Giới hạn cũng phụ thuộc vào cách kết hợp số lượng đơn vị xử lý và hàng hóa. Liên hệ với nhân viên kinh doanh của FedEx để biết thêm thông tin.
Ví dụ: Yêu cầu gửi hàng của bạn bao gồm 10 đơn vị xử lý, khi gửi sẽ tạo ra 10 nhãn và URL nhãn hoặc nhãn mã hóa theo yêu cầu sẽ được cung cấp trong phần phản hồi.
FedEx Freight Direct
Dịch vụ này mang lại trải nghiệm khách hàng vượt trội khi giao hàng hóa lớn và hàng hóa được xếp trên tấm nâng hàng, bao gồm giao các lô hàng nặng, cồng kềnh trong nhà hoặc công ty của khách hàng.
Dịch vụ này cung cấp các tùy chọn như chủ động liên lạc, tùy chọn giao hàng linh hoạt và giá theo gói bao gồm phụ phí dịch vụ.
Sau đây là một số tính năng có trong dịch vụ này:
- Cho phép tạo lô hàng cho dịch vụ giao hàng cơ bản, cơ bản theo lịch hẹn, tiêu chuẩn và cao cấp của FedEx Freight Direct cũng như lô hàng trả lại/yêu cầu lấy hàng cơ bản trong phạm vi lục địa Hoa Kỳ, Alaska và Hawaii.
- Bao gồm khả năng sử dụng số tài khoản FedEx Freight Direct để nhận ước tính giá cước đầy đủ cho lô hàng FedEx Freight Direct và khả năng hủy yêu cầu lấy hàng FedEx Freight Direct.
- Không có giá cước ước tính cho Alaska và Hawaii. Khách hàng vui lòng liên hệ bộ phận dịch vụ khách hàng của FedEx để yêu cầu báo giá cho hai tiểu bang trên.
- Để hủy yêu cầu lấy hàng được lên lịch vào cùng ngày, khách hàng phải gọi cho dịch vụ khách hàng của FedEx.
- Cho phép bạn gửi thông báo qua email đến người gửi/người nhận ban đầu để khách hàng có thể:
- Lên lịch giao hàng
- Nhận thông báo xác nhận giao hàng và/hoặc lấy hàng
- Nhận thông báo giao hàng và/hoặc lấy hàng
- Nhận thông báo đang trên đường
- Khảo sát khách hàng về các lô hàng đã giao
- Các quy tắc của doanh nghiệp về việc xác thực mã zip, kích thước, trọng lượng kiện hàng và trọng lượng đơn vị xử lý sẽ được áp dụng cho FedEx Freight Direct để xác định cách kết hợp chính xác giữa dịch vụ vận tải hàng hóa bằng đường bộ và dịch vụ chặng đầu/cuối.
FedEx Freight Direct cung cấp các loại dịch vụ khác nhau để bạn lựa chọn.
API này cung cấp các tính năng sau cùng với dịch vụ Freight Direct:
Xem giá cước Freight Direct
Sử dụng điểm cuối này để xem giá cước Freight Direct và phụ phí cho các tùy chọn dịch vụ Freight Direct đặc biệt sau đây: Dịch vụ cơ bản, Dịch vụ cơ bản theo lịch hẹn, Dịch vụ tiêu chuẩn, Dịch vụ cao cấp.
Sau đây là thông tin bắt buộc đi kèm với yêu cầu Giá cước sử dụng Giá cước Freight LTL của điểm cuối:
- Loại dịch vụ Freight Direct (CƠ BẢN, CƠ BẢN THEO LỊCH HẸN, CAO CẤP, TIÊU CHUẨN)
- Loại dịch vụ vận chuyển Freight Direct (GIAO HÀNG, LẤY HÀNG)
- Loại số điện thoại nếu số điện thoại được cung cấp (NHÀ, DI ĐỘNG, CƠ QUAN)
- Trọng lượng
- Kích thước (Chiều dài, chiều rộng và chiều cao không âm)
Tạo lô hàng Freight Direct
Sử dụng điểm cuối này để gửi lô hàng một kiện hoặc lô hàng nhiều kiện cho các tùy chọn dịch vụ Freight Direct đặc biệt sau đây: Dịch vụ cơ bản, Dịch vụ cơ bản theo lịch hẹn, Dịch vụ tiêu chuẩn, Dịch vụ cao cấp và nhận nhãn gửi hàng hoặc vận đơn, gồm cả tài liệu cần thiết để xử lý các lô hàng Freight Priority.
Sau đây là thông tin bắt buộc đi kèm với yêu cầu gửi hàng thông qua Gửi lô hàng Freight LTL của điểm cuối:
- Loại dịch vụ Freight Direct (CƠ BẢN, CƠ BẢN THEO LỊCH HẸN, CAO CẤP, TIÊU CHUẨN)
- Loại dịch vụ vận chuyển Freight Direct (GIAO HÀNG, LẤY HÀNG)
- Địa chỉ email, số điện thoại và loại số điện thoại
- Trọng lượng
- Kích thước (Chiều dài, chiều rộng và chiều cao không âm)
Vận đơn đầu ra sẽ in tên dịch vụ Freight Direct mới. Sau đây là các giá trị được in trên vận đơn, tùy thuộc vào dịch vụ đã chọn:
- GIAO HÀNG CƠ BẢN FREIGHT DIRECT
- GIAO HÀNG CƠ BẢN THEO LỊCH HẸN FREIGHT DIRECT
- GIAO HÀNG CAO CẤP FREIGHT DIRECT
- GIAO HÀNG TIÊU CHUẨN FREIGHT DIRECT
- LẤY HÀNG CƠ BẢN FREIGHT DIRECT
- LẤY HÀNG CƠ BẢN THEO LỊCH HẸN FREIGHT DIRECT
- LẤY HÀNG CAO CẤP FREIGHT DIRECT
- LẤY HÀNG TIÊU CHUẨN FREIGHT DIRECT
Lấy hàng Freight Direct
Sử dụng điểm cuối này để kiểm tra tính sẵn có của dịch vụ lấy hàng Freight LTL Freight Direct, tạo yêu cầu lấy hàng cho gói hàng sẽ được lấy hoặc hủy yêu cầu lấy hàng hiện có.
Sau đây là thông tin bắt buộc đi kèm với yêu cầu Lấy hàng sử dụng điểm cuối Kiểm tra tính sẵn có của dịch vụ lấy hàng Freight LTL, Tạo yêu cầu lấy hàng Freight LTL và Hủy yêu cầu lấy hàng Freight LTL.
- Loại dịch vụ Freight Direct (CƠ BẢN, CƠ BẢN THEO LỊCH HẸN, CAO CẤP, TIÊU CHUẨN)
- Loại dịch vụ vận chuyển Freight Direct (GIAO HÀNG, LẤY HÀNG)
- Địa chỉ email (Tạo yêu cầu lấy hàng)
- Số điện thoại và loại số điện thoại (Tạo yêu cầu lấy hàng)
- Trọng lượng
Quy tắc kinh doanh
- Số theo dõi chính (Pro) được gán cho đơn vị xử lý đầu tiên của lô hàng Freight LTL và các số theo dõi phụ được gán cho mỗi đơn vị xử lý tiếp theo.
- Bạn có thể theo dõi riêng từng đơn vị xử lý trong lô hàng hoặc theo dõi cùng toàn bộ lô hàng.
- Các chứng từ khác có thể áp dụng cho các lô hàng cụ thể (ví dụ: Vật liệu nguy hiểm Freight [HazMat] và các lô hàng quốc tế).
- Không thể thêm tài khoản chỉ vận chuyển LTL Freight và tài khoản LTL Freight được lập hóa đơn vào FedEx Developer Portal.
- Khách hàng có thể dùng một số tài khoản LTL dài hạn hoặc số tài khoản FedEx Freight Direct để sử dụng các dịch vụ Freight Direct.
- Chức năng ước tính giá cước FedEx Freight Direct chỉ áp dụng trong API LTL thông thường.
- Tất cả các lỗi/tin nhắn mới sẽ chỉ sử dụng tiếng Anh.
- Địa chỉ email và số điện thoại là thông tin bắt buộc trong yêu cầu tùy chọn dịch vụ FedEx Freight Direct khi tạo lô hàng.
Bộ sưu tập API JSON
Freight LTL API (1.0.0)
Rate Freight LTL
This endpoint providess the ability to retrieve rate quotes and optionall transitt informationnnn. The rate is calculated based on the origin and destination of the shipment. Additional information such as carrier code, service type, or service option can be used to filter the results. Applicable operating company is FedEx Freight.
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
- FullSchema
- MinimumSamplePayload
| accountNumber required | object (LTLRootAccountNumber) This is the Account number details.
|
| rateRequestControlParameters | object (LTLRateRequestControlParameters) These are various parameters you can provide for filtering and sorting capability in the response, such as transit time and commit data, rate sort order etc. |
| freightRequestedShipment required | object (LTLRequestedShipment) This contains shipment data describing the shipment for which a freight rate quote (or rate-shopping comparison) is desired. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "accountNumber": {
- "value": "XXX61073"
- "rateRequestControlParameters": {
- "returnTransitTimes": false,
- "servicesNeededOnRateFailure": true,
- "variableOptions": "FREIGHT_GUARANTEE",
- "rateSortOrder": "SERVICENAMETRADITIONAL"
- "freightRequestedShipment": {
- "shipper": {
- "address": {
- "streetLines": [
- "1550 Union Blvd",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "TN",
- "postalCode": "65247",
- "countryCode": "US",
- "residential": false
- "recipient": {
- "address": {
- "streetLines": [
- "1550 Union Blvd",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "TN",
- "postalCode": "65247",
- "countryCode": "US",
- "residential": false
- "serviceType": "FEDEX_FREIGHT_PRIORITY",
- "preferredCurrency": "USD",
- "shippingChargesPayment": {
- "payor": {
- "responsibleParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "phone extension",
- "companyName": "Fedex",
- "faxNumber": "fax number"
- "accountNumber": {
- "value": "123456789"
- "paymentType": "SENDER"
- "rateRequestType": [
- "LIST"
- "shipDateStamp": "2019-09-06",
- "requestedPackageLineItems": [
- {
- "subPackagingType": "BAG",
- "groupPackageCount": 1,
- "contentRecord": [
- {
- "itemNumber": "string",
- "receivedQuantity": 0,
- "description": "string",
- "partNumber": "string"
- "declaredValue": {
- "amount": "100",
- "currency": "USD"
- "weight": {
- "units": "KG",
- "value": 68.25
- "dimensions": {
- "length": 10,
- "width": 8,
- "height": 2,
- "units": "IN"
- "associatedFreightLineItems": [
- {
- "id": "string"
- "totalPackageCount": 3,
- "totalWeight": 87,
- "freightShipmentDetail": {
- "role": "CONSIGNEE",
- "accountNumber": {
- "value": "XXXXX6789"
- "declaredValueUnits": "string",
- "shipmentDimensions": {
- "length": 10,
- "width": 8,
- "height": 2,
- "units": "IN"
- "lineItem": [
- {
- "handlingUnits": 0,
- "nmfcCode": "string",
- "subPackagingType": "BAG",
- "description": "string",
- "weight": {
- "units": "KG",
- "value": 68.25
- "pieces": 0,
- "volume": {
- "units": "CUBIC_FT",
- "value": 0
- "freightClass": "CLASS_050",
- "purchaseOrderNumber": "string",
- "id": "string",
- "hazardousMaterials": "HAZARDOUS_MATERIALS",
- "dimensions": {
- "length": 10,
- "width": 8,
- "height": 2,
- "units": "IN"
- "clientDiscountPercent": 0,
- "fedExFreightBillingContactAndAddress": {
- "address": {
- "streetLines": [
- "string",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "string",
- "postalCode": "string",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "person name",
- "emailAddress": "email address",
- "phoneNumber": "phone number",
- "phoneExtension": "phone extension",
- "companyName": "company name",
- "faxNumber": "fax number"
- "aliasID": "string",
- "hazardousMaterialsOfferor": "string",
- "declaredValuePerUnit": {
- "amount": "100",
- "currency": "USD"
- "totalHandlingUnits": 0,
- "alternateBillingParty": {
- "address": {
- "streetLines": [
- "1550 Union Blvd",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "TN",
- "postalCode": "65247",
- "countryCode": "US",
- "residential": false
- "accountNumber": {
- "value": "XXX61073"
- "freightShipmentSpecialServices": {
- "freightGuaranteeDetail": {
- "freightGuaranteeType": "GUARANTEED_DATE",
- "guaranteeTimestamp": "string"
- "specialServiceTypes": [
- "FREIGHT_GUARANTEE"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "STANDARD",
- "transportationType": "DELIVERY",
- "emailAddress": "abc@def.com",
- "phoneNumberDetails": [
- {
- "phoneNumberType": "MOBILE",
- "phoneNumber": "XXXXXXXXX12"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "transactionId": "63a21b84-ad5c-4da2-b788-f615e5cafaa3",
- "output": {
- "alerts": [
- {
- "code": "MIXED.MEASURING.UNITS.INCLUDED",
- "message": "Package 1 - Mixed measuring units are provided for weight and dimensions.",
- "alertType": "WARNING",
- "parameterList": [
- {
- "key": "Package Index",
- "value": "1"
- "rateReplyDetails": [
- {
- "serviceType": "FEDEX_FREIGHT_PRIORITY",
- "commit": {
- "dateDetail": {
- "dayOfWeek": "Fri",
- "dayFormat": "2020-12-04T17:00:00-06:00"
- "transitDays": {
- "minimumTransitTime": "TWO_DAYS",
- "description": "2 Business Days"
- "saturdayDelivery": false
- "ratedShipmentDetails": [
- {
- "quoteNumber": "1100739606",
- "rateType": "ACCOUNT",
- "freightChargeBasis": "MINIMUM",
- "ratedWeightMethod": "FREIGHT_MINIMUM",
- "totalDiscounts": 0,
- "totalBaseCharge": 805,
- "totalNetCharge": 996.59,
- "totalNetFedExCharge": 996.59,
- "shipmentLegRateDetails": [
- {
- "rateScale": "*FXF PZONE 01/04/21 LD 11122",
- "totalBaseCharge": 0,
- "totalNetCharge": 996.59
- "shipmentRateDetail": {
- "dimDivisor": 0,
- "fuelSurchargePercent": 23.8,
- "totalSurcharges": 191.59,
- "totalFreightDiscount": 0,
- "surCharges": [
- {
- "type": "FUEL",
- "description": "Fuel Surcharge",
- "level": "SHIPMENT",
- "amount": 191.59
- "totalBillingWeight": {
- "units": "LB",
- "value": 331
- "totalDimWeight": {
- "units": "LB",
- "value": 0
- "currency": "USD",
- "rateScale": "*FXF PZONE 01/04/21 LD 11122"
- "currency": "USD"
- "operationalDetail": {
- "originLocationNumbers": [ ],
- "deliveryDate": "2020-12-04T17:00:00-06:00",
- "deliveryDay": "FRI",
- "commitDate": "2020-12-04T17:00:00-06:00",
- "commitDays": [
- "FRI"
- "transitTime": "TWO_DAYS",
- "ineligibleForMoneyBackGuarantee": true
- "freightTransitLocationDetail": {
- "originLocation": {
- "contactAndAddress": {
- "contact": {
- "personName": "DAWN THIELHART",
- "phoneNumber": "800-218-6293"
- "address": {
- "streetLines": [
- "6952 E HILLSBOROUGH AVE",
- ""
- "city": "TAMPA",
- "stateOrProvinceCode": "FL",
- "postalCode": "33610-4136",
- "countryCode": "US",
- "residential": false
- "locationId": "TPA"
- "destinationLocation": {
- "contactAndAddress": {
- "contact": {
- "personName": "TED CLAY",
- "phoneNumber": "214-333-4544"
- "address": {
- "streetLines": [
- "1501 N WALTON WALKER BLVD",
- ""
- "city": "DALLAS",
- "stateOrProvinceCode": "TX",
- "postalCode": "75211",
- "countryCode": "US",
- "residential": false
- "locationId": "SDA"
- "distance": {
- "units": "MI",
- "value": 1139
- "quoteDate": "2020-12-02",
- "encoded": false
Ship Freight LTL
This endpoint helps you to create a Freight LTL Shipment request with the required Freight LTL Shipment information, and to retrieve information for an already in process shipment. It also allows you to confirm and validate 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
- FullSchema-FreightShipment
- FreightShipment_ShipTo_Freight_Account
- FreightShipment_BillTo_Freight_Account
- FreightShipment_International_SingleShot_MPS_ShipTo_Freight_Account
- FreightShipment_OneLabelAtATime_MPS_Master_ShipTo_Freight_Account
- FreightShipment_OneLabelAtATime_MPS_Child_ShipTo_Freight_Account
| freightRequestedShipment required | object (FreightRequestedShipment_Freight2020) The descriptive data for the FreightShipment being tendered to FedEx. |
| labelResponseOptions required | string Enum: "URL_ONLY" "LABEL" If the value is LABEL, the encoded label will be included in the response and if the value is URL_ONLY, the response will include the URLs. Note: With URL_ONLY option, the URL once created will be active for 24 hours. |
| accountNumber required | object (ShipperAccountNumber) The account number associated with the shipment. |
| oneLabelAtATime | boolean If the value is false, it uses single shot MPS shipments where in all the packages are processed in the same transaction and can generate number of labels for the handling units all at once. If the value is true, the MPS shipment processes packages and labels one at a time. Default value is false.
|
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "freightRequestedShipment": {
- "shipDatestamp": "2019-10-14",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "FEDEX_FREIGHT_ECONOMY",
- "packagingType": "YOUR_PACKAGING",
- "totalWeight": 20,
- "preferredCurrency": "USD",
- "shipper": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": 91,
- "companyName": "Fedex",
- "faxNumber": "1234567",
- "stateTaxId": "1234567",
- "fedralTaxId": "11-N-1745"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "recipient": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": 91,
- "companyName": "Fedex",
- "faxNumber": "1234567",
- "stateTaxId": "1234567",
- "fedralTaxId": "11-N-1645"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "deliveryInstructions": "delivery instructions"
- "soldTo": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "91",
- "phoneNumber": "1234567890",
- "companyName": "Fedex"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "accountNumber": {
- "value": "XXXXX6789"
- "origin": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "person name",
- "emailAddress": "email address",
- "phoneNumber": "phone number",
- "phoneExtension": "phone extension",
- "companyName": "company name",
- "faxNumber": "fax number"
- "shippingChargesPayment": {
- "paymentType": "SENDER",
- "payor": {
- "responsibleParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "phone extension",
- "companyName": "Fedex",
- "faxNumber": "fax number",
- "stateTaxId": "state tax identifier",
- "fedralTaxId": "11-N-1745"
- "accountNumber": {
- "value": "801472842"
- "billingDetails": {
- "billingCode": "123876",
- "billingType": "billingType",
- "aliasId": "aliasId",
- "accountNickname": "accountNickname",
- "accountNumber": "801472842",
- "accountNumberCountryCode": "US"
- "freightShipmentSpecialServices": {
- "specialServiceTypes": [
- "THIRD_PARTY_CONSIGNEE",
- "PROTECTION_FROM_FREEZING"
- "freightGuaranteeDetail": {
- "freightGuaranteeType": "GUARANTEED_DATE",
- "guaranteeTimestamp": "2009-12-04"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "STANDARD",
- "transportationType": "DELIVERY",
- "emailAddress": "abc@def.com",
- "phoneNumberDetails": [
- {
- "phoneNumberType": "MOBILE",
- "phoneNumber": "XXXXXXXXX12"
- "customDeliveryWindowDetail": {
- "requestDate": "2023-05-15",
- "requestTime": "10:00:00",
- "requestRange": {
- "begins": "12-01-2020",
- "ends": "22-01-2020"
- "type": "AFTER"
- "emailNotificationDetail": {
- "aggregationType": "PER_PACKAGE",
- "emailNotificationRecipients": [
- {
- "name": "Joe Smith",
- "emailNotificationRecipientType": "SHIPPER",
- "emailAddress": "jsmith3@aol.com",
- "notificationFormatType": "TEXT",
- "notificationType": "EMAIL",
- "locale": "en_US",
- "notificationEventType": [
- "ON_PICKUP_DRIVER_ARRIVED",
- "ON_SHIPMENT"
- "personalMessage": "your personal message here"
- "freightShipmentDetail": {
- "role": "CONSIGNEE",
- "specialServicePayments": [
- {
- "specialService": "Special Service",
- "paymentType": "COLLECT"
- "liabilityCoverageDetail": {
- "coverageType": "USED_OR_RECONDITIONED",
- "coverageAmount": {
- "amount": 12.45,
- "currency": "USD"
- "fedExFreightAccountNumber": {
- "value": "Your account number"
- "declaredValueUnits": "LBS",
- "printedReferences": [
- {
- "printedReferenceType": "BILL_OF_LADING",
- "value": "1"
- "hazardousMaterialsEmergencyContactNumber": {
- "areaCode": "901",
- "localNumber": "3575012",
- "extension": "200",
- "countryCode": "US",
- "personalIdentificationNumber": "98712345"
- "lineItem": [
- {
- "handlingUnits": 12,
- "nmfcCode": "nmfcCode",
- "subPackagingType": "BUNDLE",
- "description": "description",
- "weight": {
- "units": "KG",
- "value": 68.25
- "pieces": 12,
- "volume": {
- "units": "CUBIC_FT",
- "value": 9.965781217890562
- "freightClass": "CLASS_050",
- "purchaseOrderNumber": "50",
- "id": "123",
- "hazardousMaterials": "HAZARDOUS_MATERIALS",
- "dimensions": {
- "length": 25,
- "width": 10,
- "height": 12,
- "units": "IN"
- "classProvidedByCustomer": true
- "clientDiscountPercent": 5.12,
- "coupons": [
- "coupons"
- "fedExFreightBillingContactAndAddress": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "person name",
- "emailAddress": "email address",
- "phoneNumber": "phone number",
- "phoneExtension": "phone extension",
- "companyName": "company name",
- "faxNumber": "fax number"
- "aliasID": "981234",
- "collectTermsType": "NON_RECOURSE_SHIPPER_SIGNED",
- "hazardousMaterialsOfferor": "offeror",
- "declaredValuePerUnit": {
- "amount": 12.45,
- "currency": "USD"
- "totalHandlingUnits": 12,
- "alternateBillingParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXX2345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "variableHandlingChargeDetail": {
- "rateType": "PREFERRED_CURRENCY",
- "percentValue": 12.45,
- "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
- "fixedValue": {
- "amount": 24.45,
- "currency": "USD"
- "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
- "customsClearanceDetail": {
- "regulatoryControls": [
- "NOT_IN_FREE_CIRCULATION",
- "USMCA"
- "brokers": [
- {
- "broker": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": 91,
- "companyName": "Fedex",
- "faxNumber": 1234567
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "number",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "deliveryInstructions": "deliveryInstructions"
- "type": "IMPORT"
- "commercialInvoice": {
- "originatorName": "originator Name",
- "comments": [
- "optional comments for the commercial invoice"
- "customerReferences": [
- {
- "customerReferenceType": "INVOICE_NUMBER",
- "value": "3686"
- "taxesOrMiscellaneousCharge": {
- "amount": 12.45,
- "currency": "USD"
- "taxesOrMiscellaneousChargeType": "COMMISSIONS",
- "freightCharge": {
- "amount": 12.45,
- "currency": "USD"
- "packingCosts": {
- "amount": 12.45,
- "currency": "USD"
- "handlingCosts": {
- "amount": 12.45,
- "currency": "USD"
- "declarationStatement": "declarationStatement",
- "termsOfSale": "FCA",
- "specialInstructions": "specialInstructions\"",
- "shipmentPurpose": "REPAIR_AND_RETURN",
- "emailNotificationDetail": {
- "emailAddress": "neena@fedex.com",
- "type": "EMAILED",
- "recipientType": "SHIPPER"
- "freightOnValue": "OWN_RISK",
- "dutiesPayment": {
- "payor": {
- "responsibleParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "phone extension",
- "companyName": "Fedex",
- "faxNumber": "fax number"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "number",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- {
- "number": "number",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "billingDetails": {
- "billingCode": "billingCode",
- "billingType": "billingType",
- "aliasId": "aliasId",
- "accountNickname": "accountNickname",
- "accountNumber": "Your account number",
- "accountNumberCountryCode": "US"
- "paymentType": "SENDER"
- "commodities": [
- {
- "unitPrice": {
- "amount": 12.45,
- "currency": "USD"
- "additionalMeasures": [
- {
- "quantity": 12.45,
- "units": "KG"
- "numberOfPieces": 12,
- "quantity": 125,
- "quantityUnits": "Ea",
- "customsValue": {
- "amount": 12.45,
- "currency": "USD"
- "countryOfManufacture": "US",
- "cIMarksAndNumbers": "87123",
- "harmonizedCode": "0613",
- "description": "description",
- "name": "non-threaded rivets",
- "weight": {
- "units": "KG",
- "value": 68.25
- "exportLicenseNumber": "26456",
- "exportLicenseExpirationDate": "2025-04-07T05:59:47Z",
- "partNumber": "167",
- "purpose": "BUSINESS",
- "usmcaDetail": {
- "originCriterion": "A"
- "isDocumentOnly": true,
- "recipientCustomsId": {
- "type": "PASSPORT",
- "value": "123"
- "customsOption": {
- "description": "Description",
- "type": "COURTESY_RETURN_LABEL"
- "importerOfRecord": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXXX345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "generatedDocumentLocale": "en_US",
- "exportDetail": {
- "destinationControlDetail": {
- "endUser": "dest country user",
- "statementTypes": "DEPARTMENT_OF_COMMERCE",
- "destinationCountries": [
- "USA",
- "India"
- "b13AFilingOption": "NOT_REQUIRED",
- "exportComplianceStatement": "12345678901234567",
- "permitNumber": "12345"
- "totalCustomsValue": {
- "amount": 12.45,
- "currency": "USD"
- "partiesToTransactionAreRelated": true,
- "declarationStatementDetail": {
- "usmcaLowValueStatementDetail": {
- "countryOfOriginLowValueDocumentRequested": true,
- "customsRole": "EXPORTER"
- "insuranceCharge": {
- "amount": 12.45,
- "currency": "USD"
- "labelSpecification": {
- "labelFormatType": "COMMON2D",
- "labelOrder": "SHIPPING_LABEL_FIRST",
- "customerSpecifiedDetail": {
- "maskedData": [
- "[\"CUSTOMS_VALUE\",\"TOTAL_WEIGHT\"]"
- "regulatoryLabels": [
- {
- "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
- "type": "ALCOHOL_SHIPMENT_LABEL"
- "additionalLabels": [
- {
- "type": "CONSIGNEE",
- "count": 1
- "docTabContent": {
- "docTabContentType": "BARCODED",
- "zone001": {
- "docTabZoneSpecifications": [
- {
- "zoneNumber": 0,
- "header": "string",
- "dataField": "string",
- "literalValue": "string",
- "justification": "RIGHT"
- "barcoded": {
- "symbology": "UCC128",
- "specification": {
- "zoneNumber": 0,
- "header": "string",
- "dataField": "string",
- "literalValue": "string",
- "justification": "RIGHT"
- "printedLabelOrigin": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "person name",
- "emailAddress": "email address",
- "phoneNumber": "phone number",
- "phoneExtension": "phone extension",
- "companyName": "company name",
- "faxNumber": "fax number"
- "labelStockType": "PAPER_85X11_TOP_HALF_LABEL",
- "labelRotation": "UPSIDE_DOWN",
- "imageType": "PDF",
- "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
- "returnedDispositionDetail": true,
- "resolution": 300
- "shippingDocumentSpecification": {
- "generalAgencyAgreementDetail": {
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "op900Detail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "signatureName": "Signature Name",
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "usmcaCertificationOfOriginDetail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "certifierSpecification": "EXPORTER",
- "importerSpecification": "UNKNOWN",
- "producerSpecification": "SAME_AS_EXPORTER",
- "producer": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXXX345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "blanketPeriod": {
- "begins": "12-01-2020",
- "ends": "22-01-2020"
- "certifierJobTitle": "Manager"
- "usmcaCommercialInvoiceCertificationOfOriginDetail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "certifierSpecification": "EXPORTER",
- "importerSpecification": "UNKNOWN",
- "producerSpecification": "SAME_AS_EXPORTER",
- "producer": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXXX345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "certifierJobTitle": "Manager"
- "shippingDocumentTypes": [
- "RETURN_INSTRUCTIONS",
- "DANGEROUS_GOODS_SHIPPERS_DECLARATION"
- "certificateOfOrigin": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "commercialInvoiceDetail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "freightAddressLabelDetail": {
- "copies": 25,
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "startingPosition": "BOTTOM_LEFT"
- "freightBillOfLadingDetail": {
- "format": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "rateRequestType": [
- "LIST",
- "PREFERRED"
- "totalPackageCount": 25,
- "masterTrackingId": {
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
- "requestedPackageLineItems": [
- {
- "sequenceNumber": "1",
- "subPackagingType": "BUCKET",
- "customerReferences": [
- {
- "customerReferenceType": "INVOICE_NUMBER",
- "value": "3686"
- "declaredValue": {
- "amount": 12.45,
- "currency": "USD"
- "weight": {
- "units": "KG",
- "value": 68.25
- "dimensions": {
- "length": 100,
- "width": 50,
- "height": 30,
- "units": "CM"
- "physicalPackaging": "class line",
- "groupPackageCount": 25,
- "itemDescriptionForClearance": "description",
- "contentRecord": [
- {
- "itemNumber": "2876",
- "receivedQuantity": 256,
- "description": "Description",
- "partNumber": "456"
- "itemDescription": "item description for the package",
- "variableHandlingChargeDetail": {
- "rateType": "PREFERRED_CURRENCY",
- "percentValue": 12.45,
- "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
- "fixedValue": {
- "amount": 24.45,
- "currency": "USD"
- "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
- "associatedFreightLineItems": [
- {
- "id": "98712345"
- "labelResponseOptions": "LABEL",
- "accountNumber": {
- "value": "Your account number"
- "oneLabelAtATime": true
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b55xxxxx492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "transactionShipments": [
- {
- "serviceType": "FEDEX_FREIGHT_ECONOMY",
- "shipDatestamp": "2010-03-04",
- "serviceCategory": "FREIGHT",
- "shipmentDocuments": [
- {
- "contentKey": "content key",
- "copiesToPrint": 10,
- "contentType": "COMMERCIAL_INVOICE",
- "trackingNumber": "794953535000",
- "docType": "PDF",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
- "encodedLabel": "encoded label",
- "pieceResponses": [
- {
- "netChargeAmount": 21.45,
- "transactionDetails": [
- {
- "transactionDetails": "transactionDetails",
- "transactionId": "12345"
- "packageDocuments": [
- {
- "contentKey": "content key",
- "copiesToPrint": 10,
- "contentType": "COMMERCIAL_INVOICE",
- "trackingNumber": "794953535000",
- "docType": "PDF",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
- "encodedLabel": "encoded label",
- "acceptanceTrackingNumber": "794953535000",
- "serviceCategory": "EXPRESS",
- "listCustomerTotalCharge": "listCustomerTotalCharge",
- "deliveryTimestamp": "2012-09-23",
- "trackingIdType": "FEDEX",
- "additionalChargesDiscount": 621.45,
- "netListRateAmount": 1.45,
- "baseRateAmount": 321.45,
- "packageSequenceNumber": 215,
- "netDiscountAmount": 121.45,
- "masterTrackingNumber": "794953535000",
- "acceptanceType": "acceptanceType",
- "trackingNumber": "794953535000",
- "successful": true,
- "customerReferences": [
- {
- "customerReferenceType": "INVOICE_NUMBER",
- "value": "3686"
- "serviceName": "FedEx Freight® Economy",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
- "completedShipmentDetail": {
- "completedPackageDetails": [
- {
- "sequenceNumber": 256,
- "operationalDetail": {
- "astraHandlingText": "astraHandlingText",
- "barcodes": {
- "binaryBarcodes": [
- {
- "type": "COMMON-2D",
- "value": "string"
- "stringBarcodes": [
- {
- "type": "ADDRESS",
- "value": "1010062512241535917900794953544894"
- "operationalInstructions": [
- {
- "number": 17,
- "content": "content"
- "signatureOption": "DIRECT",
- "trackingIds": [
- {
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
- "groupNumber": 567,
- "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
- "packageRating": {
- "effectiveNetDiscount": 0,
- "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
- "packageRateDetails": [
- {
- "ratedWeightMethod": "DIM",
- "totalFreightDiscounts": 44.55,
- "totalTaxes": 3.45,
- "minimumChargeType": "minimumChargeType",
- "baseCharge": 45.67,
- "totalRebates": 4.56,
- "rateType": "PAYOR_RETAIL_PACKAGE",
- "billingWeight": {
- "units": "KG",
- "value": 68
- "netFreight": 4.89,
- "surcharges": [
- {
- "amount": null,
- "surchargeType": "APPOINTMENT_DELIVERY",
- "level": "PACKAGE, or SHIPMENT",
- "description": "description"
- "totalSurcharges": 22.56,
- "netFedExCharge": 12.56,
- "netCharge": 121.56,
- "currency": "USD"
- "dryIceWeight": {
- "units": "KG",
- "value": 68
- "hazardousPackageDetail": {
- "regulation": "IATA",
- "accessibility": "ACCESSIBLE",
- "labelType": "II_YELLOW",
- "containers": [
- {
- "qvalue": 2,
- "hazardousCommodities": [
- {
- "quantity": {
- "quantityType": "GROSS",
- "amount": 24.56,
- "units": "Kg"
- "options": {
- "quantity": {
- "quantityType": "GROSS",
- "amount": 24.56,
- "units": "Kg"
- "innerReceptacles": [
- {
- "quantity": {
- "quantityType": "NET",
- "amount": 34.56,
- "units": "Kg"
- "options": {
- "labelTextOption": "APPEND",
- "customerSuppliedLabelText": "Customer Supplied Label Text."
- "description": {
- "sequenceNumber": 9812,
- "processingOptions": [
- "INCLUDE_SPECIAL_PROVISIONS"
- "subsidiaryClasses": [
- "Subsidiary Classes"
- "labelText": "labelText",
- "technicalName": "technicalName",
- "packingDetails": {
- "packingInstructions": "packing Instructions",
- "cargoAircraftOnly": true
- "authorization": "authorization",
- "reportableQuantity": true,
- "percentage": 12.45,
- "id": "123",
- "packingGroup": "I",
- "properShippingName": "properShippingName",
- "hazardClass": "hazard Class"
- "description": {
- "sequenceNumber": 876,
- "packingInstructions": "packingInstructions",
- "subsidiaryClasses": [
- "Subsidiary Classes"
- "labelText": "labelText",
- "tunnelRestrictionCode": "UN2919",
- "specialProvisions": "specialProvisions",
- "properShippingNameAndDescription": "properShippingNameAndDescription",
- "technicalName": "technicalName",
- "symbols": "symbols",
- "authorization": "authorization",
- "attributes": [
- "attributes"
- "id": "1234",
- "packingGroup": "packingGroup",
- "properShippingName": "properShippingName",
- "hazardClass": "hazardClass"
- "netExplosiveDetail": {
- "amount": 10,
- "units": "units",
- "type": "NET_EXPLOSIVE_WEIGHT"
- "massPoints": 2
- "cargoAircraftOnly": true,
- "referenceId": "123456",
- "radioactiveTransportIndex": 2.45
- "operationalDetail": {
- "originServiceArea": "A1",
- "serviceCode": "010",
- "airportId": "DFW",
- "postalCode": "38010",
- "scac": "scac",
- "deliveryDay": "TUE",
- "originLocationId": "678",
- "countryCode": "US",
- "astraDescription": "SMART POST",
- "originLocationNumber": 243,
- "deliveryDate": "2001-04-05",
- "deliveryEligibilities": [
- "deliveryEligibilities"
- "ineligibleForMoneyBackGuarantee": true,
- "maximumTransitTime": "SEVEN_DAYS",
- "destinationLocationStateOrProvinceCode": "GA",
- "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
- "destinationLocationId": "DALA",
- "transitTime": "TWO_DAYS",
- "stateOrProvinceCode": "GA",
- "destinationLocationNumber": 876,
- "packagingCode": "03",
- "commitDate": "2019-10-15",
- "publishedDeliveryTime": "10:30A",
- "ursaSuffixCode": "Ga",
- "ursaPrefixCode": "XH",
- "destinationServiceArea": "A1",
- "commitDay": "TUE",
- "customTransitTime": "ONE_DAY"
- "carrierCode": "FDXE",
- "completedHoldAtLocationDetail": {
- "holdingLocationType": "FEDEX_STAFFED",
- "holdingLocation": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "tollFreePhoneNumber": "6127812",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "91",
- "faxNumber": "1234567890",
- "pagerNumber": "6127812",
- "companyName": "Fedex",
- "title": "title"
- "completedEtdDetail": {
- "folderId": "0b0493e580dc1a1b",
- "type": "COMMERCIAL_INVOICE",
- "uploadDocumentReferenceDetails": [
- {
- "documentType": "PRO_FORMA_INVOICE",
- "documentReference": "DocumentReference",
- "description": "PRO FORMA INVOICE",
- "documentId": "090927d680038c61"
- "packagingDescription": "description",
- "masterTrackingId": {
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
- "serviceDescription": {
- "serviceType": "FEDEX_1_DAY_FREIGHT",
- "code": "80",
- "names": [
- {
- "type": "long",
- "encoding": "UTF-8",
- "value": "F-2"
- "operatingOrgCodes": [
- "FXE"
- "astraDescription": "2 DAY FRT",
- "description": "description",
- "serviceId": "EP1000000027",
- "serviceCategory": "freight"
- "usDomestic": true,
- "hazardousShipmentDetail": {
- "hazardousSummaryDetail": {
- "smallQuantityExceptionPackageCount": 10
- "adrLicense": {
- "licenseOrPermitDetail": {
- "number": "12345",
- "effectiveDate": "2019-08-09",
- "expirationDate": "2019-04-09"
- "dryIceDetail": {
- "totalWeight": {
- "units": "KG",
- "value": 68
- "packageCount": 10,
- "processingOptions": {
- "options": [
- "options"
- "shipmentRating": {
- "actualRateType": "PAYOR_LIST_SHIPMENT",
- "shipmentRateDetails": [
- {
- "rateZone": "US001O",
- "ratedWeightMethod": "ACTUAL",
- "totalDutiesTaxesAndFees": 24.56,
- "pricingCode": "LTL_FREIGHT",
- "totalFreightDiscounts": 1.56,
- "totalTaxes": 3.45,
- "totalDutiesAndTaxes": 6.78,
- "totalAncillaryFeesAndTaxes": 5.67,
- "taxes": [
- {
- "amount": 10,
- "level": "level",
- "description": "description",
- "type": "type"
- "totalRebates": 1.98,
- "fuelSurchargePercent": 4.56,
- "currencyExchangeRate": {
- "rate": 25.6,
- "fromCurrency": "Rupee",
- "intoCurrency": "USD"
- "totalNetFreight": 9.56,
- "totalNetFedExCharge": 88.56,
- "shipmentLegRateDetails": [
- {
- "rateZone": "rateZone",
- "pricingCode": "pricingCode",
- "taxes": [
- {
- "amount": 10,
- "level": "level",
- "description": "description",
- "type": "type"
- "totalDimWeight": {
- "units": "KG",
- "value": 68
- "totalRebates": 2,
- "fuelSurchargePercent": 6,
- "currencyExchangeRate": {
- "rate": 25.6,
- "fromCurrency": "Rupee",
- "intoCurrency": "USD"
- "dimDivisor": 6,
- "rateType": "PAYOR_RETAIL_PACKAGE",
- "legDestinationLocationId": "legDestinationLocationId",
- "dimDivisorType": "dimDivisorType",
- "totalBaseCharge": 6,
- "ratedWeightMethod": "ratedWeightMethod",
- "totalFreightDiscounts": 9,
- "totalTaxes": 12.6,
- "minimumChargeType": "minimumChargeType",
- "totalDutiesAndTaxes": 17.78,
- "totalNetFreight": 6,
- "totalNetFedExCharge": 3.2,
- "surcharges": [
- {
- "amount": null,
- "surchargeType": "APPOINTMENT_DELIVERY",
- "level": "PACKAGE, or SHIPMENT",
- "description": "description"
- "totalSurcharges": 5,
- "totalBillingWeight": {
- "units": "KG",
- "value": 68
- "freightDiscounts": [
- {
- "amount": 8.9,
- "rateDiscountType": "COUPON",
- "percent": 28.9,
- "description": "description"
- "rateScale": "6702",
- "totalNetCharge": 253,
- "totalNetChargeWithDutiesAndTaxes": 25.67,
- "currency": "USD"
- "dimDivisor": 0,
- "rateType": "RATED_ACCOUNT_SHIPMENT",
- "surcharges": [
- {
- "amount": null,
- "surchargeType": "APPOINTMENT_DELIVERY",
- "level": "PACKAGE, or SHIPMENT",
- "description": "description"
- "totalSurcharges": 9.88,
- "totalBillingWeight": {
- "units": "KG",
- "value": 68
- "freightDiscounts": [
- {
- "amount": 8.9,
- "rateDiscountType": "COUPON",
- "percent": 28.9,
- "description": "description"
- "rateScale": "00000",
- "totalNetCharge": 3.78,
- "totalBaseCharge": 234.56,
- "totalNetChargeWithDutiesAndTaxes": 222.56,
- "currency": "USD"
- "documentRequirements": {
- "requiredDocuments": [
- "COMMERCIAL_OR_PRO_FORMA_INVOICE",
- "AIR_WAYBILL"
- "prohibitedDocuments": [
- "CERTIFICATE_OF_ORIGIN"
- "generationDetails": [
- {
- "type": "COMMERCIAL_INVOICE",
- "minimumCopiesRequired": 3,
- "letterhead": "OPTIONAL",
- "electronicSignature": "OPTIONAL"
- "exportComplianceStatement": "12345678901234567",
- "accessDetail": {
- "accessorDetails": [
- {
- "password": "password",
- "role": "role",
- "emailLabelUrl": "emailLabelUrl",
- "userId": "userId"
- "shipmentAdvisoryDetails": {
- "regulatoryAdvisory": {
- "commodityClarifications": [
- {
- "commodityIndex": 25,
- "suggestions": [
- {
- "description": "description",
- "harmonizedCode": "harmonized Code"
- "prohibitions": [
- {
- "derivedHarmonizedCode": "01",
- "advisory": {
- "code": "code",
- "text": "Text",
- "parameters": [
- {
- "id": "message ID",
- "value": "Message value"
- "localizedText": "localizedText"
- "commodityIndex": 12,
- "source": "source",
- "categories": [
- "categories"
- "type": "type",
- "waiver": {
- "advisories": [
- {
- "code": "code",
- "text": "Text",
- "parameters": [
- {
- "id": "message ID",
- "value": "Message value"
- "localizedText": "localizedText"
- "description": "description",
- "id": "id"
- "status": "status"
- "masterTrackingNumber": "794953535000"
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
Check Freight LTL Pickup Availability
This endpoint allows you to check the availability of an Freight LTL pickup service. The pickup availability depends on two factors, the cut off time and the access time.
Cut off time - The latest time allowed for a pickup to be scheduled. The time is local to the pickup postal code.
Access time - The time between the pickup ready time (when the package is ready to be picked) and the time when the driver is ready to pick up the package.
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
- FullSchema-FreightPickupAvailability
- MinimumSamplePayload-FreightPickupAvailability
| pickupAddress required | object (PickupAddress) The address for which pickup availability inquiry is made. |
| packageReadyTime | string The time that the package will be ready for pickup. The time format is HH:MM:SS and it refers to the local timezone. The driver should pick up the package/shipment by the given pickup time. |
| customerCloseTime | string The latest time the driver gets access to pick up the package. The time format is in HH:MM:SS and it refers to the local timezone. The driver should pick up the package by the given pickup time. |
| shipmentAttributes | object (ShipmentAttributes) Indicates the shipment details such as service type, packaging type, weight and dimensions. |
| freightPickupSpecialServiceDetail | object (FullSchemaFreightPickupAvailability_freightPickupSpecialServiceDetail) |
| dispatchDate | string Indicates the date, the package is to be picked up. The format is YYYY-MM-DD. If the field is left blank, the system considers current date as dispatch date. |
| numberOfBusinessDays | integer <int32> Number of business days to consider when checking availability. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "pickupAddress": {
- "streetLines": [
- "123 Ship Street"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Memphis",
- "stateOrProvinceCode": "TN",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "packageReadyTime": "15:30:00",
- "customerCloseTime": "18:00:00",
- "shipmentAttributes": {
- "serviceType": "FEDEX_FREIGHT_PRIORITY",
- "weight": {
- "units": "KG",
- "value": 20
- "packagingType": "YOUR_PACKAGING",
- "dimensions": {
- "length": 7,
- "width": 8,
- "units": "CM",
- "height": 9
- "freightPickupSpecialServiceDetail": {
- "shipmentSpecialServicesRequested": {
- "freightGuaranteeDetail": {
- "time": "10:00"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "BASIC",
- "transportationType": "DELIVERY",
- "emailAddress": "a@fedex.com",
- "phoneNumberDetails": [
- {
- "phoneNumber": "XXXXXXXX43",
- "phoneNumberType": "WORK"
- "specialServiceTypes": [
- "FOOD",
- "POISON",
- "OVER_LENGTH",
- "EXTREME_LENGTH",
- "LIFTGATE_PICKUP",
- "LIFTGATE_DELIVERY"
- "dispatchDate": "2019-10-14",
- "numberOfBusinessDays": 1
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "closeTime": "12:00:00-05:00",
- "closeTimeType": "DEFAULT",
- "localTime": "19:20",
- "options": [
- {
- "carrier": "FXFR",
- "available": true,
- "pickupDate": "2019-01-20",
- "cutOffTime": "18:30:00",
- "accessTime": {
- "hours": 1,
- "minutes": 30
- "residentialAvailable": true,
- "scheduleDay": "SAME_DAY"
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
Create Freight LTL Pickup
This endpoint helps you to create a freight pickup request for a package to be picked up.
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
- FullSchema-CreatePickup
- MinimumSamplePayload-CreateFreightPickup
- MinimumSamplePayload-FreightBillToPickup
| associatedAccountNumber required | object The associated account number, which is invoiced for the freight pickup. |
| originDetail required | object The origin address if different than the one associated with the shipper account. This element value is required when the package is to be picked up from an address other than the shipper account address. |
| totalWeight | Array of objects (TotalWeight) The total weight of the packages for the pickup. Unit of measure is LB and KG. |
| packageCount | integer <int32> The total number of packages for the pickup. |
| remarks | string This is a placeholder for any message to be passed to the FedEx pickup. courier. |
| countryRelationships | string Enum: "DOMESTIC" "INTERNATIONAL" Describes the country relationship among the shipments being picked up. |
| trackingNumber | string This is a tracking number for FedEx packages used for tracking a single package or group of packages. |
| commodityDescription | string Description of the commodity being shipped. |
| freightPickupDetail required | object This provides the Freight LTL pickup detailed information. |
| oversizePackageCount | integer <int32> The number of oversize packages that are tendered to FedEx Ground. |
| pickupNotificationDetail | object This object allows user to request for pickup confirmation email. User can specify upto 5 email addresses. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "associatedAccountNumber": {
- "value": "Your account number"
- "originDetail": {
- "pickupAddressType": "ACCOUNT",
- "pickupLocation": {
- "contact": {
- "companyName": "Fedex",
- "personName": "John Taylor",
- "phoneNumber": "7194446666",
- "phoneExtension": "phone extension"
- "address": {
- "streetLines": [
- "123 Ship Street",
- "Suite 302"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Memphis",
- "stateOrProvinceCode": "TN",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "accountNumber": {
- "value": "XXX289837"
- "deliveryInstructions": "deliveryInstructions"
- "readyDateTimestamp": "2020-04-02T11:00:00Z",
- "customerCloseTime": "18:00:00",
- "pickupDateType": "SAME_DAY",
- "packageLocation": "FRONT",
- "buildingPart": "APARTMENT",
- "buildingPartDescription": "111",
- "earlyPickup": false,
- "suppliesRequested": "Supplies requested by customer",
- "geographicalPostalCode": "geographicalPostalCode"
- "totalWeight": [
- {
- "units": "LB",
- "value": 1
- "packageCount": 5,
- "remarks": "Please ring bell at loading dock.",
- "countryRelationships": "DOMESTIC",
- "trackingNumber": "795803657326",
- "commodityDescription": "This field contains CommodityDescription",
- "freightPickupDetail": {
- "accountNumber": {
- "value": "Freight Account Number"
- "role": "SHIPPER",
- "payment": "SENDER",
- "submittedBy": {
- "companyName": "Fedex",
- "personName": "John Taylor",
- "phoneNumber": "7194446666",
- "phoneExtension": "string",
- "emailAddress": "sample@company.com"
- "lineItems": [
- {
- "trackingNumber": {
- "trackingNumber": "123456789012",
- "trackingQualifier": "insightBest~200300400525~FDFR",
- "trackingCarrier": "FDXE",
- "trackingUniqueId": "245822~123456789012~FDEG"
- "service": "FEDEX_FREIGHT_PRIORITY",
- "sequenceNumber": 2,
- "totalHandlingUnits": 2,
- "justOneMore": false,
- "description": "strings",
- "packaging": "BUNDLE",
- "pieces": 4,
- "weight": {
- "units": "KG",
- "value": 68.25
- "dimensions": {
- "length": 7,
- "width": 8,
- "height": 9,
- "units": "CM"
- "destination": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "shipmentSpecialServicesRequested": {
- "freightGuaranteeDetail": {
- "time": "10:00"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "BASIC",
- "transportationType": "DELIVERY",
- "emailAddress": "a@fedex.com",
- "phoneNumberDetails": [
- {
- "phoneNumber": "XXXXXXXX43",
- "phoneNumberType": "WORK"
- "specialServiceTypes": [
- "FOOD",
- "POISON",
- "OVER_LENGTH",
- "EXTREME_LENGTH",
- "LIFTGATE_PICKUP",
- "LIFTGATE_DELIVERY"
- "alternateBilling": {
- "contact": {
- "companyName": "Fedex",
- "personName": "John Taylor",
- "phoneNumber": "7194446666",
- "phoneExtension": "phone extension"
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "accountNumber": {
- "value": "Alternate Billing Account Number"
- "deliveryInstructions": "deliveryInstructions"
- "userMessage": "This is the user message"
- "oversizePackageCount": 2,
- "pickupNotificationDetail": {
- "emailDetails": [
- {
- "address": "sample@gmail.com",
- "locale": "en_US"
- "format": "HTML",
- "userMessage": "This is the user message"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "pickupConfirmationCode": "20201012COS455402",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
Cancel Freight LTL Pickup
Use this endpoint to cancel the already scheduled freight pickup request. Note a failure notification will be sent if you attempt to cancel a pickup after the FedEx courier has been dispatched to the pickup location.
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
- FullSchema-CancelFreightPickup
- MinimumSamplePayload-FreightCancel
| associatedAccountNumber required | object (AccountNumber_2) Specify the FedEx Account number. |
| pickupConfirmationCode required | string The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested. |
| remarks | string Specify the additional information to be passed on the pickup courier. |
| reason required | string Specify the reason for cancellation of pickup. |
| contactName required | string Specify the contact name. |
| scheduledDate | string Specifies the date when pickup dispatch occurs. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "associatedAccountNumber": {
- "value": "Your account number"
- "pickupConfirmationCode": "20201007MEM628005",
- "remarks": "This is my remarks",
- "reason": "This is my reason",
- "contactName": "This is my contactName",
- "scheduledDate": "2019-10-15"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "pickupConfirmationCode": "20201007MEM628005",
- "cancelConfirmationMessage": "Requested pickup has been cancelled Successfully.",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
