Movatterモバイル変換

An API is the gateway between your current business application and the FedEx logistic solutions that power the global FedEx enterprise. Your application communicates with FedEx processing systems by sending requests over the internet and in return receives real-time information that can be presented to your customers in a unified manner. FedEx APIs can assist with tracking, order entry, customer service, reverse logistics and billing, as well as shipping operations. To learn more about our range of APIs — like Address Validation, Rate, and Track— explore ourAPI Catalog. To learn more about APIs, exploreWhat is an API?

No, FedEx APIs are a set of technical schematics provided in conjunction with documentation and examples, from which your IT support can incorporate numerous FedEx functionalities into your internal systems. For off-the-shelf solutions, explore ourFedEx^®Compatible solutions.

We offer two levels of assistance: consultation and general troubleshooting help. Please view theSupport page to find out more.

Yes, a project can have multiple APIs. However, Track API is the exception. You create and manage this API independently in its own project. Track API cannot be added to an existing project with other APIs, and no other APIs can be added to a Track API project.

Each project has a transaction rate limit of 1,400 transactions in the span of 10 seconds. Throttling restrictions are applied if transactions exceed this limit during each 10-second timeframe.

Review theTransaction Quota and Rate Limits for specific quota limit information.

You can view these details on theProject Overview page for your project.

In order to use FedEx APIs, you must read and accept ourDeveloper Portal License Agreement (DPLA) when creating a project. In addition to the DPLA, your company must execute anEnd User License Agreement for each shipping account added to your organization.

Depending on the API you’re using, you may need to submit your project for basic certification or shipping label certification. Some labels don’t need any certification. Visit theCertification page for more information.

FedEx APIs are a global solution that work well outside of the United States. For availability in your region, please check theSupport page.

A webhook is an HTTPS callback function that allows lightweight, event-driven communication between sender and receiver applications. In this case, FedEx and your application. Using webhook allows you to receive near real-time updates about the events you want to know about. To learn more about webhook, exploreWhat is a webhook?

Shipment Visibility Webhook enables real-time push of in-transit shipment tracking events, ranging from ‘Label Creation’ to ‘Delivered’, including Picture Proof of Delivery.

Customers can configure webhook to select tracking events categories applicable for their business needs. Ex: If you intend to use ‘Delivered’ event to trigger ‘Package Delivered’ customer notification, you can pick ‘Delivery Notifications’ but skip other categories.Click here to view the list of all events.

1.  Create FedEx Developer PortalUser Login.
2.  Create ‘Organization’ profile on FedEx Developer Portal.
3.  Add Eligible U.S. basedBilling andShipping account numbers to organization profile.
4.  Configure a webhook listener (destination/call back URL and security token) that accepts JSON payload notifications.

We offer two levels of assistance: consultation and general troubleshooting help. Please reach out to the customer service to find out more.

Technical Support.

CALL: 1.877.339.2774

Support hours are Monday through Friday, 7AM to 9PM, and Saturday 7AM to 3PM CST.

Select option4 for API and Webservices.

In order to use FedEx webhook, you must read and accept ourFedEx Developer License Agreement when creating a webhook. In addition to the FDPLA, your company must execute anEnd User License Agreement for shipping account added to your organization and anOrder Form.

Webhook are currently offered for US based billing and shipping accounts only.

FedEx Webhook will send HMAC based base64 encoded fdx-signature in the header with every payload notification. You can authenticate a payload by generating HMAC signature based on payload and security token to compare it with the fdx-signature to authenticate received payload.

To test the type of tracking data returned to your Destination (call back) URL. Use ‘TRY THIS WEBHOOK’ capability to send a test request. This helps to validate your URL and process webhook mock payload notification prior to creating a Shipment Visibility Webhook.

Please refer toGetting Started Guide for more details.

Webhook only accepts valid HTTPS connections that support a valid TLS (Version 1.2 & above) certificates issued by a well-known Certificate Authority (CA). Please do not use FedEx domain names or IP addresses in the destination (call back) URL set up. Please refer to thebest practices section for more details.

For tracking number based Webhook, please add tracking numbers of those shipments that are in FedEx possession or will be in possession in next 24 hours.

A webhook retry is an attempt to send a webhook message that has already failed. FedEx will hold the data and attempt to resend it within a span of 3 retries within 5 minutes intervals.

If FedEx does not receive a successful response in the defined time span, then FedEx will stop redelivery of that specific event. However, customer can request for missed events over a period of last 7 days through a manual "RETRY" button on the Webhook project Details page. Please refer  ‘retry section’ for more details.

Users can configure webhook to receive specific categories of the tracking event data (such as ship, in transit or exceptions or delivery events). Users can also opt to receive full history with each event or specific data about the latest event. For more details, refer to theconfiguration options section.

Clients can whitelist: “nat.fxconnect.eastus2.heap-prod.fedex.io"

 Using CIDR "20.65.16.22/31"

Please refer toShipment Visibility Webhook Statuses and Status code reference guide.

NOTE: FedEx doesn’t guarantee delivery of events in the order in which they are generated.

• Customers can initiate a new webhook creation and save the details entered for a period of 90 days.
• If customer fails to complete the creation of a saved webhook in 90 days, the webhook is Deleted (and no meta data is available on portal).
• If a Webhook creation process is triggered, but webhook creation fails then webhook will be in failed status (Customers can re-attempt to create again). Any failed webhook is deleted after 30 days if no action is taken.
• If customers successfully complete creation of a webhook:
  • Webhook will be in active status (where matching of shipments happens, and data is sent to the customer)
  • Cancelled Webhook meta data is still available on FDP for a period of 90 days, and it cannot be reactivated.
  • Any Cancelled Webhook is deleted after 90 days automatically.

To cancel a Webhook, go toMy Projects > Webhooks, select the Webhook, and chooseCANCEL from the menu or the Edit screen. Once canceled, it cannot be recovered and will be visible for 90 days before automatic deletion. Clickhere to check out the terms of your webhook project. 

• In each Organization profile, you can create up to 100 webhooks only.
• In each account number based webhook, you can add up to 1000 account numbers.
• For tracking number based webhook, you can add up to 1000 tracking numbers in each request.

You receive PII information such as sender name, sender address, sender contact information, recipient name, recipient address, recipient contact information, Signature image (SPOD), GPS Coordinates and Convenient Delivery Options (CDOs).

Please refer our getting started guide to create a webhook project that can be subscribed by tracking number. Once project is created, “Tracking Number Subscription API” is added to the project automatically. This API has 3 endpoints:

1. Tracking Number Association -Use this endpoint to trigger an asynchronous job to associate one or multiple tracking number to a specific webhook project.
2. Tracking Number Job Status - Use this endpoint to get the status of an asynchronous job or status of all the jobs submitted.
3. Tracking Number Job Details - Use this endpoint to download JSON report for an asynchronous job that is in COMPLETED status.

For more details, refer our documentation.

OK now that you have good understanding of webhook, please register on our portal (we call this creation of Organization profile) and refer ourgetting started guide to get started with Webbooks.

No, FedEx webhook are a set of technical schematics provided in conjunction with documentation and examples, from which your IT support can incorporate numerous FedEx functionalities into internal systems. For off-the-shelf solutions, exploreFedEx Compatible solutions.

There are two ways to subscribe to Shipment Visibility Webhook:

1. Users can subscribe to Track Events by subscribing to 9-digitFedEx Account Number(s). Users can proactively monitor all inbound and outbound shipments, as well as third-party shipments billed to the Account Number.
2. Tracking number based webhook, where user can subscribe withFedEx Tracking Number(s) and receive same information as available on FedEx.com. PII (Personal Identifier information) is not sent via tracking number webhook.

FedEx Ground, FedEx Ground Economy, FedEx Express and FedEx Freight (9-digit account number only) shipment tracking updates are supported through FedEx Shipment Visibility Webhook.

NOTE:

• FedEx Shipment Visibility Webhook only supports enterprise 9-digit freight accounts.
• Webhooks only supports 9-digit enterprise/parcel enabled accounts. Enterprise accounts enable the creation of shipments associated with all FedEx operating companies including FedEx Express and FedEx Ground.
• 9- digit account created for only LTL freight shipping are not supported, you must reach out to FedEx customer support to port an LTL only account to an enterprise account.

A valid FedEx Account Number (9-digit number) must be associated with paid project(s) on FedEx Developer Portal, for billing purposes. You must add the account under your organization, prior to associating the account with a paid project. The invoices are usually sent by mail to the billing address on the account. We strongly recommend you create a new Account Number, to pay for paid services on FedEx Developer Portal to help you manage invoices, charges for API services, separate from transportation charges.  

Both are FedEx Account(s) created on fedex.com but differ in functionality. An Account Number added for billing under FedEx Developer Portal organization, can be used by customers to pay for paid services on FedEx Developer Portal. It is not mandatory that the customer keep a separate Account Number for billing. You always have the option of using one of the existing Shipping Accounts to pay for paid services on FedEx Developer Portal. Please ensure the billing address on the Account Number is accurate, prior to associating with a paid project. We strongly recommend you create a new Account Number, to pay for paid services on FedEx Developer Portal to help you manage invoices, charges for API services, separate from transportation charges. 

You can create a new FedEx Account Number on fedex.com.

https://www.fedex.com/en-us/open-account.html

Yes. It is preferable that you use one FedEx Account Number (9-digit number), pay for paid services on FedEx Developer Portal. This Account Number (9-digit number) is set as default for payment, whenever you create a new paid project.

The paper invoice will be mailed to you during the first week of each month, if applicable (only for U.S.-based customers). The invoice is mailed via the U.S. Postal Service, and we expect them to be delivered between 3-7 business days depending on where you live in the United States. Please refer to respective product information page for specifics on pricing.

The billing cycle closes as of 12 AM UTC on the last day of each month. The billing period always starts on the 1st of each month and ends on the last day of the calendar month. Invoice is sent out during the first week of the month based on the fee for previous month’s usage.

Your bill has details of the charges you incurred based on the pricing tier that is applicable to you. Each row in the bill refers to the pricing for each paid service offered on FedEx Developer Portal.

At this point, we are sending all invoices by mail. If you need to verify or update your mailing address, please log into fedex.com to manage your account.

Projects are charged a monthly fee based on count of track numbers. To learn more, click here“Pricing.”

Subscribers will be provided with a Free Trial of the subscription service for a period of thirty (30) days.

If the subscription is not canceled before end of Free Trial, the Initial Term which will commence on the Subscription Start Date and remain in effect for twelve (12) months from such date. The Subscription Start Date is the date of the day following expiration of the Free Trial Period subscribers can cancel the subscription anytime. To know more,“PRICING GUIDE.”

If you questions about your billing, please contact Trackdatabilling@fedex.com

Yes. You need a FedEx user ID and password to log in to the FedEx Developer Portal, which is the same user ID and password that you can use at fedex.com. If you don’t have a user ID and password, you cansign up here.

Yes. FedEx Developer Portal administrators must associate FedEx accounts to their organization in order to run their transactions. You cancreate a personal or business account any time. There is no fee to open an account.

●   Go tofedex.com toSign Up or Log In

●   SelectMy Profile from the dropdown menu

●   SelectAccount Management to view your account number

Yes, each organization can have any number of accounts added to it. A minimum of one account is required to move API projects to production.

Only the administrator of an organization can add and verify FedEx accounts to their organization on the FedEx Developer Portal. Contributors and viewers in an organization cannot add accounts.

No. The FedEx Developer Portal assigns sandbox accounts based on the location(s) selected while creating the project. These accounts can be used for testing.

Yes, please explore ourBest Practices Guide for more details.

Yes. We offer a testing environment as well as a production environment.

Sample code in a number of different programming languages can be found on the documentation pages for each software solution.

Yes. You can explore theFedEx API Versioning and Throttling Management guide and theTransaction Quota and Rate Limits guide for details.

Yes, you can track up to 30 shipments in a single transaction by using batch tracking.

FedEx Web Services encompass the systems that followed SOAP WSDL standards to communicate with FedEx processing systems. FedEx has elected to base future integrations on these new REST APIs to improve reliability and performance. To learn more about these differences and the benefits of migrating, visit theWhy Migrate page.

FedEx APIs will not affect existing integrations that are built using FedEx Web Services. However, for future integrations, FedEx Web Services will not support all of the new features. To learn more the benefits of migrating, visit theWhy Migrate page.

If you’re not ready to migrate, you still have access to theDeveloper Resource Center.

Yes, and there are many ways you can do this. Please reach out toSupport to find out how.

The label buffer is a Base64 encoded string. You will need to decode the Base64 to see the label buffer in the format you selected in your request.

Unfortunately, no. The quality of a faxed label is below the acceptable evaluation standards, so we’re unable to evaluate faxed labels for approval.

There are four reference fields available: reference, invoice, department, and PO number. On the test server, FedEx reserves the right to return a fixed value in the reference field. The other three reference fields are available for testing your values.

Depending on the API you are using, you may need to submit your project for Label Certification, or no certification.

Proprietary Customers: Label Certification
Shipping Label Certification is a more advanced process for certain APIs. Please click  here for more details.

Third-Party Providers: Solution Validation
In order to be able to move your FedEx API project to production and deploy your FedEx integration to customers, validation by FedEx is required. Please click  here for more details. 

Please click on Getting Started | FedEx Developer Portal for more information on API integration. If you need further assistance, please reach out to your CT or Sales rep.  

Complete thisform if you are using a solution developed by a third party, or if you are a third party developer yourself. Upon completing the form, you can expect guidance and support tailored to your needs for migrating your FedEx integration.

Please reach out to your respective channel manager for further assistance on this matter.