Skip to main content

FedEx Address Validation REST API Configuration - Knowledgebase / SalesPad / Miscellaneous - Cavallo Technical Support

FedEx Address Validation REST API Configuration

Authors list

Overview

FedEx Web Services API will be retired on Aug 31, 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


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.

81ACZ4HTLQvB5ol5uucnKIwX57uQ5HiifSItq8CcwljSQN2kd3acd063a4TpIfrdKlo1w9Ojbb_NwZg5t5J6gIi4aqQt7G45DaeY.png?access_token=snx3p2-vbxapoaafp-00c2d16fc58b4e12621cda10be637f48a9922e18

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.

mcM1bPKUnfB_kYUygNnKNEiN1m6XHf88Nz-bxMYQ5hjYL2QZpjWCiKQvmZgGlvBAecq5kVc9hX65m5wxJpDKHwhucq-C7vpETkVo.png?access_token=snx3oz-tleowrxsaf-206beef0f682fbabdc9b703cdbc44495e2914d97

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.

pAfNTXXMq714IEfzzn99g0-qL74td85OMNGtuKKEJoHxP3VXAm7wr7Vw0oyl8_OeipDp-hzgqEjKqWlt6q_w_HL_jO67qFSQIKUc.png?access_token=snx3p5-vsqhrgcjjg-bd705f287056a82468eba5e37e638d3a9cb83e69

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.

1JFIzbxI1JLJIOoO4bhWM3-kBVirwVg3v1ETMO2Sj53-akU5Kqxr01gO5VU9G5X0xSe_Hl5DPrk59IIcIzQkqGtpu3y6OqL63Tiw.png?access_token=snx3p6-wrwrcuwfnt-26a34cc2935bb5f1ebf96d301b3fcf86a04d39bb

The following message will display if token generation was successful.

fEJUEUREKKHMsvisrni3Zoj3z7dSa2U47_6g-Jg5iDdUVzTaNHJyNDQakj2g8pRFhx6hQAO_wivGGs8Y_t5_vrLYRb6u6pV2LVOc.png?access_token=snx3p3-tylgmuiisq-78998dbeee6c811c6d40553cbd10fbf95a05407c

Revoke Token

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

pe7JvU1NI-_UR5ypfnfCh_ciCelvh1DeS3mWKkD-NhJQgA-mYS3Hd-hrllxJwhr6wdk43-EAJh7IuqhYsU3wSkzToibeWuTD-XrQ.png?access_token=snx3p3-paariakgea-b5791d73469e7e90f5717e1a84a071fb02b8071c

Delete Token

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

ot_BxsyMtzDZN9qa5RN0jcbLjCsIEyOvh3Sr9MmdIsSWw178ZoyPqJi7dquT11cMqRh-uuxwkQWgiWCEJCCDagdjL-oZrkhQUzU8.png?access_token=snx3p0-votscugpom-cfff6aae404b73b38a37a1b4df400a1d6e26bfb4

View Token Properties

To view token properties, click the Key Information button.

OyepMawk4lE0FES8kjF0-iUaZHBpy0l0ENDU5WZAOW7FTj13XC6y0WN6OpbH8vpDOBVgJKW8JL2IKvBr0gmrAPvntTapGHgU23F8.png?access_token=snx3p8-mpnivvpehj-6f2e9ed0da4fcb5bc3987216435b9a5ad9f4c3a2

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

HemhnoAHs037GFXJIpqQWPtG0fintvAB5gad681DM-C2NhjEjZKgmzxf4eAn19vd_B9Mr_6fTwLQObLm4_klNy73za7T0xCVSWpY.png?access_token=snx3p2-dvlffucadl-56c5a91598df8d0aeb3d05b5e904edb859653096

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”.

sjBpiqN2t7Uw4mHj1RV5RLFLBjA-OGQWTG6QrR2guTKKrR7Lfu8sX-HHX2-Ohd14Tnuh3b29SOutzbim6chLgnzOeYtRdgtb5QPo.png?access_token=snx3p5-rqauytnwuz-7ed8f7a040fbf0c696eebaafd2a85f77a132d129

Filter to “FedEx” and configure the following settings.

W66NMTJ2gdmlMIoszT4Xh3J9JG7EyDwBFAD5GaED-4q0fPkWgnrlT1nnAMqKQyM_shkm6EY8dCGFvjKijAJOEWFkEC-Y4lGKUjoY.png?access_token=snx3p5-vvvlpokmlm-fc0f22c5fc2a317fb91171d9821162bb4a46fec2

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.

AYjk-87iFOvKMzm0PzZYcO3IixgDeHq3o745giYjOlnmFWktsQxPsKljIs9vKGBX5M0fp2GHYPkKn0TgAN8v7KURZxV-qPMy6IuI.png?access_token=snx3p2-jtsyyncdhj-14802048347ef551ae6c7b13bfe404f19627900f

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.

aNsV_gpPXJfnI89recJVLc2wAEbJ21uLByWeBZsQ_uS88GmijiWEswEnx8-Td6ZgAwdvimFfa6zJyY1oxtPAA-6Icmo-h78m_R8.png?access_token=snx3p7-nzaseuauxt-90b03258287a0bde346379efdc81afafd4ff1f70

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.


pOGBsAzjv_iZKviCtm__WYWUxkFChrO1CSC5ccUMbxOcL1txoLHFYlS_eD2xFS6MzAPDSM5dhlRzLvVzztDbD8eNTaCmoPOl-Ch4.png?access_token=snx3p6-npuhdncfsk-75e3fe51a5703a70db335c935e74641981f3ac29

HYNMa6_n3cxh46CPIpb0ETRDEqMG80_ONSUkxXDE8V-iS4SKkGwJvHt4uEm3o0bKs-96OOV6ATihGa1s_qHG5ub3zWKR_11M-_jI.png?access_token=snx3p5-zrefxqpkfl-0aeed06cee66b883aa28baff0dc3e089aece8227

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.

si21qbYm7lfP7NycWrPkdSZM3y26ROgH36T2Uzq9PpJbUYfXTLnv_ziMmv-TvZxD3Wof4z-GbS5YCbECsgWO37IFxgyHnYfnnJzw.png?access_token=snx3p6-deokdpcwis-a8543e3f189a9e496577f70a6ed4c2b031ed5b3b

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.

aBGywEgk8ElW51IZC-WzH2MmXDOaBCZAT6b6LFv6eJpc3XLuBSUXBDCanEuNs1htaZTh5BplijK3zKdA9v5DTWzVOH335aZPLVGE.png?access_token=snx3p9-mmqncixmzg-2d6223825241d2030b8c0acf59216d1d6c55cf1f


Helpful Unhelpful