API Overview

The Logistics System API provides a comprehensive set of endpoints for integrating with the Partner Services Microservice. This overview will help you understand the API structure and available endpoints.

Base URL

https://partner-services.logistics.com/api/v1

Authentication

All API requests require HMAC authentication. See the Authentication Guide for implementation details.

Available Endpoints

Partner Management

Endpoint	Method	Description
/partners/comprehensive-data	GET	Get complete partner profile
/partners/bulk-data	GET	Load all partners (coming soon)
/partners/availability/check	POST	Check partner availability

Zone Management

Endpoint	Method	Description
/zones	GET	List all zones
/zones	POST	Create new zone
/zones/{id}	PUT	Update zone
/zones/{id}	DELETE	Delete zone

Shipment Assignment

Endpoint	Method	Description
/shipments/calculate-charges	POST	Calculate shipment charges
/shipment-assignment/assign	POST	Assign shipment to partner
/shipment-assignment/bulk	POST	Bulk assignment (coming soon)

Response Format

All API responses follow this standard format:

{
  "success": true,
  "data": {
    // Response data here
  },
  "meta": {
    "timestamp": "2024-02-20T13:25:17Z",
    "requestId": "req_123abc"
  }
}

Error Handling

Errors follow a consistent format:

{
  "success": false,
  "error": {
    "code": "INVALID_PARTNER",
    "message": "Partner ID not found",
    "details": {
      // Additional error details
    }
  },
  "meta": {
    "timestamp": "2024-02-20T13:25:17Z",
    "requestId": "req_123abc"
  }
}

Rate Limiting

• Default rate limit: 100 requests per minute
• Bulk endpoints: 10 requests per minute
• Rate limit headers included in responses

Next Steps

• View API Reference - Complete API documentation
• See Examples - Real-world implementation examples
• Authentication Setup - Set up API authentication