FedEx (Preview)

FedEx Corp. provides customers and businesses worldwide with a broad portfolio of transportation, e-commerce, and business services. Connect to FedEx APIs to validate address, search locations, create shipment, track shipment, receive updates etc.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)

Contact
Name	Microsoft Dynamics
URL	https://aka.ms/iomsupport
Email	iomdri@microsoft.com

Connector Metadata
Publisher	Microsoft
Website	https://www.fedex.com/
Privacy policy	https://www.fedex.com/en-us/trust-center.html
Categories	Commerce;Business Management

FedEx connector has been specifically developed to be used for Dynamics 365 Intelligent Order Management's Provider integration.

Prerequisites

FedEx Developer account registration is required.

Login to https://developer.fedex.com/
Select Sign up or Login
Click on Sign Up to create a new User ID. If you have an existing fedex.com user ID, you can login using those existing credentials.
If creating a new User ID, fill out the required fields. This information can be a specific developer’s information or generic. Creating the user is free and an account number is not needed.
Upon Completion, Click Create an Organization.
Type in your organization name and click create.
Select Create a Project on the landing page or by clicking on My Projects on the left-hand menu.
Give your project a name and then select the projects (Address Validation, FedEx Locations Search, Ship API, Track API).
Complete the legal agreement steps.

Note: It is recommended to use this connector specifically to set up the Dynamics 365 Intelligent Order Management FedEx provider.

How to get credentials

Login to https://developer.fedex.com/
Find the required client credentials under My Projects > Project Overview

Getting started with your connector

Follow https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider to enable FedEx Provider with the Client Credentials.

Known issues and limitations

This connector has been specifically developed to be used for Dynamics 365 Intelligent Order Management's FedEx Provider integration. Support for use cases outside of Dynamics 365 Intelligent Order Management will be limited.

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Client ID	string	FedEx Project API Key	True
Client Secret	securestring	FedEx Project Secret Key	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Cancel Shipment	Use this endpoint to cancel FedEx Express and Ground shipments that have not already been tendered to FedEx. This request will cancel all packages within the shipment.
Create Shipment	Use this endpoint to create shipment requests thereby validating all the shipping input information and generates the labels.
Find Locations	Use this endpoint to search for nearest FedEx locations by address, geographic coordinates, or phone number.
Retrieve Rate Quotes	Use this endpoint to retrieve rate quotes and optional transit information. The rate is calculated based on the origin and destination of the shipments.
Track by Tracking Number	Use this endpoint to track customers package information based on a tracking number for various shipping services.
Validate Address	Use this endpoint to get address resolution details. These details are the outcome of validatation and resolution of the input address. An address is stated as resolved when the input address matches the known reference data.

Cancel Shipment

Operation ID:: CancelShipment

Use this endpoint to cancel FedEx Express and Ground shipments that have not already been tendered to FedEx. This request will cancel all packages within the shipment.

Parameters

Name	Key	Required	Type	Description
Customer Transaction Id	x-customer-transaction-id		string	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.
Locale	x-locale		string	This indicates the combination of language code and country code.

Returns

Name	Path	Type	Description
transactionId	transactionId	string	Unique identifier returned in the reply and helps you match the request to the reply.
customerTransactionId	customerTransactionId	string	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.
cancelledShipment	output.cancelledShipment	boolean	Indicates whether the shipment has been cancelled or not.
cancelledHistory	output.cancelledHistory	boolean	Indicates whether the shipment has been deleted from history or not.
successMessage	output.successMessage	string	The success message generated during cancellation request for Shipment.
alerts	output.alerts	array of Alert	This is a cancellation request alert. This alert includes information such as alert code, alert type, and alert message.

Create Shipment

Operation ID:: CreateShipment

Use this endpoint to create shipment requests thereby validating all the shipping input information and generates the labels.

Parameters

Name	Key	Required	Type	Description
Customer Transaction Id	x-customer-transaction-id		string	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.
Locale	x-locale		string	This indicates the combination of language code and country code.

Returns

Name	Path	Type	Description
transactionId	transactionId	string	The transaction ID is a special set of numbers that defines each transaction.
customerTransactionId	customerTransactionId	string	This transaction ID helps you match the request to the reply.
transactionShipments	output.transactionShipments	array of object	These are shipping transaction details, such as master tracking number, service type, and ship date and time.
serviceType	output.transactionShipments.serviceType	string	Indicate the FedEx serviceType used for this shipment. The results will be filtered by the serviceType value indicated.
shipDatestamp	output.transactionShipments.shipDatestamp	string	This is the shipment date. Default value is current date in case the date is not provided or a past date is provided.
serviceCategory	output.transactionShipments.serviceCategory	string	Indicates the Service Category.
shipmentDocuments	output.transactionShipments.shipmentDocuments	array of LabelResponseVO	These are shipping document details.
pieceResponses	output.transactionShipments.pieceResponses	array of object	These are pieces information received in the response.
netChargeAmount	output.transactionShipments.pieceResponses.netChargeAmount	double	Indicates the net charges amount.
transactionDetails	output.transactionShipments.pieceResponses.transactionDetails	array of object	Indicates data received that governs data payload language/translations.
transactionDetails	output.transactionShipments.pieceResponses.transactionDetails.transactionDetails	string	Includes data returned which governs data payload language/translations.
transactionId	output.transactionShipments.pieceResponses.transactionDetails.transactionId	string	This element has a unique identifier added in your request, helps you match the request to the reply.
packageDocuments	output.transactionShipments.pieceResponses.packageDocuments	array of LabelResponseVO	These are package documents returned in the response.
acceptanceTrackingNumber	output.transactionShipments.pieceResponses.acceptanceTrackingNumber	string	Indicates the acceptance tracking number.
serviceCategory	output.transactionShipments.pieceResponses.serviceCategory	string	Indicates the service category.
listCustomerTotalCharge	output.transactionShipments.pieceResponses.listCustomerTotalCharge	string	Indicates total charges applicable to the customer.
deliveryTimestamp	output.transactionShipments.pieceResponses.deliveryTimestamp	string	Indicates delivery date with timestamp.
trackingIdType	output.transactionShipments.pieceResponses.trackingIdType	string	Indicates the type of the tracking identifier.
additionalChargesDiscount	output.transactionShipments.pieceResponses.additionalChargesDiscount	double	These are additional charges or discounts.
netListRateAmount	output.transactionShipments.pieceResponses.netListRateAmount	double	Indicates the net List rate amount.
baseRateAmount	output.transactionShipments.pieceResponses.baseRateAmount	double	Specifies the base rate amount.
packageSequenceNumber	output.transactionShipments.pieceResponses.packageSequenceNumber	integer	Indicates package sequence number.
netDiscountAmount	output.transactionShipments.pieceResponses.netDiscountAmount	double	Specifies the net discount amount.
codcollectionAmount	output.transactionShipments.pieceResponses.codcollectionAmount	double	Specifies the Collect on Delivery collection amount.
masterTrackingNumber	output.transactionShipments.pieceResponses.masterTrackingNumber	string	This is a master tracking number for the shipment.
acceptanceType	output.transactionShipments.pieceResponses.acceptanceType	string	Indicates acceptance type.
trackingNumber	output.transactionShipments.pieceResponses.trackingNumber	string	This is a tracking number associated with this package.
successful	output.transactionShipments.pieceResponses.successful	boolean	Returns true if the responses are successful otherwise false.
customerReferences	output.transactionShipments.pieceResponses.customerReferences	array of object	These are additional customer reference data.
customerReferenceType	output.transactionShipments.pieceResponses.customerReferences.customerReferenceType	string	This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information.
value	output.transactionShipments.pieceResponses.customerReferences.value	string	This is a customer reference type value.
serviceName	output.transactionShipments.serviceName	string	This is the service name associated with the shipment.
alerts	output.transactionShipments.alerts	array of Alert	These are alert details received in the response.
completedPackageDetails	output.transactionShipments.completedShipmentDetail.completedPackageDetails	array of object	Indicates the completed package details.
sequenceNumber	output.transactionShipments.completedShipmentDetail.completedPackageDetails.sequenceNumber	integer	This is package sequence number.
astraHandlingText	output.transactionShipments.completedShipmentDetail.completedPackageDetails.operationalDetail.astraHandlingText	string	This is human-readable astra handling text.
binaryBarcodes	output.transactionShipments.completedShipmentDetail.completedPackageDetails.operationalDetail.barcodes.binaryBarcodes	array of object	This is binary-style barcodes for the package.
type	output.transactionShipments.completedShipmentDetail.completedPackageDetails.operationalDetail.barcodes.binaryBarcodes.type	string	This is the type of barcode data available in this instance.
value	output.transactionShipments.completedShipmentDetail.completedPackageDetails.operationalDetail.barcodes.binaryBarcodes.value	string	This is the value.
stringBarcodes	output.transactionShipments.completedShipmentDetail.completedPackageDetails.operationalDetail.barcodes.stringBarcodes	array of object	This is string-style barcodes for the package.
type	output.transactionShipments.completedShipmentDetail.completedPackageDetails.operationalDetail.barcodes.stringBarcodes.type	string	This is the type of barcode data in this instance.
value	output.transactionShipments.completedShipmentDetail.completedPackageDetails.operationalDetail.barcodes.stringBarcodes.value	string	This is the value.
operationalInstructions	output.transactionShipments.completedShipmentDetail.completedPackageDetails.operationalDetail.operationalInstructions	array of object	These are operational instruction such as Ground Information printed on a given area of the label, one-dimensional barcode with only x-axis that contains the details of the shipment in encrypted form, COD Return operational instructions data such as COD amount, SECURED or UNSECURED.
number	output.transactionShipments.completedShipmentDetail.completedPackageDetails.operationalDetail.operationalInstructions.number	integer	Specifies the number of operational instructions returned for this shipment.
content	output.transactionShipments.completedShipmentDetail.completedPackageDetails.operationalDetail.operationalInstructions.content	string	This is an operational instruction printed or available on the shipping document.
signatureOption	output.transactionShipments.completedShipmentDetail.completedPackageDetails.signatureOption	string	It specifies the signature option applied, to allow cases in which the value requested conflicted with other service features in the shipment.
trackingIds	output.transactionShipments.completedShipmentDetail.completedPackageDetails.trackingIds	array of object	Tracking details for the package.
formId	output.transactionShipments.completedShipmentDetail.completedPackageDetails.trackingIds.formId	string	This is FedEx tracking Identifier associated with the package.
trackingIdType	output.transactionShipments.completedShipmentDetail.completedPackageDetails.trackingIds.trackingIdType	string	Specify the FedEx transportation type.
uspsApplicationId	output.transactionShipments.completedShipmentDetail.completedPackageDetails.trackingIds.uspsApplicationId	string	Specify the USPS tracking Identifier associated with FedEx SmartPost shipment.
trackingNumber	output.transactionShipments.completedShipmentDetail.completedPackageDetails.trackingIds.trackingNumber	string	This is a number associated with a package that is used to track it.
groupNumber	output.transactionShipments.completedShipmentDetail.completedPackageDetails.groupNumber	integer	This is group shipment number. Used with request containing PACKAGE_GROUPS, to identify which group of identical packages was used to produce a reply item.
oversizeClass	output.transactionShipments.completedShipmentDetail.completedPackageDetails.oversizeClass	string	Indicates the oversize classification.
effectiveNetDiscount	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.effectiveNetDiscount	double	This is the difference between the list and account net charge.
actualRateType	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.actualRateType	string	This is the actual rate type. It identifies which entry in the following array is considered as presenting the actual rates for the package.
packageRateDetails	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails	array of object	These are package rate details, as calculated per a specific rate type.
ratedWeightMethod	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.ratedWeightMethod	string	Indicates the weight types used in calculating this rate, such as actual weight or dimensional weight.
totalFreightDiscounts	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.totalFreightDiscounts	double	The sum of all freight discounts for this package.
totalTaxes	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.totalTaxes	double	The sum of all taxes on this package.
minimumChargeType	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.minimumChargeType	string	Indicates the minumum charge type. INTERNAL FEDEX USE ONLY.
baseCharge	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.baseCharge	double	The package transportation charge(prior to any discounts applied).
totalRebates	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.totalRebates	double	Specifies total rebates on this package.
rateType	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.rateType	string	This is the rate type used.
billingWeight	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.billingWeight	Weight	These are the package weight details.
netFreight	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.netFreight	double	This is the net freight charges. i.e. base charge minus total freight discounts for a package.
surcharges	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.surcharges	array of object	These are all surcharges on this package.
amount	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.surcharges.amount	double	This is the surcharge amount.
surchargeType	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.surcharges.surchargeType	string	This is the surcharge type.
level	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.surcharges.level	string	Specifies if the surcharge applies to the entire shipment, or to an individual package.
description	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.surcharges.description	string	Specifies the description for the surcharge.
totalSurcharges	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.totalSurcharges	double	The sum of all surcharges on this package.
netFedExCharge	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.netFedExCharge	double	This is sum of net freight and total surcharges (not including totalTaxes)
netCharge	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.netCharge	double	This is the sum of net freight, total surcharges and total taxes for a package.
currency	output.transactionShipments.completedShipmentDetail.completedPackageDetails.packageRating.packageRateDetails.currency	string	This is the currency code.
dryIceWeight	output.transactionShipments.completedShipmentDetail.completedPackageDetails.dryIceWeight	Weight	These are the package weight details.
regulation	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.regulation	string	Specifies the hazardous package regulation type.
accessibility	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.accessibility	string	Specifies the hazardous package accessibility.
labelType	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.labelType	string	Specifies the label type for Hazardous package.
containers	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers	array of object	Indicates one or more approved containers used to pack dangerous goods commodities.
qvalue	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.qvalue	double	Indicates that the quantity of the dangerous goods packaged is permissible for shipping. This is used to ensure that the dangerous goods commodities do not exceed the net quantity per package restrictions.
hazardousCommodities	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities	array of object	Indicates the details of the hazardous commodities in the completed package.
quantityType	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.quantity.quantityType	string	Indicate the measure of units quantity to be validated.
amount	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.quantity.amount	double	Indicate the amount of the commodity in alternate units.
units	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.quantity.units	string	Indicate the unit of measure.
quantityType	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.quantity.quantityType	string	Indicate the measure of units quantity to be validated.
amount	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.quantity.amount	double	Indicate the amount of the commodity in alternate units.
units	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.quantity.units	string	Indicate the unit of measure.
innerReceptacles	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.innerReceptacles	array of object	Specifies the inner receptacles within the container.
quantityType	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.innerReceptacles.quantity.quantityType	string	Specifies which measure of quantity is to be validated.
amount	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.innerReceptacles.quantity.amount	float	Number of units of the type.
units	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.innerReceptacles.quantity.units	string	Specifies the units.
labelTextOption	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.options.labelTextOption	string	Indicates the label text option.
customerSuppliedLabelText	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.options.customerSuppliedLabelText	string	Text used in labeling the commodity under control of the LabelTextOption field.
sequenceNumber	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.sequenceNumber	integer	Specify the sequence number.
processingOptions	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.processingOptions	array of string	Indicates any special processing options to be applied to the description of the dangerous goods commodity.
subsidiaryClasses	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.subsidiaryClasses	array of string	Indicates list of subsidiary classes.
labelText	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.labelText	string	Specifies the text for the label.
technicalName	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.technicalName	string	Specifies the technical name for the hazardous material.
packingInstructions	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.packingDetails.packingInstructions	string	Coded specification for how commodity is to be packed.
cargoAircraftOnly	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.packingDetails.cargoAircraftOnly	boolean	Shipment is packaged/documented for movement ONLY on cargo aircraft.
authorization	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.authorization	string	Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.
reportableQuantity	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.reportableQuantity	boolean	Reportable Quantity.
percentage	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.percentage	double	Percentage detail.
id	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.id	string	ID information.
packingGroup	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.packingGroup	string	Identifies DOT packing group for a hazardous commodity.
properShippingName	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.properShippingName	string	The proper shipping name as defined by the regulation.
hazardClass	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.options.description.hazardClass	string	Specifies the hazard class for the commodity.
sequenceNumber	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.sequenceNumber	integer	In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
packingInstructions	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.packingInstructions	string	Specifies Packing Instructions.
subsidiaryClasses	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.subsidiaryClasses	array of string	Specifies subsidiary Classes.
labelText	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.labelText	string	Specifies the text for the label.
tunnelRestrictionCode	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.tunnelRestrictionCode	string	There are five categories of tunnel categorization with A representing the least restrictive and E as the most restrictive.
specialProvisions	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.specialProvisions	string	Specifies Special Provisions if any.
properShippingNameAndDescription	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.properShippingNameAndDescription	string	Fully-expanded descriptive text for a hazardous commodity.
technicalName	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.technicalName	string	Specifies Technical Name.
symbols	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.symbols	string	Specifies Symbols.
authorization	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.authorization	string	Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.
attributes	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.attributes	array of string	Specifies attributes.
id	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.id	string	Specifies the Identification.
packingGroup	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.packingGroup	string	Specifies packing group.
properShippingName	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.properShippingName	string	Specifies proper shipping name.
hazardClass	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.description.hazardClass	string	Specifies hazard class.
amount	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.netExplosiveDetail.amount	double	Specifies amount.
units	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.netExplosiveDetail.units	string	Specifies net explosive units.
type	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.netExplosiveDetail.type	string	Specifies net explosive classification type.
massPoints	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.containers.hazardousCommodities.massPoints	double	The mass points are a calculation used by ADR regulations for measuring the risk of a particular hazardous commodity.
cargoAircraftOnly	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.cargoAircraftOnly	boolean	When TRUE-indicates that the package can be transported only on a cargo aircraft.
referenceId	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.referenceId	string	A unique reference id that matches the package to a package configuration.
radioactiveTransportIndex	output.transactionShipments.completedShipmentDetail.completedPackageDetails.hazardousPackageDetail.radioactiveTransportIndex	float	Specifies the maximum radiation level from the package.
originServiceArea	output.transactionShipments.completedShipmentDetail.operationalDetail.originServiceArea	string	Indicates the origin service area.
serviceCode	output.transactionShipments.completedShipmentDetail.operationalDetail.serviceCode	string	Indicates the service code.
airportId	output.transactionShipments.completedShipmentDetail.operationalDetail.airportId	string	Indicates the airport identifier.
postalCode	output.transactionShipments.completedShipmentDetail.operationalDetail.postalCode	string	Specifies the postal code.
scac	output.transactionShipments.completedShipmentDetail.operationalDetail.scac	string	Indicates standard carrier alpha code.
deliveryDay	output.transactionShipments.completedShipmentDetail.operationalDetail.deliveryDay	string	Specifies expected/estimated day of week of the delivery.
originLocationId	output.transactionShipments.completedShipmentDetail.operationalDetail.originLocationId	string	This is the origin Location identifier.
countryCode	output.transactionShipments.completedShipmentDetail.operationalDetail.countryCode	string	Indicate the two-letter country code.
astraDescription	output.transactionShipments.completedShipmentDetail.operationalDetail.astraDescription	string	Specifies astra description.
originLocationNumber	output.transactionShipments.completedShipmentDetail.operationalDetail.originLocationNumber	integer	Specifies origin location number.
deliveryDate	output.transactionShipments.completedShipmentDetail.operationalDetail.deliveryDate	string	Specifies delivery date for the shipment.
deliveryEligibilities	output.transactionShipments.completedShipmentDetail.operationalDetail.deliveryEligibilities	array of string	FedEx Ground delivery features for which this shipment may be eligible.
ineligibleForMoneyBackGuarantee	output.transactionShipments.completedShipmentDetail.operationalDetail.ineligibleForMoneyBackGuarantee	boolean	Indicates that this shipment is not eligible for money back guarantee.
maximumTransitTime	output.transactionShipments.completedShipmentDetail.operationalDetail.maximumTransitTime	string	Maximum expected transit time.
destinationLocationStateOrProvinceCode	output.transactionShipments.completedShipmentDetail.operationalDetail.destinationLocationStateOrProvinceCode	string	This is the state or province code of the shipment destination location, and is not necessarily the same as the postal state.
astraPlannedServiceLevel	output.transactionShipments.completedShipmentDetail.operationalDetail.astraPlannedServiceLevel	string	Text describing planned delivery.
destinationLocationId	output.transactionShipments.completedShipmentDetail.operationalDetail.destinationLocationId	string	Specifies the FedEx Destination Location Identifier.
transitTime	output.transactionShipments.completedShipmentDetail.operationalDetail.transitTime	string	Standard transit time per origin, destination, and service.
stateOrProvinceCode	output.transactionShipments.completedShipmentDetail.operationalDetail.stateOrProvinceCode	string	This is a placeholder for State or Province code.
destinationLocationNumber	output.transactionShipments.completedShipmentDetail.operationalDetail.destinationLocationNumber	integer	Indicates destination location number.
packagingCode	output.transactionShipments.completedShipmentDetail.operationalDetail.packagingCode	string	Indicates packaging code.
commitDate	output.transactionShipments.completedShipmentDetail.operationalDetail.commitDate	string	This is committed date of delivery.
publishedDeliveryTime	output.transactionShipments.completedShipmentDetail.operationalDetail.publishedDeliveryTime	string	This is delivery time, as published in Service Guide.
ursaSuffixCode	output.transactionShipments.completedShipmentDetail.operationalDetail.ursaSuffixCode	string	This is ursa suffix code.
ursaPrefixCode	output.transactionShipments.completedShipmentDetail.operationalDetail.ursaPrefixCode	string	This is ursa prefix code.
destinationServiceArea	output.transactionShipments.completedShipmentDetail.operationalDetail.destinationServiceArea	string	Specifies destination service area.
commitDay	output.transactionShipments.completedShipmentDetail.operationalDetail.commitDay	string	Committed day of week of delivery.
customTransitTime	output.transactionShipments.completedShipmentDetail.operationalDetail.customTransitTime	string	Transit time based on customer eligibility.
carrierCode	output.transactionShipments.completedShipmentDetail.carrierCode	string	Specifies which carrier should be included.
holdingLocationType	output.transactionShipments.completedShipmentDetail.completedHoldAtLocationDetail.holdingLocationType	string	Indicates the type of the FedEx holding location.
address	output.transactionShipments.completedShipmentDetail.completedHoldAtLocationDetail.holdingLocation.address	Address_ship
personName	output.transactionShipments.completedShipmentDetail.completedHoldAtLocationDetail.holdingLocation.contact.personName	string	Specify person name.
tollFreePhoneNumber	output.transactionShipments.completedShipmentDetail.completedHoldAtLocationDetail.holdingLocation.contact.tollFreePhoneNumber	string	Specify toll free phone number.
emailAddress	output.transactionShipments.completedShipmentDetail.completedHoldAtLocationDetail.holdingLocation.contact.emailAddress	string	Specify email address.
phoneNumber	output.transactionShipments.completedShipmentDetail.completedHoldAtLocationDetail.holdingLocation.contact.phoneNumber	string	Specify phone number.
phoneExtension	output.transactionShipments.completedShipmentDetail.completedHoldAtLocationDetail.holdingLocation.contact.phoneExtension	string	Specify phone extension.
companyName	output.transactionShipments.completedShipmentDetail.completedHoldAtLocationDetail.holdingLocation.contact.companyName	string	Specify company name.
pagerNumber	output.transactionShipments.completedShipmentDetail.completedHoldAtLocationDetail.holdingLocation.contact.pagerNumber	string	Specify pager number.
faxNumber	output.transactionShipments.completedShipmentDetail.completedHoldAtLocationDetail.holdingLocation.contact.faxNumber	string	Specify fax number.
title	output.transactionShipments.completedShipmentDetail.completedHoldAtLocationDetail.holdingLocation.contact.title	string	Specify the title of the contact.
folderId	output.transactionShipments.completedShipmentDetail.completedEtdDetail.folderId	string	Returns the folder id where the documents is uploaded.
type	output.transactionShipments.completedShipmentDetail.completedEtdDetail.type	string	Returns the type of the document that is being uploaded.
uploadDocumentReferenceDetails	output.transactionShipments.completedShipmentDetail.completedEtdDetail.uploadDocumentReferenceDetails	array of object	Specify the document upload reference details.
documentType	output.transactionShipments.completedShipmentDetail.completedEtdDetail.uploadDocumentReferenceDetails.documentType	string	Specify document type for the uploaded document.
documentReference	output.transactionShipments.completedShipmentDetail.completedEtdDetail.uploadDocumentReferenceDetails.documentReference	string	Specify the reference for the uploaded document.
description	output.transactionShipments.completedShipmentDetail.completedEtdDetail.uploadDocumentReferenceDetails.description	string	Specify additional information about the uploaded document for better understanding.
documentId	output.transactionShipments.completedShipmentDetail.completedEtdDetail.uploadDocumentReferenceDetails.documentId	string	This is the uploaded document ID value.
packagingDescription	output.transactionShipments.completedShipmentDetail.packagingDescription	string	Specifies packaging description.
formId	output.transactionShipments.completedShipmentDetail.masterTrackingId.formId	string	This is FedEx tracking Identifier associated with the package.
trackingIdType	output.transactionShipments.completedShipmentDetail.masterTrackingId.trackingIdType	string	Specify the FedEx transportation type.
uspsApplicationId	output.transactionShipments.completedShipmentDetail.masterTrackingId.uspsApplicationId	string	Specify the USPS tracking Identifier associated with FedEx SmartPost shipment.
trackingNumber	output.transactionShipments.completedShipmentDetail.masterTrackingId.trackingNumber	string	This is a number associated with a package that is used to track it.
serviceType	output.transactionShipments.completedShipmentDetail.serviceDescription.serviceType	string	Indicate the FedEx serviceType used for this shipment.
code	output.transactionShipments.completedShipmentDetail.serviceDescription.code	string	Specifies code of the Service.
names	output.transactionShipments.completedShipmentDetail.serviceDescription.names	array of object	Branded, translated, and/or localized names for this service.
type	output.transactionShipments.completedShipmentDetail.serviceDescription.names.type	string	The type of name (long, medium, short, etc.) to which this value refers.
encoding	output.transactionShipments.completedShipmentDetail.serviceDescription.names.encoding	string	The character encoding used to represent this product name.
value	output.transactionShipments.completedShipmentDetail.serviceDescription.names.value	string	Specifies the value of the Product.
operatingOrgCodes	output.transactionShipments.completedShipmentDetail.serviceDescription.operatingOrgCodes	array of string	FOR FEDEX INTERNAL USE ONLY. The operating org code in a service.
astraDescription	output.transactionShipments.completedShipmentDetail.serviceDescription.astraDescription	string	Specifies astra Description.
description	output.transactionShipments.completedShipmentDetail.serviceDescription.description	string	Specifies the description.
serviceId	output.transactionShipments.completedShipmentDetail.serviceDescription.serviceId	string	FOR FEDEX INTERNAL USE ONLY, Designates the service ID.
serviceCategory	output.transactionShipments.completedShipmentDetail.serviceDescription.serviceCategory	string	FOR FEDEX INTERNAL USE ONLY. This is tied to the Product EFS interface definition.
usDomestic	output.transactionShipments.completedShipmentDetail.usDomestic	boolean	Indicates whether or not this is an intra-U.S. shipment.
smallQuantityExceptionPackageCount	output.transactionShipments.completedShipmentDetail.hazardousShipmentDetail.hazardousSummaryDetail.smallQuantityExceptionPackageCount	integer	Specifies the total number of packages containing hazardous commodities in small exceptions.
number	output.transactionShipments.completedShipmentDetail.hazardousShipmentDetail.adrLicense.licenseOrPermitDetail.number	string	Specifies license or permit detail number.
effectiveDate	output.transactionShipments.completedShipmentDetail.hazardousShipmentDetail.adrLicense.licenseOrPermitDetail.effectiveDate	string	Specifies the effective date of the license.
expirationDate	output.transactionShipments.completedShipmentDetail.hazardousShipmentDetail.adrLicense.licenseOrPermitDetail.expirationDate	string	Specifies the expiration date of the license.
totalWeight	output.transactionShipments.completedShipmentDetail.hazardousShipmentDetail.dryIceDetail.totalWeight	Weight	These are the package weight details.
packageCount	output.transactionShipments.completedShipmentDetail.hazardousShipmentDetail.dryIceDetail.packageCount	integer	Specifies the package Count for the shipment.
options	output.transactionShipments.completedShipmentDetail.hazardousShipmentDetail.dryIceDetail.processingOptions.options	array of string	Specifies the options.
actualRateType	output.transactionShipments.completedShipmentDetail.shipmentRating.actualRateType	string	This rate type identifies which entry in the following array is considered as presenting the actual rates for the shipment.
shipmentRateDetails	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails	array of object	Each element of this field provides shipment-level rate totals for a specific rate type.
rateZone	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.rateZone	string	Indicates the rate zone used (based on origin and destination)
ratedWeightMethod	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.ratedWeightMethod	string	Indicates which weight was used.
totalDutiesTaxesAndFees	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalDutiesTaxesAndFees	double	The total of the total duties & taxes and the total ancillary fees & taxes.
pricingCode	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.pricingCode	string	Specifies pricing Code.
totalFreightDiscounts	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalFreightDiscounts	double	The total discounts used in the rate calculation.
totalTaxes	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalTaxes	double	Total of the transportation-based taxes.
totalDutiesAndTaxes	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalDutiesAndTaxes	double	Total of all values under this shipment's duties and taxes; only provided if estimated duties and taxes were calculated for this shipment.
totalAncillaryFeesAndTaxes	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalAncillaryFeesAndTaxes	double	Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
taxes	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.taxes	array of Tax	All transportation-based taxes applicable to this shipment.
totalRebates	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalRebates	double	The total sum of all rebates applied to this shipment.
fuelSurchargePercent	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.fuelSurchargePercent	double	Specifies a fuel surcharge percentage.
currencyExchangeRate	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.currencyExchangeRate	CurrencyExchangeRate	Specifies the currency exchange performed on financial amounts on this rate.
totalNetFreight	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalNetFreight	float	The freight charge minus discounts.
totalNetFedExCharge	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalNetFedExCharge	float	This is the sum of shipment's total net freight, total surchages (not including totalTaxes).
shipmentLegRateDetails	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails	array of object	This is data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type.
rateZone	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.rateZone	string	Indicates the rate zone used (based on origin and destination).
pricingCode	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.pricingCode	string	Specifies the Pricing Code.
taxes	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.taxes	array of Tax	Specifies the taxes.
totalDimWeight	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalDimWeight	Weight	These are the package weight details.
totalRebates	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalRebates	double	Specifies the total rebate.
fuelSurchargePercent	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.fuelSurchargePercent	double	Specifies a fuel surcharge percentage.
currencyExchangeRate	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.currencyExchangeRate	CurrencyExchangeRate	Specifies the currency exchange performed on financial amounts on this rate.
dimDivisor	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.dimDivisor	integer	The value used to calculate the weight based on the dimensions.
rateType	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.rateType	string	Type used for this specific set of rate data.
legDestinationLocationId	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.legDestinationLocationId	string	Specifies the location id the destination of shipment leg.
dimDivisorType	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.dimDivisorType	string	Identifies the type of dim divisor that was applied.
totalBaseCharge	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalBaseCharge	double	The total freight charge that was calculated before surcharges, discounts and taxes.
ratedWeightMethod	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.ratedWeightMethod	string	Indicates which weight was used.
totalFreightDiscounts	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalFreightDiscounts	double	The sum of all discounts.
totalTaxes	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalTaxes	double	Total of the transportation-based taxes.
minimumChargeType	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.minimumChargeType	string	Specifies minimum charge type.
totalDutiesAndTaxes	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalDutiesAndTaxes	double	Total of shipments duties and taxes; only provided if estimated duties and taxes were calculated for this shipment.
totalNetFreight	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalNetFreight	double	The freight charge minus discounts.
totalNetFedExCharge	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalNetFedExCharge	double	This is the sum of shipment's total surcharges (not including total taxes).
surcharges	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.surcharges	array of object	All surcharges that apply to this shipment.
amount	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.surcharges.amount	double	This is the surcharge amount.
surchargeType	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.surcharges.surchargeType	string	This is the surcharge type.
level	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.surcharges.level	string	Specifies if the surcharge applies to the entire shipment, or to an individual package.
description	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.surcharges.description	string	Specifies the description for the surcharge.
totalSurcharges	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalSurcharges	double	The total amount of all surcharges applied to this shipment.
totalBillingWeight	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalBillingWeight	Weight	These are the package weight details.
freightDiscounts	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.freightDiscounts	array of object	Indicates the freight discounts.
amount	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.freightDiscounts.amount	double	Specifies the amount.
rateDiscountType	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.freightDiscounts.rateDiscountType	string	The type of rate discount.
percent	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.freightDiscounts.percent	double	Specifies the percentage of Rate discount.
description	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.freightDiscounts.description	string	Specifies the description of the discounted rate.
rateScale	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.rateScale	string	Indicates the rate scale used.
totalNetCharge	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalNetCharge	double	The net charge after applying all discounts and surcharges.
totalNetChargeWithDutiesAndTaxes	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.totalNetChargeWithDutiesAndTaxes	double	Sum of total net charge, total duties and taxes.
currency	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.shipmentLegRateDetails.currency	string	This is the currency code for the amount.
dimDivisor	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.dimDivisor	integer	The value used to calculate the weight based on the dimensions.
rateType	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.rateType	string	The Type used for this specific set of rate data.
surcharges	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.surcharges	array of object	All surcharges that apply to this shipment.
amount	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.surcharges.amount	double	This is the surcharge amount.
surchargeType	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.surcharges.surchargeType	string	This is the surcharge type.
level	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.surcharges.level	string	Specifies if the surcharge applies to the entire shipment, or to an individual package.
description	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.surcharges.description	string	Specifies the description for the surcharge.
totalSurcharges	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalSurcharges	double	The total amount of all surcharges applied to this shipment.
totalBillingWeight	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalBillingWeight	Weight	These are the package weight details.
freightDiscounts	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.freightDiscounts	array of object	Indicates the freight discounts.
amount	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.freightDiscounts.amount	double	Specifies the amount.
rateDiscountType	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.freightDiscounts.rateDiscountType	string	The type of rate discount.
percent	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.freightDiscounts.percent	double	Specifies the percentage of Rate discount.
description	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.freightDiscounts.description	string	Specifies the description of the discounted rate.
rateScale	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.rateScale	string	Indicates the rate scale used.
totalNetCharge	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalNetCharge	double	The net charge after applying all discounts and surcharges.
totalBaseCharge	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalBaseCharge	double	The total Shipment charge that was calculated before surcharges, discounts and taxes.
totalNetChargeWithDutiesAndTaxes	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.totalNetChargeWithDutiesAndTaxes	double	Sum of total net charge, total duties and taxes.
currency	output.transactionShipments.completedShipmentDetail.shipmentRating.shipmentRateDetails.currency	string	This is the currency code for the amount.
requiredDocuments	output.transactionShipments.completedShipmentDetail.documentRequirements.requiredDocuments	array of string	Indicates the required documents information.
prohibitedDocuments	output.transactionShipments.completedShipmentDetail.documentRequirements.prohibitedDocuments	array of string	Indicates the prohibited Documents info.
generationDetails	output.transactionShipments.completedShipmentDetail.documentRequirements.generationDetails	array of object	Specifies the generation details.
type	output.transactionShipments.completedShipmentDetail.documentRequirements.generationDetails.type	string	It is an Enterprise Document Type.
minimumCopiesRequired	output.transactionShipments.completedShipmentDetail.documentRequirements.generationDetails.minimumCopiesRequired	integer	It is a non-Negative Integer.
letterhead	output.transactionShipments.completedShipmentDetail.documentRequirements.generationDetails.letterhead	string	Indicates the letterhead requirement type.
electronicSignature	output.transactionShipments.completedShipmentDetail.documentRequirements.generationDetails.electronicSignature	string	Indicates electronic signature requirement type.
exportComplianceStatement	output.transactionShipments.completedShipmentDetail.exportComplianceStatement	string	Specifies export compliance Statement.
accessorDetails	output.transactionShipments.completedShipmentDetail.accessDetail.accessorDetails	array of object	Indicates the details about the users who can access the shipment.
password	output.transactionShipments.completedShipmentDetail.accessDetail.accessorDetails.password	string	Specifies the accessor password.
role	output.transactionShipments.completedShipmentDetail.accessDetail.accessorDetails.role	string	Specifies the accessor role.
emailLabelUrl	output.transactionShipments.completedShipmentDetail.accessDetail.accessorDetails.emailLabelUrl	string	Specifies the URL for the email label.
userId	output.transactionShipments.completedShipmentDetail.accessDetail.accessorDetails.userId	string	Specifies the accessor User ID.
commodityClarifications	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.commodityClarifications	array of object	Indicates the Commodity clarifications.
commodityIndex	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.commodityClarifications.commodityIndex	integer	This is a index identifying the commodity in the request that resulted in this COMMODITY or DOCUMENT type prohibition.
suggestions	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.commodityClarifications.suggestions	array of object	These are suggested commodity details.
description	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.commodityClarifications.suggestions.description	string	This is a suggested commodity description.
harmonizedCode	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.commodityClarifications.suggestions.harmonizedCode	string	Specify the harmonized code.
prohibitions	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.prohibitions	array of object	It is regulatory probitions.
derivedHarmonizedCode	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.prohibitions.derivedHarmonizedCode	string	Indicates the derived harmonized code value.
advisory	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.prohibitions.advisory	Message	Specifies the advisory details.
commodityIndex	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.prohibitions.commodityIndex	integer	Indicates one based index identifying the associated commodity.
source	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.prohibitions.source	string	Indicates the prohibition source type.
categories	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.prohibitions.categories	array of string	Indicate the shipment rule type.
type	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.prohibitions.type	string	Indicates the prohibition type.
advisories	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.prohibitions.waiver.advisories	array of Message	Indicates the advisories list.
description	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.prohibitions.waiver.description	string	Indicates the regulatory prohibitions description.
id	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.prohibitions.waiver.id	string	Indicates the prohibitory ID.
status	output.transactionShipments.shipmentAdvisoryDetails.regulatoryAdvisory.prohibitions.status	string	Indicates the prohibitory status.
masterTrackingNumber	output.transactionShipments.masterTrackingNumber	string	This is a master tracking number for the shipment.
alerts	output.alerts	array of Alert	Indicates API Alerts includes alert type, alert code, and alert message that is received when the address is resolved.
jobId	output.jobId	string	Unique identifier for a Job.

Find Locations

Operation ID:: FindLocations

Use this endpoint to search for nearest FedEx locations by address, geographic coordinates, or phone number.

Parameters

Name	Key	Required	Type	Description
Customer Transaction Id	x-customer-transaction-id		string	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.
Locale	x-locale		string	This indicates the combination of language code and country code.

Returns

Name	Path	Type	Description
transactionId	transactionId	string	The transaction ID is a special set of numbers that defines each transaction.
customerTransactionId	customerTransactionId	string	This transaction ID helps you match the request to the reply.
totalResults	output.totalResults	integer	Indicates the total number of locations that are displayed in the result.
resultsReturned	output.resultsReturned	integer	Specifies the number of results returned in the reply.
matchedAddress	output.matchedAddress	Address
matchedAddressGeoCoord	output.matchedAddressGeoCoord	GeoPositionalCoordinates	The ISO6709GeographicCoordinates for a specific geographic location.
locationDetailList	output.locationDetailList	array of LocationDetail	List of FedEx locations meeting the search criteria.
alerts	output.alerts	array of Alert	Specifies the alerts.
nearestLocation	output.nearestLocation	LocationDetail
latestLocation	output.latestLocation	LocationDetail
ambiguousAddress	output.ambiguousAddress	array of LocationDetail	Indicates the values for ambiguous address details.
ambiguousLocationsReturned	output.ambiguousLocationsReturned	boolean	Indicates whether value for ambigous locations were returned or not.
nearestLocationReturned	output.nearestLocationReturned	boolean	Indicates whether value for nearest locations were returned or not.
latestLocationReturned	output.latestLocationReturned	boolean	Indicates whether value for latest locations were returned or not.
lockerAvailabilityCode	output.lockerAvailabilityCode	integer	Code for locker availability.
lockerAvailabilityMessage	output.lockerAvailabilityMessage	string	Message for locker availability.
address	output.location.address	Address
latitude	output.location.longLat.latitude	string	The geo coordinate value that specifies the north-south position of the address.
longitude	output.location.longLat.longitude	string	The geo coordinate value that specifies the East-West position of the address.
phoneNumber	output.phoneNumber	string	Specify the phone number If the locationSearchCriterion is set to 'PHONE_NUMBER'.
multipleMatchesAction	output.multipleMatchesAction	string	Specify the criterion to be used to return location results when there are multiple matches.
criteria	output.sort.criteria	string	Specify the criteria to sort the location details.
order	output.sort.order	string	Specify the sort order of the location search results.
uniqueTrackingId	output.trackingInfo.uniqueTrackingId	string	A unique tracking number identifying a shipment.
trackingNumber	output.trackingInfo.trackingNumber	string	A tracking number identifying a shipment.
shipDate	output.trackingInfo.shipDate	string	The date of shipment.
sameState	output.sameState	boolean	Filter to display locations within the same state as the search criteria.
sameCountry	output.sameCountry	boolean	Filter to display locations within the same country as the search criteria.
redirectToHoldType	output.redirectToHoldType	string	Specify the type of service supported by a FedEx location for redirect to hold.
locationAttrTypes	output.locationAttrTypes	array of string	Indicates the attributes for the location.
locationCapabilities	output.locationCapabilities	array of LocationCapabilities	Any required location supported package constraints to narrow the search.
packageMaximumLimits	output.packageMaximumLimits	array of PackageMaximumLimits	Any required location supported package constraints to narrow the search.
locationTypes	output.locationTypes	array of string	Results filter which narrows the search to specific types of FedEx Locations.
includeHoliday	output.includeHoliday	boolean	Indicates true if the location holiday list is desired in the results.
dropoffTime	output.dropoffTime	string	Specifies the latest time by which you can drop-off a package at a location to process the shipment the same day.
includeDropoffTime	output.includeDropoffTime	boolean	Specify if the location drop-off time must be included in the results.
dropOffServiceType	output.dropOffServiceType	string	The drop-off service types supported by the specified location.
searchBy	output.searchBy	string	Location search based on searchBy.
contentOptions	output.contentOptions	string	Location content options.
carrierCodes	output.carrierCodes	array of string	Unique code to identify the transporter.
getCall	output.getCall	boolean	Get a call.

Retrieve Rate Quotes

Operation ID:: RetrieveRateQuotes

Use this endpoint to retrieve rate quotes and optional transit information. The rate is calculated based on the origin and destination of the shipments.

Parameters

Name	Key	Required	Type	Description
Customer Transaction Id	x-customer-transaction-id		string	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.
Locale	x-locale		string	This indicates the combination of language code and country code.

Returns

Name	Path	Type	Description
customerTransactionId	customerTransactionId	string	This element has a unique identifier added in your request, helps you match the request to the reply
alerts	output.alerts	array of Alert	The alert code, alert type, and alert message obtained when a rate quote is requested.
encoded	output.encoded	boolean	Specifies the encoded form of the rate.
quoteDate	output.quoteDate	string	The date on which the rate is quoted.
rateReplyDetails	output.rateReplyDetails	array of object	This object will hold the rate and shipment data returned for a request.
brokerDetail	output.rateReplyDetails.brokerDetail	object	These are Broker Detail for the rate quote.
commit	output.rateReplyDetails.commit	object	Specifies the delivery commitment details.
customerMessages	output.rateReplyDetails.customerMessages	array of object	These are messages concerning the ability to provide an accurate delivery commitment on an International commit quote.
code	output.rateReplyDetails.customerMessages.code	string	This is a message code.
message	output.rateReplyDetails.customerMessages.message	string	This is a message description.
MaximumTransitTime	output.rateReplyDetails.operationalDetail.MaximumTransitTime	string	Specify Maximum transit time.
airportId	output.rateReplyDetails.operationalDetail.airportId	string	Specify the Airport Id.
astraDescription	output.rateReplyDetails.operationalDetail.astraDescription	string	Indicate the ASTRA description for the label.
astraPlannedServiceLevel	output.rateReplyDetails.operationalDetail.astraPlannedServiceLevel	string	Indicate Astra Planned Service Level.
commitDate	output.rateReplyDetails.operationalDetail.commitDate	string	Indicate the shipment Commit Date.
commitDays	output.rateReplyDetails.operationalDetail.commitDays	array of string	Indicate the delivery commitment day.
countryCodes	output.rateReplyDetails.operationalDetail.countryCodes	array of string	Indicate the Country Code.
customTransitTime	output.rateReplyDetails.operationalDetail.customTransitTime	string	This is Custom Transit Time in days.
deliveryDate	output.rateReplyDetails.operationalDetail.deliveryDate	string	Indicate the delivery date.
deliveryDay	output.rateReplyDetails.operationalDetail.deliveryDay	string	Specify the delivery commitment day.
deliveryEligibilities	output.rateReplyDetails.operationalDetail.deliveryEligibilities	array of string	Indicate the delivery eligibilities.
destinationLocationIds	output.rateReplyDetails.operationalDetail.destinationLocationIds	array of string	Indicate Destination Location Ids. Example: HKAA
destinationLocationNumbers	output.rateReplyDetails.operationalDetail.destinationLocationNumbers	array of integer	Indicate the Destination Location Numbers.
destinationLocationStateOrProvinceCodes	output.rateReplyDetails.operationalDetail.destinationLocationStateOrProvinceCodes	array of string	Indicate destination location State Or Province code.
destinationPostalCode	output.rateReplyDetails.operationalDetail.destinationPostalCode	string	Indicate the destination postal code.
destinationServiceAreas	output.rateReplyDetails.operationalDetail.destinationServiceAreas	array of string	This is Destination Service Areas.
ineligibleForMoneyBackGuarantee	output.rateReplyDetails.operationalDetail.ineligibleForMoneyBackGuarantee	boolean	indicate if ineligible For Money Back Guarantee.
originLocationIds	output.rateReplyDetails.operationalDetail.originLocationIds	array of string	Indicate the location ID of the origin of shipment.
originLocationNumbers	output.rateReplyDetails.operationalDetail.originLocationNumbers	array of integer	Specify the origin location ID.
originPostalCodes	output.rateReplyDetails.operationalDetail.originPostalCodes	array of string	This is Origin Postal Codes.
originServiceAreas	output.rateReplyDetails.operationalDetail.originServiceAreas	array of string	Specify origin service area.
packagingCode	output.rateReplyDetails.operationalDetail.packagingCode	string	Indicate the Packaging Code.
publishedDeliveryTime	output.rateReplyDetails.operationalDetail.publishedDeliveryTime	string	Indicate the Published Delivery Time.
scac	output.rateReplyDetails.operationalDetail.scac	string	Indicate the Standard Carrier Alpha Code (SCAC).
serviceCode	output.rateReplyDetails.operationalDetail.serviceCode	string	Indicate the service code.
stateOrProvinceCodes	output.rateReplyDetails.operationalDetail.stateOrProvinceCodes	array of string	Specify the state Or Province Code.
transitTime	output.rateReplyDetails.operationalDetail.transitTime	string	Indicate the Transit Time in days.
ursaPrefixCode	output.rateReplyDetails.operationalDetail.ursaPrefixCode	string	This is FedEx URSA Prefix Code.
ursaSuffixCode	output.rateReplyDetails.operationalDetail.ursaSuffixCode	string	This is URSA Suffix Code.
packagingType	output.rateReplyDetails.packagingType	string	This is the Packaging type.
ratedShipmentDetails	output.rateReplyDetails.ratedShipmentDetails	array of object	This provides the shipment and package rating data in a rate request reply.
ancillaryFeesAndTaxes	output.rateReplyDetails.ratedShipmentDetails.ancillaryFeesAndTaxes	array of object	This is the total amount of the shipment-level fees and taxes that are not based on transportation charges of commodity-level estimated duties and taxes.
amount	output.rateReplyDetails.ratedShipmentDetails.ancillaryFeesAndTaxes.amount	double	Specifies the list of ancillary fees And Taxes
description	output.rateReplyDetails.ratedShipmentDetails.ancillaryFeesAndTaxes.description	string	Identifies the amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
type	output.rateReplyDetails.ratedShipmentDetails.ancillaryFeesAndTaxes.type	string	Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
edtCharges	output.rateReplyDetails.ratedShipmentDetails.edtCharges	array of object	These are the estimation and duty charges.
items	output.rateReplyDetails.ratedShipmentDetails.edtCharges	object
freightChargeBasis	output.rateReplyDetails.ratedShipmentDetails.freightChargeBasis	string	This identifies the manner in which the chargeRate was applied.
preferredEdtCharges	output.rateReplyDetails.ratedShipmentDetails.preferredEdtCharges	array of object	Specifies the Edt charges.
items	output.rateReplyDetails.ratedShipmentDetails.preferredEdtCharges	object
quoteNumber	output.rateReplyDetails.ratedShipmentDetails.quoteNumber	string	Indicates the unique identifier for a specific rate quotation.
rateType	output.rateReplyDetails.ratedShipmentDetails.rateType	string	Indicates the rate type used for this rate data.
ratedPackages	output.rateReplyDetails.ratedShipmentDetails.ratedPackages	array of object	These are the package-level data for this rate type.
items	output.rateReplyDetails.ratedShipmentDetails.ratedPackages	object
ratedWeightMethod	output.rateReplyDetails.ratedShipmentDetails.ratedWeightMethod	string	Indicates the weight type used for the rate.
shipmentLegRateDetails	output.rateReplyDetails.ratedShipmentDetails.shipmentLegRateDetails	array of object	This is data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type.
items	output.rateReplyDetails.ratedShipmentDetails.shipmentLegRateDetails	object
shipmentRateDetail	output.rateReplyDetails.ratedShipmentDetails.shipmentRateDetail	object	This is shipment level rate data.
totalAncillaryFeesAndTaxes	output.rateReplyDetails.ratedShipmentDetails.totalAncillaryFeesAndTaxes	double	Indicates the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
totalBaseCharge	output.rateReplyDetails.ratedShipmentDetails.totalBaseCharge	double	This is total base charges for the shipment.
totalDiscounts	output.rateReplyDetails.ratedShipmentDetails.totalDiscounts	double	This is the total discount.
totalDutiesAndTaxes	output.rateReplyDetails.ratedShipmentDetails.totalDutiesAndTaxes	double	The total of shipment/package Duties and taxes.
totalDutiesTaxesAndFees	output.rateReplyDetails.ratedShipmentDetails.totalDutiesTaxesAndFees	double	This is the total amount of the duties and taxes plus the total ancillary fees and taxes.
totalNetCharge	output.rateReplyDetails.ratedShipmentDetails.totalNetCharge	double	This is net charges for the shipment.
totalNetChargeWithDutiesAndTaxes	output.rateReplyDetails.ratedShipmentDetails.totalNetChargeWithDutiesAndTaxes	double	This is total net Charges with Duties And Taxes for the shipment.
totalNetFedExCharge	output.rateReplyDetails.ratedShipmentDetails.totalNetFedExCharge	double	This shipment's totalNetFedExChargeList, which is totalNetFreight plus totalSurcharges (not including totalTaxes).
totalVariableHandlingCharges	output.rateReplyDetails.ratedShipmentDetails.totalVariableHandlingCharges	object	The variable handling charge amount calculated based on the requested variable handling charge detail.
totalVatCharge	output.rateReplyDetails.ratedShipmentDetails.totalVatCharge	double	This is total value added tax charges (VAT).
variableHandlingCharges	output.rateReplyDetails.ratedShipmentDetails.variableHandlingCharges	object	The variable handling charge amount calculated based on the requested variable handling charge detail.
serviceDescription	output.rateReplyDetails.serviceDescription	object	Indicates the Service Description details.
serviceName	output.rateReplyDetails.serviceName	string	This is the service name associated with this rate.
smartPostIndiciaType	output.rateReplyDetails.serviceSubOptionDetail.smartPostIndiciaType	string	This identifies the indicia used during rate quote.
serviceType	output.rateReplyDetails.serviceType	string	This is the service type associated with this rate.
signatureOptionType	output.rateReplyDetails.signatureOptionType	string	Indicates the signature Option for this service.
transactionId	transactionId	string	The transaction ID is a special set of numbers that defines each transaction. Example: 624deea6-b709-470c-8c39-4b5511281492

Track by Tracking Number

Operation ID:: TrackByTrackingNumber

Use this endpoint to track customers package information based on a tracking number for various shipping services.

Parameters

Name	Key	Required	Type	Description
Customer Transaction Id	x-customer-transaction-id		string	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.
Locale	x-locale		string	This indicates the combination of language code and country code.

Returns

Name	Path	Type	Description
transactionId	transactionId	string	Unique identifier returned in the reply and helps you match the request to the reply.
customerTransactionId	customerTransactionId	string	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.
completeTrackResults	output.completeTrackResults	array of object	Contains detailed tracking entry information.
trackingNumber	output.completeTrackResults.trackingNumber	string	A tracking number to identify a package.
trackResults	output.completeTrackResults.trackResults	array of object	An array of detailed tracking information for the requested packages(s).
trackingNumber	output.completeTrackResults.trackResults.trackingNumberInfo.trackingNumber	string	This is a Tracking number for FedEx packages used for tracking a single package or group of packages.
carrierCode	output.completeTrackResults.trackResults.trackingNumberInfo.carrierCode	string	This is a placeholder to provide the FedEx operating company (transportation) code used for package delivery.
trackingNumberUniqueId	output.completeTrackResults.trackResults.trackingNumberInfo.trackingNumberUniqueId	string	Unique identifier used to distinguish duplicate FedEx tracking numbers. This value will be set by FedEx systems.
hasAssociatedShipments	output.completeTrackResults.trackResults.additionalTrackingInfo.hasAssociatedShipments	boolean	Field which indicates if the current shipment has associated shipments.
nickname	output.completeTrackResults.trackResults.additionalTrackingInfo.nickname	string	Field which holds information about nickname of the shipment.
packageIdentifiers	output.completeTrackResults.trackResults.additionalTrackingInfo.packageIdentifiers	array of object	Other related identifiers for this package.
type	output.completeTrackResults.trackResults.additionalTrackingInfo.packageIdentifiers.type	string	Indicate the package identifier to identify the package.
value	output.completeTrackResults.trackResults.additionalTrackingInfo.packageIdentifiers.value	string	Field which holds the value of the identifier used to identify the package.
trackingNumberUniqueId	output.completeTrackResults.trackResults.additionalTrackingInfo.packageIdentifiers.trackingNumberUniqueId	string	Unique identifier used to distinguish duplicate FedEx tracking numbers.
shipmentNotes	output.completeTrackResults.trackResults.additionalTrackingInfo.shipmentNotes	string	Field which holds customer assigned notes for a package.
units	output.completeTrackResults.trackResults.distanceToDestination.units	string	Field which holds the distance unit type.
value	output.completeTrackResults.trackResults.distanceToDestination.value	double	Field which holds the value for the distance.
consolidationDetail	output.completeTrackResults.trackResults.consolidationDetail	array of object	Indicates the consolidation details.
timeStamp	output.completeTrackResults.trackResults.consolidationDetail.timeStamp	string	The timestamp for the consolidation.
consolidationID	output.completeTrackResults.trackResults.consolidationDetail.consolidationID	string	The identifier for the consolidation.
reasonDetail	output.completeTrackResults.trackResults.consolidationDetail.reasonDetail	ReasonDetail	This object contains reason description and type.
packageCount	output.completeTrackResults.trackResults.consolidationDetail.packageCount	integer	Specifies the package count for the consolidation.
eventType	output.completeTrackResults.trackResults.consolidationDetail.eventType	string	Specifies the consolidation event type for a package.
meterNumber	output.completeTrackResults.trackResults.meterNumber	string	The associated meter number for your FedEx account number.
authorizationName	output.completeTrackResults.trackResults.returnDetail.authorizationName	string	Name of person authorizing the return, entered by the customer.
reasonDetail	output.completeTrackResults.trackResults.returnDetail.reasonDetail	array of ReasonDetail	Specifies the return reason details.
description	output.completeTrackResults.trackResults.serviceDetail.description	string	Field which holds the text description of the service type of this package.
shortDescription	output.completeTrackResults.trackResults.serviceDetail.shortDescription	string	Field which holds the abbreviated text description of the service type of this package.
type	output.completeTrackResults.trackResults.serviceDetail.type	string	This is the service type.
locationId	output.completeTrackResults.trackResults.destinationLocation.locationId	string	Location Identification for facilities identified by an alpha numeric location code.
contact	output.completeTrackResults.trackResults.destinationLocation.locationContactAndAddress.contact	Contact	Indicate the contact details for this package.
address	output.completeTrackResults.trackResults.destinationLocation.locationContactAndAddress.address	Address_track_1	Descriptive data for a physical location.
locationType	output.completeTrackResults.trackResults.destinationLocation.locationType	string	The FedEx Location Type.
scanLocation	output.completeTrackResults.trackResults.latestStatusDetail.scanLocation	Address_track
code	output.completeTrackResults.trackResults.latestStatusDetail.code	string	A code that identifies this type of status.
derivedCode	output.completeTrackResults.trackResults.latestStatusDetail.derivedCode	string	This is the latest tracking derived code.
ancillaryDetails	output.completeTrackResults.trackResults.latestStatusDetail.ancillaryDetails	array of object	Specifies the cause of exception along with any action that needs to taken by customer.
reason	output.completeTrackResults.trackResults.latestStatusDetail.ancillaryDetails.reason	string	Field which holds Reason code associated to the status of the shipment being tracked.
reasonDescription	output.completeTrackResults.trackResults.latestStatusDetail.ancillaryDetails.reasonDescription	string	Field which holds Reason description associated to the status of the shipment being tracked.
action	output.completeTrackResults.trackResults.latestStatusDetail.ancillaryDetails.action	string	Field which holds recommended action for customer to resolve reason.
actionDescription	output.completeTrackResults.trackResults.latestStatusDetail.ancillaryDetails.actionDescription	string	actionDescription
statusByLocale	output.completeTrackResults.trackResults.latestStatusDetail.statusByLocale	string	This is the latest tracking status by locale.
description	output.completeTrackResults.trackResults.latestStatusDetail.description	string	A human-readable description of this status.
type	output.completeTrackResults.trackResults.latestStatusDetail.delayDetail.type	string	Specifies the type of delay.
subType	output.completeTrackResults.trackResults.latestStatusDetail.delayDetail.subType	string	Specifies the subType of delay.
status	output.completeTrackResults.trackResults.latestStatusDetail.delayDetail.status	string	Specifies the status of package indicating whether a package is arriving early or is on time or has been delayed.
message	output.completeTrackResults.trackResults.serviceCommitMessage.message	string	Field which holds the commitment message for this package.
type	output.completeTrackResults.trackResults.serviceCommitMessage.type	string	Field which holds the type of service commit message.
informationNotes	output.completeTrackResults.trackResults.informationNotes	array of object	Notifications to the end user that provide additional information relevant to the tracked shipment.
code	output.completeTrackResults.trackResults.informationNotes.code	string	Field which holds the code that designates the type of informational message being returned.
description	output.completeTrackResults.trackResults.informationNotes.description	string	Field which holds the The informational message in human readable form.
code	output.completeTrackResults.trackResults.error.code	string	Error Code.
parameterList	output.completeTrackResults.trackResults.error.parameterList	array of object	List of parameters.
value	output.completeTrackResults.trackResults.error.parameterList.value	string	Identifies the error option to be applied.
key	output.completeTrackResults.trackResults.error.parameterList.key	string	Indicates the value associated with the key.
message	output.completeTrackResults.trackResults.error.message	string	Error Message.
specialHandlings	output.completeTrackResults.trackResults.specialHandlings	array of object	Specify types of special handlings that are applied to this package.
description	output.completeTrackResults.trackResults.specialHandlings.description	string	Field which holds the text description of the special handling code.
type	output.completeTrackResults.trackResults.specialHandlings.type	string	Field which holds type representing the special handling.
paymentType	output.completeTrackResults.trackResults.specialHandlings.paymentType	string	Field which holds information about the payment handling related to the special handling.
availableImages	output.completeTrackResults.trackResults.availableImages	array of object	The available tracking documents for the shipment being tracked.
size	output.completeTrackResults.trackResults.availableImages.size	string	Field which holds the size of available images for the shipment being tracked.
type	output.completeTrackResults.trackResults.availableImages.type	string	Field which holds the type of available images for the shipment being tracked.
receivedByName	output.completeTrackResults.trackResults.deliveryDetails.receivedByName	string	Field which holds the name of the person who received the package, if applicable.
destinationServiceArea	output.completeTrackResults.trackResults.deliveryDetails.destinationServiceArea	string	Field which holds the destination service area code.
destinationServiceAreaDescription	output.completeTrackResults.trackResults.deliveryDetails.destinationServiceAreaDescription	string	Field which holds the description corresponding to the destination service area.
locationDescription	output.completeTrackResults.trackResults.deliveryDetails.locationDescription	string	Field which holds the FedEx location description for the package destination.
actualDeliveryAddress	output.completeTrackResults.trackResults.deliveryDetails.actualDeliveryAddress	Address_track
deliveryToday	output.completeTrackResults.trackResults.deliveryDetails.deliveryToday	boolean	This element indicates whether the package will be delivered today.
locationType	output.completeTrackResults.trackResults.deliveryDetails.locationType	string	Field which holds the FedEx location type code for the package destination.
signedByName	output.completeTrackResults.trackResults.deliveryDetails.signedByName	string	Field which holds the name of the person who signed for the package, if applicable.
officeOrderDeliveryMethod	output.completeTrackResults.trackResults.deliveryDetails.officeOrderDeliveryMethod	string	Field which identifies the method of office order delivery.
deliveryAttempts	output.completeTrackResults.trackResults.deliveryDetails.deliveryAttempts	string	Field which holds the number of delivery attempts made to deliver the package.
deliveryOptionEligibilityDetails	output.completeTrackResults.trackResults.deliveryDetails.deliveryOptionEligibilityDetails	array of object	Specifies eligibility type for the different delivery option.
option	output.completeTrackResults.trackResults.deliveryDetails.deliveryOptionEligibilityDetails.option	string	This is the type of delivery option.
eligibility	output.completeTrackResults.trackResults.deliveryDetails.deliveryOptionEligibilityDetails.eligibility	string	Eligibility of the customer for the specific delivery options.
scanEvents	output.completeTrackResults.trackResults.scanEvents	array of object	FedEx scan event information for a shipment. Includes the list of events and/or scans applied.
date	output.completeTrackResults.trackResults.scanEvents.date	string	Date and time of the scan event.
derivedStatus	output.completeTrackResults.trackResults.scanEvents.derivedStatus	string	Field which holds status description of the track information for the scan event.
locationId	output.completeTrackResults.trackResults.scanEvents.scanLocation.locationId	string	Location Identification for facilities identified by an alpha numeric location code.
contact	output.completeTrackResults.trackResults.scanEvents.scanLocation.locationContactAndAddress.contact	Contact	Indicate the contact details for this package.
address	output.completeTrackResults.trackResults.scanEvents.scanLocation.locationContactAndAddress.address	Address_track_1	Descriptive data for a physical location.
locationType	output.completeTrackResults.trackResults.scanEvents.scanLocation.locationType	string	locationType
exceptionDescription	output.completeTrackResults.trackResults.scanEvents.exceptionDescription	string	Field which holds the text description for the exception if the event was an exception.
eventDescription	output.completeTrackResults.trackResults.scanEvents.eventDescription	string	Field which holds the text description of the scan event.
eventType	output.completeTrackResults.trackResults.scanEvents.eventType	string	Field which holds the code identifying the type of scan event.
derivedStatusCode	output.completeTrackResults.trackResults.scanEvents.derivedStatusCode	string	Field which holds status code of the track information for the scan event.
exceptionCode	output.completeTrackResults.trackResults.scanEvents.exceptionCode	string	Field which holds the code identifier for the exception if the event was an exception.
type	output.completeTrackResults.trackResults.scanEvents.delayDetail.type	string	Specifies the type of delay.
subType	output.completeTrackResults.trackResults.scanEvents.delayDetail.subType	string	Specifies the subType of delay.
status	output.completeTrackResults.trackResults.scanEvents.delayDetail.status	string	Specifies the status of package indicating whether a package is arriving early or is on time or has been delayed.
dateAndTimes	output.completeTrackResults.trackResults.dateAndTimes	array of object	Date and time information for the tracked shipment.
dateTime	output.completeTrackResults.trackResults.dateAndTimes.dateTime	string	Field which holds the tracking date or timestamp in ISO format.
type	output.completeTrackResults.trackResults.dateAndTimes.type	string	Field which holds information about the type of tracking date or timestamp.
physicalPackagingType	output.completeTrackResults.trackResults.packageDetails.physicalPackagingType	string	Indicate the physical package type for non-Express shipments.
sequenceNumber	output.completeTrackResults.trackResults.packageDetails.sequenceNumber	string	Field which holds the number representing which package in a multi-piece shipment applies to this TrackDetail.
undeliveredCount	output.completeTrackResults.trackResults.packageDetails.undeliveredCount	string	Field which holds information about total count of the undelivered packages in the shipment.
description	output.completeTrackResults.trackResults.packageDetails.packagingDescription.description	string	Indicate the packaging type description.
type	output.completeTrackResults.trackResults.packageDetails.packagingDescription.type	string	Indicate the packaging type.
count	output.completeTrackResults.trackResults.packageDetails.count	string	Field which holds the total number of pieces in the shipment which includes the package represented by this TrackDetail.
weight	output.completeTrackResults.trackResults.packageDetails.weightAndDimensions.weight	array of object	Field which holds the weight of the package.
unit	output.completeTrackResults.trackResults.packageDetails.weightAndDimensions.weight.unit	string	This is package weight type.
value	output.completeTrackResults.trackResults.packageDetails.weightAndDimensions.weight.value	string	This is package weight.
dimensions	output.completeTrackResults.trackResults.packageDetails.weightAndDimensions.dimensions	array of object	Indicate the dimensions of the package.
length	output.completeTrackResults.trackResults.packageDetails.weightAndDimensions.dimensions.length	integer	Indicate the length of the package.
width	output.completeTrackResults.trackResults.packageDetails.weightAndDimensions.dimensions.width	integer	Indicate the width of the package.
height	output.completeTrackResults.trackResults.packageDetails.weightAndDimensions.dimensions.height	integer	Indicate the height of the package.
units	output.completeTrackResults.trackResults.packageDetails.weightAndDimensions.dimensions.units	string	Unit of measure for the provided dimensions.
packageContent	output.completeTrackResults.trackResults.packageDetails.packageContent	array of string	Field which holds information about the package content of the shipment.
contentPieceCount	output.completeTrackResults.trackResults.packageDetails.contentPieceCount	string	Field which holds information about total count of the packages in the shipment.
currency	output.completeTrackResults.trackResults.packageDetails.declaredValue.currency	string	Indicate the currency code.
value	output.completeTrackResults.trackResults.packageDetails.declaredValue.value	double	Field which holds the amount value.
goodsClassificationCode	output.completeTrackResults.trackResults.goodsClassificationCode	string	Classification codes for the goods in package.
locationId	output.completeTrackResults.trackResults.holdAtLocation.locationId	string	Location Identification for facilities identified by an alpha numeric location code.
contact	output.completeTrackResults.trackResults.holdAtLocation.locationContactAndAddress.contact	Contact	Indicate the contact details for this package.
address	output.completeTrackResults.trackResults.holdAtLocation.locationContactAndAddress.address	Address_track
locationType	output.completeTrackResults.trackResults.holdAtLocation.locationType	string	The FedEx Location Type.
customDeliveryOptions	output.completeTrackResults.trackResults.customDeliveryOptions	array of object	List of delivery options that can be used to customize the delivery of the package.
date	output.completeTrackResults.trackResults.customDeliveryOptions.requestedAppointmentDetail.date	string	Field which holds the requested appointment date.
window	output.completeTrackResults.trackResults.customDeliveryOptions.requestedAppointmentDetail.window	array of TimeWindow	Array of different appointment time windows available on the date specified such as, Morning, afternoon, mid-day.
description	output.completeTrackResults.trackResults.customDeliveryOptions.description	string	Field which specifies the description of the custom delivery option requested.
type	output.completeTrackResults.trackResults.customDeliveryOptions.type	string	Field which specifies the type of the custom delivery option requested.
status	output.completeTrackResults.trackResults.customDeliveryOptions.status	string	Field which specifies the status of the custom delivery option requested.
estimatedDeliveryTimeWindow	output.completeTrackResults.trackResults.estimatedDeliveryTimeWindow	TimeWindow	Time window details.
pieceCounts	output.completeTrackResults.trackResults.pieceCounts	array of object	Piece count information at origin and destination.
count	output.completeTrackResults.trackResults.pieceCounts.count	string	Field which holds the piece count.
description	output.completeTrackResults.trackResults.pieceCounts.description	string	Field which holds the piece count description detail.
type	output.completeTrackResults.trackResults.pieceCounts.type	string	Field which holds the piece count location type.
locationId	output.completeTrackResults.trackResults.originLocation.locationId	string	Location Identification for facilities identified by an alpha numeric location code.
contact	output.completeTrackResults.trackResults.originLocation.locationContactAndAddress.contact	Contact	Indicate the contact details for this package.
address	output.completeTrackResults.trackResults.originLocation.locationContactAndAddress.address	Address_track_1	Descriptive data for a physical location.
locationType	output.completeTrackResults.trackResults.originLocation.locationType	string	The FedEx Location Type.
contact	output.completeTrackResults.trackResults.recipientInformation.contact	Contact	Indicate the contact details for this package.
address	output.completeTrackResults.trackResults.recipientInformation.address	Address_track
standardTransitTimeWindow	output.completeTrackResults.trackResults.standardTransitTimeWindow	TimeWindow	Time window details.
contents	output.completeTrackResults.trackResults.shipmentDetails.contents	array of object	Field which holds information about contents of the shipment.
itemNumber	output.completeTrackResults.trackResults.shipmentDetails.contents.itemNumber	string	Field holds the item number for the contents of shipment.
receivedQuantity	output.completeTrackResults.trackResults.shipmentDetails.contents.receivedQuantity	string	Field which holds information about the quantity received.
description	output.completeTrackResults.trackResults.shipmentDetails.contents.description	string	Field which holds informative description about shipment content.
partNumber	output.completeTrackResults.trackResults.shipmentDetails.contents.partNumber	string	Holds the part number of the content in shipment.
beforePossessionStatus	output.completeTrackResults.trackResults.shipmentDetails.beforePossessionStatus	boolean	Indicates the shipment is not yet in FedEx possession, but is still in shipper's possession.
weight	output.completeTrackResults.trackResults.shipmentDetails.weight	array of object	Array of package level weights, which represent the total weight of the shipment.
unit	output.completeTrackResults.trackResults.shipmentDetails.weight.unit	string	This is package weight type.
value	output.completeTrackResults.trackResults.shipmentDetails.weight.value	string	This is package weight.
contentPieceCount	output.completeTrackResults.trackResults.shipmentDetails.contentPieceCount	string	Field which holds information about content piece count of the shipment.
splitShipments	output.completeTrackResults.trackResults.shipmentDetails.splitShipments	array of object	Field which holds information about split shipments.
pieceCount	output.completeTrackResults.trackResults.shipmentDetails.splitShipments.pieceCount	string	Field which holds the number of pieces in the part.
statusDescription	output.completeTrackResults.trackResults.shipmentDetails.splitShipments.statusDescription	string	Field which holds human-readable description of the status.
timestamp	output.completeTrackResults.trackResults.shipmentDetails.splitShipments.timestamp	string	Field which holds the date and time the status began.
statusCode	output.completeTrackResults.trackResults.shipmentDetails.splitShipments.statusCode	string	Field which holds the status code.
reasonDetail	output.completeTrackResults.trackResults.reasonDetail	ReasonDetail	This object contains reason description and type.
availableNotifications	output.completeTrackResults.trackResults.availableNotifications	array of string	The types of email notifications that are available for the package.
contact	output.completeTrackResults.trackResults.shipperInformation.contact	Contact	Indicate the contact details for this package.
address	output.completeTrackResults.trackResults.shipperInformation.address	Address_track
lastUpdatedDestinationAddress	output.completeTrackResults.trackResults.lastUpdatedDestinationAddress	Address_track
alerts	output.alerts	array of Alert	The cxs alert type, alert code and alert message.

Validate Address

Operation ID:: ValidateAddress

Use this endpoint to get address resolution details. These details are the outcome of validatation and resolution of the input address. An address is stated as resolved when the input address matches the known reference data.

Parameters

Name	Key	Required	Type	Description
Customer Transaction Id	x-customer-transaction-id		string	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.
Locale	x-locale		string	This indicates the combination of language code and country code.

Returns

Name	Path	Type	Description
transactionId	transactionId	string	Unique identifier returned in the reply and helps you match the request to the reply.
customerTransactionId	customerTransactionId	string	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.
resolvedAddresses	output.resolvedAddresses	array of object	Indicates the list of resolved addresses. The detailed resolved address includes city, state, postal information, and resolution method.
streetLinesToken	output.resolvedAddresses.streetLinesToken	array of string	Indicates the resolved street address lines.
city	output.resolvedAddresses.city	string	This is resolved city name.
stateOrProvinceCode	output.resolvedAddresses.stateOrProvinceCode	string	This is resolved state or province code.
countryCode	output.resolvedAddresses.countryCode	string	This is resolved ISO alpha 2 country code.
customerMessage	output.resolvedAddresses.customerMessage	array of	Returns messages pertaining to the resolved address indicating if any additional information is required.
cityToken	output.resolvedAddresses.cityToken	array of object	This is the resolved city name with a token. The token is an indication to the changes made.
changed	output.resolvedAddresses.cityToken.changed	boolean	changed
value	output.resolvedAddresses.cityToken.value	string	value
changed	output.resolvedAddresses.postalCodeToken.changed	boolean	Changed details.
value	output.resolvedAddresses.postalCodeToken.value	string	Value for changed.
base	output.resolvedAddresses.parsedPostalCode.base	string	Indicates the base.
addOn	output.resolvedAddresses.parsedPostalCode.addOn	string	Indicates the addOn.
deliveryPoint	output.resolvedAddresses.parsedPostalCode.deliveryPoint	string	Indicates the deliveryPoint.
classification	output.resolvedAddresses.classification	string	This is the classification type of a FedEx address.
postOfficeBox	output.resolvedAddresses.postOfficeBox	boolean	Indicates if the resolved address is a P.O. Box.
normalizedStatusNameDPV	output.resolvedAddresses.normalizedStatusNameDPV	boolean	Indicates the presence of a delivery point such as a mailbox. Provided only for US addresses that are standardized against Postal Data.
standardizedStatusNameMatchSource	output.resolvedAddresses.standardizedStatusNameMatchSource	string	Indicates the source from which the standardized address is matched.
resolutionMethodName	output.resolvedAddresses.resolutionMethodName	string	Indicates the resolution method used to resolve the address.
ruralRouteHighwayContract	output.resolvedAddresses.ruralRouteHighwayContract	boolean	Indicates if the resolved address is a Rural Route or Highway Contract (US only). It returns true if it is rural route.
generalDelivery	output.resolvedAddresses.generalDelivery	boolean	Indicates the mail service is for those without permanent address. The mails for this address are held at a post office. Only applies to addresses that can be standardized against Postal Data.
EncompassingZIP	output.resolvedAddresses.attributes.EncompassingZIP	string	Indicates that the current address zip code encompasses other zip codes.
RuralRoute	output.resolvedAddresses.attributes.RuralRoute	string	Indicates that the input address was recognized as a Rural Route or Highway Contract addresses.
InterpolatedStreetAddress	output.resolvedAddresses.attributes.InterpolatedStreetAddress	string	Indicates that the house number of the address is valid within a known range of street numbers but that the existence of the specific street number could not be confirmed.
Intersection	output.resolvedAddresses.attributes.Intersection	string	Indicates that the address is an intersection.
MissingOrAmbiguousDirectional	output.resolvedAddresses.attributes.MissingOrAmbiguousDirectional	string	Indicates that the address is missing a required leading or trailing directional.
PostalValidated	output.resolvedAddresses.attributes.PostalValidated	string	Indicates if the PostalCode was validated against reference data. For US addresses- this is only returned when address cannot be standardized.
StreetAddress	output.resolvedAddresses.attributes.StreetAddress	string	Indicates that the house number and street name were validated against reference data.
StreetBuildingAddress	output.resolvedAddresses.attributes.StreetBuildingAddress	string	Indicates that the building and street information were validated against reference data, but not house number.
StreetNameAddress	output.resolvedAddresses.attributes.StreetNameAddress	string	Indicates that the street name was validated against reference data, but not house number.
StreetOrganizationAddress	output.resolvedAddresses.attributes.StreetOrganizationAddress	string	Indicates that organization and street information were validated against reference data.
StreetPointNotApplicable	output.resolvedAddresses.attributes.StreetPointNotApplicable	string	Indicates that house number at the street level is not applicable for this address.
StreetPointNotValidated	output.resolvedAddresses.attributes.StreetPointNotValidated	string	Indicates that house number at the street level is not applicable for this address.
StreetRange	output.resolvedAddresses.attributes.StreetRange	string	Indicates that the address includes a street number range instead of a single house number.
StreetRangeValidated	output.resolvedAddresses.attributes.StreetRangeValidated	string	Indicates that the house number and street were validated against a range of house numbers for that street provided in the reference data.
POBox	output.resolvedAddresses.attributes.POBox	string	Indicates whether an input address was recognized as a PO Box address.
POBoxOnlyZIP	output.resolvedAddresses.attributes.POBoxOnlyZIP	string	Indicates that USPS considers this ZIP as a PO Box- only postal code.
SplitZIP	output.resolvedAddresses.attributes.SplitZIP	string	Indicates when the address comes under a new ZIP code that did not previously exist.
SuiteRequiredButMissing	output.resolvedAddresses.attributes.SuiteRequiredButMissing	string	Indicates that an input address was resolved to a base building address and that a suite or unit number is required to achieve a more exact match.
SuiteNotValidated	output.resolvedAddresses.attributes.SuiteNotValidated	string	Indicates whether Suite was validated.
InvalidSuiteNumber	output.resolvedAddresses.attributes.InvalidSuiteNumber	string	Indicates Invalid Suite Number in the address.
ResolutionInput	output.resolvedAddresses.attributes.ResolutionInput	string	Resolution Input considered.
DPV	output.resolvedAddresses.attributes.DPV	string	Indicates the presence of a Delivery Point such as a mailbox.
ResolutionMethod	output.resolvedAddresses.attributes.ResolutionMethod	string	Resolution Method used for validation.
DataVintage	output.resolvedAddresses.attributes.DataVintage	string	Historical date.
MatchSource	output.resolvedAddresses.attributes.MatchSource	string	Indicates the Match Source.
CountrySupported	output.resolvedAddresses.attributes.CountrySupported	string	Country Supported.
ValidlyFormed	output.resolvedAddresses.attributes.ValidlyFormed	string	Validly Formed address.
Matched	output.resolvedAddresses.attributes.Matched	string	Matched details.
Resolved	output.resolvedAddresses.attributes.Resolved	string	Indicates if address can be standardized (resolved).
Inserted	output.resolvedAddresses.attributes.Inserted	string	Inserted details.
MultiUnitBase	output.resolvedAddresses.attributes.MultiUnitBase	string	Indicates whether an input address was resolved to a standardized address for the base address of a multi-unit building.
ZIP11Match	output.resolvedAddresses.attributes.ZIP11Match	string	Indicates that the input address was resolved to a standardized address based upon a match at the postal barcode level (i.e. Zip-11 match). This is the highest level of postal code validation.
ZIP4Match	output.resolvedAddresses.attributes.ZIP4Match	string	Indicates that the input address was resolved to a standardized address based upon at least a ZIP+4 match.
UniqueZIP	output.resolvedAddresses.attributes.UniqueZIP	string	Unique ZIP details.
RRConversion	output.resolvedAddresses.attributes.RRConversion	string	Indicates if a Rural Route conversion was applied to the address during standardization.
ValidMultiUnit	output.resolvedAddresses.attributes.ValidMultiUnit	string	Indicates that the address includes a validated suite or unit number.
AddressType	output.resolvedAddresses.attributes.AddressType	string	Indicates type of Address.
AddressPrecision	output.resolvedAddresses.attributes.AddressPrecision	string	Indicates the Precision details of the found Address.
MultipleMatches	output.resolvedAddresses.attributes.MultipleMatches	string	Indicates whether Multiple Matches were found for the address.
alerts	output.alerts	array of Alert	Indicates API Alerts includes alert type, alert code, and alert message that is received when the address is resolved.

Definitions

LocationDetail

Name	Path	Type	Description
units	distance.units	string	Indicates the unit of measure for the distance.
value	distance.value	float	Specifies the distance value.
address	contactAndAddress.address	Address
personName	contactAndAddress.contact.personName	string	Identifies the contact person's name.
emailAddress	contactAndAddress.contact.emailAddress	string	Contact person's email address.
firstName	contactAndAddress.contact.parsedPersonName.firstName	string	First Name.
lastName	contactAndAddress.contact.parsedPersonName.lastName	string	Last Name.
middleName	contactAndAddress.contact.parsedPersonName.middleName	string	Middle Name.
suffix	contactAndAddress.contact.parsedPersonName.suffix	string	Suffix detail.
phoneNumber	contactAndAddress.contact.phoneNumber	string	Contact person's phone number.
phoneExtension	contactAndAddress.contact.phoneExtension	integer	Contact person's phone extension.
companyName	contactAndAddress.contact.companyName	string	Contact person's fax number.
faxNumber	contactAndAddress.contact.faxNumber	string	Contact person's company name.
stateTaxId	contactAndAddress.contact.stateTaxId	string	State TaxID for the contact.
fedralTaxId	contactAndAddress.contact.fedralTaxId	string	Federal TaxId for the contact.
locationInCity	contactAndAddress.addressAncillaryDetail.locationInCity	string	This is the subdivision or community within a city for the given address.
suite	contactAndAddress.addressAncillaryDetail.suite	string	This is the suite information for the given address.
adderssVerificationOverrideReason	contactAndAddress.addressAncillaryDetail.adderssVerificationOverrideReason	string	Indicate the reason to override address verification.
displayName	contactAndAddress.addressAncillaryDetail.displayName	string	Display Name.
locationInProperty	contactAndAddress.addressAncillaryDetail.locationInProperty	string	This is location in a campus, such as exterior building.
addtionalDescriptions	contactAndAddress.addressAncillaryDetail.addtionalDescriptions	string	This is any additional information about the given address.
department	contactAndAddress.addressAncillaryDetail.department	string	This is the department for the given address.
roomFloor	contactAndAddress.addressAncillaryDetail.roomFloor	string	This is to specify the room or floor information for the given address.
crossStreet	contactAndAddress.addressAncillaryDetail.crossStreet	string	This is the cross street information for the given address.
building	contactAndAddress.addressAncillaryDetail.building	string	This is the building information for the given address.
apartment	contactAndAddress.addressAncillaryDetail.apartment	string	This is the apartment information for the given address.
room	contactAndAddress.addressAncillaryDetail.room	string	This is room specific information for the given address.
locationId	locationId	string	This is the FedEx location id for the given location.
storeHours	storeHours	array of object	Includes the days and times specific to the location.
dayofweek	storeHours.dayofweek	string	The day of the week for the location hours.
operationalHoursType	storeHours.operationalHoursType	string	Indicates the type of operatioal hours.
begins	storeHours.operationalHours.begins	string	Start time.
ends	storeHours.operationalHours.ends	string	End time.
exceptionalHoursType	storeHours.exceptionalHoursType	string	Indicates the type of exceptional hours.
exceptionalHours	storeHours.exceptionalHours	array of object	List of operating hours for the location that are an exception from the normal hours of operation.
begins	storeHours.exceptionalHours.begins	string	Start time.
ends	storeHours.exceptionalHours.ends	string	End time.
carrierDetailList	carrierDetailList	array of object	List of FedEx Operating companies (FedEx Carriers) along with different service capabilities available with the location.
serviceType	carrierDetailList.serviceType	string	Specifies the service type.
countryRelationshipType	carrierDetailList.countryRelationshipType	string	Specifies the country relationship type.
carrierCodeType	carrierDetailList.carrierCodeType	string	Carrier Code Type.
latestDropoffDetails	carrierDetailList.latestDropoffDetails	array of object	Latest Dropoff details.
dayOfWeek	carrierDetailList.latestDropoffDetails.dayOfWeek	string	Day Of Week.
exceptionalTime	carrierDetailList.latestDropoffDetails.exceptionalTime	string	Exceptional Time.
time	carrierDetailList.latestDropoffDetails.exceptionalOverlay.time	string	Exceptional Overlay time.
type	carrierDetailList.latestDropoffDetails.exceptionalOverlay.type	string	Time type.
operationTime	carrierDetailList.latestDropoffDetails.operationTime	string	Operation Time.
serviceCategory	carrierDetailList.serviceCategory	string	The service category for which this capability applies.
geoPositionalCoordinates	geoPositionalCoordinates	GeoPositionalCoordinates	The ISO6709GeographicCoordinates for a specific geographic location.
locationType	locationType	string	The FedEx Location Type.
locationAttributeTypes	locationAttributeTypes	array of string	Attributes for the location.
lockerAvailability	lockerAvailability	boolean	Indicates if FedEx locker is available at the location.
packageMaximumLimits	packageMaximumLimits	PackageMaximumLimits	This is the maximum package limits that are supported at the location.
specialInstructions	specialInstructions	string	Indicates the special instructions needed to access a location.
rthservice	rthservice	string	Indicates if the location supports RedirectToHold Service.
locationCapabilities	locationCapabilities	array of LocationCapabilities	Location capabilities such as services, day of week, ability to dropoff, pickup shipments, ability to hold shipments for pickup, etc.

Alert

Name	Path	Type	Description
code	code	string	Indicates the API alert code.
message	message	string	Indicates the API alert message.
alertType	alertType	string	Indicates the API alert type.

Address

Name	Path	Type	Description
streetLines	streetLines	array of string	This is a combination of number, street name, etc.
city	city	string	This is a placeholder for City Name.
stateOrProvinceCode	stateOrProvinceCode	string	This is a placeholder for State or Province code.
postalCode	postalCode	string	This is placeholder for postal code.
countryCode	countryCode	string	This is the Two-letter country code.
residential	residential	boolean	Indicate whether this address is Residential as opposed to Commercial.
addressVerificationId	addressVerificationId	string	This is the address verification identifier.
addressClassification	addressClassification	string	The business residential indicators.
addressClassificationConfidence	addressClassificationConfidence	string	The confidence of business residential classification business residential indicators.

Address_ship

Name	Path	Type	Description
streetLines	streetLines	array of string	This is a combination of number, street name, etc.
city	city	string	This is a placeholder for City Name.
stateOrProvinceCode	stateOrProvinceCode	string	This is a placeholder for State or Province code.
postalCode	postalCode	string	This is placeholder for postal code.
countryCode	countryCode	string	This is the Two-letter country code.
residential	residential	boolean	Indicate whether this address is Residential as opposed to Commercial.

Address_track

Name	Path	Type	Description
streetLines	streetLines	array of string	This is a combination of number, street name, etc.
city	city	string	This is a placeholder for City Name.
urbanizationCode	urbanizationCode	string	Relevant only to addresses in Puerto Rico.
stateOrProvinceCode	stateOrProvinceCode	string	This is a placeholder for State or Province code.
postalCode	postalCode	string	This is placeholder for postal code.
countryCode	countryCode	string	This is the Two-letter country code.
countryName	countryName	string	Field holds the fully spelled out name of a country.
classification	classification	string	Specifies the FedEx classification type for an address.
residential	residential	boolean	Indicate whether this address is Residential as opposed to Commercial.

Address_track_1

Descriptive data for a physical location.

Name	Path	Type	Description
streetLines	streetLines	array of string	This is a combination of number, street name, etc.
city	city	string	This is a placeholder for City Name.
urbanizationCode	urbanizationCode	string	Relevant only to addresses in Puerto Rico.
stateOrProvinceCode	stateOrProvinceCode	string	This is a placeholder for State or Province code.
postalCode	postalCode	string	This is placeholder for postal code.
countryCode	countryCode	string	This is the Two-letter country code.
classification	classification	string	Specifies the FedEx classification type for an address.
residential	residential	boolean	Indicate whether this address is Residential as opposed to Commercial.

Contact

Indicate the contact details for this package.

Name	Path	Type	Description
personName	personName	string	Identifies the contact person's name.
phoneNumber	phoneNumber	string	Identifies the phone number associated with this contact.
companyName	companyName	string	Identifies the company this contact is associated with.

GeoPositionalCoordinates

The ISO6709GeographicCoordinates for a specific geographic location.

Name	Path	Type	Description
latitude	latitude	float	The geo coordinate value that specifies the north-south position of the address.
longitude	longitude	float	The geo coordinate value that specifies the East-West position of the address.

LocationCapabilities

Location capabilities such as services, day of week, ability to dropoff, pickup shipments, ability to hold shipments for pickup, etc.

Name	Path	Type	Description
serviceType	serviceType	string	Indicates the service types supported by the location.
transferOfPossessionType	transferOfPossessionType	string	The method by which a package is transferred to the possession of a FedEx location.
carrierCode	carrierCode	string	Unique code to identify the transporter.
daysOfWeek	daysOfWeek	array of string	The days of the week for which this capability applies.
serviceCategory	serviceCategory	string	The service category applicable for the capability.

PackageMaximumLimits

This is the maximum package limits that are supported at the location.

Name	Path	Type	Description
units	weight.units	string	This is package weight type.
value	weight.value	double	This is package weight.
length	dimensions.length	integer	Indicate the length of the package.
width	dimensions.width	integer	Indicate the width of the package.
units	dimensions.units	string	Indicate the dimensions of the package.
height	dimensions.height	integer	Indicate the height of the package.

LabelResponseVO

These are shipping document/label specific information.

Name	Path	Type	Description
contentKey	contentKey	string	This is the content key for the document/label.
copiesToPrint	copiesToPrint	integer	These are the number of copies to print for the specific document type.
contentType	contentType	string	Indicates the type of document/label.
trackingNumber	trackingNumber	string	This is a tracking number for the package.
docType	docType	string	This is the document type.
alerts	alerts	array of Alert	These are alert details received in the label response.
encodedLabel	encodedLabel	string	Specifies if the document is encoded.
url	url	string	The URL of the shipping document/label.

CurrencyExchangeRate

Specifies the currency exchange performed on financial amounts on this rate.

Name	Path	Type	Description
rate	rate	double	Multiplier used to convert from Currency units to into Currency units.
fromCurrency	fromCurrency	string	The currency code for the original (converted FROM) currency.
intoCurrency	intoCurrency	string	The currency code for the final(converted INTO) currency.

Tax

Specifies the tax for the shipment.

Name	Path	Type	Description
amount	amount	double	Indicates the amount of tax.
level	level	string	Indicates the level of tax.
description	description	string	Specifies the tax description.
type	type	string	Specifies the type of the tax.

Weight

These are the package weight details.

Name	Path	Type	Description
units	units	string	Indicate the weight unit type.
value	value	double	This is the weight.

Message

Specifies the advisory details.

Name	Path	Type	Description
code	code	string	Specifies the message code for the tag created.
text	text	string	Specifies the text message for the tag created.
parameters	parameters	array of object	Specifies the message parameters list.
id	parameters.id	string	Specifies the message parameter code.
value	parameters.value	string	Specifies the message parameter value of the code.
localizedText	localizedText	string	Specifies the message ID and value.

ReasonDetail

This object contains reason description and type.

Name	Path	Type	Description
description	description	string	Field which holds the reason description.
type	type	string	Field which holds the reason type.

TimeWindow

Time window details.

Name	Path	Type	Description
description	description	string	Field which describes the time window provided.
begins	window.begins	string	Field which holds the begin date/timestamp for a range.
ends	window.ends	string	Field which holds the end date/timestamp for a range.
type	type	string	Field which holds the code representing the description for the time window provided.

Share via

FedEx (Preview)

Prerequisites

How to get credentials

Getting started with your connector

Known issues and limitations

Creating a connection

Default

Throttling Limits

Actions

Cancel Shipment

Parameters

Returns

Create Shipment

Parameters

Returns

Find Locations

Parameters

Returns

Retrieve Rate Quotes

Parameters

Returns

Track by Tracking Number

Parameters

Returns

Validate Address

Parameters

Returns

Definitions

LocationDetail

Alert

Address

Address_ship

Address_track

Address_track_1

Contact

GeoPositionalCoordinates

LocationCapabilities

PackageMaximumLimits

LabelResponseVO

CurrencyExchangeRate

Tax

Weight

Message

ReasonDetail

TimeWindow