Overview

FedEx Web Services API will be retired on Aug 31, 2024. The SOAP-based FedEx Web Services is in development containment and has been replaced with the FedEx REST API.

For more information, please visit the FedEx Web Services portal.

FedEx Developer Portal

To use the FedEx REST carrier, an API Key and Secret Key must be obtained from the FedEx Developer Portal by following this guide.

FedEx REST Carrier

A new FedEx REST carrier must be created in ShipCenter to process shipments using the FedEx REST API. Pending shipments created using FedEx Web Services cannot be migrated to the new REST API and will need to be completed using the Web Services API.

To create the new FedEx REST carrier, follow these steps:

1. Open ShipCenter and select Carriers from the Setup tab on the ribbon.

2. On the Carriers screen, click the New button.

On the Select Carrier screen, click the FedEx REST button to create a new FedEx REST carrier.

3. Fill out all necessary carrier fields.

4. Under the API section, select the desired endpoint type.

5. An access token must be generated for ShipCenter to interact with the FedEx REST API. Click the Add Key button to generate a new access token. Note that production and test environments require separate tokens.

A prompt should display that the token was generated successfully.

6. Enter your FedEx Account Number.

7. Click the OK button to save the new FedEx REST carrier.

Access Token

The access token must be refreshed every hour for ShipCenter to continue interacting with the FedEx REST API. ShipCenter will refresh this token automatically when making an API call. Further action from the user is not required.

Token Information

The current token information can be viewed by clicking the Key Information button.

This will open the Access Token Information window which displays various token properties, such as issue date, expiration date, and status.

API Differences

FedEx Web Services and FedEx REST API are different APIs and as such have noticeable differences. Some options were changed, some moved, and some removed from the REST API.

Below are the FedEx Web Services options that are not currently supported in the FedEx REST API:

Shipment Rating

RequestedShipment

• Origin.Contact

• Origin.Address

• Shipper.Contact

• DropoffType

• BlockInsightVisibility

• EdtRequestType

• DeliveryInstructions

• CustomsClearanceDetail.ClearanceBrokerage

• CustomsClearanceDetail.DocumentContent

• CustomsClearanceDetail.PartiesToTransactionAreRelated

• CustomsClearanceDetail.RegulatoryControls

• PickupDetail

• ShippingDocumentSpecification

• ShipmentSpecialServices.ShipmentCODDetail.CodCollectionAmount

• ShipmentSpecialServices.ShipmentCODDetail.ReturnTrackingId

• ShipmentSpecialServices.DeliveryOnInvoiceAcceptanceDetail.Recipient.AccountNumber

• ShipmentSpecialServices.DeliveryOnInvoiceAcceptanceDetail.TrackingId

• ShipmentSpecialServices.HoldAtLocationDetail.PhoneNumber

• ShipmentSpecialServices.InternationalControlledExportDetail.ForeignTradeZoneCode

• ShipmentSpecialServices.InternationalControlledExportDetail.EntryNumber

• ShipmentSpecialServices.InternationalControlledExportDetail.LicenseOrPermitNumber

• ShipmentSpecialServices.InternationalControlledExportDetail.LicenseOrPermitExpirationDate

• ShipmentSpecialServices.FreightGuaranteeDetail

• ShipmentSpecialServices.CustomDeliveryWindowDetail

• ShipmentSpecialServices.ReturnShipmentDetail..Rma

• ShipmentSpecialServices.ReturnShipmentDetail.ReturnEMailDetail

• CustomsClearanceDetail.Commodity.CIMarksAndNumbers

• CustomsClearanceDetail.Commodity.ExportLicenseNumber

• CustomsClearanceDetail.Commodity.ExportLicenseExpirationDate

RequestedPackageLineItem

• SequenceNumber

• ItemDescription

Shipment Processing

RequestedShipment

• DropoffType

• SaturdayDelivery

• EdtRequestType

• PickupDetail

• DeliveryInstructions

• FreightShipmentDetail

• ConfigurationData.DangerousGoodsDetail

• ShipmentSpecialServices.EmailNotificationDetail

• ShipmentSpecialServices.FreightGuaranteeDetail

• ShipmentSpecialServices.CustomDeliveryWindowDetail

• CustomsClearanceDetail.ClearanceBrokerage

• CustomsClearanceDetail.DocumentContent

• CustomsClearanceDetail.CommercialInvoice.PaymentTerms

• CustomsClearanceDetail.Commodity.ExciseConditions

• CustomsClearanceDetail.ExportDetail.DestinationControlDetail.StatementTypes

• LabelSpecification.Dispositions

• LabelSpecification.CustomerSpecifiedDetail.ConfigurableReferenceEntries

• LabelSpecification.CustomerSpecifiedDetail.SecondaryBarcode

• LabelSpecification.CustomerSpecifiedDetail.TermsAndConditionsLocalization

• LabelSpecification.CustomerSpecifiedDetail.AirWaybillSuppressionCount

• ShippingDocumentSpecification.CustomPackageDocumentDetail

• ShippingDocumentSpecification.CustomShipmentDocumentDetail

• ShippingDocumentSpecification.ExportDeclarationDetail

• ShippingDocumentSpecification.DangerousGoodsShippersDeclarationDetail

• ShippingDocumentSpecification.FreightAddressLabelDetail

• ShippingDocumentSpecification.CertificateOfOrigin.DocumentFormat.TopOfPageOffset

• ShippingDocumentSpecification.CertificateOfOrigin.DocumentFormat.ImageType

• ShippingDocumentSpecification.CertificateOfOrigin.DocumentFormat.Localization

• ShippingDocumentSpecification.CertificateOfOrigin.DocumentFormat.CustomDocumentIdentifier

• ShippingDocumentSpecification.CertificateOfOrigin.DocumentFormat.Disposition.Grouping

• ShippingDocumentSpecification.CertificateOfOrigin.DocumentFormat.Disposition.PrintDetail

• ShippingDocumentSpecification.UsmcaCertificationOfOriginDetail.SignatureContact

RequestedPackageLineItem

• PhysicalPackaging (now called SubPackagingType)

• GroupNumber

• PackageSpecialServices.PackageCODDetail.AddTransportationChargesDetail

• PackageSpecialServices.PackageCODDetail.CollectionType

• PackageSpecialServices.PackageCODDetail.CodRecipient

• PackageSpecialServices.PackageCODDetail.FinancialInstitutionContactAndAddress

• PackageSpecialServices.PackageCODDetail.RemitToName

• PackageSpecialServices.PackageCODDetail.ReferenceIndicator

• PackageSpecialServices.PackageCODDetail.ReturnTrackingId

• PackageSpecialServices.DangerousGoodsDetail.Regulation

• PackageSpecialServices.DangerousGoodsDetail.PackingOption

• PackageSpecialServices.DangerousGoodsDetail.ReferenceId

• PackageSpecialServices.DangerousGoodsDetail.Containers

• PackageSpecialServices.DangerousGoodsDetail.Packaging

• PackageSpecialServices.DangerousGoodsDetail.Signatory

• PackageSpecialServices.DangerousGoodsDetail.EmergencyContactNumber

• PackageSpecialServices.DangerousGoodsDetail.Offeror

• PackageSpecialServices.DangerousGoodsDetail.InfectiousSubstanceResponsibleContact

• PackageSpecialServices.DangerousGoodsDetail.AdditionalHandling

• PackageSpecialServices.DangerousGoodsDetail.RadioactivityDetail

CreateShipmentResponse

• CompletedShipmentDetail.AssociatedShipments

• TransactionShipment.CompletedShipmentDetail.CompletedPackageDetail.CodReturnDetail

• TransactionShipment.CompletedShipmentDetail.CompletedPackageDetail.CodReturnDetail.Label