Skip to main content
All delivery boy endpoints require authentication with auth:sanctum and user_type must be delivery_boy.

Dashboard Summary

Path Parameters

id
integer
required
Delivery boy user ID

Response

{
  "completed_delivery": 123,
  "pending_delivery": 15,
  "total_collection": "$5,420.00",
  "total_earning": "$542.00",
  "cancelled": 5,
  "on_the_way": 8,
  "picked": 12,
  "assigned": 10
}

Example

curl -X GET https://your-domain.com/api/v2/delivery-boy/dashboard-summary/123 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Deliveries by Status

Assigned Deliveries

Picked Up Deliveries

On The Way Deliveries

Completed Deliveries

Query Parameters

date_range
string
Filter by date: today, this_week, this_month
payment_type
string
Filter by payment: cod, non-cod
page
integer
default:"1"
Page number

Cancelled Deliveries

Query Parameters

date_range
string
Filter by date: today, this_week, this_month
payment_type
string
Filter by payment: cod, non-cod

Example

curl -X GET "https://your-domain.com/api/v2/delivery-boy/deliveries/completed/123?date_range=this_week&payment_type=cod" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Change Delivery Status

Request

order_id
integer
required
Order ID
delivery_boy_id
integer
required
Delivery boy user ID
status
string
required
New status: picked_up, on_the_way, delivered, cancelled

Response

{
  "result": true,
  "message": "Delivery status changed to Picked Up"
}

Example

curl -X POST https://your-domain.com/api/v2/delivery-boy/change-delivery-status \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": 456,
    "delivery_boy_id": 123,
    "status": "picked_up"
  }'
When status is changed to delivered:
  • Payment status is updated to paid for COD orders
  • Collection amount is added to delivery boy’s total
  • Earning is calculated based on commission settings
  • Commission and club points are calculated
  • SMS notification is sent (if enabled)

Order Details

Get Order Details

Path Parameters

id
integer
required
Order ID

Get Order Items

Path Parameters

id
integer
required
Order ID

Collection Management

Collection Summary

Path Parameters

id
integer
required
Delivery boy user ID

Response

{
  "today_date": "15 Mar, 2024",
  "today_collection": "$350.00",
  "yesterday_date": "14 Mar, 2024",
  "yesterday_collection": "$420.00"
}

Collection History

Path Parameters

id
integer
required
Delivery boy user ID
page
integer
default:"1"
Page number

Earnings Management

Earning Summary

Path Parameters

id
integer
required
Delivery boy user ID

Response

{
  "today_date": "15 Mar, 2024",
  "today_earning": "$35.00",
  "yesterday_date": "14 Mar, 2024",
  "yesterday_earning": "$42.00"
}

Earning History

Path Parameters

id
integer
required
Delivery boy user ID

Cancel Request

Path Parameters

id
integer
required
Order ID

Response

{
  "result": true,
  "message": "Requested for cancellation"
}
This only creates a cancellation request. Admin approval is required to actually cancel the order.

Delivery Status Flow

  1. assigned/pending - Order assigned to delivery boy
  2. confirmed - Order confirmed by seller
  3. picked_up - Delivery boy picked up the order
  4. on_the_way - Order is out for delivery
  5. delivered - Order successfully delivered
  6. cancelled - Order cancelled

Payment Commission

Delivery boy earnings are calculated based on the delivery_boy_payment_type setting:
  • commission: Fixed commission per delivery (from delivery_boy_commission setting)
  • percentage: Percentage of order value

COD Collection

For Cash on Delivery orders:
  • Collection amount is tracked when status changes to delivered
  • Total collection is accumulated in delivery boy’s account
  • Payment status automatically updates to paid

Important Notes

  • Only orders assigned to the specific delivery boy are accessible
  • Orders are sorted by delivery_history_date (most recent first)
  • Cancel requests require admin approval
  • SMS notifications sent on status changes (if OTP system is enabled)

Build docs developers (and LLMs) love