Update Delivery Details

Update Delivery Details

PUT {baseUrl}/deliveries/drops/:id

Update delivery details by providing the drop ID

Path Parameters

Name
Type
Description

id*

String

Headers

Name
Type
Description

app_id*

String

Your app ID

app_secret*

String

Your app secret

Request Body

Name
Type
Description

address

String

recipientName

String

recipientNumber

String

altRecipientNumber

String

note

String

locationCode

String

{
    // Response
}

Sample Success Data

// Sample Request information
Url: https://sandbox.sendstack.africa/api/v1/deliveries/drops/yourDropId
NB: Replace yourDropId with an actual dropId
Method: PUT
Headers:
 - app_id: "your app_id"
 - app_secret: "your app_secret"
//Sample Request Body
{
    "locationCode": "04",
    "address": "4, Toyin Street, Yaba",
    "recipientName": "Clinton",
    "recipientNumber": "09067234756"
}
// Sample Response Body - 200 OK
{
    "status": true,
    "message": "Delivery updated successfully",
    "data": {
        "id": "65b8c2c734d8cd1be099fd45",
        "processed": false,
        "status": "PENDING",
        "paymentStatus": "PENDING",
        //..truncated for brevity
    }
}

Sample Error Data

// Sample Request information
Url: https://sandbox.sendstack.africa/api/v1/deliveries/drops/invalidDropId
Method: PUT
Headers:
 - app_id: "your app_id"
 - app_secret: "your app_secret"
// Sample Response Body - 400 Bad Request
{
    "status": false,
    "message": "Invalid dropId"
}

Last updated