REST API Documentation
- Authentication
- Manage Deliveries
- Manage Riders
Update delivery
This endpoint updates a pending delivery request.
Endpoint POST
curl --request POST \
--url https://api.usedora.com/v1/deliveries/update/{delivery_uuid}
--header 'Authorization: Bearer <store_access_token>' \
--header 'Content-Type: application/json'
Path Parameters
The uuid of the delivery
Sample Request
{
"sender_address": "10 John Street, Ipaja, Lagos",
"customer_name": "TundeNasri",
"customer_email": "sinoma@example.com",
"customer_state_id": 4,
"customer_house_number": 4,
"customer_phone_number": "0802839***8",
"phone_code": 234,
"customer_address": "12 Ahmadu Bello way, Central Business District, Abuja",
"delivery_total_order_value": 10000,
"delivery_number_of_parcels": 1,
"delivery_unit_weight": 10,
"items": {
[
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": 0.1,
"item_value": 10000
],
[
"item_uuid" : "48555811-5c4e-47xxxxx",
"item_description": "Mellon",
"item_quantity": 0.5,
"item_weight": 0,
"item_value": 10000
]
}
}
Request Body Parameters
The provider selected provider uuid that was selected after generating delivery estimate.
The pickup location of the sender or business
boolean 1 or 0
boolean 1 or 0
The name of your customer
(Optional) the email of your customer
The state id (can be gotten from the state metas) endpoint
The phone number of the customer
The country phone code of the customer phone number. Can be gotten from country metas) endpoint
The destination address of the customer
Cummulative value of the order
The number of parcel for the order
Average weight of each item in the parcel in (kg)
Average weight of each item in the parcel in (kg)
{
"data": {
"uuid": "48555811-5c4e-4711-8d06-1519a56f8a99",
"order_number": "609039957141",
"creation_mode": "Manual",
"sender_detail": {
"id": "239ec2e7-ab3b-4a3d-9427-afe09fc92e7d",
"sender_address": "12 Aso Housing Estate, Airport road, Abuja",
"sender_send_email_thirty_minutes_after_processing_order": true,
"sender_include_return_portal_in_tracking_mail": true,
"created_at": "2023-09-25T22:35:23.000000Z"
},
"customer_detail": {
"id": "863ed498-6558-48b0-b049-5a4cfd8013fb",
"customer_name": "Prince Anosike",
"customer_company": null,
"customer_email": "prince@gmail.com",
"customer_postal_code": null,
"customer_state_id": 4,
"customer_house_number": null,
"customer_phone_number": "08065302534",
"phone_code": "234",
"customer_address": "10 John Street, Ipaja, Lagos",
"created_at": "2023-09-25T22:35:22.000000Z"
},
"delivery_detail": {
"id": "2ed39e73-52f4-4ed4-87b4-0036c85c1407",
"delivery_method": "car",
"delivery_box": null,
"delivery_total_order_value": "10000.00",
"delivery_number_of_parcels": 1,
"delivery_unit_weight": "10.00",
"delivery_insurance_value": null,
"created_at": "2023-09-25T22:35:23.000000Z"
},
"items": [
{
"uuid": "54183172-fc39-4bee-9a1a-7b6f08bd7eba",
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-09-25T22:35:28.000000Z"
},
{
"uuid": "51a65590-9787-4d63-a4dc-03d14cd61a44",
"item_description": "Cold stone",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-09-25T23:38:30.000000Z"
}
],
"store_type": "personal_store",
"store": {
"uuid": "8fd4928d-d96a-414a-9527-bbbdb9dcbe59",
"store_name": "Jona Coffee",
"store_access_token": "597cfcf3-184b-4baf-967d-dc2f81470bb6",
"delivery_counts": {
"pending_deliveries": 55,
"inprogress_deliveries": 33,
"delivered_deliveries": 42,
"cancelled_deliveries": 50
},
"created_at": "2023-06-25T14:39:31.000000Z"
},
"delivery_provider": {
"uuid": "478b18fc-95ba-4068-9aa1-3902d026368c",
"name": "Sendyit",
"logo": "https://usedora-bucket-dev.s3.amazonaws.com/provider-logos/sendy.svg"
},
"estimate_response_metas": "\"{\\\"name\\\":\\\"Sendyit\\\",\\\"provider_uuid\\\":\\\"478b18fc-95ba-4068-9aa1-3902d026368c\\\",\\\"logo\\\":\\\"https:\\\\\\/\\\\\\/usedora-bucket-dev.s3.amazonaws.com\\\\\\/provider-logos\\\\\\/sendy.svg\\\",\\\"rates\\\":[{\\\"courier\\\":\\\"Sendyit\\\",\\\"pickup_eta\\\":\\\"Not specified\\\",\\\"delivery_eta\\\":\\\"2-5 days\\\",\\\"amount\\\":2175,\\\"currency\\\":\\\"NGN\\\",\\\"insurance\\\":\\\"Not Insured\\\"}]}\"",
"current_amount": 2175,
"previous_amount": "1500",
"status": "pending",
"remarks": null,
"created_at": "2023-09-25T22:35:26.000000Z"
},
"message": "Delivery updated.",
"status": "success"
}