Create Pick Up V2 has been deprecated and will soon be removed
No action is needed, current projects using deprecated APIs will remain live. The POST /pickup/v2/pickups endpoint has been deprecated and should no longer be used.
Introduction
The Pickup Request API allows you to check for pickup availability, schedule a courier to pick up, and cancel a pickup request.
The Pickup Request API is applicable for new or previously processed packages across all regions for FedEx Express and FedEx Ground (return and outbound) shipments. This detailed guide will get you up to speed and teach you everything you need to know about Pickup Request API.
Pickup Request API Details
The following are the key features associated with the Pickup Request API:
Pickup Availability
With pickup availability, you can check the availability of the pickup service based on the input request. The pickup availability depends on two factors: the cutoff time and the access time.
Cutoff time - The latest allowed time 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 up) and the time when the driver is ready to pick up the package.
Create Pickup
This option allows you to schedule a pickup and applies to FedEx Express® and FedEx Ground® domestic and international shipments. The FedEx Ground and Express pickup request API returns a pickup confirmation number and additionally location code is returned with Express pickup request for the scheduled pickup. You can also schedule pickup for a return shipment using this API.
Additional recipient address line (Address line 3) allows you to provide more complete and accurate location details to achieve faster delivery of FedEx Express® shipments. You can save your time and effort by scheduling a FedEx courier to pick up shipments from your location or from another location at an extra charge.
Cancel Pickup
This option allows you to cancel a previously scheduled pickup. This option applies to FedEx Express and FedEx Ground domestic and international shipments. FedEx Express domestic and International pickups can be cancelled on the same day. FedEx Ground domestic and international shipments will be available for cancellation 24 hrs. after the pickup request is submitted. If your shipment has already been picked-up, please contact FedEx Customer Service at 800 FedEx (800 3339) to proceed with the cancellation.
Pickup Request Details
FedEx Express Pickup Requests
- The time that your packages will be ready to be picked up must be no later than the postal code cutoff time for your location.
- The length of time from when your packages will be ready to the time at which the courier will no longer be able to enter the premises to pick up the packages must be no less than the “access time,” which can also be retrieved with the Pickup Availability request.
- FedEx Express pickups can be scheduled for the current or next business day.
- If you already have a regular scheduled pickup, it is not necessary to schedule a one-time pickup or add another regular scheduled pickup.
- You cannot change a pickup request. To change a request, you must cancel the original request and enter a new request.
- FedEx systems now support domestic UK Pickup functionality.
For example: ‘PT4H0M’ indicates the pickup time is 4 hours and 0 minutes.
FedEx Ground Pickup Requests
- Pickup can be scheduled for the next business day or any business day up to 2 weeks in advance.
- If you already have a regular scheduled pickup, it is not necessary to schedule a one-time pickup or add another regular scheduled pickup.
- Pickup at a residential address is available for an additional surcharge.
- You cannot change a pickup request. To change a request, you must cancel the original request and enter a new request.
Pickup Request API Service Types
FedEx Express Pickup
A courier pickup charge applies when you request a FedEx Express Pickup, including requests made through fedex.com and FedEx Customer Service.
FedEx Ground Pickup
FedEx Ground provides pickup service upon request for an additional charge. For regular scheduled pickup customers, we assess the weekly pickup fee to the account number associated with the regular scheduled pickup.
- For customers that do not have a regular scheduled pickup, we assess a per-package on-call pickup charge. On-call pickup charges do not apply if you drop off your package at a FedEx shipping location. Additionally, on-call pickup charges do not apply to FedEx Ground® Economy (Formerly known as FedEx SmartPost®) Print Return Label, FedEx Ground® Economy (Formerly known as FedEx SmartPost®) Email Return Label and FedEx Ground® Package Returns Program pickups.
- For regular scheduled pickup customers, FedEx Ground provides pickup service upon request from an address other than the shipping location of the FedEx Ground account number. An additional alternate address pickup charge per unique address per week is applicable for this service.
FedEx Extra Hours
FedEx Extra Hours services are available for pickup with overnight 1-day transit Monday through Friday, enabling retailers to fulfill evening orders with FedEx Express next-day local delivery.
For more information on available services, visit fedex.com.
How Pickup Request API works
Following are the pickup options available with Pickup Request API:
Check Pickup Availability
Use this endpoint to request available pickup schedule details.
The key input information associated with this request are:
- Pickup address/postal details.
- Pickup request type (ex: same day/future day).
- FedEx transportation carrier for pickup (ex: express/ground).
- Whether or not domestic/international pickup.
The successful response to this request will return available pickup schedule details, such as the cutoff time of the pickup, pickup date, access time for the pickup, default ready time, and other pickup availability scheduled details. It also returns errors and the descriptions in case of any failures.
Create Pickup
Use this endpoint to create a pickup request for a package to be picked up.
The key input information associated with this request are:
- FedEx account number, which will be invoiced for the pickup.
- Origin details (address, location and pickup address type such as account/shipper/other).
- FedEx transportation carrier for pickup (express/ground).
- Address details for the associated account.
The successful pickup request will return a pickup confirmation number, pickup notification and location code for the pickup being scheduled. It also returns errors and the descriptions in case of any failures.
Cancel Pickup
Use this request to cancel an already scheduled pickup request for a package.
The key input information associated with this request are:
- Pickup Confirmation Code (obtained while submitting a pickup request)
- FedEx transportation carrier for pickup (Express/Ground)
- Scheduled Date (Date the pickup dispatch occurs)
- Location (FedEx Express location responsible for processing the pickup request)
The successful pickup cancellation will return a confirmation number and a pickup cancellation confirmation message. It also returns errors and the descriptions in case of any failures.
Note: Submit the pickup confirmation number and the corresponding location code (only applies to FDXE)to cancel the pickup that was scheduled. Pickup confirmation number and the corresponding location code (only applies to FDXE) information are obtained while submitting a pickup request. A failure notification will be sent if you attempt to cancel a pickup after the FedEx courier has been dispatched to the pickup location
Business Rules
- To request a pickup for a different country, include the country element with the appropriate country code where you would like FedEx to pick up your shipment.
- FedEx returns a dispatch confirmation number for a successful dispatch request. Dispatch requests should be limited to one request per day unless you add packages that exceed the dimensions or weight for the original request.
- Dispatch requests may fail if you enter an insufficient time window between package ready and business close. If you have questions about pickup times, contact your regional FedEx Support Hotline.
- Pickup Request API supports weight types as ″LB″ and ″KG″. The unit of weight for package and the commodity should be same else the request will result into error.
- If you need to schedule a pickup for both FedEx Express (including intra-Mexico shipping) and FedEx Ground packages, you are required to schedule one pickup for each of the carriers individually.
- If your pickup location is in a remote area, make sure your packages are ready earlier to accommodate remote pickup schedule.
- Always include the latest time your package can be picked up (or your company’s close time).
- Saturday pickup service is offered in select locations worldwide for your FedEx Express packages. Saturday dropoff is also available at many FedEx locations. Use the Locations Service endpoint to receive a list of Saturday dropoff locations.
- For FedEx Ground and FedEx Express pickups, you may request an alternate pickup address other than the shipping location attached to your FedEx account number.
- If you want a regular FedEx Express or FedEx Ground pickup service, contact your FedEx account executive.
- You may cancel a FedEx Express or FedEx Ground pickup only if:
- The request package ready time has not already been met, and
- Courier has not been dispatched.
