Cancel Drops

Cancel Drops

POST {baseUrl}/drops/cancel

Cancel drops by passing an array of dropIDs

Headers

Name	Type	Description
app_id*	string	Your app ID
app_secret*	string	Your app secret key

Request Body

Name	Type	Description
dropIds*	Array<string>	array of drop IDs
trackingId	String
batchId	String
note	String

200 Deliveries cancelled

{
  "status": true,
  "message": "Delivery cancelled",
  "data": {
  }
}

400: Bad Request Invalid dropId

{
    "status": false,
    "message": "Invalid app_id or app_secret",
    "data": {
        "statusCode": 401,
        "message": "Invalid app_id or app_secret",
        "isOperational": true,
    }
}

// Sample Request information
Url: https://sandbox.sendstack.africa/api/v1/drops/cancel
Method: POST
Headers: 
 - app_id: "your app_id"
 - app_secret: "your app_secret"

Sample Success Data

// Sample Request Body
{
    "dropIds": ["{{dropId}}"],
    "trackingId": "BN8IU3",
    "batchId": "MFUD2A",
    "note": "drop cancelled"
}

//Sample Response Body - 200 OK
{
    "status": true,
    "message": "Deliveries cancelled",
    "data": {}
}

Sample Error Data

{
    "dropIds": ["invalid dropId"]
}

//Sample Response Body - 400 OK
{
    "status": false,
    "message": "Invalid dropIds"
}