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.
Last update : June 25, 2026
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 Status
Every order transitions through the following states. Subscribe to webhooks to receive real-time status updates.
Delivered
RTO Delivered
Cancelled (from your side)
Cancelled (from Adloggs side)
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://<Adloggs_host>/aa/oporder/v2/createRequired Headers
| Header | Value | Description |
|---|---|---|
| Authorization | Add header { 'x-api-key': '<Given adloggs key>'} | Your Adloggs API key |
| Content-Type | application/json | Request body format |
{
{
"partner_order_id": "10012458t",
"partner_merchant_id": "5421",
"partner_reference_id": "78964tghbb", //Optional
"pickup_contact_name": "Ramu",
"pickup_contact_no": 9000000000,
"pickup_contact_email": "ramu@gmail.com", //Optional
"pickup_address": "new bus stand , avinashi, tiruppur",
"pickup_address_details": {
"door_no": "10", //Optional
"street_name": "north street", //Optional
"city_name": "Avinashi",
"district_name": "Tiruppur", //Optional
"state_name": "Tamilnadu",
"country_name": "India",
"pincode": "641654"
},
"pickup_date_time": "2026-07-05 21: 20",
"pickup_lat": 11.18731,
"pickup_long": 77.27788,
"delivery_contact_name": "Somu",
"delivery_contact_no": 9000000000,
"delivery_contact_email": "somu@gmail.com", //Optional
"delivery_address": "The quest international school, avinashilingapalyam, Tiruppur,tamilnadu,india",
"delivery_address_details": {
"door_no": "10", //Optional
"street_name": "The Quest International schoo", //Optional
"city_name": "Avinashi",
"district_name": "Tiruppur", //Optional
"state_name": "Tamilnadu",
"country_name": "India",
"pincode": "641654"
},
"delivery_lat": 11.17350,
"delivery_long": 77.26865,
"pickup_otp": 5623, //Optional-Only4digit
"delivery_otp": 6698,//Optional-Only4digit
"return_otp": 4789, //Optional-Only4digit
"order_category": "Food and Beverage", //FoodandBeverage, Grocery
"order_total_price": "455.50",
"order_total_weight_in_kg": "5.50",
"items": [
{
"name": "Atta",
"quantity": "2",
"price": "200.50"
}
],
"order_description": "dev order", //Optional-Deliveryandorderdescription
"utc_offset": 330,
"payment_type": "COD", //ENUM(“COD”,”Online”)ItismandatoryforCash-On-DeliveryOrders
"collectible_amount": 0, //Requiredonlyifpayment_typeisCOD
}
}| 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://<Adloggs_host>/aa/oporder/v1.2/service/availability Required Headers
| Header | Value | Description |
|---|---|---|
| Authorization | Add header { 'x-api-key': '<Given adloggs key>'} | Your Adloggs API key |
| Content-Type | application/json | Request body format |
// Query Parameters
// GET /api/order/v1/ServiceAvailability
{
"partner_merchant_id": 5421, // Optional
"partner_order_id": "ADO12345",
"pickup_lat": 12.9783692,
"pickup_long": 77.64083560,
"pickup_pincode": "628621" ,
"delivery_lat": 12.95836920,
"delivery_long": 77.64083560,
"delivery_pincode": "628621" ,
"utc_offset": 330, // 330 for india
"payment_type": "Online" // Or “COD”
} Get Order Status
Retrieve the current status and live tracking details for an existing order using its UUID.
https://<Adloggs_host>/aa/oporder/getcurrentstatus Required Headers
| Header | Value | Description |
|---|---|---|
| Authorization | Add header { 'x-api-key': '<Given adloggs 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" : "4BQhO3m0AFaL_AZ9SXo0c**iPIOWKuDlXzd1RLTeDr5A"
}Cancel Order
Cancel a pending or assigned order. Orders that are already picked up cannot be cancelled programmatically.
https://<Adloggs_host>/aa/oporder/v1.2/cancel Required Headers
| Header | Value | Description |
|---|---|---|
| Authorization | Add header { 'x-api-key': '<Given adloggs key>'} | Your Adloggs API key |
| Content-Type | application/json | Request body format |
{
"order_uuid" : "4ed83e5d-ec49-44ef-a7ea-eba3cfd91416",
"order_cancel_description" : "Changed my mind"
}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
{
"order_uuid": "fe2c5bc9-6e2b00478612142**CS8ER9cpmLpbu36LgGYvc",
"order_status_id": 3,
"partner_order_id": "fe2c5bc9-6e2b00478612142",
"deliveryStaffDetails": {
"name": "viknesh",
"phone": "9090909090",
"currentLocation": {
"lat": "11.17910110",
"long": "77.28851930"
}
},
"eta": {
"to_pickup": 5 //Minutes
},
"rider_platform": {
"name": "Adloggs",
"lsp_uniq_id": "CRN1361694246"
},
"reason": null,
"otps": {
"delivery_otp": "9243",
"pickup_otp": null,
"return_otp": null
}
}Check Wallet Balance
Retrieve the current wallet balance for a merchant account. Useful for building low-balance alerts in your system.
https://<Adloggs_host>/aa/oporder/wallet/balance Required Headers
| Header | Value | Description |
|---|---|---|
| Authorization | Add header { 'x-api-key': '<Given adloggs key>'} | Your Adloggs API key |
| Content-Type | application/json | Request body format |
// GET /api/merchant/wallet/balance
// // No request body required
{
"partner_merchant_id": 96 // Optional
}
Order 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