API Reference
Overview
The API Reference provides a complete, structured description of all available endpoints in the Fredi API. It serves as the technical contract between your system and Fredi, enabling seamless integration for authentication, shipment processing, tracking, and configuration.
This section is intended for developers and integration partners who need detailed information about:
- Available endpoints
- HTTP methods
- Request and response structures
- Required headers and authentication
- Field definitions and data types
- Error codes and validation rules
Architecture Context
Fredi APIs are powered by an internal .NET Core–based integration layer that connects Fredi with multiple carrier systems. The API layer abstracts carrier-specific complexities and provides a consistent interface for:
- Shipment Creation
- Shipment Cancellation
- Shipment Update
- Exracting Shipment Details
This ensures a unified integration experience across carriers.
API Structure
The API is organized into logical groups to simplify navigation and implementation:
1. Authentication
Handles secure access to the API. Use the Authentication section generate secure tokens authorize for session validation and shipment handling.
2. Setup & Configuration
Used to configure system-level or customer-level settings.
- Loading locations
- Packing stations
- Carrier configurations
- Print settings
3. Shipment Management
Core logistics functionality.
- Create shipment
- Cancel shipment
- Update shipment
- Shipment Details
Request & Response Format
All APIs use REST principles and require proper authentication headers. It accepts and return JSON and follow consistent HTTP status codes.
Each endpoint documentation includes:
- Endpoint URL
- HTTP method
- Required headers
- Path parameters
- Query parameters
- Request body schema
- Response schema
- Example payloads
- Error responses
Error Handling
Fredi API uses standardized HTTP status codes:
| Status Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
See Errors for detailed error responses.
Best Practices for Integration
- Always validate request payloads before submission.
- Store and reuse authentication tokens until expiration.
- Handle error responses gracefully.
- Use test/sandbox environments before production rollout.
- Log API responses for troubleshooting.
How to Use This Reference
- Start with Authentication to obtain access.
- Configure system-level settings if required.
- Use Shipment endpoints for operational workflows.
- Monitor responses and handle errors accordingly.