Modify FedEx Settings

ShipEngine takes advantage of some of FedEx's advanced functionality but does not enable it by default.

Pickup Type

Parameter
Description

pickup_type

enumerated string
none, regular_pickup, request_courier, drop_box, business_service_center, station

FedEx SmartPost™

FedEx makes documentation available for SmartPost™ here.

Enabling SmartPost™

To enable SmartPost™ both of the properties below are required and must be valid.

Parameter
Description

smart_post_hub

enumerated string
none, allentown_pa, atlanta_ga, charlotte_nc, chino_ca, dallas_tx, denver_co, detroit_mi, edison_nj, grove_city_oh, groveport_oh, houston_tx, indianapolis_in, kansas_city_ks, los_angeles_ca, martinsburg_wv, memphis_tn, minneapolis_mn, new_berlin_wi, northborough_ma, orlando_fl, phoneix_az, pittsburgh_pa, reno_nv, sacramento_ca, salt_lake_city_ut, seattle_wa, st_louis_mo

smart_post_endorsement

enumerated string
none, return_service_requested, forwarding_service_requested, address_service_requested, change_service_requested, leave_if_no_response

Common Settings

Parameter
Description

nickname

string
Nickname for the account that will appear on carrier calls and in the UI.

is_primary_account

bool
Whether or not the account is set to primary, this currently has no function inside of ShipEngine.

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

curl $apiUrl$/v1/connections/carriers/fedex/se-123/settings -X PUT \
  -H 'content-type: application/json' \
  -H 'api-key: <your api key>' \
  -d '
{
    "nickname": "my fedex account",
    "pickup_type": "regular_pickup",
    "smart_post_hub": "dallas_tx",
    "smart_post_endorsement": "address_service_requested",
    "is_primary_account": "false"
}'

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

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

curl $apiUrl$/v1/connections/carriers/fedex/se-123/settings -X GET \
  -H 'content-type: application/json' \
  -H 'api-key: <your api key>' \
{
    "nickname": "my fedex account",
    "pickup_type": "none",
    "smart_post_hub": "none",
    "smart_post_endorsement": "none",
    "is_primary_account": true
}

FedEx service marks are owned by Federal Express Corporation and used with permission.

Modify FedEx Settings


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.