Manage Deliveries
Create Delivery
REST API Documentation
Manage Deliveries
Create Delivery
curl --request POST \
--url https://dev.api.fleet.usedora.com/api/v1/deliveries/create{
"status": "success",
"data": [
{
"uuid": "fa782a23-0e61-4148-b49e-75fb2ec352a8",
"order_number": 11909599,
"fleet_identity_number": "42714897",
"status": "Pending",
"status_label": "Pending",
"sender_longitude": null,
"sender_latitude": null,
"customer_longitude": null,
"customer_latitude": null,
"delivery_fee": "3450",
"service_charge": null,
"currency": "NGN",
"note": null,
"creation_mode": null,
"created_at": "2024-12-05T16:16:34.000000Z",
"pickup_at": null,
"dropoff_at": null,
"customer_detail": {
"uuid": "8582e220-0ce3-405a-8af5-9fcb685f71c7",
"customer_name": "Moses",
"customer_email": null,
"customer_phone_number": "07062423707",
"customer_phone_code": "234",
"customer_address": "Home",
"created_at": "2024-12-05T16:16:34.000000Z"
},
"sender_detail": {
"uuid": "5291b1c9-5b2e-40ec-974a-fbd2fe19576f",
"sender_name": "Enki Groups",
"sender_phone": "07062423707",
"sender_email": "ze@zivalogistics.com",
"sender_phonecode": "234",
"sender_address": "2 Umuleri street, Lagos",
"business_owned": true,
"created_at": "2024-07-01T18:11:16.000000Z",
"updated_at": "2024-07-01T18:11:16.000000Z"
},
"items": [
{
"uuid": "b70594a3-6927-4afa-ba0f-7ed56d377b35",
"item_description": "Packaged makeup for mama emma's birthday celebration",
"item_quantity": 2,
"item_value": "43500.00",
"currency": "NGN",
"created_at": "2024-12-05T16:16:34.000000Z"
}
],
"rider_info": null,
"delivery_info_from_rider": null,
"is_paid": true
},
{
"uuid": "16b84f6a-eb79-4d60-a16a-8abb83a9af57",
"order_number": 68826450,
"fleet_identity_number": "42714897",
"status": "Pending",
"status_label": "Pending",
"sender_longitude": null,
"sender_latitude": null,
"customer_longitude": null,
"customer_latitude": null,
"delivery_fee": "3450",
"service_charge": null,
"currency": "NGN",
"note": null,
"creation_mode": null,
"created_at": "2024-12-05T16:16:36.000000Z",
"pickup_at": null,
"dropoff_at": null,
"customer_detail": {
"uuid": "de3cbc3f-f51a-4175-8d4e-4bc69e3262ff",
"customer_name": "Okekeni",
"customer_email": null,
"customer_phone_number": "07062423707",
"customer_phone_code": "234",
"customer_address": "My home town",
"created_at": "2024-12-05T16:16:36.000000Z"
},
"sender_detail": {
"uuid": "5291b1c9-5b2e-40ec-974a-fbd2fe19576f",
"sender_name": "Enki Groups",
"sender_phone": "07062423707",
"sender_email": "ze@zivalogistics.com",
"sender_phonecode": "234",
"sender_address": "2 Umuleri street, Lagos",
"business_owned": true,
"created_at": "2024-07-01T18:11:16.000000Z",
"updated_at": "2024-07-01T18:11:16.000000Z"
},
"items": [
{
"uuid": "9c4ffd05-5295-406d-aea2-162ccf675e1b",
"item_description": "Packaged makeup for mama emma's birthday celebration",
"item_quantity": 2,
"item_value": "43500.00",
"currency": "NGN",
"created_at": "2024-12-05T16:16:36.000000Z"
}
],
"rider_info": null,
"delivery_info_from_rider": null,
"is_paid": true
}
],
"message": "Delivery created successfully"
}
📝 Summary
This endpoint allows users to create a new delivery request in the system. It accepts details such as sender and recipient information, delivery address, package details, and delivery preferences. Upon successful creation, it returns a unique delivery ID and the status of the delivery request.
📥 Requests
Body Parameters
Description:
| Field | Type | Required | Description |
|---|---|---|---|
creation_date | string | ||
customer_address | string | ||
customer_email | string | ||
customer_name | string | optional | |
customer_phone_number | string | ||
delivery_fee | string | ||
iam_sender | string | ||
is_paid | string | ||
items[0][item_description] | string | ||
items[0][item_quantity] | string | optional | |
items[0][item_value] | string | optional | |
items[1][item_description] | string | ||
items[1][item_quantity] | string | ||
items[1][item_value] | string | ||
receivers[0][customer_address] | string | ||
receivers[0][customer_name] | string | ||
receivers[0][customer_phone_code] | string | ||
receivers[0][customer_phone_number] | string | ||
receivers[1][customer_address] | string | ||
receivers[1][customer_name] | string | ||
receivers[1][customer_phone_code] | string | ||
receivers[1][customer_phone_number] | string | ||
riderid | string | ||
send_sms | string | True Or False | |
sender_address | string | ||
sender_email | string | ||
sender_name | string | ||
sender_phone | string | ||
sender_phonecode | string |
📤 Responses
✅ 200 OK
❌ 422 Bad Request
Description:
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.created_at | string | ||
data.creation_mode | any / null | ||
data.currecncy | string | ||
data.customer_detail | object | ||
data.customer_detail.created_at | string | ||
data.customer_detail.customer_address | string | ||
data.customer_detail.customer_email | any / null | ||
data.customer_detail.customer_name | string | ||
data.customer_detail.customer_phone_code | string | ||
data.customer_detail.customer_phone_number | string | ||
data.customer_detail.uuid | string | ||
data.customer_latitude | any / null | ||
data.customer_longitude | any / null | ||
data.delivery_fee | string | ||
data.delivery_info_from_rider | any / null | ||
data.dropoff_at | any / null | ||
data.fleet_identity_number | string | ||
data.is_paid | boolean | ||
data.items | object | ||
data.items.created_at | string | ||
data.items.currency | string | ||
data.items.item_description | string | ||
data.items.item_quantity | number | ||
data.items.item_value | string | ||
data.items.uuid | string | ||
data.note | any / null | ||
data.order_number | string | ||
data.pickup_at | any / null | ||
data.rider_info | any / null | ||
data.sender_detail | object | ||
data.sender_detail.business_owned | boolean | ||
data.sender_detail.created_at | string | ||
data.sender_detail.sender_address | string | ||
data.sender_detail.sender_email | string | ||
data.sender_detail.sender_name | string | ||
data.sender_detail.sender_phone | string | ||
data.sender_detail.sender_phonecode | string | ||
data.sender_detail.updated_at | string | ||
data.sender_detail.uuid | string | ||
data.sender_latitude | any / null | ||
data.sender_longitude | any / null | ||
data.service_charge | any / null | ||
data.status | string | ||
data.status_label | string | ||
data.uuid | string | ||
message | string | ||
status | string |
{
"status": "success",
"data": [
{
"uuid": "fa782a23-0e61-4148-b49e-75fb2ec352a8",
"order_number": 11909599,
"fleet_identity_number": "42714897",
"status": "Pending",
"status_label": "Pending",
"sender_longitude": null,
"sender_latitude": null,
"customer_longitude": null,
"customer_latitude": null,
"delivery_fee": "3450",
"service_charge": null,
"currency": "NGN",
"note": null,
"creation_mode": null,
"created_at": "2024-12-05T16:16:34.000000Z",
"pickup_at": null,
"dropoff_at": null,
"customer_detail": {
"uuid": "8582e220-0ce3-405a-8af5-9fcb685f71c7",
"customer_name": "Moses",
"customer_email": null,
"customer_phone_number": "07062423707",
"customer_phone_code": "234",
"customer_address": "Home",
"created_at": "2024-12-05T16:16:34.000000Z"
},
"sender_detail": {
"uuid": "5291b1c9-5b2e-40ec-974a-fbd2fe19576f",
"sender_name": "Enki Groups",
"sender_phone": "07062423707",
"sender_email": "ze@zivalogistics.com",
"sender_phonecode": "234",
"sender_address": "2 Umuleri street, Lagos",
"business_owned": true,
"created_at": "2024-07-01T18:11:16.000000Z",
"updated_at": "2024-07-01T18:11:16.000000Z"
},
"items": [
{
"uuid": "b70594a3-6927-4afa-ba0f-7ed56d377b35",
"item_description": "Packaged makeup for mama emma's birthday celebration",
"item_quantity": 2,
"item_value": "43500.00",
"currency": "NGN",
"created_at": "2024-12-05T16:16:34.000000Z"
}
],
"rider_info": null,
"delivery_info_from_rider": null,
"is_paid": true
},
{
"uuid": "16b84f6a-eb79-4d60-a16a-8abb83a9af57",
"order_number": 68826450,
"fleet_identity_number": "42714897",
"status": "Pending",
"status_label": "Pending",
"sender_longitude": null,
"sender_latitude": null,
"customer_longitude": null,
"customer_latitude": null,
"delivery_fee": "3450",
"service_charge": null,
"currency": "NGN",
"note": null,
"creation_mode": null,
"created_at": "2024-12-05T16:16:36.000000Z",
"pickup_at": null,
"dropoff_at": null,
"customer_detail": {
"uuid": "de3cbc3f-f51a-4175-8d4e-4bc69e3262ff",
"customer_name": "Okekeni",
"customer_email": null,
"customer_phone_number": "07062423707",
"customer_phone_code": "234",
"customer_address": "My home town",
"created_at": "2024-12-05T16:16:36.000000Z"
},
"sender_detail": {
"uuid": "5291b1c9-5b2e-40ec-974a-fbd2fe19576f",
"sender_name": "Enki Groups",
"sender_phone": "07062423707",
"sender_email": "ze@zivalogistics.com",
"sender_phonecode": "234",
"sender_address": "2 Umuleri street, Lagos",
"business_owned": true,
"created_at": "2024-07-01T18:11:16.000000Z",
"updated_at": "2024-07-01T18:11:16.000000Z"
},
"items": [
{
"uuid": "9c4ffd05-5295-406d-aea2-162ccf675e1b",
"item_description": "Packaged makeup for mama emma's birthday celebration",
"item_quantity": 2,
"item_value": "43500.00",
"currency": "NGN",
"created_at": "2024-12-05T16:16:36.000000Z"
}
],
"rider_info": null,
"delivery_info_from_rider": null,
"is_paid": true
}
],
"message": "Delivery created successfully"
}
curl --request POST \
--url https://dev.api.fleet.usedora.com/api/v1/deliveries/create{
"status": "success",
"data": [
{
"uuid": "fa782a23-0e61-4148-b49e-75fb2ec352a8",
"order_number": 11909599,
"fleet_identity_number": "42714897",
"status": "Pending",
"status_label": "Pending",
"sender_longitude": null,
"sender_latitude": null,
"customer_longitude": null,
"customer_latitude": null,
"delivery_fee": "3450",
"service_charge": null,
"currency": "NGN",
"note": null,
"creation_mode": null,
"created_at": "2024-12-05T16:16:34.000000Z",
"pickup_at": null,
"dropoff_at": null,
"customer_detail": {
"uuid": "8582e220-0ce3-405a-8af5-9fcb685f71c7",
"customer_name": "Moses",
"customer_email": null,
"customer_phone_number": "07062423707",
"customer_phone_code": "234",
"customer_address": "Home",
"created_at": "2024-12-05T16:16:34.000000Z"
},
"sender_detail": {
"uuid": "5291b1c9-5b2e-40ec-974a-fbd2fe19576f",
"sender_name": "Enki Groups",
"sender_phone": "07062423707",
"sender_email": "ze@zivalogistics.com",
"sender_phonecode": "234",
"sender_address": "2 Umuleri street, Lagos",
"business_owned": true,
"created_at": "2024-07-01T18:11:16.000000Z",
"updated_at": "2024-07-01T18:11:16.000000Z"
},
"items": [
{
"uuid": "b70594a3-6927-4afa-ba0f-7ed56d377b35",
"item_description": "Packaged makeup for mama emma's birthday celebration",
"item_quantity": 2,
"item_value": "43500.00",
"currency": "NGN",
"created_at": "2024-12-05T16:16:34.000000Z"
}
],
"rider_info": null,
"delivery_info_from_rider": null,
"is_paid": true
},
{
"uuid": "16b84f6a-eb79-4d60-a16a-8abb83a9af57",
"order_number": 68826450,
"fleet_identity_number": "42714897",
"status": "Pending",
"status_label": "Pending",
"sender_longitude": null,
"sender_latitude": null,
"customer_longitude": null,
"customer_latitude": null,
"delivery_fee": "3450",
"service_charge": null,
"currency": "NGN",
"note": null,
"creation_mode": null,
"created_at": "2024-12-05T16:16:36.000000Z",
"pickup_at": null,
"dropoff_at": null,
"customer_detail": {
"uuid": "de3cbc3f-f51a-4175-8d4e-4bc69e3262ff",
"customer_name": "Okekeni",
"customer_email": null,
"customer_phone_number": "07062423707",
"customer_phone_code": "234",
"customer_address": "My home town",
"created_at": "2024-12-05T16:16:36.000000Z"
},
"sender_detail": {
"uuid": "5291b1c9-5b2e-40ec-974a-fbd2fe19576f",
"sender_name": "Enki Groups",
"sender_phone": "07062423707",
"sender_email": "ze@zivalogistics.com",
"sender_phonecode": "234",
"sender_address": "2 Umuleri street, Lagos",
"business_owned": true,
"created_at": "2024-07-01T18:11:16.000000Z",
"updated_at": "2024-07-01T18:11:16.000000Z"
},
"items": [
{
"uuid": "9c4ffd05-5295-406d-aea2-162ccf675e1b",
"item_description": "Packaged makeup for mama emma's birthday celebration",
"item_quantity": 2,
"item_value": "43500.00",
"currency": "NGN",
"created_at": "2024-12-05T16:16:36.000000Z"
}
],
"rider_info": null,
"delivery_info_from_rider": null,
"is_paid": true
}
],
"message": "Delivery created successfully"
}