Get Delivery Price Estimate
Get Delivery Price
POST
{baseUrl}/deliveries/offers
This endpoint allows you to get the delivery price estimate between two locations.
You have 2 options:
Pass a location code. You can get a location code of every location via the get locations endpoint here.
Pass lat and long values as properties of pickup and drop object
Request Body
Name | Type | Description |
---|---|---|
orderType | string | |
pickup | object | pickup details |
drop | object | dropoff details |
{
"status": true,
"message": "Available Delivery Offers Returned",
"data": [
{
"name": "DLVR By Sendstack",
"price": 3200,
"id": "657217b5901fd21b282399ca",
"partnerLogo": "https://sendstack.s3.us-west-2.amazonaws.com/partnerDocuments/65bcd97c1e38ed2e78e78e93/supportingDocument/be48d753-075c-4611-9c0a-52ebe8e2b270.png",
"deliveryTimeline": {
"estimatedDropoffWindow": {
"start": "2024-04-26T13:00:00.000Z",
"end": "2024-04-26T18:00:00.000Z"
},
"estimatedPickupWindow": {
"start": "2024-04-26T07:00:00.000Z",
"end": "2024-04-26T13:00:00.000Z"
}
},
"scope": "intracity_scheduled",
"createdAt": "2024-04-25T16:40:18+01:00"
}
]
}
{
"status": false,
"message": "\"dropoffCode\" is required",
"data": {
"statusCode": 400,
"message": "\"dropoffCode\" is required",
}
}
Sample Success Data
{
"orderType": "FULFILLMENT",
"pickup": {
"pickupDate": "2024-04-26", //optional
"locationCode": "0NUP",
"city": "Ikeja",
"state": "Lagos",
"address": "30, Allen Avenue, Ikeja",
"address2": "5, Allen Avenue, Ikeja"
},
"drop": {
"locationCode": "OHZ2",
"city": "Yaba",
"state": "Lagos",
"address": "7, Adebiyi Street, Yaba",
"address2": "10, Adebiyi Street, Yaba",
"category": "Electronic",
"width": 5,
"height": 5,
"weight": 5,
"length": 5
}
}
{
"orderType": "FULFILLMENT",
"pickup": {
"pickupDate": "2024-10-27", //optional
"locationCode": "0NUP",
"city": "Ikeja", //optional
"state": "Lagos", //optional
"address": "30, Allen Avenue, Ikeja",
"address2": "5, Allen Avenue, Ikeja"
},
"drop": {
"locationCode": "OHZ2",
"city": "Yaba", //optional
"state": "Lagos", //optional
"address": "7, Adebiyi Street, Yaba",
"address2": "10, Adebiyi Street, Yaba",
"category": "Electronic",
"width": 5,
"height": 5,
"weight": 5,
"length": 5
}
}
// Sample Response Body - 200 OK
{
"status": true,
"message": "Available Delivery Offers Returned",
"data": [
{
"name": "DLVR By Sendstack",
"price": 3200,
"id": "657217b5901fd21b282399ca",
"partnerLogo": "https://sendstack.s3.us-west-2.amazonaws.com/partnerDocuments/65bcd97c1e38ed2e78e78e93/supportingDocument/be48d753-075c-4611-9c0a-52ebe8e2b270.png",
"deliveryTimeline": {
"estimatedDropoffWindow": {
"start": "2024-04-26T13:00:00.000Z",
"end": "2024-04-26T18:00:00.000Z"
},
"estimatedPickupWindow": {
"start": "2024-04-26T07:00:00.000Z",
"end": "2024-04-26T13:00:00.000Z"
}
},
"scope": "intracity_scheduled",
"createdAt": "2024-04-25T16:40:18+01:00"
}
]
}
Sample Error Data
{
"orderType": "FULFILLMENT",
"pickup": {
"pickupDate": "2024-04-26",
"city": "Ikeja",
"state": "Lagos",
"address": "30, Allen Avenue, Ikeja",
"address2": "5, Allen Avenue, Ikeja"
},
"drop": {
"city": "Yaba",
"state": "Lagos",
"address": "7, Adebiyi Street, Yaba",
"address2": "10, Adebiyi Street, Yaba",
"category": "Electronic",
"width": 5,
"height": 5,
"weight": 5,
"length": 5
}
}
// Sample Response Body - 400 Bad Request
{
"status": false,
"message": "Pickups in Lagos or Intra-city deliveries must include lat/long or locationCode"
}
Last updated