POST https://webhook.example.com

Gets called to validate if there are drivers available and to check if it's possible to deliver one or multiple orders.

application/json

Body

Responses

  • 200 application/json

    200

  • 406 application/json

    406

POST /yourwebhook.com/validateJob
Request example
{
  "jobId": "627a6f4c2*****3fbc79a",
  "account": "60f15a8***069643633",
  "ageCheck": false,
  "driverTip": 500,
  "pickupTime": "2022-05-10T14:12:31.649000Z",
  "transportType": "unknown",
  "pickupLocation": {
    "city": "Amsterdam",
    "name": "Location 1",
    "street": "Van Slingelandtstraat",
    "remarks": "",
    "latitude": "52.3842918",
    "location": "60f15a8e9****ddceb6a7b1",
    "longitude": "4.8662024",
    "postalCode": "1051CH",
    "streetNumber": "32"
  },
  "deliveryLocations": [
    {
      "city": "Gent",
      "name": "",
      "phone": "",
      "street": "4 The Krook",
      "company": "",
      "orderId": "627a6f*****5c09221a9837",
      "payment": {
        "amount": 800,
        "paymentType": 0,
        "orderIsAlreadyPaid": true
      },
      "latitude": "29.37045479999999",
      "longitude": "47.9787778",
      "postalCode": "8888KL",
      "packageSize": "unknown",
      "deliveryTime": "2022-05-10T14:27:31.649000Z",
      "deliveryRemarks": "",
      "phoneAccessCode": "43121212",
      "orderDescription": "This is a test order",
      "channelOrderDisplayId": "T191051"
    }
  ]
}
Response examples (200)
{
  "jobId": "609***72e",
  "price": {
    "price": 750,
    "taxRate": 10000
  },
  "canDeliver": true,
  "pickupTimeETA": "2021-05-13T13:42:00Z",
  "deliveryLocations": [
    {
      "orderId": "5f47a223280a29046404e2af",
      "deliveryId": "ABC567",
      "deliveryTimeETA": "2021-05-13T13:59:00Z"
    }
  ]
}
Response examples (406)
{
  "jobId": "",
  "errors": [
    {
      "reason": 10,
      "orderId": "",
      "deliveryId": "",
      "description": "package size too large for delivery type",
      "channelOrderDisplayId": ""
    },
    {
      "reason": 20,
      "orderId": "",
      "deliveryId": "",
      "description": "No drivers available at this time",
      "channelOrderDisplayId": ""
    },
    {
      "reason": 30,
      "orderId": "",
      "deliveryId": "",
      "description": "address outside of delivery area",
      "channelOrderDisplayId": ""
    },
    {
      "reason": 40,
      "orderId": "",
      "deliveryId": "",
      "description": "too many packages for selected transport type",
      "channelOrderDisplayId": ""
    }
  ],
  "canDeliver": false
}