Pickup Availability Request Elements

In addition to the basic service elements required for most transactions (AuthenticationDetail, ClientDetail, TransactionDetail, and AccountNumber), the following elements are required to request availability of pickup for a FedEx Freight shipment:

Element Description
PickupAddress Includes descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit, such as a city-state-ZIP combination within the U.S.
PickupRequestType Describes the relationship between the date on which a dispatch occurs and the date on which it is created (scheduled) by means of a CourierDispatchRequest.
  • FUTURE_DAY means that the dispatch date is later than the date on which it is created. If FUTURE_DAY is included, then Options with ScheduleDay of FUTURE_DAY will be included in the reply
  • SAME_DAY means that the dispatch is to occur on the date on which it is created. If SAME_DAY is included, then Options with ScheduleDay of SAME_DAY will be included in the reply.
DispatchDate Identifies the dispatch date (in the local time zone) for the pickup whose availability is being requested.
NumberOfBusinessDays Identifies the number of business days to consider when checking availability.
PackageReadyTime Identifies the time when the package will be ready to be picked up. The time is local to the pickup postal code, in 24-hour form, such as 13:00:00. It should not contain a TZD. If a TZD is included, it will be ignored.
CustomerCloseTime Identifies the latest time at which the courier will be able to gain access to pick up the package(s). The time is local to the pickup postal code, in 24-hour form, such as 17:00:00. It should not contain a TZD. If a TZD is included, it will be ignored.
Carriers Identifies the FedEx carrier(s) for which availability is requested.

Valid values are:

  • FDXC
  • FDXE
  • FDXG
  • FXCC
  • FXFR
  • FXSP
ShipmentAttributes Includes descriptive information about the shipment.