This endpoint retrieves all deliveries booked under your business. You can apply filters using the query parameters outlined below:
{
"status": true,
"message": "Deliveries successfully retrieved",
"data": {
"results": [
{
"id": "65fbffcc98e73c14e499bb50",
"trackingUrl": "https://app.sendstack.africa/tracking?batchId=4B12LN",
"checkoutUrl": "https://checkout.paystack.com/g278qsf89ngt43d",
"paymentStatus": "PENDING",
"paymentSource": "08085632323",
"batchId": "4B12LN",
"totalAmount": "1500",
"initiator": "65fbffc398e73c14e499bab4",
"pickup": {
"address": "95975 Barton Fields",
"locationCode": "01",
"pickupName": "Toni Dicki PhD",
"pickupNumber": "+2348017126895",
"pickupDate": "2024-03-22T00:00:00.000Z",
"lga": "Location 1",
"state": "Lagos"
}
}
],
"page": 1,
"limit": 10,
"totalPages": 1,
"totalResults": 1
}
}
// Sample Request information
Url: https://sandbox.sendstack.africa/api/v1/deliveries
Method: GET
Headers:
- app_id: "your app_id"
- app_secret: "your app_secret"
// Sample Response Body - 200 OK
{
"status": true,
"message": "Deliveries successfully retrieved",
"data": {
"drops": [
{
"id": "65b8c2c734d8cd1be099fd45",
"deliveryId": "65b8c2c734d8cd1be099fd47",
"status": "PENDING",
"paymentStatus": "PENDING",
"trackingId": "E033LM",
"batchId": "T4SYZ3",
"customer": {
"id": "670f5170d244e83e2424919e",
"name": "Bob",
"phone": "+2348151911111"
}
}
//...trunated for brevity
}
// Sample Request information
Url: https://sandbox.sendstack.africa/api/v1/deliveries?batchId={{batchId}}
Method: GET
Headers:
- app_id: "your app_id"
- app_secret: "your app_secret"
Query parameter:
- batchId = "delivery batchId"
// Sample Response Body - 200 OK
{
"status": true,
"message": "Deliveries successfully retrieved",
"data": {
"drops": [
{
"id": "65b8c02734d8cd1be099fcf1",
"status": "PENDING",
"paymentStatus": "PENDING",
"trackingId": "KH3I65",
"batchId": "MFUD2A",
"address": "95975 Barton Fields",
"pickupName": "Toni Dicki PhD",
"pickupNumber": "+2348017126895",
"altPickupNumber": "+2348033000000",
"pickupLga": "Yaba - Makoko",
"pickupState": "Lagos",
"recipientName": "Kabir",
"recipientNumber": "+23490234500690",
"recipientLga": "Yaba - Makoko",
"amount": 1500,
"estimatedPickupWindow": {
"date": "2024-10-27T08:00:00.000Z",
"start": "2024-10-27T08:00:00.000Z",
"end": "2024-10-27T13:00:00.000Z"
},
//...truncated for brevity
}
}
Filter By a Specific customer
// Sample Request information
Url: https://sandbox.sendstack.africa/api/v1/deliveries?customer={{customerId}}
Method: GET
Headers:
- app_id: "your app_id"
- app_secret: "your app_secret"
Query parameter:
- customer = "customerId"
// Sample success Response Body - 200 OK
{
"status": true,
"message": "Deliveries successfully retrieved",
"data": {
"drops": [
{
"id": "65b8c02734d8cd1be099fcf1",
"status": "PENDING",
"paymentStatus": "PENDING",
"trackingId": "KH3I65",
"batchId": "MFUD2A",
"address": "95975 Barton Fields",
"pickupName": "Toni Dicki PhD",
"pickupNumber": "+2348017126895",
"altPickupNumber": "+2348033000000",
"pickupLga": "Yaba - Makoko",
"pickupState": "Lagos",
"recipientName": "Kabir",
"recipientNumber": "+23490234500690",
"recipientLga": "Yaba - Makoko",
"amount": 1500,
"customer": {
"id": "670f5170d244e83e2424919e",
"name": "Bob",
"phone": "+2348151911111"
}
//...truncated for brevity
}
}