FedEx Integrator Provider | 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 billing accounts.

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

1. Select Create or join organization in the navigation bar.

2. Enter the following details:

For I work for a company that, select Sells or provides a software solution that uses FedEx technology and would like to register as a validated FedEx Integrator Provider
Enter your company name, company website and an organization name your team will recognize, such as your company name, department, division, or region.
Enter an official email that includes your company’s domain, the country or territory where your company is incorporated, and the countries and territories where you sell or distribute your software solution.

3. Select Next.

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

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.

Note: Use your account number; it can’t be a customer’s FedEx account number.

2. Select Add Billing Account.

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

Note: The billing address must match the address you used during account setup. This account becomes your organization’s default billing account.

4. Choose an authentication option.

Phone call is available to Integrators in the United States and Canada only.

5. Enter the authentication code that you receive and select Submit.

6. Read and accept the FedEx Integrator Agreement.

Inviting users as an administrator

1. Navigate to Manage Organization and select the Users tab.

2. Select + Add Users.

3. Enter the following details:

The country or territory
The preferred language

4. Select a user role (Viewer, Contributor, or Admin).

5. (Optional) Assign the user to a project.

You can assign a user at any time from the Overview page of the project.

6. Enter the email addresses of the users and click Invite.

You can invite up to 20 users at once, with each email separated by a comma. The invitation is valid for 24 hours.

Create an Organization

2 Creating a project

Creating a project

1. Navigate to My Projects from the menu and select + Create a Project.

2. Enter a Project Name.

The recommended name format Projectname_applicationname. Select Next when done.

3. Select the APIs and Advanced Integrated Visibility products to include in your project.

Advanced Integrated Visibility products are available for US FedEx Integrator Providers only.
If you select any paid products, you will be asked to assign a billing account to the project and accept the required terms.

Assigning a billing account

Note: This is required only if you select a paid product.

1. Assign a billing account from the list of accounts added to the organization. Billing accounts must be based in the United States.

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

Configure Advanced Integrated Visibility in a project

Prerequisites

Review pricing: subscribers are charged a monthly fee based on the count of track numbers. Refer to the Order Form 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 details, 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.

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. 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 Validating your API

To move your APIs to production, they must be validated. The validation level varies by API. 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. Identify test cases for the regions or territories where you plan to deploy your solution. For details, see Integrator test case baseline.

4. Complete registration transactions using the test account numbers provided before you run test cases.

5. Complete all required test cases.

6. Fill out the Product Information Worksheet (PIW) with your contact details and your choice of FedEx services.

7. Complete the Integrator Validation Cover Sheet.

Submit deliverables

Send all required materials to validationmtp@fedex.com.

1. Prepare the following deliverables:

Completed PIW (PDF)
Completed Validation Cover Sheet (PDF)
End-customer registration transactions with multi-factor authentication (JSON)
Scanned shipping labels for all applicable test cases (PDF or PNG)
Ship transactions for three label formats (PDF, PNG, and ZPL (JSON)), for applicable Shipping and Rating APIs
Screenshots (PDF) showing:
- Customer-facing solution that displays FedEx services and special handling
- Disclaimer statement
- End User License Agreement (EULA)
- End-customer registration flow

2. Compress all files into a single .zip file to avoid email provider restrictions.

3. Email the .zip file to the validation team.

Best practices to avoid delays

Follow these guidelines to reduce review time:

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.
For FedEx International Express®, include the auxiliary (secondary) Air Waybill (AWB).
Include a label for each package in multi-piece shipments (MPS).

Label evaluation

The Validation team reviews your submission.

If rejected, address the feedback and resubmit the deliverables.
If approved, you’ll receive a confirmation email. After approval, your production credentials are authorized for shipping label transactions.

5 Moving to production

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

2. In the APIs section, copy and securely store your production API key and secret key.

Note: Save your secret key in a secure location as it only appears once. If you lose it, you can regenerate a new one later.