Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

To obtain your FEDEX Test API credentials:

  1. Register for a FedEx developer account if you do not already have one.
  2. Click on the "My Projects" link in the left menu.
  3. Click on the large orange "Create API Project" button.
  4. 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".
  5. On the Step 1 - Select API(s) for your project screen, select "Ship, Rate & Other APIs".
  6. 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.
  7. 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:
    1. Do you plan on shipping using FedEx SmartPost Returns - UltraCart does not support processing returns through the FedEx API.
    2. Do you plan on shipping using FedEx Freight LTL - select Yes or No depending on your need.
  8. On the Step 3 - Confirm details screen, check both boxes.
  9. 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

  1. Visit the FedEx Developer Portal, then navigate:
    Menu → My Projects → Click on your
    project  project (create one if you do not have one)   Production Key tab ( this is at the top of the screen below "API Project overview")
  2. 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.
  3. The next screen titled Production keys will display your API key and Secret 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.

...

  1. 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.
  2. Sender Label Type: Choose "4x6" or "Half Sheet" and also optional setting "( packing slip with 4x6 label)"

    Tip

    There are two types of labels that FedEx can print (half sheet and 4x6).  Most merchants get a Zebra LP2844 label printer and print the 4x6 labels.  The signature type option allows you to control how the customer will be required to sign for the package.  The label reference allows you to print custom fields 1-5 on the label.


  3. Signature Type: Choose "Indirect", "Direct", or "Adult"
  4. Include Clearance Entry Fee (Checkbox field)

...

FieldDescription
Include Clearance Entry FeeSelect this checkbox to include Clearance Entry Fee in the shipping cost presented to the customer during checkout.
Merchant Paid DutiesSelect 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 CopySelect checkbox if using ETD, but still wish provide local copy of customs for printing.
LetterheadUpload your letterhead in either *.gif or *.png (Attention: Max Size for image 700x50 pixels.)
SignatureUpload your digital signature in either *.gif or *.png (Attention: Max Size for image 240x25 pixels.)

Completing the FedEx Label Certification Step

Info
titleIMPORTANT NOTE ABOUT LABEL CERTIFICATION

When submitting the label certification: It's important to state that you print PDF and make sure to send in the PDF bundle.

Failure to submit as printing PDF's will cause a certification to be rejected.


Most likely you'll want to take advantage of FedEx label printing directly within the UltraCart Shipping department.  This requires label certification from FedEx.

...

  • Step 3: Fill out the Label Cover Sheet:  https://developer.fedex.com/api/content/dam/fedex-com/irc/common/Label-Cover-Sheet-form.pdf
    • Your Fedex Production Authentication Key is your production "REST API Key" in the UltraCart configuration.   It's also displayed on your FedEx developer project (https://developer.fedex.com/api/en-us/project.html#/myprojects) as the "API KEY".
    • Are you using Third Party Solution?  NO.  UltraCart is not a third party solution.
    • Third Party Solution Name: <leave this blank>
    • The remaining fields are your own company's fields.
  • Step 4: Generate and submit test labels to the Label Analysis Group
    • Navigate to the FedEx configuration tab:  Main Menu → Configuration → (middle menu) Checkout → Shipping → (Middle Menu) Under "Carriers", click "FedEx"
    • Scroll down the Test credentials column, to the blue button titled "Generate certification labels in test environment", then click the button.You'll be presented with a table of 10 label scenarios, click the button titled "stock test scenarios", then click the save button.
    • Next, click the "Generate labels".
    • Generate test labels within the FedEx test environment associated with the application and
      then submit the test labels to the FedEx label evaluation team(s) for approval.

      Note: The Bar Code Analysis group requires a three-business-day turnaround time for label evaluation.

      To avoid processing delays, follow the below best practices:
      Labels must be printed on the model printer that will be used in production. These labels
      must be scanned at a minimum resolution of 600 DPI to ensure clear images are available
      for the certification process. DO NOT SEND WEB SERVICES GENERATED FILES.
      • For thermal printers, the label image type must be requested in accordance with the
      printer model. Example: ZPLII for Zebra printers
      • Use the sender shipper/recipient address information when creating sample labels for
      evaluation. Only create sample labels for the specific services that are being applied for.
      • FedEx®
      Collect on Delivery (C.O.D.) label must also include the corresponding C.O.D.
      Return label.
      • FedEx International Express®
      shipments must also include the auxiliary/secondary Air
      Waybill (AWB) label.
      • Multi-piece shipments (MPS) must include one label for each package in the shipment.
      • Certain customized FedEx Ground Economy (formerly SmartPost®) labels require up to 72 hours for evaluation.
      • FedEx Freight® labels do not require evaluation.
      • Email the PDF and Label Cover sheet to: label@fedex.com

      Physical labels may be sent to:
      FedEx Services
      WTC – Business Solutions Testing
      10 FedEx Parkway
      2nd Floor Horizontal
      Collierville, TN 38017

      Note: If the scanned labels are without visible defects (such as lines going through the
      barcode, spots in the ink, or physical damage), then they may pass inspection and approval will
      be granted. However, if there are defects, physical copies will be requested.
      If sending physical labels, pay attention to print quality and accidental enlargement/shrinkage
      of labels (i.e. scaling). These are the top two reasons why labels do not pass the label evaluation
      process.
      Step 5. Label Evaluation
      The Bar Code Analysis group will evaluate the submitted test labels and approve or reject the
      labels. The Bar Code Analysis group will contact you regarding the approval or rejection of the
      submitted labels. If the labels are approved, continue to the next step. If the labels are rejected,
      correct the labels as instructed and resubmit them for approval.

...