REST API Documentation
- Authentication
- Manage Deliveries
- Manage Riders
Create delivery 📦
This endpoint creates customer order fulfilment request.
Endpoint POST
Copy
curl --request POST \
--url https://api.usedora.com/v1/deliveries
--header 'Authorization: Bearer <store_access_token>' \
--header 'Content-Type: application/json'
Request Body Parameters
The provider selected provider uuid that was selected after generating delivery estimate.
The store uuid where the delivery will be saved
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)
Sample Request
Copy
{
"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": 10,
"item_value": 10000
]
}
}
Copy
{
"status": "success",
"data": {
"uuid": "819b3aa6-89af-4fdc-b47c-071449dbcddf",
"order_number": 100253813774,
"creation_mode": "Automated",
"sender_detail": {
"id": "aa3fba98-6442-4051-82d3-f8eee16b0f98",
"sender_address": "12 Ahmadu Bello way, Central Business District, Abuja",
"sender_send_email_thirty_minutes_after_processing_order": true,
"sender_include_return_portal_in_tracking_mail": true,
"created_at": "2023-09-25T23:40:22.000000Z"
},
"customer_detail": {
"id": "764677c6-20f0-4e9c-b93f-2cb09a408fcf",
"customer_name": "TundeNasri",
"customer_company": null,
"customer_email": "sinoma@gmail.com",
"customer_postal_code": null,
"customer_state_id": 4,
"customer_house_number": null,
"customer_phone_number": "08065302534",
"phone_code": null,
"customer_address": "1 Ajao estate, Ikeja, Lagos",
"created_at": "2023-09-25T23:40:22.000000Z"
},
"delivery_detail": {
"id": "411dc1fb-4858-4835-b7a4-b23d780198a5",
"delivery_method": "car",
"delivery_box": null,
"delivery_total_order_value": "1000.00",
"delivery_number_of_parcels": 1,
"delivery_unit_weight": "10.00",
"delivery_insurance_value": null,
"created_at": "2023-09-25T23:40:22.000000Z"
},
"items": [
{
"uuid": "aad0512b-acde-4bdc-bbde-77ce788e4a91",
"item_description": "Freshfish",
"item_quantity": 1,
"item_weight": "10.00",
"item_value": "10000.00",
"created_at": "2023-09-25T23:40:29.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": 56,
"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\\\":1500,\\\"currency\\\":\\\"NGN\\\",\\\"insurance\\\":\\\"Not Insured\\\"}]}\"",
"current_amount": 1500,
"previous_amount": 0,
"status": "pending",
"remarks": null,
"created_at": "2023-09-25T23:40:25.000000Z"
},
"message": "Delivery created"
}
On this page
Assistant
Responses are generated using AI and may contain mistakes.