Configuring FedEx API
FedEx
The FedEx integration is one of the most advanced integrations in UltraCart. By configuring your FedEx API information, UltraCart will not only be able to estimate rates using the discounts that you have with FedEx, but also print domestic shipping labels directly to PDF.
If you do not have complete product FedEx web service credentials on file, then UltraCart will only be able to obtain estimates limited to standard list rates for shipments originating in the US or destined for the US only.
FEDEX Credentials
There are two sets of API credentials required for the FEDEX API integration:
"Sandbox " Test Credentials (Used to complete the Label Certification)
Production Credentials
The 4 API credentials are:
Account Number (found on fedex.com in your account settings)
Meter Number (found on fedex.com in your account settings)
API Key (aka Client ID)
Secret Key (aka Client Secret)
Obtaining Your Sandbox Test Credentials
Your test credentials are required to complete the Label printing certification step.
To obtain your FEDEX Test API credentials:
Register for a FedEx developer account if you do not already have one.
Click on the "My Projects" link in the left menu.
Click on the large orange "Create API Project" button.
When the "Tell us about your API needs" popup displays, choose the option "I work for a company that Ships with FedEx and needs to integrate FedEx APIs into their system".
On the Step 1 - Select API(s) for your project screen, select "Ship, Rate & Other APIs".
Scrolling down on that same screen is a list of all APIs. Check the "Rates and Transit Times API" and optionally (Ship API) if you will be printing labels as well.
On the Step 2 - Configure project screen, give your project a name (does not matter to UltraCart) and select your country. There are two options as well:
Do you plan on shipping using FedEx SmartPost Returns - UltraCart does not support processing returns through the FedEx API.
Do you plan on shipping using FedEx Freight LTL - select Yes or No depending on your need.
On the Step 3 - Confirm details screen, check both boxes.
When finished, you will be redirected to your Project screen where you will find your development API Key, Secret Key, and Account Number. Record those values.
Obtaining Your Production API Credentials
Visit the FedEx Developer Portal, then navigate:
Menu → My Projects → Click on your project (create one if you do not have one) → Production Key tab ( this is at the top of the screen below "API Project overview")On the Configure Project screen, provide a Key name (UltraCart does not care about this name) and choose your Account Number to associated with the project.
The next screen titled Production keys will display your
API keyandSecret key. Record those safely, as you will not see the secret again. You should also have your Shipping Account which is easily viewed from your project page at any time.
Now that we have our Test and Production API credentials, we can configure them within UltraCart.
Log into your UltraCart account, then navigate:
Navigation
Main Menu → Configuration → (middle menu) Checkout → Shipping → (Middle Menu) Under "Carriers", click "FedEx"
The FedEx configuration shown below. Fill in your Test and Production Credentials:
Meter Number No Longer Used
Please note that with the lest REST API implementation of the FedEx API, the meter number is no longer used.
The required FedEx API Credentials are:
REST API Key
REST Secret Key
Account Number
Now that you have your Test and Production credentials saved, you'll need to complete the rest of the UltraCart FEDEX Configuration form.
For Rating you'll choose between "List" (retail pricing) or "Discounted" (your negotiated rates)
Enter your Sender Address details
For Ground Economy (formerly SmartPost) Hub, enter your Hub ID.
Ground Economy (SmartPost) Rate < 1 LB (Checkbox field) select if you wish to apply SmartPost rate for packages that weight less than one pound.
Ground Economy (SmartPost) Ship > $100 (Fedex will only insure up to $100 with Ground Economy) (Checkbox field)
Ground Economy (SmartPost) Minimum Weight ____LB (Allows you to specify the minimum weight that Ground Economy Rate will be used for estimates.)
General Settings
There are 5 general settings for the API:
Web Service Environment (Choose either: Test or Production)
*Select test during the Label Certification then switch to Production after the Label Certification step is completed.Sender Label Type: Choose "4x6" or "Half Sheet" and also optional setting "( packing slip with 4x6 label)"
Signature Type: Choose "Indirect", "Direct", or "Adult"
Include Clearance Entry Fee (Checkbox field)
Customs
Field | Description |
|---|---|
Include Clearance Entry Fee | Select this checkbox to include Clearance Entry Fee in the shipping cost presented to the customer during checkout. |
Merchant Paid Duties | Select this checkbox to designate duties to be paid by merchant. |
Electronic Trade Docs (ETD) | Select this checkbox to instruct FedEx to submit customs documents electronically. See ITN and the notes on screen for more details. |
Hard Copy | Select checkbox if using ETD, but still wish provide local copy of customs for printing. |
Letterhead | Upload your letterhead in either *.gif or *.png (Attention: Max Size for image 700x50 pixels.) |
Signature | Upload your digital signature in either *.gif or *.png (Attention: Max Size for image 240x25 pixels.) |