POST https://webhook.example.com

Cancel a delivery job after it was created at the partner. This can happen if all the orders on the job cannot be fulfilled or if the customer no longer wants the delivery.

application/json

Body

object object

Responses

  • 200 application/json

    200

POST /yourwebhook.com/cancelJob
Request example
{
  "jobId": "5c8fbfd3c6489f00010e50d1",
  "account": "5be9fe94c6489f0001b2fe57",
  "courier": {
    "courierId": "D1234"
  },
  "pickupLocation": {
    "location": "5ea823bc8b4c780001a674a9"
  },
  "deliveryLocations": [
    {
      "orderId": "5f47a223280a29046404e2af",
      "deliveryId": "ABC567",
      "channelOrderDisplayId": "MT4YVTPL"
    }
  ]
}
Response examples (200)
{
  "price": 0,
  "reason": "",
  "status": "confirmed"
}