Create Delivery Job

Purpose

Following a successful delivery validation, this event confirms the delivery job is assigned and will include the full details of the job

ℹ️ Standardised Cancel Webhook URL

The Create Job webhook needs to be standardised, i.e. the same URL should be used for every customer installation.

Request Parameters

See the full delivery job via the link below;

Request Example

{
    "jobId": "609***72e",
    "account": "5f1***131",
    "pickupTime": "2021-05-13T13:40:04Z",
    "transportType": "unknown",
    "driverTip": 500,
    "pickupLocation": {
        "location": "606***555",
        "name": "Deliverect'\''s Pizza Place",
        "remarks": "please use the backdoor for order pickup",
        "street": "van Ghentlaan",
        "streetNumber": "3",
        "postalCode": "9000 LK",
        "city": "Leusden",
        "latitude": "52.379189",
        "longitude": "4.899431"
    },
    "deliveryLocations": [
        {
            "orderId": "609***4dd",
            "channelOrderDisplayId": "MT4YVTPL",
            "deliveryTime": "2021-05-13T13:55:00Z",
            "packageSize": "medium",
            "orderDescription": "hot food",
            "company": "BrainQuantums",
            "name": "V. Bertels",
            "street": "Refugehof",
            "streetNumber": "49",
            "postalCode": "9001 AB",
            "city": "Leusden",
            "phone": "+32123456789",
            "phoneAccessCode" : "342241214",
            "deliveryRemarks": "Don'\''t ring door bell.",
            "latitude": "52.379189",
            "longitude": "4.899431",
            "payment": {
                "orderIsAlreadyPaid": true,
                "amount": 1100,
                "paymentType": 0
            }
        }
    ],
    "ageCheck": False
}

Response Example

Below is an example of the expeted response from the Dispatch platform;

{
    "jobId": "609***72e",
    "canDeliver": true,
    "pickupTimeETA": "2021-05-13T13:42:00Z",
    "externalJobId": "DJ123456",
    "distance": 4200,
    "price":
    {
        "price": 750,
        "taxRate": 10000
    },
    "courier":
    {
        "courierId": "D1234",
        "firstName": "Delivery",
        "lastName": "Rider",
        "phoneNumber": "0032494112233",
        "transportType": "bicycle"
    },
    "deliveryLocations":
    [
        {
            "deliveryId": "ABC567",
            "orderId": "5f4***e2af",
            "channelOrderDisplayId": "MT4YVTPL",
            "deliveryTimeETA": "2021-05-13T13:57:00Z",
            "deliveryRemarks": ""
        }
    ]
}

Body Params
string
string
date-time
string
integer
pickupLocation
object
deliveryLocations
array of objects
deliveryLocations
boolean
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json