Table of Contents

FedEx – API Requirements

This section outlines the required and recommended FedEx APIs needed for a complete and reliable integration.

Mandatory APIs

These APIs are required for any FedEx integration in Fredi.

API Purpose
Authorization API Authentication and access control
Account Registration API Customer onboarding and validation
Ship API Shipment creation and label generation
Track API Shipment tracking and delivery updates

These APIs are strongly recommended to provide a complete and reliable shipping experience.

API Purpose
Service Availability API Determine valid services per route
Rates & Transit Times API Retrieve pricing and delivery estimates
Address Validation API Validate sender and receiver addresses
Trade Document Upload API Upload customs and trade documents
Pickup API Schedule and manage pickups
Important
  • FedEx recommends using Ship API instead of OpenShip API!
  • Use of OpenShip requires prior approval from FedEx Technical Support!

API Design Guidance

  • Use dynamic API responses to drive UI options
  • Validate addresses before shipment creation
  • Retrieve rates before confirming shipment cost
  • Upload documents electronically whenever possible

Notes

  • API behavior may vary by region and service
  • Freight shipments require dimension (DIMS) support
  • OpenShip API usage requires FedEx approval
Back to top ↑