REST API
Adloggs API
A RESTful API to programmatically interact with Adloggs' delivery management functionality. Integrate hyperlocal and last-mile delivery management into your platform in minutes.
Authentication
All API requests require a Bearer token in the Authorization header. API keys are available in your Adloggs merchant dashboard.
// Include in every request header:
Content-Type: application/json
// API keys are environment-specific:
// adl_live_... — Production
// adl_test_... — Sandbox (no real deliveries)
// Obtain your API key from:
// Dashboard → Settings → API KeysOrder Statuses
Every order transitions through the following states. Subscribe to webhooks to receive real-time status updates.
Create Order
Submit a new delivery order to the Adloggs platform. The system automatically assigns the best available partner based on your location, SLA, and cost preferences.
https://api.adloggs.com/api/order/placeorder/v1Required Headers
| Header | Value | Description |
|---|---|---|
| Authorization | Bearer <api_key> | Your Adloggs API key |
| Content-Type | application/json | Request body format |
{
"partner_order_id": "ORD-10021", // Your internal order ID
"partner_contact_no": "+919876543210", // Customer phone
"pickup_contact_no": "+919123456789", // Store/pickup phone
"pickup_contact_name": "The Quint Grill, Tirupur",
"pickup_location_lat": 11.1085,
"pickup_location_lng": 77.3411,
"delivery_location_lat": 11.1160,
"delivery_location_lng": 77.3502,
"delivery_contact_name": "Arjun Patel",
"delivery_address": "42, Gandhi Street, Avinashi, Tirupur",
"city": "Tirupur",
"order_type": "Trigger", // Trigger | Scheduled
"item_count": 2,
"item_description": "2x Butter Chicken",
"order_value": 420.00,
"payment_mode": "Prepaid",
"delivery_instructions": "Ring doorbell twice"
}| Parameter | Type | Required | Description |
|---|---|---|---|
| partner_order_id | string | required | Your internal order identifier |
| partner_contact_no | string | required | Customer phone number (E.164 format) |
| pickup_location_lat | number | required | Pickup latitude coordinate |
| pickup_location_lng | number | required | Pickup longitude coordinate |
| delivery_location_lat | number | required | Delivery latitude coordinate |
| delivery_location_lng | number | required | Delivery longitude coordinate |
| order_type | string | required | "Trigger" for instant or "Scheduled" |
| order_value | number | required | Order value in INR |
| payment_mode | string | required | "Prepaid" or "COD" |
Service Availability
Check if Adloggs delivery service is available between two coordinates before placing an order.
https://api.adloggs.com/api/order/v1/ServiceAvailabilityRequired Headers
| Header | Value | Description |
|---|---|---|
| Authorization | Bearer <api_key> | Your Adloggs API key |
| Content-Type | application/json | Request body format |
// Query Parameters
// GET /api/order/v1/ServiceAvailability
{
"partner_order_lat": 11.1085, // Pickup latitude
"partner_order_lng": 77.3411, // Pickup longitude
"delivery_lat": 11.1160, // Delivery latitude
"delivery_lng": 77.3502 // Delivery longitude
}Get Order Status
Retrieve the current status and live tracking details for an existing order using its UUID.
https://api.adloggs.com/api/order/{order_uuid}Required Headers
| Header | Value | Description |
|---|---|---|
| Authorization | Bearer <api_key> | Your Adloggs API key |
| Content-Type | application/json | Request body format |
// GET /api/order/{order_uuid}
// No request body required
// Path Parameter:
// order_uuid: "ADL-2024-7X9KP"Cancel Order
Cancel a pending or assigned order. Orders that are already picked up cannot be cancelled programmatically.
https://api.adloggs.com/api/order/{order_uuid}/cancelRequired Headers
| Header | Value | Description |
|---|---|---|
| Authorization | Bearer <api_key> | Your Adloggs API key |
| Content-Type | application/json | Request body format |
{
"order_uuid": "ADL-2024-7X9KP",
"reason": "Customer requested cancellation",
"cancel_by": "merchant" // merchant | customer | system
}Client Webhooks
Adloggs pushes real-time delivery events to your registered webhook URL. Configure your endpoint in Dashboard → Settings → Webhooks.
https://your-server.com/webhook/adloggs// Adloggs posts this payload to your configured webhook URL
// on every order status transition
{
"event": "order.status_changed",
"timestamp": "2024-03-15T14: 40: 00Z",
"order_uuid": "ADL-2024-7X9KP",
"partner_order_id": "ORD-10021",
"previous_status": "Assigned",
"current_status": "Picking",
"rider_name": "Karthik R.",
"rider_contact": "+919912345678",
"estimated_delivery": "2024-03-15T15: 05: 00Z",
"metadata": {
"partner": "Rapido",
"city": "Tirupur",
"lat": 11.1085,
"lng": 77.3411
}
}Check Wallet Balance
Retrieve the current wallet balance for a merchant account. Useful for building low-balance alerts in your system.
https://api.adloggs.com/api/merchant/wallet/balanceRequired Headers
| Header | Value | Description |
|---|---|---|
| Authorization | Bearer <api_key> | Your Adloggs API key |
| Content-Type | application/json | Request body format |
// GET /api/merchant/wallet/balance
// No request body requiredOrder Flow Examples
Below are the common end-to-end delivery flows and the status transitions your integration should handle.
1. Standard Delivery Flow
2. Cancellation Flow
3. Failed Delivery + Retry