Manage Deliveries
Get Deliveries
REST API Documentation
Manage Deliveries
Get Deliveries
curl --request GET \
--url https://dev.api.fleet.usedora.com/api/v1/deliveries
{
"message": "Deliveries retrieved successfully!",
"data": {
"delivery_counts": {
"overall_user_awaiting_pickup_deliveries": 1,
"overall_user_in_transit_deliveries": 0,
"overall_user_delivered_deliveries": 0,
"overall_user_cancelled_deliveries": 0
},
"deliveries": {
"current_page": 1,
"data": [
{
"uuid": "4224a405-15c6-4579-9733-12620450d45c",
"order_number": "021393049",
"status": "Awaiting Pickup",
"created_at": "2023-10-28T16:57:53.000000Z",
"customer_detail": {
"id": "8ddf85e3-436a-47f9-a9ec-5113cdb19979",
"customer_name": "TundeNasri",
"customer_email": "sinoma@gmail.com",
"customer_state_id": 304,
"customer_phone_number": "08065302534",
"customer_phone_code": "234",
"customer_address": "12 Ahmadu Bello way, Central Business District, Abuja",
"created_at": "2023-10-29T00:50:58.000000Z"
},
"delivery_detail": {
"uuid": "b94aff30-ebe0-4439-a82d-a173773d78b5",
"sender_name": "Ac Nice",
"sender_phone": "08087168391",
"sender_phonecode": "234",
"sender_address": "T-pumpy estate, phase 20 lugbe, Abuja",
"delivery_total_order_value": "10000.00",
"delivery_number_of_parcels": 1,
"delivery_unit_weight": "10.00",
"created_at": "2023-10-29T00:50:58.000000Z",
"updated_at": "2023-10-29T00:50:58.000000Z"
},
"items": [
{
"uuid": "416dbe29-434f-4cb6-bed5-ce7183176b8d",
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-10-28T22:08:57.000000Z"
},
{
"uuid": "4ae72c0f-7fc7-4dfa-9d7e-6eebefb84c1a",
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-10-28T22:11:42.000000Z"
},
{
"uuid": "e37d909e-a3f9-4443-9912-9c2befdf23db",
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-10-29T00:50:59.000000Z"
}
],
"organization_detail": {
"uuid": "355c96cd-aa77-459e-9107-1223bea38f9b",
"business_address": "Aso Housing Estate, Airport road, Abuja",
"country_id": 161,
"state_id": 303,
"city": "Abuja",
"logo": "https://usedora-bucket-dev.s3.amazonaws.com/provider-logos/mwFmcQ7ppveoNULRwL3AEyKtwoHT2KViXte8AYJA.jpg",
"created_at": "2023-10-15T10:57:05.000000Z",
"updated_at": "2023-10-28T16:40:21.000000Z"
}
}
],
"first_page_url": "http://localhost:8000/api/deliveries?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/deliveries?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://localhost:8000/api/deliveries?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/api/deliveries",
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1
}
},
"status": "success"
}
📝 Summary
This endpoint allows users to retrieve the details of a many deliveries by providing the unique delivery ID. It returns all relevant information related to the delivery, including the delivery status, sender and recipient details, assigned driver, and vehicle information.
📥 Requests
Query Parameters
Description:
Field | Type | Required | Description |
---|---|---|---|
paginate | string | Can be 1 or 0 | |
per_page | string | ||
filter | string | All/Last 3 days/Last 7 days/Last 14 days/Last Month | |
start_date | string | ||
end_date | string | ||
delivery_status | string | pending/awaiting_pickup/in_transit/delivered/cancelled/declined | |
create_mode | string | automated/manual/via booking/imported | |
search | string |
📤 Responses
✅ 200 OK
❌ 422 Bad Request
Description:
Field | Type | Required | Description |
---|---|---|---|
data | object | ||
data.deliveries | object | ||
data.deliveries.current_page | number | ||
data.deliveries.data.created_at | string | ||
data.deliveries.data.customer_detail | object | ||
data.deliveries.data.customer_detail.created_at | string | ||
data.deliveries.data.customer_detail.customer_address | string | ||
data.deliveries.data.customer_detail.customer_email | string | ||
data.deliveries.data.customer_detail.customer_name | string | ||
data.deliveries.data.customer_detail.customer_phone_code | string | ||
data.deliveries.data.customer_detail.customer_phone_number | string | ||
data.deliveries.data.customer_detail.customer_state_id | number | ||
data.deliveries.data.customer_detail.id | string | ||
data.deliveries.data.delivery_detail | object | ||
data.deliveries.data.delivery_detail.created_at | string | ||
data.deliveries.data.delivery_detail.delivery_number_of_parcels | number | ||
data.deliveries.data.delivery_detail.delivery_total_order_value | string | ||
data.deliveries.data.delivery_detail.delivery_unit_weight | string | ||
data.deliveries.data.delivery_detail.sender_address | string | ||
data.deliveries.data.delivery_detail.sender_name | string | ||
data.deliveries.data.delivery_detail.sender_phone | string | ||
data.deliveries.data.delivery_detail.sender_phonecode | string | ||
data.deliveries.data.delivery_detail.updated_at | string | ||
data.deliveries.data.delivery_detail.uuid | string | ||
data.deliveries.data.items | object | ||
data.deliveries.data.items.created_at | string | ||
data.deliveries.data.items.item_description | string | ||
data.deliveries.data.items.item_quantity | number | ||
data.deliveries.data.items.item_value | string | ||
data.deliveries.data.items.item_weight | string | ||
data.deliveries.data.items.uuid | string | ||
data.deliveries.data.organization_detail | object | ||
data.deliveries.data.organization_detail.business_address | string | ||
data.deliveries.data.organization_detail.city | string | ||
data.deliveries.data.organization_detail.country_id | number | ||
data.deliveries.data.organization_detail.created_at | string | ||
data.deliveries.data.organization_detail.logo | string | ||
data.deliveries.data.organization_detail.state_id | number | ||
data.deliveries.data.organization_detail.updated_at | string | ||
data.deliveries.data.organization_detail.uuid | string | ||
data.deliveries.data.status | string | ||
data.deliveries.data.uuid | string | ||
data.deliveries.from | number | ||
data.deliveries.last | number | ||
data.deliveries.last_page_url | string | ||
data.deliveries.links | object | ||
data.deliveries.links.active | boolean | ||
data.deliveries.links.label | string | ||
data.deliveries.links.url | string / null | ||
data.deliveries.next_page_url | any / null | ||
data.deliveries.path | string | ||
data.deliveries.per_page | number | ||
data.deliveries.prevt_page_url | any / null | ||
data.deliveries.to | number | ||
data.deliveries.total | number | ||
data.delivery_count | object | ||
data.delivery_counts.overall_user_awaiting_pickup_deliveries | number | ||
data.delivery_counts.overall_user_cancelled_deliveries | number | ||
data.delivery_counts.overall_user_delivered_deliveries | number | ||
data.delivery_counts.overall_user_in_transit_deliveries | number | ||
message | string | ||
status | number |
{
"message": "Deliveries retrieved successfully!",
"data": {
"delivery_counts": {
"overall_user_awaiting_pickup_deliveries": 1,
"overall_user_in_transit_deliveries": 0,
"overall_user_delivered_deliveries": 0,
"overall_user_cancelled_deliveries": 0
},
"deliveries": {
"current_page": 1,
"data": [
{
"uuid": "4224a405-15c6-4579-9733-12620450d45c",
"order_number": "021393049",
"status": "Awaiting Pickup",
"created_at": "2023-10-28T16:57:53.000000Z",
"customer_detail": {
"id": "8ddf85e3-436a-47f9-a9ec-5113cdb19979",
"customer_name": "TundeNasri",
"customer_email": "sinoma@gmail.com",
"customer_state_id": 304,
"customer_phone_number": "08065302534",
"customer_phone_code": "234",
"customer_address": "12 Ahmadu Bello way, Central Business District, Abuja",
"created_at": "2023-10-29T00:50:58.000000Z"
},
"delivery_detail": {
"uuid": "b94aff30-ebe0-4439-a82d-a173773d78b5",
"sender_name": "Ac Nice",
"sender_phone": "08087168391",
"sender_phonecode": "234",
"sender_address": "T-pumpy estate, phase 20 lugbe, Abuja",
"delivery_total_order_value": "10000.00",
"delivery_number_of_parcels": 1,
"delivery_unit_weight": "10.00",
"created_at": "2023-10-29T00:50:58.000000Z",
"updated_at": "2023-10-29T00:50:58.000000Z"
},
"items": [
{
"uuid": "416dbe29-434f-4cb6-bed5-ce7183176b8d",
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-10-28T22:08:57.000000Z"
},
{
"uuid": "4ae72c0f-7fc7-4dfa-9d7e-6eebefb84c1a",
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-10-28T22:11:42.000000Z"
},
{
"uuid": "e37d909e-a3f9-4443-9912-9c2befdf23db",
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-10-29T00:50:59.000000Z"
}
],
"organization_detail": {
"uuid": "355c96cd-aa77-459e-9107-1223bea38f9b",
"business_address": "Aso Housing Estate, Airport road, Abuja",
"country_id": 161,
"state_id": 303,
"city": "Abuja",
"logo": "https://usedora-bucket-dev.s3.amazonaws.com/provider-logos/mwFmcQ7ppveoNULRwL3AEyKtwoHT2KViXte8AYJA.jpg",
"created_at": "2023-10-15T10:57:05.000000Z",
"updated_at": "2023-10-28T16:40:21.000000Z"
}
}
],
"first_page_url": "http://localhost:8000/api/deliveries?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/deliveries?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://localhost:8000/api/deliveries?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/api/deliveries",
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1
}
},
"status": "success"
}
curl --request GET \
--url https://dev.api.fleet.usedora.com/api/v1/deliveries
{
"message": "Deliveries retrieved successfully!",
"data": {
"delivery_counts": {
"overall_user_awaiting_pickup_deliveries": 1,
"overall_user_in_transit_deliveries": 0,
"overall_user_delivered_deliveries": 0,
"overall_user_cancelled_deliveries": 0
},
"deliveries": {
"current_page": 1,
"data": [
{
"uuid": "4224a405-15c6-4579-9733-12620450d45c",
"order_number": "021393049",
"status": "Awaiting Pickup",
"created_at": "2023-10-28T16:57:53.000000Z",
"customer_detail": {
"id": "8ddf85e3-436a-47f9-a9ec-5113cdb19979",
"customer_name": "TundeNasri",
"customer_email": "sinoma@gmail.com",
"customer_state_id": 304,
"customer_phone_number": "08065302534",
"customer_phone_code": "234",
"customer_address": "12 Ahmadu Bello way, Central Business District, Abuja",
"created_at": "2023-10-29T00:50:58.000000Z"
},
"delivery_detail": {
"uuid": "b94aff30-ebe0-4439-a82d-a173773d78b5",
"sender_name": "Ac Nice",
"sender_phone": "08087168391",
"sender_phonecode": "234",
"sender_address": "T-pumpy estate, phase 20 lugbe, Abuja",
"delivery_total_order_value": "10000.00",
"delivery_number_of_parcels": 1,
"delivery_unit_weight": "10.00",
"created_at": "2023-10-29T00:50:58.000000Z",
"updated_at": "2023-10-29T00:50:58.000000Z"
},
"items": [
{
"uuid": "416dbe29-434f-4cb6-bed5-ce7183176b8d",
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-10-28T22:08:57.000000Z"
},
{
"uuid": "4ae72c0f-7fc7-4dfa-9d7e-6eebefb84c1a",
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-10-28T22:11:42.000000Z"
},
{
"uuid": "e37d909e-a3f9-4443-9912-9c2befdf23db",
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-10-29T00:50:59.000000Z"
}
],
"organization_detail": {
"uuid": "355c96cd-aa77-459e-9107-1223bea38f9b",
"business_address": "Aso Housing Estate, Airport road, Abuja",
"country_id": 161,
"state_id": 303,
"city": "Abuja",
"logo": "https://usedora-bucket-dev.s3.amazonaws.com/provider-logos/mwFmcQ7ppveoNULRwL3AEyKtwoHT2KViXte8AYJA.jpg",
"created_at": "2023-10-15T10:57:05.000000Z",
"updated_at": "2023-10-28T16:40:21.000000Z"
}
}
],
"first_page_url": "http://localhost:8000/api/deliveries?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/deliveries?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://localhost:8000/api/deliveries?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/api/deliveries",
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1
}
},
"status": "success"
}