Overview

FedEx Web Services API will be retired on May 15, 2024. The SOAP-based FedEx Web Services is in development containment and has been replaced with the FedEx REST API.

For more information, please visit the FedEx Web Services portal.

Required Modules

The following modules are required to use the new FedEx REST API:

Module	Replaces	Requires
SalesPad.Module.FedEx	SalesPad.Module. FedExAddressValidation	N/A
SalesPad.Module.ShippingV2	SalesPad.Module.Shipping	SalesPad.Module.FedEx

FedEx Developer Portal

To configure the FedEx REST API, the API Key and Secret Key must be obtained from the FedEx Developer Portal by following this guide.

NOTE: Enter "SalesPad" instead of "ShipCenter" for the project name.

Settings

Before generating the FedEx REST API access token, enter the API Key and Secret Key in settings. Copy the API Key and Secret Key from the FedEx Developer Portal into the corresponding settings and save.

Endpoint Type - Specify the API endpoint to connect to. Use 'Test' for testing and 'Production' for live.

API Key - Specify the API Key (also known as Client ID) received during FedEx Developer Portal registration.

API Secret Key - Specify the Secret Key (also known as Client Secret) received during FedEx Developer Portal registration.

FedEx Account Number - A nine-digit number associated with your FedEx account.

Access Token Maintenance

Overview

The Access Token Maintenance screen allows generating new access tokens for the FedEx REST API.

Security

Enable the Access Token Maintenance screen by going to the Security Editor (Modules -> System -> Security Editor) and making sure the Access Token Maintenance checkmark is checked.

Can Generate Tokens - Can generate new access tokens.

Can Revoke Tokens - Can revoke access tokens.

Can Delete Tokens - Can delete access tokens. This action will not revoke tokens from service.

Can View Token Properties - Can view access token properties.

Generate Token

1. To generate a new access token, click the Generate Token button.

2. A New Access Token window will open. Select the endpoint type and click OK to start the token generation process. Note that production and test environments require separate access tokens.

The following message will display if token generation was successful.

Revoke Token

FedEx access tokens cannot be revoked. The following message will appear if a user attempts to revoke an existing access token.

Delete Token

To delete an access token, click the Delete Token button. Click Yes on the following prompt to confirm deletion.

View Token Properties

To view token properties, click the Key Information button.

This will open the Token Properties window which displays various token properties, such as issue date, expiration date, and status.

Access Token

The access token must be refreshed every hour for SalesPad to continue interacting with the FedEx REST API. SalesPad will refresh this token automatically when making an API call. Further action from the user is not required.

Address Validation

Overview

Address validation is part of the SalesPad.Module.FedEx module. This module replaces the legacy SalesPad.Module.FedExAddressValidation module.

Settings

Go to Settings (Modules -> System -> Settings). Set the Address Query Handlers setting to “FedExAddressQueryHandler”.

Filter to “FedEx” and configure the following settings.

9 Digit Zip Code Address Suggestions Cause Address Validation Failure - If false, will not flag the address as invalid as long as the first 5 digits of the zip code match for US addresses. Defaults to false.

Address Validation Abbreviation Custom Mappings - Abbreviation mappings that can be applied to the addresses being validated to determine whether suggested addresses returned by the FedEx Address Validation are equal to the provided address.

Automatically Correct Address Per FedEx Suggestion If FedEx Response Is Successful - If true, when submitting an address to the FedEx Address Validation service, compare the submitted address against the FedEx Address Validation service's effective address and if the address line, city, state, or zip are not the same then apply the effective address values to the submitted address. Otherwise, alert the user of the incorrect values. Defaults to false.

DPV Shipping Method - DPV (Delivery Point Validation) indicates that an address can receive mail. When this setting is filled in, an address that has a valid DPV will have this shipping method set.

Post Address Validation Script - C# script that executes after address validation.

Validation Precision - Determines how precise the address validation should be. Exact means the entire address needs to be matched by FedEx, Medium means it will validate the street/city combination but not necessarily the house number.

Customer Address Card

1. Navigate to the Customer Address Card.

2.Click the Save button when the customer address is ready to be saved and validated. If an address is ambiguous, SalesPad will open the address validation window and allow the user to review the results.

NOTE: if the Automatically Correct Address Per FedEx Suggestion If FedEx Response Is Successful setting is enabled, SalesPad will automatically correct the address and will not show the validation prompt.

Sales Document Entry Addresses

1. Navigate to the Addresses formlet on the sales document entry screen.

2. Click the Save button when the sales document is ready to be saved and have its Ship To address validated. If an address is ambiguous, SalesPad will open the address validation window and allow the user to review the results.

Freight Calculator

Overview

The freight calculator is part of the SalesPad.Module.ShippingV2 module. This module replaces the legacy SalesPad.Module.Shipping module.

Security

Go to the Security Editor (Modules -> System -> Security Editor) and make sure that Sales Document Freight Rates and Sales Document Simple Freight Rates are enabled.

NOTE: Sales Document Freight Rates has the same functionality as the Sales Document Freight Calculator, and the Sales Document Simple Freight Rates has the same functionality as the Sales Document Simple Freight Calculator from the legacy Shipping module.

Settings

Go to Settings (Modules -> System -> Settings) and filter to “Shipping Tools V2”, then configure the following settings.

FedEx Max Weight - Max weight allowed for calculating FedEx rates. Defaults to 0.

FedEx Pickup Type - Specify a pickup type for FedEx. Defaults to ‘Use Scheduled Pickup’.

Use Account Rates - Use 'Account Rates' as opposed to 'List Rates' from the FedEx API. Defaults to false.

Shipping Carrier Query Handlers - Specify the carriers that can be used. Set this setting to ‘FedExQueryHandler’ to obtain FedEx rates.

Freight Rates

The Freight Rates tab (formerly Freight Calculator) is used to obtain FedEx shipping rates.