Doc-Tab Coding Details

All data from the customer’s description of the shipment (RequestedShipment) and the data returned to the customer (CompletedShipmentDetail) is eligible for use in the Doc-Tab. The complete structure of those objects is necessarily complex, due to the tremendous range of service features that may occur within a FedEx shipment. The first segments of a Doc-Tab path come from a set of alias/shortcut values that allow the customer to indicate whether the requested value is to come from one of the following:

  • Client or transaction detail
  • Request or reply data
  • Shipment- or Package-level data
  • Rate data, and if so, which rate type

The prefix (leading segments) of the path specifies the above choices in that order, as shown in the following tables:

Prefix (Non-Rate Data) Remainder of path selects data from…
CLIENT/… The effective copy of the ClientDetail
TRANSACTION/… The effective copy of the TransactionDetail
REQUEST/SHIPMENT/… The effective copy of the RequestedShipment
REQUEST/PACKAGE/… The effective copy of the current RequestedPackage
REPLY/SHIPMENT/… The CompletedShipmentDetail
REPLY/PACKAGE/… The current CompletedPackageDetail
Prefix (Rate Data) Remainder of path selects data from…
REPLY/SHIPMENT/RATE/ACTUAL/… Shipment-level rate data (totals for actual rate applied)
REPLY/SHIPMENT/RATE/PAYOR_ACCOUNT/… Shipment-level rate data (totals for specific returned rate type)
REPLY/SHIPMENT/RATE/RATED_LIST/… Shipment-level rate data (totals for specific returned rate type)
REPLY/PACKAGE/RATE/ACTUAL/… Package-level rate data (details for actual rate applied)
REPLY/PACKAGE/RATE/PAYOR_ACCOUNT/… Package-level rate data (details for specified returned rate type)
REPLY/PACKAGE/RATE/RATED_LIST/… Package-level rate data (details for specified returned rate type)

The rate data is taken from the appropriate instance (based on the rate type specified by the fourth segment of the path) of ShipmentRateDetail (for shipment-level data) or PackageRateDetail (for package-level data).