RESTful API
Clean, intuitive REST endpoints
Secure
OAuth 2.0 authentication
Well Documented
Comprehensive guides & examples
High Performance
99.99% uptime SLA
đ Quick Start
Get started with our API in just a few steps:
1. Get Your API Key
Sign up for a developer account and generate your API key from the dashboard.
2. Authentication
Include your API key in the request header:
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
3. Base URL
https://api.deliveryofthefuture.com/v1
4. Make Your First Request
curl -X POST https://api.deliveryofthefuture.com/v1/deliveries \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"pickup_address": "123 Main St, Tokyo",
"delivery_address": "456 Oak Ave, Osaka",
"package_weight": 2.5,
"delivery_speed": "express"
}'
đĄ API Endpoints
POST
/deliveries
Create a new delivery request
Request Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
pickup_address |
string | Required | Pickup location address |
delivery_address |
string | Required | Delivery destination address |
package_weight |
float | Required | Package weight in kg |
delivery_speed |
enum | Optional | standard | express | sameday | drone |
Response Example:
{
"delivery_id": "DEL-2025-001234",
"status": "confirmed",
"tracking_number": "DOF123456789",
"estimated_delivery": "2025-01-20T15:30:00Z",
"price": 24.99
}
GET
/deliveries/{delivery_id}
Get delivery details and tracking information
Response Example:
{
"delivery_id": "DEL-2025-001234",
"status": "in_transit",
"current_location": {
"lat": 35.6762,
"lng": 139.6503,
"address": "Tokyo Distribution Center"
},
"timeline": [
{
"timestamp": "2025-01-20T10:00:00Z",
"status": "picked_up",
"location": "Tokyo"
},
{
"timestamp": "2025-01-20T12:30:00Z",
"status": "in_transit",
"location": "Distribution Center"
}
]
}
GET
/tracking/{tracking_number}
Track a package using the tracking number
PUT
/deliveries/{delivery_id}
Update an existing delivery
DELETE
/deliveries/{delivery_id}
Cancel a delivery request
POST
/webhooks
Register a webhook for delivery status updates
Webhook Events:
delivery.created- New delivery createddelivery.picked_up- Package picked updelivery.in_transit- Package in transitdelivery.delivered- Package delivereddelivery.failed- Delivery failed