Fedex Logo
Developer Portal

Freight LTL API
DOWNLOAD JSON SCHEMA

소개

Freight LTL API를 사용해 LTL(less-than-truckload) 발송물을 생성할 수 있습니다. LTL 화물이란 소포로 발송하기에는 너무 부피가 크지만 트럭 한 대를 채우지는 않는 화물을 가리킵니다.

이 API를 사용하면 요금 견적을 받고, 개별 취급 단위 및 B/L(선하증권)별 고유 발송 라벨을 생성하고, 픽업을 예약하고, 발송물 상태를 조회하고, 픽업 가능성을 확인할 수 있습니다. 이를 통해 크고 무거운 화물의 발송을 더 효율적으로 진행할 수 있습니다.

FedEx Freight의 LTL 발송은 취급 단위 수준 배송 조회를 제공하고, 대부분의 경우 종이로 된 B/L(선하증권) 없이 국내 발송만이 아니라 복수 취급 단위 발송물의 상태를 확인할 수 있습니다. 필요 시 B/L(선하증권)을 생성할 수 있습니다. 취급 단위마다 고유의 배송 조회 번호가 있지만, 발송물은 하나의 B/L(선하증권), 배달 영수증 및 송장으로 연결됩니다.

Freight LTL API 세부 정보

Freight LTL API를 통해 LTL 발송을 이용하고 필요한 서류를 작성할 수 있습니다. 예를 들어 B/L(선하증권)(요청 시), FedEx Freight 발송 라벨을 비롯하여 다양한 발송 서류를 작성합니다. Freight LTL 발송물에서 첫 번째 취급 단위에 마스터 라벨이 적용되고 두 번째와 이후의 취급 단위에는 하위 라벨이 적용됩니다. 하위 라벨은 자체 고유 배송 조회 번호를 갖지만 마스터 배송 조회 번호를 참조합니다. 발송물당 모든 취급 단위와 수량이 포함된 단일 B/L(선하증권)이 생성될 수 있습니다.

각 취급 단위는 하나의 배송 조회 번호와 연결될 수 있으며, 라벨은 화물(Freight) 발송물임을 나타내는 F가 포함되는 것만 제외하고 FedEx Ground 또는 Express Parcel 라벨과 유사합니다.

최대 취급 단위 수 및 취급 단위당 최대 수량:

  • 취급 단위당 최대 수량 – 9,999
  • 최대 취급 단위 – 200개(취급 단위 라벨을 하나씩 인쇄 시).
  • 최대 취급 단위 – 40개(취급 단위 라벨을 한꺼번에 인쇄 시) 

FedEx LTL Freight 발송은 미국 50개 주 모두와 푸에르토리코, 미국령 버진 아일랜드, 캐나다, 멕시코로 배송 시에 이용할 수 있습니다. 일부 발송물에는 발송 라벨과 함께 B/L(선하증권)이 필요합니다. 예를 들어 위험 물질이 포함된 발송물은 발송 라벨과 함께 B/L(선하증권)이 필요합니다.

FedEx Freight®는 하나의 원활한 LTL 네트워크 안에서 빠르고 저렴한 화물 발송을 손쉽게 만들어 LTL 산업을 변혁하고 있습니다.

이 API에서 사용할 수 있는 기능은 다음과 같습니다.

  • Freight LTL 픽업 관리

    이 기능을 사용하여 Freight LTL 픽업 위치를 확인하고 픽업 예약 및 예약 취소를 할 수 있습니다.

  • Freight LTL 요금 견적 받기

    이 기능을 사용하여 해당 위치와 선택한 서비스 옵션에 따라 Freight LTL 발송물의 요금 견적을 받아볼 수 있습니다.

  • Freight LTL 화물 발송

    이 기능을 사용하여 Freight LTL 발송물을 생성할 수 있습니다.

Freight LTL API에서 사용할 수 있는 기능은 다음과 같습니다.

  • 어떤 서비스 유형에 대해서도 MPS(복수 발송물) 한 건으로 발송하여, 발송 라벨 또는 B/L(선하증권)을 생성합니다(필요 시).
  • 복수 취급 단위 발송물을 생성하고 각 취급 단위를 개별적으로 배송 조회합니다.
  • FedEx Freight Priority와 Freight Economy 서비스를 사용해 LTL 발송물을 생성합니다.
    • 고객번호, 연락처, 주소 등의 수취인 정보를 입력합니다.
    • 엔드포인트 스키마에 나오는 대로 타임 스탬프, 포장재 유형, 총 중 및 기타 여러 가지 필요한 세부 사항을 입력합니다.
  • 표준 브랜드 표시가 있는 FedEx 라벨을 제공하고 열 전사 라벨에 대한 특정 크기를 지원합니다.
  • 발송 트랜잭션을 진행하며 이메일이나 문자메시지로 다음과 같은 알림을 받습니다.
    • 발송 알림
    • 예상 배달 날짜
    • 픽업 알림
  • 다음과 같은 발송 서류를 작성합니다.
    • 개별 취급 단위별 발송 라벨
    • B/L(선하증권)
    • 상업송장
    • 캐나다 세관 송장
  • 발송물을 생성하고 한 번에 한 개의 취급 단위 라벨을 인쇄하거나 한 번에 모든 취급 단위를 처리하십시오.
  • 모든 서비스 유형에 대한 단일 또는 복수 발송물의 요금을 검색합니다.
  • 화물의 픽업 가능 여부를 확인하고, 픽업 예약 및 예약 취소를 합니다.
  • 대체 청구 주소에 대해 제3자 고객번호로 픽업을 생성하고 예약합니다.

화물 C.O.D: 지원 종료

운송업체가 고객에게 C.O.D.(배송 시 요금 수납) 서비스를 제공하지 않습니다. 운송업체가 제공하는 서비스가 아니므로 C.O.D. 금액 수납에 대해 운송업체는 책임을 지지 않습니다. 모든 보관, 재위탁, 화물 요금은 C.O.D.로 표시된 발송물에 적용됩니다.

Freight LTL 발송 서비스

다음과 같은 Freight LTL 발송 서비스를 이용할 수 있습니다.

FedEx Freight® Priority

업계 최고의 정시 배송 실적과 빠른 배송 기간을 자랑하는 FedEx Freight® Priority는 발송물을 빠르고 안전하게 배송해드립니다. 지역 서비스를 통하여 귀하의 고객에게 폭넓은 익일 및 2일 배송이 가능하며 이는 추가 비용 없이 제공되는 운임환불보장제로 뒷받침되므로 믿고 이용하실 수 있습니다. *

FedEx Freight® Priority 서비스의 특징:

  • 익일 배송은 600마일(965km)까지, 2일 배송은 1,600마일(2,574km)까지 가능한 빠른 배송
  • 미국, 캐나다, 멕시코의 사실상 모든 주소에 직접 배송
  • 늘 신뢰할 수 있는 정시 배송
  • 추가 비용 없이 운임환불보장제 적용*
  • 발송지에서 도착지까지 배송 상황 가시성을 제공하는 최첨단 IT 기술
  • 지역적으로 필요한 화물 배송을 지원하는 전문가로 구성된 전담팀 운영

*모든 서비스에는 FXFR 100 Series Rules Tariff 이용 약관이 적용됩니다.

FedEx Freight Economy

FedEx Freight® Economy는 기본적인 화물 발송에 초점을 맞춘 저렴한 LTL(less-than-truckload) 서비스입니다. FedEx LTL 배송 서비스를 이용하면 믿을 수 있는 정시 배송과 화물의 세심한 취급으로 좋은 고객 서비스를 선사할 수 있습니다.

FedEx Freight® Economy가 제공하는 서비스

  • 저렴한 화물 배송 솔루션
  • 긴급성은 덜하지만 안전한 배송이 필요한 발송물에 대한 비용 절감
  • 늘 신뢰할 수 있는 정시 배송
  • 미국, 캐나다, 멕시코 및 푸에르토리코의 사실상 모든 주소에 대한 직접 배송
  • 발송지에서 도착지까지 배송 상황 가시성을 제공하는 최첨단 IT 기술
  • 발송지에서 도착지까지 배송 조회의 개선된 가시성

FedEx International Deferred Freight(FDF)

FedEx International Deferred Freight(FDF)는 국제 항공 화물의 배송에 대해 연장된 배송/운송 시간으로 부담 없는 요금에 이용할 수 있는 글로벌 항송 화물 발송 서비스입니다. Airport-to-Airport, Door-to-Airport, Airport-to-Door, Door-to-Door 배송 서비스도 FDF로 이용할 수 있습니다.

참고:

  • 현재 이 서비스는 일부 국가 간 노선에서만 제공됩니다.
  • 위험물(DG) 및 제한된 물품은 허용되지 않습니다. 예: 드라이아이스, 리튬 이온 배터리. 자세한 내용은 FedEx 고객지원팀에 문의하세요.
  • 미국 국내 발송물 및 미국 외 국내 발송물은 허용되지 않습니다.

Freight LTL API 이용 방법

여기서는 Freight LTL API의 엔드포인트와 필요한 핵심 요소를 설명합니다.

참고: FedEx Freight LTL API를 사용하려면 먼저 FedEx Freight LTL 고객번호가 활성화되어야 합니다. 필요한 주요 정보는 FedEx Freight 고객번호와 LTL 발송 처리를 위한 고객번호에 등록된 정확한 우편 주소입니다.

이 API에서 사용 가능한 엔드포인트는 다음과 같습니다.

Freight LTL 발송

이 엔드포인트를 사용하여 FedEx Freight LTL 발송물을 확인하고 생성하십시오.

이 요청과 관련된 필수 입력 정보는 다음과 같습니다.

  • Freight 고객번호
  • 고객번호에 등록된 우편 주소
  • 화물 운송 요청된 발송물
  • 라벨 응답 옵션 – 인코딩된 라벨을 받을지 URL로 받을지 선택합니다.
  • 마스터 배송 조회 세부 정보 – MPS 발송물을 처리해야 하며 라벨을 한 번에 출력하지 않고 하나씩 출력해야 할 경우(singleShotMPS가 추가되지 않거나 거짓 값으로 추가됨)에만 해당.

이 요청이 성공적으로 이루어지면 LTL 발송물이 생성되고 응답에서 배송 조회 세부 정보와 알림 세부 정보가 제공됩니다. 요청 실패가 있을 경우에는 오류 메시지와 설명이 반환됩니다.

참고: 우편 주소는 실제 발송지 주소와 다를 수 있습니다.

Freight LTL 픽업 가능 여부 확인

이 엔드포인트를 사용하여 화물 픽업이 가능한 모든 위치의 목록을 운송업체, 최종 픽업 시간, 기본적인 최종 픽업 시간, 픽업 가능 여부, 패키지 픽업이 준비되는 시간, 주소지가 거주지인지 여부, 픽업 마감 시간 및 패키지 픽업을 위한 운전자 출입 권한 등의 픽업 일정 세부 정보와 함께 요청하십시오.

이 요청과 관련된 필수 입력 정보는 다음과 같습니다.

  • 픽업 주소/우편번호
  • 픽업 요청 유형(예: 당일/이후 날짜)
  • 국내/국제 픽업 여부

참고: 정확하고 유효한 픽업 주소를 사용하십시오. 

이 요청이 성공하면 응답으로 화물 픽업이 가능한 모든 위치의 목록과 배송 날짜, 가능 여부(플래그), 픽업 날짜, 마감 시간, 출입 가능 시간, 거주지 여부(플래그), 종료 시간(플래그), 종료 시간 및 현지 시간이 제공됩니다. 요청 실패가 있을 경우에는 오류 메시지와 설명이 반환됩니다.

Freight LTL 픽업 생성

이 엔드포인트를 사용하여 Freight LTL 픽업을 생성하고 예약하십시오.

이 요청과 관련된 필수 입력 정보는 다음과 같습니다.

  • 픽업을 위해 송장에 기재될 Freight 고객번호
  • 발송지 세부 정보(주소, 위치, 고객번호 주소/발송인 주소/기타 등 픽업 주소의 유형)
  • 관련 고객번호에 해당하는 세부 주소

픽업 요청이 성공하면 예약된 픽업의 픽업 확인 번호, 픽업 알림 및 위치 코드가 반환됩니다. 요청 실패가 있을 경우에는 오류 메시지와 설명이 반환됩니다.

참고: 픽업을 위해 정확하고 유효한 주소를 사용해주시고 픽업 예약을 위해 정확한 고객번호 등록 주소를 제공해주시기 바랍니다. 픽업 예약 시 이미 지난 준비 시간이나 과거 날짜, 또는 너무 먼 향후 날짜를 입력하지 마십시오. 익명 픽업은 허용되지 않습니다. 유효한 대체 주소 세부정보를 제공해 제3자 고객번호로 픽업을 예약할 수 있습니다.

Freight LTL 픽업 취소

이 엔드포인트를 사용하여 기존에 예약한 LTL 패키지 픽업 요청을 취소하십시오. 픽업 취소에 성공하면 확인 번호와 함께 픽업 취소 확인 메시지가 반환됩니다.

이 요청과 관련된 필수 입력 정보는 다음과 같습니다.

  • 픽업 확인 코드(픽업 요청 제출 시에 제공)
  • 예약 날짜(픽업을 위한 인원 파견 날짜)
  • 위치(해당 픽업 요청 처리를 담당하는 FedEx Express 사무소 위치)

요청이 성공하면 예약된 픽업의 픽업 확인 번호, 픽업 알림 및 위치 코드가 반환됩니다. 요청 실패가 있을 경우에는 오류 메시지와 설명이 반환됩니다.

참고: 예약된 픽업을 취소하기 위해서는 픽업 확인 번호와 그에 해당하는 위치 코드(FDXE에만 해당)를 제출해주시기 바랍니다. 픽업 확인 번호와 그에 해당하는 위치 코드(FDXE에만 해당) 정보는 픽업 요청 제출 시에 제공됩니다. 또한 픽업 취소를 위해 정확한 고객번호 등록 주소를 사용하시기 바랍니다. 이미 FedEx 배송 직원이 픽업 위치로 출발한 후에 취소를 시도하면 실패 알림을 받게 됩니다.

Freight LTL 요금 견적

이 엔드포인트를 사용해 입력된 세부 정보를 기초로 가능한 모든 화물 요금 견적과 선택적 배송 정보를 반환하도록 요청할 수 있습니다. 요금은 발송지와 도착지를 비롯하여 발송물에 입력한 여러 정보를 기초로 검색됩니다. 운송업체 코드, 서비스 유형, 서비스 옵션 등의 추가적인 정보를 사용하여 더 정확한 결과를 얻을 수 있습니다.

이 요청과 관련된 필수 입력 정보는 다음과 같습니다.

  • Freight 고객번호
  • 화물 운송 요청된 발송물

이 요청이 성공하면 응답에서, 가능한 모든 요금 견적과 해당 픽업 예약에 대한 위치 코드가 반환됩니다. 요청 실패가 있을 경우에는 오류 메시지와 설명이 반환됩니다.

Freight LTL 복수 발송물(MPS)

복수 발송물(MPS)은 동일한 수취인 주소로 배송되는 두 개 이상의 취급 단위로 구성됩니다. 발송 요청의 첫 번째 취급 단위가 마스터로 간주됩니다.

복수 발송물을 생성하려면 다음 내용이 포함되어야 합니다.

  • serviceType, packagingType, totalWeight, totalPackageCount, freightShipmentDetail 및 requestedPackageLineItems 세부 정보와 같은 배송 수준 정보를 포함합니다. [참고: 마스터 패키지의 sequenceNumber는 1과 같아야 합니다.]
  • 취급 단위별 라벨 인쇄의 경우 모든 후속 취급 단위의 masterTrackingId 요소에 마스터 배송 조회 세부정보를 포함합니다.

다음은 이 API에서 사용할 수 있는 복수 발송 처리 옵션입니다.

취급 단위 라벨을 하나씩 인쇄

이 API를 사용하면 MPS 발송물을 처리하고 라벨을 하나씩 생성할 수 있습니다.

발송에 해당 기능이 필요한 경우 발송 요청에서 필요한 모든 MPS 요소와 함께 oneLabelAtATime을 참으로 설정하여 제공합니다.

첫 번째 요청에 대한 결과로 라벨과 마스터 배송 조회 번호인 배송 조회 번호가 생성됩니다. 후속 발송 요청을 처리하고 정의된 총 패키지 수(totalPackageCount)에 대한 배송 조회 번호(하위 조회 번호)가 있는 라벨을 생성하려면 masterTrackingId 요소에 해당 마스터 배송 조회 번호를 입력합니다.

참고: 허용되는 최대 취급 단위는 200개입니다.

취급 단위 라벨을 한 번에 모두 인쇄

이 API를 사용하면 MPS 발송물을 처리하고 라벨을 한꺼번에 생성할 수 있습니다. 40개 이하의 취급 단위를(totalPackageCount<=40) 하나의 수취인 주소로 발송할 때 사용하기에 이상적인 방법입니다.

40개 이하의 취급 단위 요청에서 oneLabelAtATime을 거짓으로 설정하면 즉시 라벨들이 생성됩니다.

참고: 최대 40개라는 취급 단위 제한은 제안 사항이며 고정된 것이 아닙니다. 이 제한은 또한 취급 단위 수와 상품의 조합에 따라 달라집니다. 자세한 내용은 FedEx 담당자에게 문의하십시오.

예: 10개의 취급 단위에 대한 발송 요청을 제출하면 10개의 라벨이 생성되며, 이때 요청에 따라 라벨의 URL이나 인코딩된 라벨이 응답으로 제공됩니다.

FedEx Freight Direct

FedEx Freight Direct 서비스는 대형 물품과 팔레트를 사용하는 물품의 배송 시 탁월한 고객 경험을 선사하며, 무겁고 부피가 큰 화물을 고객의 집이나 사업장 내에 배송할 수도 있습니다.

이 서비스는 사전 커뮤니케이션, 유연한 배송 옵션 및 다양한 추가요금이 포함된 묶음 요금 등의 옵션을 제공합니다.

다음은 이 서비스에 포함된 일부 기능에 대한 설명입니다.

  • 미국 본토, 알래스카, 하와이 내 FedEx Freight Direct 베이직, 예약별 베이직, 스탠다드, 프리미엄 배송 발송물 및 베이직 반송 발송물/픽업 생성이 가능합니다.
  • FedEx Freight Direct 고객번호로 FedEx Freight Direct 발송물의 전체 요금 견적을 받을 수 있고 FedEx Freight Direct 픽업을 취소할 수 있습니다.
    • 알래스카 및 하와이에 대해서는 요금 견적이 반환되지 않습니다. 이러한 주에 대한 견적을 요청하려면 고객이 FedEx 고객 서비스에 전화해야 합니다.
    • 배송 당일 예정된 픽업을 취소하려면 고객이 FedEx 고객 서비스에 전화해야 합니다.
  • 원래 발송인/수취인에게 이메일 알림을 보낼 수 있어 고객은 다음과 같은 서비스를 이용할 수 있습니다.
    • 배송 예약
    • 배송 및/또는 픽업 확인 수신
    • 배송 출고 및/또는 픽업 알림 수신
    • 도착 예정 알림 수신
    • 배송된 발송물에 대한 고객 설문
  • 우편번호 유효성 확인, 치수, 개당 중량 및 취급 단위 중량에 대한 비즈니스 규칙이 FedEx Freight Direct에 적용되어 터미널 간 화물 수송 및 퍼스트/라스트 마일 서비스의 올바른 조합을 결정하게 됩니다.

FedEx Freight Direct는 다양한 서비스 유형 선택 옵션을 제공합니다.

이 API는 Freight Direct 서비스와 함께 다음과 같은 기능을 제공합니다.

Freight Direct 요금 확인

이 엔드포인트를 사용해 베이직 서비스, 예약별 베이직 서비스, 스탠다드 서비스, 프리미엄 서비스 등 특별 Freight Direct 서비스 옵션에 대한 Freight Direct 요금 및 추가요금을 확인할 수 있습니다.

다음은 Freight LTL 요금 엔드포인트를 사용해 요금 견적 요청 시 제공해야 하는 필수 세부정보입니다.

  • Freight Direct 유형(베이직, 예약별 베이직, 프리미엄, 스탠다드)
  • Freight Direct 운송 유형(배송, 픽업)
  • 전화번호가 입력된 경우 전화번호 유형(집, 휴대폰, 직장)
  • 무게
  • 치수(음수가 아닌 길이, 폭, 높이)

Freight Direct 발송물 생성

이 엔드포인트를 사용해 베이직 서비스, 예약별 베이직 서비스, 스탠다드 서비스, 프리미엄 서비스 등 특별 Freight Direct 서비스 옵션에 대한 단일 물품 또는 MPS 발송물을 발송하고, Freight Priority 발송물을 처리하는 데 필요한 문서를 포함해 발송 라벨 또는 B/L(선하증권)을 받을 수 있습니다.

다음은 Freight LTL 발송 엔드포인트를 통해 발송물 요청 시 제공해야 하는 필수 세부정보입니다.

  • Freight Direct 유형(베이직, 예약별 베이직, 프리미엄, 스탠다드)
  • Freight Direct 운송 유형(배송, 픽업)
  • 이메일 주소, 전화번호, 전화 유형
  • 무게
  • 치수(음수가 아닌 길이, 폭, 높이)

출력된 B/L(선하증권)에는 새 Freight Direct가 인쇄됩니다. 선택한 서비스에 따라 B/L(선하증권)에 다음과 같은 값이 인쇄됩니다.

  • DIRECT BASIC DELIVERY
  • DIRECT BASIC BY APPOINTMENT DELIVERY
  • DIRECT PREMIUM DELIVERY
  • DIRECT STANDARD DELIVERY
  • DIRECT BASIC PICKUP
  • DIRECT BASIC BY APPOINTMENT PICKUP
  • DIRECT PREMIUM PICKUP
  • DIRECT STANDARD PICKUP

Freight Direct 픽업

이 엔드포인트를 사용해 Freight LTL Freight Direct 픽업 서비스의 이용 가능 여부를 확인하거나, 픽업할 패키지의 픽업 요청을 생성하거나, 기존 픽업 요청을 취소할 수 있습니다.

다음은 Freight LTL 픽업 이용 가능 여부 확인, Freight LTL 픽업 생성, Freight LTL 픽업 취소 엔드포인트를 사용해 픽업 요청 시 제공해야 하는 필수 세부정보입니다.

  • Freight Direct 유형(베이직, 예약별 베이직, 프리미엄, 스탠다드)
  • Freight Direct 운송 유형(배송, 픽업)
  • 이메일 주소(픽업 요청 생성)
  • 전화번호 및 전화 유형(픽업 요청 생성)
  • 무게

비즈니스 규칙

  • Freight LTL 발송물의 첫 번째 취급 단위에 마스터 배송 조회 (Pro) 번호가 할당되고, 이후의 취급 단위 각각에 하위 배송 조회 번호가 할당됩니다.
  • 발송물의 각 취급 단위를 개별적으로 배송 조회하거나 전체 발송물의 일부로서 배송 조회할 수 있습니다.
  • 특정 발송물(예: Freight 위험 물질[HazMat] 및 국제 발송물)에는 다른 문서가 적용될 수 있습니다.
  • LTL Freight 전용 및 LTL Freight 고객번호로 청구는 FedEx Developer Portal에 추가할 수 없습니다.
  • 고객은 장기 단일 LTL 고객번호 또는 FedEx Freight Direct 고객번호를 사용해 Freight Direct 서비스를 이용할 수 있습니다.
  • FedEx Freight Direct 요금 견적 기능은 일반 LTL API에서만 사용할 수 있습니다.
  • 모든 새 오류/메시지는 영어로만 제공됩니다.
  • 발송물을 생성하는 동안 FedEx Freight Direct 서비스 옵션의 일부로 이메일 주소 및 전화번호가 필요합니다.
Documentation Powered by ReDoc

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.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

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
accountNumber
required
object (LTLRootAccountNumber)

This is the Account number details.
Note:

  • In case if this is shipping account number, do use the account number used for creating Auth Token.

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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /rate/v1/freight/rates/quotes

Sandbox Server

https://apis-sandbox.fedex.com/rate/v1/freight/rates/quotes

Production Server

https://apis.fedex.com/rate/v1/freight/rates/quotes

Request samples - Rate Freight LTL

Content type
application/json
Example
FullSchema
Copy
 Expand all Collapse all
{
  • "accountNumber":
    {
    },
  • "rateRequestControlParameters":
    {
    },
  • "freightRequestedShipment":
    {
    }
}

Response samples - Rate Freight LTL

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

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.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

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-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.
Example: true or false

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/freight/shipments

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/freight/shipments

Production Server

https://apis.fedex.com/ship/v1/freight/shipments

Request samples - Ship Freight LTL

Content type
application/json
Example
FullSchema-FreightShipment
Copy
 Expand all Collapse all
{
  • "freightRequestedShipment":
    {
    },
  • "labelResponseOptions": "LABEL",
  • "accountNumber":
    {
    },
  • "oneLabelAtATime": true
}

Response samples - Ship Freight LTL

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

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.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

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-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.
For example if you are indicating pickupDate as Saturday and you indicate 3, Saturday, Sunday and Monday will be considered.
Example: 3

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/freight/pickups/availabilities

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/freight/pickups/availabilities

Production Server

https://apis.fedex.com/pickup/v1/freight/pickups/availabilities

Request samples - Check Freight LTL Pickup Availability

Content type
application/json
Example
FullSchema-FreightPickupAvailability
Copy
 Expand all Collapse all
{
  • "pickupAddress":
    {
    },
  • "packageReadyTime": "15:30:00",
  • "customerCloseTime": "18:00:00",
  • "shipmentAttributes":
    {
    },
  • "freightPickupSpecialServiceDetail":
    {
    },
  • "dispatchDate": "2019-10-14",
  • "numberOfBusinessDays": 1
}

Response samples - Check Freight LTL Pickup Availability

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

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.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

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-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.
Example: 5

remarks
string

This is a placeholder for any message to be passed to the FedEx pickup. courier.
Example: Please ring bell at loading dock.

countryRelationships
string
Enum: "DOMESTIC" "INTERNATIONAL"

Describes the country relationship among the shipments being picked up.
'DOMESTIC' indicates intra-country shipping; origin and destination country are the same.
'INTERNATIONAL' indicates inter-country shipping; origin and destination countries are different.
Not applicable for FedEx Ground shipments
Example: DOMESTIC

trackingNumber
string

This is a tracking number for FedEx packages used for tracking a single package or group of packages.
Example: XXXX0365XXXX

commodityDescription
string

Description of the commodity being shipped.
Example:This field contains CommodityDescription

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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/freight/pickups/

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/freight/pickups/

Production Server

https://apis.fedex.com/pickup/v1/freight/pickups/

Request samples - Create Freight LTL Pickup

Content type
application/json
Example
FullSchema-CreatePickup
Copy
 Expand all Collapse all
{
  • "associatedAccountNumber":
    {
    },
  • "originDetail":
    {
    },
  • "totalWeight":
    [
    ],
  • "packageCount": 5,
  • "remarks": "Please ring bell at loading dock.",
  • "countryRelationships": "DOMESTIC",
  • "trackingNumber": "795803657326",
  • "commodityDescription": "This field contains CommodityDescription",
  • "freightPickupDetail":
    {
    },
  • "oversizePackageCount": 2,
  • "pickupNotificationDetail":
    {
    }
}

Response samples - Create Freight LTL Pickup

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

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.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

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-CancelFreightPickup
  • MinimumSamplePayload-FreightCancel
associatedAccountNumber
required
object (AccountNumber_2)

Specify the FedEx Account number.
Example: Your account number

pickupConfirmationCode
required
string

The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested.
Example: XXXX1007MEM62XXXX.

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.
Format YYYY-MM-DD
Example: 2019-10-15

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /pickup/v1/freight/pickups/cancel/

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/freight/pickups/cancel/

Production Server

https://apis.fedex.com/pickup/v1/freight/pickups/cancel/

Request samples - Cancel Freight LTL Pickup

Content type
application/json
Example
FullSchema-CancelFreightPickup
Copy
 Expand all Collapse all
{
  • "associatedAccountNumber":
    {
    },
  • "pickupConfirmationCode": "20201007MEM628005",
  • "remarks": "This is my remarks",
  • "reason": "This is my reason",
  • "contactName": "This is my contactName",
  • "scheduledDate": "2019-10-15"
}

Response samples - Cancel Freight LTL Pickup

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

Response

Copy