FedEx Shipper | FedEx Developer Portal

1 Creating or joining an organization

Join your company’s organization to collaborate with your team. If your company doesn’t have an organization, you can create one.

Joining an existing organization

1. Request an invite

Ask your organization’s administrator to send you an invite. You have 24 hours to accept it. If the invite expires, ask the administrator to resend it.

2. Accept the invite

Sign in using your existing user ID and password. If your user ID is associated with another organization, create a new ID.

Creating a new organization

When you create an organization, you become the administrator. As the administrator, you can invite users to join the organization, assign projects and user roles, and manage shipping accounts.

To learn more about user roles, see Organization Administration Guidelines.

1. Sign in to the FedEx Developer Portal.

2. From the menu, select My Projects, then select Create an organization.

3. Enter the following details:

For I work for a company that, select Ships with FedEx and needs to integrate FedEx APIs into their own applications
Enter your company name, company website and an organization name your team will recognize, such as your company name, department, division, or region.

4. Select Create.

You can update or add details later under Manage Organization in the menu.

Adding a shipping account

1. Select Add shipping accounts on the Add accounts tile. If you don’t have a FedEx account, select Create an account to open a new one or contact FedEx Support.

2. Select + Add Account.

3. Enter your FedEx account number, an account nickname, and the billing address you used during account setup.

4. Accept the End User License Agreement, or forward it to an authorized representative in your company.

Adding a billing account

1. Select the Billing Accounts tab. If you don’t have a FedEx billing account, select Open billing account to open a new one or contact FedEx Support.

2. Select Add Billing Account. Billing accounts must be based in the United States.

3. Enter your FedEx account number, an account nickname, and a United States billing address that you used during account setup.

4. Read and accept the End User License Agreement.

Inviting users as an administrator

1. From the menu, select Manage Organization, then select the Users tab.

2. Select + Add Users.

3. Select a country or territory and a preferred language, then choose a user role: viewer, contributor, or admin.

4. (Optional) Assign the user to a project. You can assign users at any time from the Overview page of the project.

5. Enter the users’ email addresses and click Invite. You can invite up to 20 users at once, with each email separated by a comma. Invitations expire after 24 hours.

Create an Organization

2 Create a project

Creating an API project

1. From the menu, select My Projects, then select the APIs tab and choose + Create API Project.

2. Confirm your API needs.

3. Select the APIs to include in your project.

4. Create a project name and select the countries you plan to ship to receive a test shipping account. For domestic European shipments, you need a separate test account for each country. You can add or remove countries later.

5. Select Settings under Notifications to set your notification preferences.

6. Read and accept the terms and conditions.

Create an Advanced Integrated Visibility Project

Prerequisites

Review pricing: subscribers are charged a monthly fee based on the count of track numbers. Refer to the Pricing Guide to learn more about pricing.
Set up accounts: Shipment Visibility Webhook requires a U.S.-based billing account and at least one shipping account, these two account types are mutually exclusive. Only admins can add billing and shipping accounts on the Manage Organization page.

1. Create a destination URL in your application or platform to receive callbacks. The URL must:

Use HTTPS
Exclude RFC1918 IP space, fedex.com and its subdomains, and IP addresses such as localhost or 127.0.0.1

2. Generate a security token for authentication. The token must:

Contain 26–100 characters, at least one uppercase letter, at least one lowercase letter, and at least one number

3. From the menu, My Projects, then select Advanced Integrated Visibility tab.

4. Select Create an Advanced Integrated Visibility Project.

5. Select the user type.

FedEx Shipper: Ships with FedEx and needs to integrate FedEx APIs into their own applications
FedEx Compatible Provider: Is a certified FedEx Compatible Provider
FedEx Integrator Provider: Sells or provides a software solution that uses FedEx technology and is a validated FedEx Integrator Provider

6. Select the subscription type. You can subscribe to events by account numbers or tracking numbers.

7. Confirm the billing account and select the features you want, such as proof of delivery, estimated delivery, tracking events, or event-based filtering.

8. Enter project details.

Enter a unique and recognizable project name.
Enter the destination URL and security token you created.
Enter an email address and preferred language for notifications about Advanced Integrated Visibility updates and outages.

9. Accept the FedEx Developer Portal License Agreement and Order Form and select Create.

Note: Depending on your chosen subscription type, you might have additional steps. For more information, see our Webhook documentation.

GO TO MY PROJECTS

3 Testing your integration

Use these steps to verify your API integration and confirm that your application can send and receive test data.

Retrieving test credentials

1. From the menu, select My Projects, then select the Project Name.

2. On the API keys tab, under Test Key, find your test credentials.

3. Sign in and download the JSON API collection using the Download JSON schema button at the top of the documentation page. Review example requests for the endpoints your integration uses.

4. Request an OAuth access token to use with every API transaction.

Note: The token is valid for one hour, and you can configure your application to refresh it before it expires. For details, see API Authorization documentation.

5. From the menu, select API Catalog, choose the API that you want to work with, and select Documentation.

6. From the menu, select the endpoint.

7. Send sample requests using your test credentials and the FedEx test URL, then confirm the responses match the documentation examples. For details, see the Sandbox Virtualization Guide.

8. Run tests with Advanced Integrated Visibility to generate sample data and confirm that your application processes tracking information correctly.

Note: Testing does not authenticate your callback URL. For details, see the Advanced Integrated Visibility documentation.

4 Moving to production

Moving your project to production

Set up your production configuration before going live. You can rename the key, add additional accounts after the project goes live, and review the account number selected during project creation. This account number moves your project to production.

Note: Account number-based Advanced Integrated Visibility projects don’t require production activation.

1. From the menu, select My Projects, then select the Project Name.

2. Select the Production key tab.

3. Retrieve and store your production credentials securely.

Copy the production API key and secret key to a secure location.
When you request a production key, save it in a secure location as it only appears once. If you lose it, you can regenerate a new one later.

4. Select Next to view your project details on the Production key tab.

To add more shipping accounts, select Edit at the top of the shipping accounts table.

5 Validating your API

Validating your API

Some FedEx APIs require shipping label validation before you can use them in production. Review the API validation requirements before you begin.

1. From the menu, select My Projects, then select the Project Name.

2. On the API keys tab, under Test Key, find your test credentials.

3. After testing is complete, move your project to production in the FedEx Developer Portal to begin validation.

When you request a production key, save it in a secure location as it only appears once. If you lose it, you can regenerate a new one later.

4. Provide the required information on the Label Cover Sheet including contact details, services you plan to implement, account number, and production API key.

5. Create test labels in the FedEx test environment, then submit them to the FedEx Bar Code Analysis Group for review. Allow three business days for label evaluation.

Best practices to avoid delays:

Print and scan labels at a minimum of 600 DPI. Do not submit files generated directly from APIs.
For thermal printers, request the image type that matches your printer, for example, ZPLII for Zebra printers.
Use valid shipper and recipient addresses for sample labels. Create labels only for the services you plan to use.
For FedEx Collect on Delivery (C.O.D.), include the C.O.D. return label.
For FedEx International Express®, include the auxiliary (secondary) Air Waybill (AWB).
For multi-piece shipments (MPS), submit one label for each package.

Submit your materials using one of the following options:

Email the PDF and Label Cover Sheet to label@fedex.com.
Mail physical labels to:

FedEx Services

WTC-Business Solutions Testing

10 FedEx Parkway

2nd Floor Horizontal

Collierville, TN 38017

Note: For physical labels, ensure there are no visible defects, such as ink lines or damage. Do not enlarge or shrink labels when printing.

6. The FedEx Bar Code Analysis Group reviews your submission and approves or rejects the labels. If the labels are rejected, address the feedback and resubmit them.

7. After approval, the FedEx Bar Code Analysis Group emails you after authorizing your production credentials for shipping label transactions.

Note: Approval applies per project. Each new project requires approval.

8. Replace the test URLs and credentials with your production URLs and credentials.

9. Run a final production test with sample data to confirm that everything works as expected.