Fedex Logo
Developer Portal

Pickup Request API

Giới thiệu

API Yêu cầu lấy hàng cho phép bạn kiểm tra khả năng lấy hàng, lên lịch để nhân viên chuyển phát lấy hàng và hủy yêu cầu đến lấy hàng.

API Yêu cầu lấy hàng áp dụng cho các gói hàng mới hoặc trước đây từng xử lý ở mọi khu vực đối với lô hàng FedEx Express và FedEx Ground (trả lại và xuất). Tài liệu hướng dẫn chi tiết này sẽ cung cấp cho bạn thông tin mới nhất và giúp bạn tìm hiểu mọi điều cần biết về API Yêu cầu lấy hàng.

Chi tiết về API Yêu cầu lấy hàng

Sau đây là các tính năng quan trọng liên kết với API Yêu cầu lấy hàng:

Khả năng lấy hàng

Với tính năng khả năng lấy hàng, bạn có thể kiểm tra tính sẵn có của dịch vụ lấy hàng dựa trên yêu cầu đầu vào. Khả năng lấy hàng phụ thuộc vào hai yếu tố: thời gian chốt sổ lấy hàng và thời gian tiếp cận.

Thời gian chốt sổ lấy hàng - Thời gian muộn nhất bạn có thể lên lịch lấy hàng. Thời gian tính theo giờ địa phương của mã bưu chính nơi lấy hàng.

Thời gian tiếp cận - Thời gian tính từ lúc sẵn sàng lấy hàng (khi gói hàng sẵn sàng để lấy) đến lúc tài xế sẵn sàng lấy gói hàng.

Tạo yêu cầu lấy hàng

Tùy chọn này cho phép bạn lên lịch lấy hàng, áp dụng cho các lô hàng FedEx Express® và FedEx Ground® nội địa và quốc tế. API Yêu cầu lấy hàng FedEx Ground và Express sẽ trả về số xác nhận lấy hàng, ngoài ra còn trả về mã địa điểm cho yêu cầu lấy hàng Express đã lên lịch. Bạn cũng có thể lên lịch lấy hàng cho lô hàng trả lại bằng API này.

Dòng địa chỉ người nhận bổ sung (Dòng địa chỉ 3) cho phép bạn cung cấp chi tiết đầy đủ và chính xác hơn về địa điểm, giúp cho việc giao lô hàng FedEx Express® nhanh hơn. Bạn có thể tiết kiệm thời gian và công sức bằng cách lên lịch để nhân viên chuyển phát của FedEx lấy lô hàng từ địa điểm của bạn hoặc từ địa điểm khác (mất thêm phí).

Hủy lấy hàng

Tùy chọn này cho phép bạn hủy yêu cầu lấy hàng đã lên lịch. Tùy chọn này áp dụng cho các lô hàng FedEx Express và FedEx Ground nội địa và quốc tế. Các yêu cầu lấy hàng FedEx Express nội địa và quốc tế có thể hủy trong cùng ngày. Các yêu cầu lấy hàng FedEx Ground nội địa và quốc tế có thể hủy trong 24 giờ sau khi bạn gửi yêu cầu. Nếu lô hàng của bạn đã được lấy, vui lòng liên hệ với bộ phận Dịch vụ khách hàng FedEx theo số 800 FedEx (800 3339) để tiến hành hủy.

Chi tiết về yêu cầu lấy hàng

Yêu cầu lấy hàng FedEx Express

  • Thời gian gói hàng của bạn sẵn sàng để lấy không được muộn hơn thời gian chốt sổ lấy hàng theo mã bưu chính ở địa điểm của bạn. Bạn có thể truy xuất thời gian chốt sổ lấy hàng bằng yêu cầu về Khả năng lấy hàng.
  • Khoảng thời gian từ khi gói hàng của bạn sẵn sàng đến thời điểm nhân viên chuyển phát không thể vào địa điểm để lấy gói hàng nữa không được ngắn hơn "thời gian tiếp cận". Bạn cũng có thể truy xuất thời gian tiếp cận bằng yêu cầu về Khả năng lấy hàng.

    • Ví dụ: "PT4H0M" cho biết thời gian lấy hàng là 4 giờ 0 phút.

  • Bạn có thể lên lịch lấy hàng FedEx Express trong ngày hiện tại hoặc ngày làm việc tiếp theo.
  • Số lượng gói hàng tối đa cho một yêu cầu lấy hàng là 99.
  • Nếu bạn đã có một yêu cầu lấy hàng theo lịch thường xuyên, bạn không cần lên lịch yêu cầu lấy hàng một lần hay thêm yêu cầu lấy hàng theo lịch thường xuyên khác.
  • Bạn không thể thay đổi yêu cầu lấy hàng. Để thay đổi yêu cầu, bạn phải hủy yêu cầu ban đầu và nhập yêu cầu mới.
  • Giờ đây, hệ thống FedEx hỗ trợ chức năng Lấy hàng trong nội địa Vương quốc Anh.

Yêu cầu lấy hàng FedEx Ground

  • Bạn có thể lên lịch lấy hàng cho ngày làm việc tiếp theo hoặc ngày làm việc bất kỳ trước tối đa 2 tuần.
  • Số lượng gói hàng tối đa cho một yêu cầu lấy hàng là 99.
  • Nếu bạn đã có một yêu cầu lấy hàng theo lịch thường xuyên, bạn không cần lên lịch yêu cầu lấy hàng một lần hay thêm yêu cầu lấy hàng theo lịch thường xuyên khác.
  • Có tùy chọn lấy hàng tại nơi cư trú (tính thêm phụ phí).
  • Bạn không thể thay đổi yêu cầu lấy hàng. Để thay đổi yêu cầu, bạn phải hủy yêu cầu ban đầu và nhập yêu cầu mới.

Các loại dịch vụ của API Yêu cầu lấy hàng

Nhận hàng FedEx Express

Áp dụng phí nhân viên chuyển phát lấy hàng khi bạn yêu cầu Lấy hàng FedEx Express, bao gồm cả yêu cầu được tạo thông qua fedex.com và bộ phận Dịch vụ khách hàng FedEx.

Nhận hàng FedEx Ground

FedEx Ground cung cấp dịch vụ lấy hàng theo yêu cầu có tính thêm phí. Với khách hàng lấy hàng theo lịch thường xuyên, chúng tôi sẽ áp dụng phí lấy hàng mỗi tuần cho số tài khoản liên kết với dịch vụ lấy hàng theo lịch thường xuyên.

  • Với khách hàng không sử dụng dịch vụ lấy hàng theo lịch thường xuyên, chúng tôi sẽ áp dụng phí lấy hàng theo lượt gọi trên mỗi gói hàng. Phí lấy hàng theo lượt gọi sẽ không áp dụng nếu bạn bỏ gói hàng tại một địa điểm vận chuyển của FedEx. Ngoài ra, phí lấy hàng theo lượt gọi không áp dụng cho việc lấy hàng FedEx Ground® Economy (Trước đây gọi là FedEx SmartPost®) Nhãn trả hàng bản in FedEx Ground® Economy (Trước đây gọi là FedEx SmartPost®) Nhãn trả hàng điện tử và Chương trình chuyển hoàn gói hàng FedEx Ground®.
  • Với khách hàng lấy hàng theo lịch thường xuyên, FedEx Ground cung cấp dịch vụ lấy hàng theo yêu cầu từ một địa chỉ không phải địa điểm vận chuyển của số tài khoản FedEx Ground. Phí tính thêm cho dịch vụ lấy hàng tại địa chỉ thay thế được tính hằng tuần cho mỗi địa chỉ độc nhất.

FedEx Extra Hours

Các dịch vụ FedEx Extra Hours áp dụng cho yêu cầu lấy hàng có thể vận chuyển qua đêm trong 1 ngày từ thứ Hai đến thứ Sáu, cho phép đại lý bán lẻ hoàn thành đơn đặt hàng buổi tối bằng dịch vụ giao hàng tại địa phương vào ngày tiếp theo của FedEx Express.

Để biết thêm thông tin về các dịch vụ có sẵn, hãy truy cập fedex.com.

Phương thức hoạt động của API Yêu cầu lấy hàng

Sau đây là các tùy chọn lấy hàng có sẵn với API Yêu cầu lấy hàng:

Kiểm tra khả năng lấy hàng

Điểm cuối này dùng để yêu cầu thông tin chi tiết hiện có về lịch lấy hàng.

Những thông tin đầu vào quan trọng gắn với yêu cầu này gồm:

  • Đị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).
  • Hãng vận tải vận chuyển của FedEx để lấy hàng (ví dụ: Express/Ground).
  • Yêu cầu lấy hàng này là nội địa/quốc tế.

Phản hồi thành công cho yêu cầu này sẽ trả về các thông tin chi tiết hiện có về lịch lấy hàng, chẳng hạn như thời hạn chốt lấy hàng, ngày lấy hàng, thời gian ra vào lấy hàng, thời gian sẵn sàng mặc định cũng như các chi tiết khác về khả năng đến lấy hàng theo 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.

Tạo yêu cầu lấy hàng

Điểm cuối này dùng để tạo yêu cầu lấy hàng cho một gói hàng chờ lấy.

Những thông tin đầu vào quan trọng gắn với yêu cầu này gồm:

  • Số tài khoản FedEx 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).
  • Hãng vận tải vận chuyển của FedEx để lấy hàng (Express/Ground).
  • 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.

Hủy đến lấy hàng

Sử dụng yêu cầu này để hủy yêu cầu lấy gói hàng đã lên lịch.

Những thông tin đầu vào quan trọng gắn với yêu cầu này gồm:

  • Mã xác nhận lấy hàng (nhận được khi gửi yêu cầu lấy hàng)
  • Hãng vận tải vận chuyển của FedEx để lấy hàng (Express/Ground)
  • 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 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. 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. 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

Quy tắc kinh doanh 

  • Để yêu cầu lấy hàng ở một quốc gia khác, hãy bổ sung phần tử quốc gia cùng mã quốc gia tương ứng của nơi bạn muốn FedEx đến lấy lô hàng.
  • FedEx sẽ trả về số xác nhận điều phối cho một yêu cầu điều phối thành công. Các yêu cầu điều phối phải giới hạn trong một yêu cầu mỗi ngày, trừ phi bạn thêm các gói hàng vượt quá kích thước hoặc trọng lượng trong yêu cầu ban đầu.
  • Các yêu cầu điều phối có thể thất bại nếu bạn nhập khung thời gian không đủ giữa thời gian gói hàng sẵn sàng và thời gian đóng cửa doanh nghiệp. Nếu bạn có thắc mắc về thời gian lấy hàng, hãy liên hệ Đường dây nóng hỗ trợ FedEx tại khu vực.
  • API Yêu cầu lấy hàng hỗ trợ các loại trọng lượng như "LB" và "KG". Đơn vị trọng lượng của gói hàng và hàng hóa phải giống nhau, nếu không yêu cầu sẽ gặp lỗi.
  • Nếu bạn cần lên lịch lấy hàng cho cả gói hàng FedEx Express (bao gồm cả vận chuyển trong Mexico) và FedEx Ground, bạn cần lên lịch lấy hàng riêng cho mỗi hãng vận tải.
  • Nếu địa điểm lấy hàng của bạn ở khu vực xa xôi, hãy đảm bảo gói hàng của bạn sẵn sàng sớm hơn để phù hợp với lịch lấy hàng ở xa.
  • Luôn đưa vào thời gian muộn nhất để lấy gói hàng của bạn (hoặc thời gian đóng cửa công ty).
  • Dịch vụ lấy hàng thứ Bảy được cung cấp ở một số địa điểm trên thế giới đối với gói hàng FedEx Express. Dịch vụ bỏ hàng thứ Bảy cũng có sẵn tại nhiều địa điểm FedEx. Sử dụng điểm cuối Dịch vụ địa điểm để nhận danh sách các địa điểm bỏ hàng thứ Bảy.
  • Với các yêu cầu lấy hàng FedEx Ground và FedEx Express, bạn có thể yêu cầu địa chỉ lấy hàng thay thế không phải địa điểm vận chuyển gắn với số tài khoản FedEx của bạn.
  • Nếu bạn muốn sử dụng dịch vụ lấy hàng FedEx Express hoặc FedEx Ground thường xuyên, hãy liên hệ với nhân viên kinh doanh của FedEx.
  • Bạn chỉ có thể hủy yêu cầu lấy hàng FedEx Express hoặc FedEx Ground nếu:
    • Chưa đến thời gian gói hàng sẵn sàng trong yêu cầu, và
    • Nhân viên chuyển phát chưa được điều phối.

Bộ sưu tập API JSON

Documentation Powered by ReDoc

Pickup Request API (1.0.0)

Create Pickup

Use this endpoint to create a pickup request for a 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
One of
  • Full_Schema_Create_Pickup
  • Create_Pickup_Ground
  • Create_Pickup_Express
  • MinimumSamplePayload-ExpressFreightPickup
associatedAccountNumber
required
object (AccountNumber)

This is the FedEx account number.
Example: Your account number

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.

associatedAccountNumberType
string

This enumeration represents a kind of legacy account number from a FedEx operating entity for the account number associated to the pickup.
Valid values are: FEDEX_EXPRESS
FEDEX_GROUND

totalWeight
object

Specify The total weight of the packages for the pickup. Unit of measure is LB.

packageCount
integer <int32>

Specify the total number of packages for the pickup.
Example: 5

carrierCode
required
string
Enum: "FDXE" "FDXG"

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

  • FDXE- FedEx Express
  • FDXG- FedEx Ground

accountAddressOfRecord
object

The city name, state or province code and the address classification associated with the customer account which requested the pickup.

remarks
string

Placeholder for any message to be passed to the FedEx pickup courier.
Note:Maximum length is 60 characters.
Example: Please ring bell at loading dock.

countryRelationships
string
Enum: "DOMESTIC" "INTERNATIONAL"

Describes the country relationship among the shipments being picked up. This element is not mandatory for this request, but when added, the mandatory values are DOMESTIC or INTERNATIONAL. Empty or incorrect values will result in to errors.

pickupType
string

Indicate the pickup type method by which the shipment to be tendered to FedEx.
Note: The value of this element does not specify dispatching the courier for package pickup.
Example: ON_CALL, PACKAGE_RETURN_PROGRAM, REGULAR_STOP
Click here for more information on Pickup Types.

trackingNumber
string

This is a Tracking number for FedEx packages used for tracking a single package or group of packages.
Example: 795803657326
Click here to see mock tracking numbers for FedEx Express and FedEx Ground.

commodityDescription
string

Description of the commodity being shipped.
Example:This field contains Commodity Description.
Click here to see Vague commodity descriptions

expressFreightDetail
object

Placeholder for Express Freight pickup details.

oversizePackageCount
integer <int32>

Specify 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/pickups

Sandbox Server

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

Production Server

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

Request samples

Content type
application/json
Example
Full_Schema_Create_Pickup
Copy
 Expand all Collapse all
{
  • "associatedAccountNumber":
    {
    },
  • "originDetail":
    {
    },
  • "associatedAccountNumberType": "FEDEX_GROUND",
  • "totalWeight":
    {
    },
  • "packageCount": 5,
  • "carrierCode": "FDXE",
  • "accountAddressOfRecord":
    {
    },
  • "remarks": "Please ring bell at loading dock.",
  • "countryRelationships": "DOMESTIC",
  • "pickupType": "ON_CALL, PACKAGE_RETURN_PROGRAM, REGULAR_STOP.",
  • "trackingNumber": "795803657326",
  • "commodityDescription": "This field contains CommodityDescription",
  • "expressFreightDetail":
    {
    },
  • "oversizePackageCount": 2,
  • "pickupNotificationDetail":
    {
    }
}

Response samples

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

Check Pickup Availability

Use this endpoint to check the availability of a pickup service.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

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

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

content-type
required
string
Example: application/json

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

x-locale
string
Example: en_US

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

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • Full_Schema_Pickup_Availability
  • Check_Pickup_Availability_Domestic_Express
  • Check_Pickup_Availability_Domestic_Ground
  • Check_Pickup_Availability_International_Express
pickupAddress
required
object (PickupAddress)

Specify the address for which pickup availability inquiry has been made.

dispatchDate
string

Specify the date the package is to be picked up. The format is YYYY-MM-DD. If left blank, the system considers current date as dispatch date.
Example: 2020-01-01

packageReadyTime
string

Specify 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.
Example: 15:00:00

customerCloseTime
string

Specify 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.
Example: 18:00:00

pickupType
string
Enum: "ON_CALL" "TAG"

Indicate the pickup type method by which the shipment to be tendered to FedEx.
Note: The value of this element does not specify dispatching the courier for package pickup.
Click here for more information on Pickup Types.

pickupRequestType
required
Array of strings
Items Enum: "SAME_DAY" "FUTURE_DAY"

Specify pickup request type.

shipmentAttributes
object (ShipmentAttributes)

Specify the shipment details, such as service type, packaging type, weight and dimensions.

Note: serviceType is required for domestic or international pickup availabilities.

numberOfBusinessDays
integer <int32>

Specify number of business days to consider when checking availability.
For example if you are indicating pickupDate for a Saturday and you indicate 3, Saturday, Sunday and Monday will be considered.
Example: 3

packageDetails
Array of objects (RequestedPickupPackageDetail)

This object is used to specify the package details.

associatedAccountNumber
string

The associated account number, which will be invoiced for the pickup.
Example:613787364.

associatedAccountNumberType
string
Enum: "FEDEX_EXPRESS" "FEDEX_GROUND"

This represents a kind of legacy account number from a FedEx operating entity for the account number associated to the pickup.
Valid values are: FEDEX_EXPRESS
FEDEX_GROUND

carriers
required
Array of strings
Items Enum: "FDXE" "FDXG"

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

  • FDXE - FedEx Express
  • FDXG - FedEx Ground

countryRelationship
required
string
Enum: "DOMESTIC" "INTERNATIONAL"

Specify the country relationship among the shipments being picked up. Empty or incorrect values will result in to errors.

Note: shipmentAttributes/serviceType is required for domestic or international pickup availabilities.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/pickups/availabilities

Sandbox Server

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

Production Server

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

Request samples

Content type
application/json
Example
Full_Schema_Pickup_Availability
Copy
 Expand all Collapse all
{
  • "pickupAddress":
    {
    },
  • "dispatchDate": "2020-10-14",
  • "packageReadyTime": "15:30:00",
  • "customerCloseTime": "18:00:00",
  • "pickupType": "ON_CALL",
  • "pickupRequestType":
    [
    ],
  • "shipmentAttributes":
    {
    },
  • "numberOfBusinessDays": 1,
  • "packageDetails":
    [
    ],
  • "associatedAccountNumber": "613787364",
  • "associatedAccountNumberType": "FEDEX_EXPRESS",
  • "carriers":
    [
    ],
  • "countryRelationship": "INTERNATIONAL"
}

Response samples

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

Cancel Pickup

Use this endpoint to cancel the already scheduled 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
One of
  • Full_Schema_Cancel_Pickup
  • Cancel_Pickup_Ground
  • Cancel_Pickup_Express
associatedAccountNumber
required
object (AccountNumber)

This is 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: 7

remarks
string

Placeholder for any message to be passed to the FedEx pickup courier.
Note:Maximum length is 60 characters.
Example: Please ring bell at loading dock.

carrierCode
string
Enum: "FDXE" "FDXG"

This is a placeholder to provide the FedEx operating company (transportation) code used for package delivery. Required for FedEx Ground.
Optional for FedEx Express.
The Default is FedEx Express i.e. FDXE.

accountAddressOfRecord
object (AccountAddressOfRecord)

Address details for the associated pickup account. Indicates if the address is residential. Specifies the city name, country code, streetline number, postal code, address verification Identifier, and state or province code.

scheduledDate
required
string

Indicates the date the pickup dispatch occurs.
Format YYYY-MM-DD
Example: 2019-10-15

location
string

The FedEx Express location identifier responsible for processing the pickup request. This is returned in the CreatePickup response and is required to cancel a FedEx Express dispatch.Required only for FedEx Express Pickups. Optional for FedEx Ground. Example: LOSA

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /pickup/v1/pickups/cancel

Sandbox Server

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

Production Server

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

Request samples

Content type
application/json
Example
Full_Schema_Cancel_Pickup
Copy
 Expand all Collapse all
{
  • "associatedAccountNumber":
    {
    },
  • "pickupConfirmationCode": "7",
  • "remarks": "Please ring bell at loading dock.",
  • "carrierCode": "FDXE",
  • "accountAddressOfRecord":
    {
    },
  • "scheduledDate": "2019-10-15",
  • "location": "LOSA"
}

Response samples

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

Response

Copy