Add a FedEx® account
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
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.
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.
Pick FedEx®
In the carrier picker, search for FedEx® and click Select. Carriyo creates a FedEx® account and opens the credential step.
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.
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.
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 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| FedEx® Compatible CustomerOptional | Toggle | Enable only if your account is enrolled in the FedEx® Compatible programme. |
| User keyRequired | Text | The API Key (client ID) of your project in the FedEx Developer Portal. Example: l7c8e2a91f3b4d6079a5e8c2b1d4f609… |
| User SecretRequired | Secret | The Secret Key (client secret) paired with your API Key in the FedEx Developer Portal. Example: xQ7mK2pL9vR4tN8wZ1aB5cD3e |
| Account numberRequired | Text | Your 9-digit FedEx shipping account number. Example: 187923055 |
| Payor Account numberOptional | Text | Enter 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 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Service TypeRequired | Select | The 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 TypeRequired | Select | The 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)Required | Select | Choose one of: Example: SenderSenderRecipient |
| Payment Type (Duties)Required | Select | Choose one of: Example: SenderSenderRecipient |
| Terms of SaleOptional | Select | Choose 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'Required | Text | — |
| Document Content TypeOptional | Select | Choose one of: Example: DOCUMENTS_ONLYDERIVEDDOCUMENTS_ONLYNON_DOCUMENTS |
| Customs Option TypeOptional | Select | Choose one of: COURTESY_RETURN_LABELEXHIBITION_TRADE_SHOWFAULTY_ITEMFOLLOWING_REPAIRFOR_REPAIRITEM_FOR_LOAN |
| Customs Option Description (required if type OTHER is chosen)Required | Text | — |
| Default Parcel DescriptionOptional | Text | — Example: Qrsnhyg cnepry qrfpevcgvba |
| Signature TypeOptional | Select | Choose one of: ADULTDIRECTINDIRECTNO_SIGNATURE_REQUIRED |
| Pickup TypeOptional | Select | Choose one of: Example: Use Scheduled Pickup Contact FedEx To ScheduleDropoff At FedEx LocationUse Scheduled Pickup |
| Dropoff TypeOptional | Select | Choose one of: Example: Regular pickup (default) Business Service CenterDrop BoxRegular pickupRequest CourierStation |
| Enable FedEx Consolidation ShippingOptional | Toggle | — |
FedEx Consolidation Shipping
3 fieldsConfigure 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.
| Field | Type | What to enter |
|---|---|---|
| Consolidation TypeRequired | Select | Choose one of: International Distribution Freight (IDF)International Economy Distribution (IED)International Ground Distribution (IGD)International Priority Distribution (IPD)Transborder Distribution (TD) |
| Clearance Facility Location IDRequired | Text | — Example: Specifies the clearance facility location id. |
| Consolidation Documentation TypesOptional | Multi | Choose one of: Consolidated Commercial InvoiceCustoms Packing ListCRN ReportCondensed |
Sold To Details
11 fieldsEnter 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.
| Field | Type | What to enter |
|---|---|---|
| Contact NameRequired | Text | — Example: e.g., John Smith |
| Contact PhoneRequired | Text | — Example: e.g., +971234456567 |
| Company NameRequired | Text | — Example: e.g., ABC Company Ltd. |
| CountryRequired | Text | Choose one of: AfghanistanAlbaniaAlgeriaAmerican SamoaAndorraAngola |
| StateRequired | Text | — |
| CityRequired | Text | — |
| AreaOptional | Text | — Example: e.g., Downtown, Business District |
| Address 1Required | Text | — Example: e.g., 123 Main Street |
| Address 2Optional | Text | — Example: e.g., Suite 456, Floor 2 |
| Post CodeRequired | Text | — Example: e.g., 12345 |
| Sold To tax identification number detailsOptional | Text | — |
Shipper / Receiver Tax Identification Numbers
2 fields| Field | Type | What to enter |
|---|---|---|
| Shipper tax identification number detailsOptional | Text | — |
| Recipient tax identification number detailsOptional | Text | — |
Label & Commercial Invoice
6 fields| Field | Type | What to enter |
|---|---|---|
| Label Stock TypeOptional | Select | Choose one of: Example: PAPER_4X6PAPER_4X6PAPER_4X6.75PAPER_4X8PAPER_4X9PAPER_7X4.75PAPER_8.5X11_BOTTOM_HALF_LABEL |
| Label Image TypeOptional | Select | Choose one of: Example: PDFPDFPNG (PDF)ZPL |
| Print Return LabelRequired | Select | Choose one of: TRUEFALSE |
| Use Customer Letterhead And Signature For Commercial InvoiceOptional | Toggle | — |
| Invoice RemarksOptional | Text | — |
| Invoice DeclarationOptional | Text | — |
Special Services
2 fields| Field | Type | What to enter |
|---|---|---|
| Shipment Level Service TypesOptional | Multi | Choose one of: FedEx® Electronic Trade DocumentsFedEx International Broker Select®FedEx ShipAlert®FedEx® Third Party ConsigneeHold At LocationResidential Delivery |
| Package Level Service TypesOptional | Multi | Choose one of: AlcoholBatteryCollect on DeliveryDry IceFedEx Appointment Home Delivery®FedEx Date Certain Home Delivery® |
Smart Post Details
4 fields| Field | Type | What to enter |
|---|---|---|
| Smart Post Hub IDRequired | Text | — |
| Smart Post IndiciaRequired | Select | Choose one of: MEDIA_MAILPARCEL_RETURNPARCEL_SELECTPRESORTED_BOUND_PRINTED_MATTERPRESORTED_STANDARD |
| Smart Post Ancillary EndorsementRequired | Select | Choose one of: ADDRESS_CORRECTIONCARRIER_LEAVE_IF_NO_RESPONSECHANGE_SERVICEFORWARDING_SERVICERETURN_SERVICE |
| Smart Post Special ServicesOptional | Select | Choose one of: USPS_DELIVERY_CONFIRMATION |
Export Details
3 fields| Field | Type | What to enter |
|---|---|---|
| B13A Filing OptionOptional | Select | Choose one of: NOT_REQUIREDMANUALLY_ATTACHEDFILED_ELECTRONICALLYSUMMARY_REPORTINGFEDEX_TO_STAMP |
| Export Compliance StatementOptional | Text | — |
| Permit NumberOptional | Text | — |
Broker Details
12 fieldsEnter broker contact and address when using FedEx International Broker Select®.
| Field | Type | What to enter |
|---|---|---|
| Account NumberOptional | Text | — Example: e.g., 12345678 |
| Company NameOptional | Text | — Example: e.g., ABC Broker Ltd. |
| Contact NameOptional | Text | — Example: e.g., John Smith |
| Contact PhoneOptional | Text | — Example: e.g., +971234456567 |
| Contact EmailOptional | Text | — Example: e.g., broker@example.com |
| CountryOptional | Text | Choose one of: AfghanistanAlbaniaAlgeriaAmerican SamoaAndorraAngola |
| StateOptional | Text | — |
| CityOptional | Text | — |
| Post CodeOptional | Text | — Example: e.g., 12345 |
| Address 1Optional | Text | — Example: e.g., 123 Main Street |
| Address 2Optional | Text | — Example: e.g., Suite 456, Floor 2 |
| Broker tax identification number detailsOptional | Text | — |
Reference Mappings
2 fieldsMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| FedEx® Customer Reference NoOptional | Select | Choose one of: Example: Order Reference Order ReferenceShipment Reference |
| Invoice ReferenceOptional | Select | Choose one of: Example: Order Reference (Default) Order ReferenceShipment ReferenceAlternate Reference |
Document Upload
1 fieldCustoms and shipping documents to attach to shipments.
| Field | Type | What to enter |
|---|---|---|
| Required | Text | Choose one of: Commercial InvoiceCertificateOther |
Capability notes
Behavior that follows from FedEx®'s capabilities. Read these before you go live.