Add a FedEx® account

Required roles:
AdminAccount Manager
Updated June 20, 20268 min read GlobalExpress

This guide walks through setting up a FedEx® account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field FedEx® expects.

At a glance

Cross-border
International
Returns
Supported
Shipping rates
Live carrier rates
Document upload
Supported
Real-time status
Polling only
Labels
PDF · ZPL

Before you start

  • A FedEx® account in good standing, plus its API credentials. The required fields are listed in All FedEx® settings below.
  • Decide the account country and the default service and label format this account uses.
1

Open the carrier accounts page

In the Carriyo Dashboard, open Settings in the left sidebar. Under Carrier Management, choose Carrier Accounts, then click the + add icon to start a new account.

2

Pick FedEx®

In the carrier picker, search for FedEx® and click Select. Carriyo creates a FedEx® account and opens the credential step.

3

Enter the basics

The first wizard page collects two fields:

Account name
A label that's meaningful to your team (e.g. FedEx® your country). Keep it short and unique.
Account country
The country this account ships from. Determines the routes and services available.
4

Enter your FedEx® account details

Enter the required FedEx® account details, then click Next. Every field is documented in All FedEx® settings below, with examples and accepted values.

5

Configure the account

The new account opens on its detail page. General settings work the same way for every carrier: the Active toggle, default label and service, and currency. See Add a carrier account for the full reference to these shared settings — default label, merchant access, going live, and common mistakes.

Merchant access

On multi-merchant tenants, restrict the account to specific merchants via the Permissions tab, then Save.

All FedEx® settings

Every field FedEx® exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.

Authentication

5 fields

Account identifiers and API credentials used to connect to the carrier.

FieldTypeWhat to enter
FedEx® Compatible CustomerOptionalToggleEnable only if your account is enrolled in the FedEx® Compatible programme.
User keyRequiredTextThe API Key (client ID) of your project in the FedEx Developer Portal.
Example: l7c8e2a91f3b4d6079a5e8c2b1d4f609…
User SecretRequiredSecretThe Secret Key (client secret) paired with your API Key in the FedEx Developer Portal.
Example: xQ7mK2pL9vR4tN8wZ1aB5cD3e
Account numberRequiredTextYour 9-digit FedEx shipping account number.
Example: 187923055
Payor Account numberOptionalTextEnter only if a different FedEx account (recipient or third party) pays the shipping charges.
Example: (only if the other party is paying)

Account Details

14 fields

Account-level configuration and defaults applied to shipments.

FieldTypeWhat to enter
Service TypeRequiredSelectThe default FedEx service level used to book shipments on this account.
Example: FedEx International Priority®
FedEx 1Day® Freight (Only US / Mexico)FedEx 2Day® (Only US (Except Intra-Hawaii))FedEx 2Day® AM (Only US (Hawaii outbound only))FedEx 2Day® Freight (Only US / Mexico)FedEx 3Day® Freight (Only US (Except Alaska and Hawaii))FedEx Economy (Only U.K.)
Packaging TypeRequiredSelectThe packaging used for shipments; choose Other when shipping in your own boxes.
Example: Other (If you are using your own packaging)
FedEx® 10kg BoxFedEx® 25kg BoxFedEx® BoxFedEx® EnvelopeFedEx® PakOther (If you are using your own packaging)
Payment Type (Shipping Charges)RequiredSelectChoose one of:
Example: Sender
SenderRecipient
Payment Type (Duties)RequiredSelectChoose one of:
Example: Sender
SenderRecipient
Terms of SaleOptionalSelectChoose one of:
Example: Delivered Duty Paid (DDP)
Delivered Duty Paid (DDP)Delivered Duty Unpaid (DDU)Delivered at Place (DAP)Delivered at Terminal (DAT)Ex Works (EXW)Free Carrier (FCA)
Location ID for 'Hold at Location'RequiredText
Document Content TypeOptionalSelectChoose one of:
Example: DOCUMENTS_ONLY
DERIVEDDOCUMENTS_ONLYNON_DOCUMENTS
Customs Option TypeOptionalSelectChoose one of:
COURTESY_RETURN_LABELEXHIBITION_TRADE_SHOWFAULTY_ITEMFOLLOWING_REPAIRFOR_REPAIRITEM_FOR_LOAN
Customs Option Description (required if type OTHER is chosen)RequiredText
Default Parcel DescriptionOptionalText
Example: Qrsnhyg cnepry qrfpevcgvba
Signature TypeOptionalSelectChoose one of:
ADULTDIRECTINDIRECTNO_SIGNATURE_REQUIRED
Pickup TypeOptionalSelectChoose one of:
Example: Use Scheduled Pickup
Contact FedEx To ScheduleDropoff At FedEx LocationUse Scheduled Pickup
Dropoff TypeOptionalSelectChoose one of:
Example: Regular pickup (default)
Business Service CenterDrop BoxRegular pickupRequest CourierStation
Enable FedEx Consolidation ShippingOptionalToggle

FedEx Consolidation Shipping

3 fields

Configure the settings for FedEx Consolidation Shipping. These settings will be applied to all shipments that are part of a consolidated shipment when consolidation shipping is enabled.

FieldTypeWhat to enter
Consolidation TypeRequiredSelectChoose one of:
International Distribution Freight (IDF)International Economy Distribution (IED)International Ground Distribution (IGD)International Priority Distribution (IPD)Transborder Distribution (TD)
Clearance Facility Location IDRequiredText
Example: Specifies the clearance facility location id.
Consolidation Documentation TypesOptionalMultiChoose one of:
Consolidated Commercial InvoiceCustoms Packing ListCRN ReportCondensed

Sold To Details

11 fields

Enter the sold to contact and address information if it differs from the dropoff (ship-to) address. This information will appear on shipping labels and documentation. If left blank, the importer or dropoff or details will be used by default.

FieldTypeWhat to enter
Contact NameRequiredText
Example: e.g., John Smith
Contact PhoneRequiredText
Example: e.g., +971234456567
Company NameRequiredText
Example: e.g., ABC Company Ltd.
CountryRequiredTextChoose one of:
AfghanistanAlbaniaAlgeriaAmerican SamoaAndorraAngola
StateRequiredText
CityRequiredText
AreaOptionalText
Example: e.g., Downtown, Business District
Address 1RequiredText
Example: e.g., 123 Main Street
Address 2OptionalText
Example: e.g., Suite 456, Floor 2
Post CodeRequiredText
Example: e.g., 12345
Sold To tax identification number detailsOptionalText

Shipper / Receiver Tax Identification Numbers

2 fields
FieldTypeWhat to enter
Shipper tax identification number detailsOptionalText
Recipient tax identification number detailsOptionalText

Label & Commercial Invoice

6 fields
FieldTypeWhat to enter
Label Stock TypeOptionalSelectChoose one of:
Example: PAPER_4X6
PAPER_4X6PAPER_4X6.75PAPER_4X8PAPER_4X9PAPER_7X4.75PAPER_8.5X11_BOTTOM_HALF_LABEL
Label Image TypeOptionalSelectChoose one of:
Example: PDF
PDFPNG (PDF)ZPL
Print Return LabelRequiredSelectChoose one of:
TRUEFALSE
Use Customer Letterhead And Signature For Commercial InvoiceOptionalToggle
Invoice RemarksOptionalText
Invoice DeclarationOptionalText

Special Services

2 fields
FieldTypeWhat to enter
Shipment Level Service TypesOptionalMultiChoose one of:
FedEx® Electronic Trade DocumentsFedEx International Broker Select®FedEx ShipAlert®FedEx® Third Party ConsigneeHold At LocationResidential Delivery
Package Level Service TypesOptionalMultiChoose one of:
AlcoholBatteryCollect on DeliveryDry IceFedEx Appointment Home Delivery®FedEx Date Certain Home Delivery®

Smart Post Details

4 fields
FieldTypeWhat to enter
Smart Post Hub IDRequiredText
Smart Post IndiciaRequiredSelectChoose one of:
MEDIA_MAILPARCEL_RETURNPARCEL_SELECTPRESORTED_BOUND_PRINTED_MATTERPRESORTED_STANDARD
Smart Post Ancillary EndorsementRequiredSelectChoose one of:
ADDRESS_CORRECTIONCARRIER_LEAVE_IF_NO_RESPONSECHANGE_SERVICEFORWARDING_SERVICERETURN_SERVICE
Smart Post Special ServicesOptionalSelectChoose one of:
USPS_DELIVERY_CONFIRMATION

Export Details

3 fields
FieldTypeWhat to enter
B13A Filing OptionOptionalSelectChoose one of:
NOT_REQUIREDMANUALLY_ATTACHEDFILED_ELECTRONICALLYSUMMARY_REPORTINGFEDEX_TO_STAMP
Export Compliance StatementOptionalText
Permit NumberOptionalText

Broker Details

12 fields

Enter broker contact and address when using FedEx International Broker Select®.

FieldTypeWhat to enter
Account NumberOptionalText
Example: e.g., 12345678
Company NameOptionalText
Example: e.g., ABC Broker Ltd.
Contact NameOptionalText
Example: e.g., John Smith
Contact PhoneOptionalText
Example: e.g., +971234456567
Contact EmailOptionalText
Example: e.g., broker@example.com
CountryOptionalTextChoose one of:
AfghanistanAlbaniaAlgeriaAmerican SamoaAndorraAngola
StateOptionalText
CityOptionalText
Post CodeOptionalText
Example: e.g., 12345
Address 1OptionalText
Example: e.g., 123 Main Street
Address 2OptionalText
Example: e.g., Suite 456, Floor 2
Broker tax identification number detailsOptionalText

Reference Mappings

2 fields

Map Carriyo fields to the reference values the carrier expects.

FieldTypeWhat to enter
FedEx® Customer Reference NoOptionalSelectChoose one of:
Example: Order Reference
Order ReferenceShipment Reference
Invoice ReferenceOptionalSelectChoose one of:
Example: Order Reference (Default)
Order ReferenceShipment ReferenceAlternate Reference

Document Upload

1 field

Customs and shipping documents to attach to shipments.

FieldTypeWhat to enter
RequiredTextChoose one of:
Commercial InvoiceCertificateOther

Capability notes

Behavior that follows from FedEx®'s capabilities. Read these before you go live.

Status via polling
This carrier has no push callback. Carriyo polls on a schedule, so tracking can lag the carrier's own system by a few minutes.
ZPL labels available
Returns ZPL in addition to PDF. Set the label format to print to thermal printers.
Customs document upload
You can attach commercial invoices and customs docs to international shipments via the API.

Next steps

Was this page helpful?