All delivery boy endpoints require authentication with
auth:sanctum and user_type must be delivery_boy.Dashboard Summary
Path Parameters
Delivery boy user ID
Response
Example
Deliveries by Status
Assigned Deliveries
Picked Up Deliveries
On The Way Deliveries
Completed Deliveries
Query Parameters
Filter by date:
today, this_week, this_monthFilter by payment:
cod, non-codPage number
Cancelled Deliveries
Query Parameters
Filter by date:
today, this_week, this_monthFilter by payment:
cod, non-codExample
Change Delivery Status
Request
Order ID
Delivery boy user ID
New status:
picked_up, on_the_way, delivered, cancelledResponse
Example
When status is changed to
delivered:- Payment status is updated to
paidfor 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
Order ID
Get Order Items
Path Parameters
Order ID
Collection Management
Collection Summary
Path Parameters
Delivery boy user ID
Response
Collection History
Path Parameters
Delivery boy user ID
Page number
Earnings Management
Earning Summary
Path Parameters
Delivery boy user ID
Response
Earning History
Path Parameters
Delivery boy user ID
Cancel Request
Path Parameters
Order ID
Response
Delivery Status Flow
- assigned/pending - Order assigned to delivery boy
- confirmed - Order confirmed by seller
- picked_up - Delivery boy picked up the order
- on_the_way - Order is out for delivery
- delivered - Order successfully delivered
- cancelled - Order cancelled
Payment Commission
Delivery boy earnings are calculated based on thedelivery_boy_payment_type setting:
- commission: Fixed commission per delivery (from
delivery_boy_commissionsetting) - 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)