FedEx Carrier Guide

FedEx is a multi-national, courier service that offers domestic and international shipping solutions. FedEx offers a wide range of services and package delivery solutions.

This guide provides developers an overview of shipping services that FedEx offers and the service codes that you will use to create FedEx shipments.

Whether you need to create a new FedEx account or are ready to connect an existing one to ShipEngine, the setup guides below can help you get started.

Connect Your Account

ShipEngine API allows you to connect your FedEx accounts programmatically without logging in to the ShipEngine API dashboard. This is useful if you have wrapped a custom UI around the ShipEngine API toolset and want to add or disconnect existing carrier accounts without exposing your end users to the API dashboard.

These APIs can be used in parallel with the ShipEngine Partner APIs to programmatically create new ShipEngine users, and then connect existing FedEx accounts all via the API without logging into a dashboard. Together these APIs empower you to completely white-label the ShipEngine experience for your end users.

Continue below for instructions on how to programatically connect FedEx using the ShipEngine API.

For instructions on connecting FedEx via the ShipEngine dashboard, go to our FedEx help article.

FedEx Account Information Model

Example POST Call

POST /v1/connections/carriers/fedex

Copy

HTTPcURLJavaScriptNodeJSPHPPythonRubyC#JavaGoSwiftObjective-CPowerShell

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
POST /v1/connections/carriers/fedex HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
  "account_number": "123456789",
  "company": "Example Corp.",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "111-111-1111",
  "address1": "4009 Marathon Blvd.",
  "address2": "Suite 300",
  "city": "Austin",
  "state": "TX",
  "postal_code": "78756",
  "country_code": "US",
  "email": "[email protected]",
  "agree_to_eula": "true"
}

Example Response

1
2
3
{
  "carrier-id": "se-1234567"
}

Modify FedEx Settings

ShipEngine takes advantage of some of FedEx's advanced functionality but does not enable it by default. You can update these settings in the Dashboard or via the API.

Pickup Type

FedEx Ground Economy™ (formerly SmartPost™)

To enable Ground Economy™ both of the properties below are required and must be valid. As of 03/07/2023, the parameter names remain as listed here.

FedEx makes documentation available here for Ground Economy™ (formerly SmartPost™).

Common Settings

Example PUT Request

PUT /v1/connections/carriers/fedex/:carrier_id/settings

Copy

HTTPcURLJavaScriptNodeJSPHPPythonRubyC#JavaGoSwiftObjective-CPowerShell

1
2
3
4
5
6
7
8
9
10
11
12
13
14
PUT /v1/connections/carriers/fedex/se-108252/settings HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
    "nickname": "my fedex account",
    "pickup_type": "regular_pickup",
    "smart_post_hub": "dallas_tx",
    "smart_post_endorsement": "address_service_requested",
    "is_primary_account": "false",
    "signature_image" : "base64string",
    "letterhead_image" : "base64string"
}

Example Response

On a successful response, you will receive an HTTP status 204.

Example GET Request

GET /v1/connections/carriers/fedex/:carrier_id/settings

Copy

HTTPcURLJavaScriptNodeJSPHPPythonRubyC#JavaGoSwiftObjective-CPowerShell

1
2
3
GET /v1/connections/carriers/fedex/se-108252/settings HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Example Response

1
2
3
4
5
6
7
8
9
{
  "nickname": "my fedex account",
  "pickup_type": "none",
  "smart_post_hub": "none",
  "smart_post_endorsement": "none",
  "is_primary_account": true,
  "signature_image" : "base64string",
  "letterhead_image" : "base64string"
}

FedEx Service Details

FedEx Freight Service Levels

Adding Shipment Insurance

FedEx supports adding insurance to your shipments. Review the Parcel Insurance page for details on adding shipment insurance with ShipEngine.

There are a few things to know about adding insurance to FedEx shipments:

FedEx Advanced Options

Advanced Options are a property of the shipment that are used to communicate carrier add-ons used to get rates and create labels, such as "Saturday Delivery". Carrier Options are available dynamically at the List Carriers endpoint.

FedEx Ground Collect

FedEx Ground Collect is a program that allows a recipient to use their own FedEx account when receiving shipments. Note that this is different from Collect on Delivery (COD) where the shipping charges are collected directly from the recipient when the package is delivered.

With FedEx Ground Collect, the recipient displays a placard for the FedEx courier to scan when they deliver the package. Once it is scanned, the recipient's FedEx account is invoiced for the shipping charges.

To use this option, you must set your service_code to fedex_ground and supply a bill_to_party in the advanced_options when you create a shipping label, as indicated in the example below.

You'll notice that bill_to_party is set to recipient and there is no bill_to_account set in the payload. This differs from billing a third party, which also uses the bill_to_party property.

Example Request

Copy

HTTPcURLJavaScriptNodeJSPHPPythonRubyC#JavaGoSwiftObjective-CPowerShell

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
POST /v1/labels HTTP/1.1
  Host: api.shipengine.com
  API-Key: __YOUR_API_KEY_HERE__
  Content-Type: application/json
  {
    "shipment": {
      "service_code": "fedex_ground",
      "advanced_options": {
          "bill_to_party": "recipient"
        },
      "ship_to": {
        "name": "Amanda Miller",
        "phone": "7147814565",
        "company_name": "Test Co",
        "address_line1": "500 South Buena Vista Street",
        "city_locality": "Burbank",
        "state_province": "CA",
        "postal_code": "91521",
        "country_code": "US",
        "address_residential_indicator": "No"
      },
      "ship_from": {
        "name": "John Doe",
        "phone": "555-555-5555",
        "company_name": "Example Corp",
        "address_line1": "4009 Marathon Blvd",
        "city_locality": "Austin",
        "state_province": "TX",
        "postal_code": "78756",
        "country_code": "US",
        "address_residential_indicator": "No"
      },
      "packages": [
        {
          "weight": {
            "value": 1.0,
            "unit": "ounce"
          }
        }
      ]
    }
  }

To ensure you always have the most up-to-date information, use the List Carrier Advanced Options call.

FedEx Hold at Location (HAL)

ShipEngine supports the FedEx Hold at Location (HAL) feature, which ships the package to a designated location - like a FedEx store - instead of the recipient's home or business address. The recipient then picks up the package from the location by presenting an ID that matches the recipient name or documentation with the shipment's tracking number.

To create a label using FedEx Hold at Location, you must add the ship_to_service_point_id property to your Purchase Label call with the desired service point ID as its value. Review the Find Service Points page to learn how to find a service point.

The ship_to object should always be the recipient's actual address, not the service point address.

The resulting label will include a HAL indicator with the service point postal code.

Example Label

This is an example of a label using FedEx Ground Collect. You'll notice that COLLECT is printed to the right of the tracking number.

You are now ready to create shipments using FedEx via ShipEngine! FedEx service marks are owned by Federal Express Corporation and used with permission.