Required Elements

Most requests to FedEx require the following complex elements:

Note: These elements are common to most FedEx Web Services (see the table below to learn which WSDLs need which common elements) and are not documented service by service.

WebAuthenticationDetail: The WebAuthenticationDetail element includes user credentials issued by FedEx so that your transactions are recognized by the FedEx back-end systems. The following elements are required:

Element Description
WebAuthenticationDetail The descriptive data to be used in authentication of the sender's identity and right to use FedEx Web Services.
WebAuthenticationDetail/CspCredential Credential key and password used to authenticate a CSP product/software version. This information is provided by FedEx.
WebAuthenticationDetail/UserCredential Credential key and password used to authenticate a specific end user/customer of the CSP. This information is obtained by processing the Register Web CSP User Request.
UserCredential Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
WebAuthenticationCredential Two-part authentication string used to verify shipper identity.
WebAuthenticationCredential/Key Unique identifier assigned to each customer as part of their authentication credentials.
WebAuthenticationCredential/Password Second part of the authentication credential which has a direct relationship with the credential key.
Note: FedEx Web Services now use two-factor authentication. If you do not have new credentials, the latest WSDLs will use your old authentication credentials. If you do not have a new user authentication credential, do not populate the password element.

Client detail: The ClientDetail element is required for all services that need your account number and meter number. Requirements are

  • A standard type such as “string” appears in black text below element name.
  • A FedEx specific type such as “Address” appears in red text below the element name.
    Element Description
    ClientDetail/AccountNumber Your FedEx account number.
    ClientDetail/MeterNumber The associated meter number for your FedEx account number. Maximum of 9 characters.
    ClientDetail/ClientProductId Identifies the CSP software product. This identifier is provided by FedEx
    ClientDetail/ClientProductVersion Identifies the CSP software version. This identifier is provided by FedEx
    Note: When building a web-based application for shipping that will be used at multiple locations, include the local FedEx Express® account and meter in the ClientDetail section of the ship transaction. Create a database to hold multiple account and meter numbers for the shipping locations.

TransactionDetail: The TransactionDetail element is optional for all transactions. However, if you want to identify associated request and reply transactions, use this element.

Element Description
TransactionDetail/CustomerTransactionId Maximum of 40 characters. This element allows you to assign a unique identifier to your transaction. This element is returned in the reply and helps you match requests to replies.

VersionId: The VersionId element is required and uploads the WSDL version number to FedEx. FedEx provides the latest version number for the service you are using. This number should be updated when you implement a new version of the service.

Element Description
ServiceId Identifies a system or sub-system which performs an operation.
Major Identifies the service business level.
Intermediate Identifies the service interface level.
Minor Identifies the service code level.

Sender Information: Your shipper information is required for all shipping transactions:

Element Description
AccountNumber If you include this element in the ship request, this entry overrides the account number in the ClientDetail element.
TIN Tax Identification Number — this information is required for international shipments only.
Contact The Contact element includes:
  • PersonName
  • Title
  • CompanyName
  • Department
  • PhoneNumber
  • PagerNumber
  • FaxNumber
  • EmailAddress
Address This element includes:
  • StreetLines: two StreetLines elements are allowed.
  • City
  • StateOrProvinceCode: required if your shipper address is in the U.S. or Canada.
  • PostalCode: required.
  • UrbanizationCode: may be required if your shipper address is in Puerto Rico.
  • CountryCode: required.
Residential Required if your shipper address is considered a residential location. If you are unsure, use the Address Validation Service to check your address.