Addison Lee can push Job Status Updates to partners via HTTP POST.
Please enter in contact with your Account Manager if you are interested in receiving Job Status Updates.
All the possible status updates are:
| Status | Description |
|---|
| BOOKED | Confirmation that the booking is placed in our systems |
| ONWAY | The driver is on their way to the pick-up point |
| ARRIVED | The driver is waiting at the pick-up point |
| ONBOARD | Passenger gets in the vehicle or parcel collected |
| DONE | Confirmation that the job has finished |
| COMPLETED | Completion of the job containing amendments |
| PRICED | Final price details for a completed job including all amendments. This status is published 24 hours after COMPLETED |
| CANCELLED | Confirmation that a job has been cancelled |
Supported Authorization Headers:
| Header | Description |
|---|
| Authorization | Basic authentication header |
| client_id | client id |
| client_secret | client secret |
Provide either the Authorization header or client_id/client_secret combination which will sent with each status update to authenticate with your API.
Please find below examples of each status:
BOOKED
{
"status": "BOOKED",
"job": {
"id": "J685000000028967171",
"number": "914052",
"uuid": "6b17a0ec-3329-4f86-b80b-4931b4e16665",
"vendor": "A12345678"
},
"dates": {
"event": "2016-12-10T09:01:00+01:00",
"sent": "2016-12-12T09:01:20+01:00"
}
}
| Parameters | Description | Required |
|---|
| status | Current status | Yes |
| job.id | Quickbook API V2 booking ID | Yes |
| job.uuid | Quickbook API V3 booking ID | No |
| job.number | 6-digit booking number | Yes |
| job.vendor | Partner's booking reference | No |
| dates.event | Date and time when the event happened | Yes |
| dates.sent | Date and time when this status has been sent to the partner | Yes |
| stop_number | Stop number in which the driver or courier is on its way | Yes |
ONWAY
{
"status": "ONWAY",
"job": {
"id": "J685000000028967171",
"number": "914052",
"uuid": "6b17a0ec-3329-4f86-b80b-4931b4e16665",
"vendor": "A12345678"
},
"dates": {
"event": "2016-12-10T09:01:00+01:00",
"sent": "2016-12-12T09:01:20+01:00"
},
"stop_number": 1,
"allocation": {
"type": "DRIVER",
"driver": {
"name": "John Doe",
"id": "83453",
"callsign": "A12",
"pl_number": "7842",
"license": "88999",
"image": "https://static.addisonlee.com/images/drivers/83453.jpg",
"contact": "447712555666"
},
"vehicle": {
"class": "vip_e",
"reg": "4DD L33",
"model": "Ford Galaxy",
"color": "Black"
}
}
}
| Parameters | Description | Required |
|---|
| status | Current status | Yes |
| job.id | Quickbook API V2 booking ID | Yes |
| job.uuid | Quickbook API V3 booking ID | No |
| job.number | 6-digit booking number | Yes |
| job.vendor | Partner's booking reference | No |
| dates.event | Date and time when the event happened | Yes |
| dates.sent | Date and time when this status has been sent to the partner | Yes |
| stop_number | Stop number in which the driver or courier is on its way | Yes |
| allocation.type | The allocation type can be DRIVER or COURIER | Yes |
| allocation.driver.name | Driver's name and surname | Yes |
| allocation.driver.id | Backend's driver unique id | Yes |
| allocation.driver.callsign | Driver's callsign | No |
| allocation.driver.license | PCO license | Yes |
| allocation.driver.image | Driver's photo | No |
| allocation.driver.contact | Driver's mobile phone | Yes |
| allocation.vehicle.class | Type of service offered by Addison Lee | No |
| allocation.vehicle.reg | Vehicle's registration plate | Yes |
| allocation.vehicle.model | Vehicle's maker and model | Yes |
| allocation.vehicle.color | Vehicle's colour | Yes |
ARRIVED
{
"status": "ARRIVED",
"job": {
"id": "J685000000028967171",
"number": "914052",
"uuid": "6b17a0ec-3329-4f86-b80b-4931b4e16665",
"vendor": "A12345678"
},
"dates": {
"event": "2016-12-10T09:01:00+01:00",
"sent": "2016-12-12T09:01:20+01:00"
},
"stop_number": 1
}
| Parameters | Description | Required |
|---|
| status | Current status | Yes |
| job.id | Quickbook API V2 booking ID | Yes |
| job.uuid | Quickbook API V3 booking ID | No |
| job.number | 6-digit booking number | Yes |
| job.vendor | Partner's booking reference | No |
| dates.event | Date and time when the event happened | Yes |
| dates.sent | Date and time when this status has been sent to the partner | Yes |
| stop_number | Stop number in which the driver or courier is on its way | Yes |
ONBOARD
{
"status": "ONBOARD",
"job": {
"id": "J685000000028967171",
"number": "914052",
"uuid": "6b17a0ec-3329-4f86-b80b-4931b4e16665",
"vendor": "A12345678"
},
"dates": {
"event": "2016-12-10T09:01:00+01:00",
"sent": "2016-12-12T09:01:20+01:00"
}
}
| Parameters | Description | Required |
|---|
| status | Current status | Yes |
| job.id | Quickbook API V2 booking ID | Yes |
| job.uuid | Quickbook API V3 booking ID | No |
| job.number | 6-digit booking number | Yes |
| job.vendor | Partner's booking reference | No |
| dates.event | Date and time when the event happened | Yes |
| dates.sent | Date and time when this status has been sent to the partner | Yes |
| stop_number | Stop number in which the driver or courier is on its way | Yes |
DONE
{
"status": "DONE",
"job": {
"id": "J685000000028967171",
"number": "914052",
"uuid": "6b17a0ec-3329-4f86-b80b-4931b4e16665",
"vendor": "A12345678"
},
"dates": {
"event": "2016-12-10T09:01:00+01:00",
"sent": "2016-12-12T09:01:20+01:00"
},
"stop_number": 2
}
| Parameters | Description | Required |
|---|
| status | Current status | Yes |
| job.id | Quickbook API V2 booking ID | Yes |
| job.uuid | Quickbook API V3 booking ID | No |
| job.number | 6-digit booking number | Yes |
| job.vendor | Partner's booking reference | No |
| dates.event | Date and time when the event happened | Yes |
| dates.sent | Date and time when this status has been sent to the partner | Yes |
| stop_number | Stop number in which the driver or courier is on its way | Yes |
COMPLETED
{
"status": "COMPLETED",
"job": {
"id": "J685000000028967171",
"number": "914052",
"uuid": "6b17a0ec-3329-4f86-b80b-4931b4e16665",
"vendor": "A12345678"
},
"dates": {
"event": "2019-12-10T09:01:00+01:00",
"sent": "2019-12-10T09:01:20+01:00"
},
"journey": [
{
"stop": {
"type": "ADDRESS",
"wait": 5,
"address": {
"formatted_address": "10 Paris House, 20 Peterborought Road, Harrow, HA1 2AJ",
"address_components": {
"building": "10 Paris House",
"street": "20 Peterborought Road",
"locality": "Harrow",
"region": "London",
"postal_code": "HA1 2AJ",
"country": "GB"
},
"geo": {
"lat": 51.577543,
"long": -0.333567
}
}
}
},
{
"stop": {
"type": "ADDRESS",
"wait": 5,
"address": {
"formatted_address": "The O2, Peninsula Square, London SE10 0DX",
"address_components": {
"place_name": "The O2",
"street": "Peninsula Square",
"locality": "London",
"region": "London",
"postal_code": "SE10 0DX",
"country": "GB"
},
"geo": {
"lat": 51.503087,
"long": 0.003072
}
}
}
}
],
"signatures": [ {
"signature": {
"name": "John Smith",
"image": "data:image/png;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4QBoRXhpZgAATU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAABJKGAAcAAAAQAAAAUKABAAMAAAABAAEAAKACAAQAAAABAAAA9qADAAQAAAABAAAA9gAAAABBU0NJSQAAAG1hZ2UgMTlM/+0AOFBob3Rvc2hvcCAzLjAAOEJJTQQEAAAAAAAAOEJJTQQlAAAAAAAQ1B2M2Y8AsgTpgAmY7PhCfv/AABEIAPYA9gMBIgACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMoGRoQgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+fr/xAAfAQADAQEBAQEBAQEBAAAAAAAAAQIDBAUGBwgJCgv/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2wBDAAICAgICAgMCAgMEAwMDBAUEBAQEBQcFBQUFBQcIBwcHBwcHCAgICAgICAgKCgoKCgoLCwsLCw0NDQ0NDQ0NDQ3/2wBDAQICAgMDAwYDAwYNCQcJDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ3/3QAEABD/2gAMAwEAAhEDEQA/APiOiiiuMAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD//0PiOiiiuMAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD//0fiOiiiuMAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD//0viOiiiuMAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD//0/iOiiiuMAooooAKKKKACiiigAooooAK+ov2W/hB/wALG8Z/2/rMG/QPD7pNMHGUubr70UPoVH33HoAD96vnfw54e1XxZr1h4a0OEz3+pTpbwIOm5u5PZVGWY9gCa/br4a+AtJ+Gfg3T/B+k4ZbRN1xNjDXFw/Mkrf7zdPRQB2r+dPpGeKH+rOR/2ZgZ2xeJTStvCG0p+Tfwx822vhPrOE8m+uYn21Re5D8X0X6v/gnXf2Xpn/Pnb/8AfpP8KP7L0z/nzt/+/Sf4Veor/ND6xV/mf3s/XuSPYo/2Xpn/AD52/wD36T/CvnL9q+xsYPgdrUkFtDG4nscMkaqRm5j7gZr6br5u/a0/5IXrf/XxYf8ApTHX3vhZXqPjLKk5P/eKPX/p5E8zOor6hW0+zL8j4K/ZSiim+OOhxzIsiGG+yrgMDi2k7Hiv14/svTP+fO3/AO/Sf4V+Rf7J3/JddC/643//AKTSV+wVfsn0tas48ZUFGTX+zw/9OVTwOBop5fK6+0/yRR/svTP+fO3/AO/Sf4Uf2Xpn/Pnb/wDfpP8ACr1Ffy99Yq/zP72fZckexR/svTP+fO3/AO/Sf4V5v8UvHngn4T+GJPEfiC2gkdiYrO0jjTzrqfGQiZHAHVmPCjnrgH1avxi/aG+JVx8SviTqF3HKW0rSpHsNNjB+QRRNh5APWVwWJ9No7V+z+B/hxU40z76vipyWGormqNN3avaME+jk769IqTWtj5/iPNo5fhuaCXPLRf5/I574lfF7xf8AE+/abWZI7SwV90Gm2aCK2iHbIABkcf33yfTA4ry2iiv9QspyjBZXhYYLL6Sp0o6KMVZf8F929Xu9T8ar16labqVZXb7hRRRXomQUUUUAFFFFABRRRQB//9T4jooorjAKKKKACiiigAooooAKKK9u+Afwnn+LPjuDTLlGGi6ftutVlHA8kH5Ygf70zDaPRdx7V5Gf57g8my6tmuYT5aVKLlJ+S6Lu29EuraRvhcNUxFWNGkrybsfVX7K3w603wF4Qv/jh4322vm2sj2TSj/j3sFGXmAP8c5GE7lcY+/XqP7NXxF1P4pah478Wahujjl1K1is7cnIt7SOJhHGO2cfMx7sSa8F/bA+LEEksHwe8LusVjpwifVPJ4TzEA8m1AHG2IYZh03bR/Ca7X9hX/kWfFn/YQtf/AES1fw7xvkWMzPgbM/EHPYWxOLdJUov/AJdUFVhyRXnLRt9VZ7ykfo2XYmnRzGjleGfuQvzPvKzv939bI+7KKKK/jg+/Cvm79rT/AJIXrf8A18WH/pTHX0jXzd+1p/yQvW/+viw/9KY6++8K/wDks8q/7CKP/pyJ5mdf8i+t/hl+R8Hfsnf8l10L/rjf/wDpNJX7BV+Pv7J3/JddC/643/8A6TSV+wVfsv0uP+Szof8AYPD/ANOVT5/gb/kXy/xP8kFFFFfy4fZnMeNtQl0nwZr+qQnElnpd5Oh9GjhdgfzFfgquSoJOTjk1+7HxP/5Jt4r/AOwLqH/pO9fhOv3R9K/vX6HVKKy3M6iWrnTXyUZW/Nn5nx837WivJ/mhaKKK/ss/PwooooAKKKKACiiigAooooA//9X4jooorjAKKKKACiiigAooooAsWlpdahdwWFjE89zcyJDDFGMvJJIQqqo7kkgCv1EH9lfsm/ArJ8qbxRqf0Pn6lKv6w2y/gQPV68h/Y/8AhPDNcT/GDxOix2Om+Yml+dgIZEBE1yc8bYhlVPTduP8ACK8B+P3xYm+LPjufUbV2Gi6dutdLjPAMQPzTEf3pmG71C7R2r+bOLpy4/wCLYcI0HfL8G1UxTW06n2KN/LXm/wC3tpQR9dgUsswLx0v4tTSHkusv8vl3PGLy8u9Qu59Qv5XuLm5keaaVzl5JJCWZmPcknJr9G/2Ff+RZ8Wf9hC1/9EtX5t1+kn7Cv/Is+LP+wha/+iWr1vpLQjHw8xcYqyTpf+nIGHCDbzSDfn+TPuyiiiv8vD9lCvm79rT/AJIXrf8A18WH/pTHX0jXzd+1p/yQvW/+viw/9KY6++8K/wDks8q/7CKP/pyJ5mdf8i+t/hl+R8Hfsnf8l10L/rjf/wDpNJX7BV+Pv7J3/JddC/643/8A6TSV+wVfsv0uP+Szof8AYPD/ANOVT5/gb/kXy/xP8kFFFFfy4fZnDfE//km3iv8A7Auof+k71+E6/dH0r92Pif8A8k28V/8AYF1D/wBJ3r8J1+6PpX98/Q7/AORVmX/XyH/pLPzLj3+NR9H+YtFFFf2OfABRRRQAUUUUAFFFFABRRRQB/9b4jooorjAKKKKACiiigAr0T4V/DvU/ij42sPCWnbkjmbzby4AyLe1jI8yQ++OFHdiBXnfJ4AJJ6AdTX6h/C3w7pP7M/wAF7/4geLogNd1KFJ5oW4k3uD9lsl7g5O6T0JYnhRX5Z4tcdVeHMoVPL1z47EP2VCC1bnLTmt2he/a/Knue1keWxxde9XSnDWT8l0+Zy37U/wARNM+H/g6w+B/gjbama0jS8WI82+nqMJESP45yMt3K5z9+vzlrc8S+ItW8W6/f+JtdmM9/qU7Tzv23N0VR2VRhVHYACsOvR8MuBKXCmR08vvz1pNzqz3c6kvid92lsr9Em9WzHOMyeNxLq7RWkV2S2Cv0k/YV/5FnxZ/2ELX/0S1fm3X6SfsK/8iz4s/7CFr/6JavhvpM/8m+xn+Kl/wCnInp8If8AI0h6P8mfdlFFFf5dH7KFfN37Wn/JC9b/AOviw/8ASmOvpGvm79rT/khet/8AXxYf+lMdffeFf/JZ5V/2EUf/AE5E8zOv+RfW/wAMvyPg79k7/kuuhf8AXG//APSaSv2Cr8ff2Tv+S66F/wBcb/8A9JpK/YKv2X6XH/JZ0P8AsHh/6cqnz/A3/Ivl/if5IKKKK/lw+zOG+J//ACTbxX/2BdQ/9J3r8J1+6PpX7sfE/wD5Jt4r/wCwLqH/AKTvX4Tr90fSv75+h3/yKsy/6+Q/9JZ+Zce/xqPo/wAxaKKK/sc+ACiiigAooooAKKKKACiiigD/1/iOiiiuMAooooAKKK6Twf4U1fxx4m07wpoUfmXupTCJM/dQdXkb0RFBZj6CufF4qjhaE8TiJKMIJyk3skldt+SWpcISnJQgrtn0r+yZ8IP+E48Wf8JrrcG/RPD0qtGrj5Lm/GGjTngrFw7e+0dzWX+1P8X/APhYnjP/AIRzRp9+g+HpHiiKn5Lm7+7LN7qv3E9gSPvV9LfGzxXpH7PXwh074W+CpPL1bUbZreOVeJUhb/j5u3x0klYlUPYkkfcr8xBxxX89eGuFrcZcQ1fELMYtUI3pYOD6QTalVt/NJ3XzktlFn1ObzjgMLHK6T9561H59I/L+uoUUUV/Rp8mFfpJ+wr/yLPiz/sIWv/olq/Nuv0k/YV/5FnxZ/wBhC1/9EtX4J9Jn/k32M/xUv/TkT6fhD/kaQ9H+TPuyiiiv8uj9lCvm79rT/khet/8AXxYf+lMdfSNfN37Wn/JC9b/6+LD/ANKY6++8K/8Aks8q/wCwij/6cieZnX/Ivrf4ZfkfB37J3/JddC/643//AKTSV+wVfj7+yd/yXXQv+uN//wCk0lfsFX7L9Lj/AJLOh/2Dw/8ATlU+f4G/5F8v8T/JBRRRX8uH2Zw3xP8A+SbeK/8AsC6h/wCk71+E6/dH0r92Pif/AMk28V/9gXUP/Sd6/Cdfuj6V/fP0O/8AkVZl/wBfIf8ApLPzLj3+NR9H+YtFFFf2OfABRRRQAUUUUAFFFFABRRRQB//Q+I6KKK4wCiiigAr9KP2Z/AOl/Cn4e6j8afHAFtPd2bTw7x89vpy4YbQf+Wly2CB1I2Dua+Wf2cvhG/xU8cx/2jEW0DRyl1qLH7svP7u3z6ykfN/sBvavpf8Abc8aT2GlaD8O7BvKhvt2oXap8oMVuQkEeB/Dv3Nj1UV/NPi/n0+Is9wnhnllTldZqWIkt40orn5PWSV3/wBuraTPr8iwywuGnm9ZfDpBd5bX+X+fY+HviP481b4leMdR8X6uSsl5JiGHOVt7dOIol9lXqe7EnvXD0UV/RWX5fh8DhaeCwkFGnTSjFLZJKyX3HylWrOrN1Kju3qwooorsMwr9JP2Ff+RZ8Wf9hC1/9EtX5t1+kn7Cv/Is+LP+wha/+iWr8E+kz/yb7Gf4qX/pyJ9Pwh/yNIej/Jn3ZRRRX+XR+yhXzd+1p/yQvW/+viw/9KY6+ka+bv2tP+SF63/18WH/AKUx1994V/8AJZ5V/wBhFH/05E8zOv8AkX1v8MvyPg79k7/kuuhf9cb/AP8ASaSv2Cr8ff2Tv+S66F/1xv8A/wBJpK/YKv2X6XH/ACWdD/sHh/6cqnz/AAN/yL5f4n+SCiiiv5cPszhvif8A8k28V/8AYF1D/wBJ3r8J1+6PpX7sfE//AJJt4r/7Auof+k71+E6/dH0r++fod/8AIqzL/r5D/wBJZ+Zce/xqPo/zFooor+xz4AKKKKACiitvw14ev/FniHTfDOloXutUuYrWIDsZGALH2UZY+wrHEYilQpSr1pcsIptt7JJXbfoioQcpKMd2UL+xm0+ZYJ+HaGGbH+zPGsq/+OsKp17F8ftMtdE+LviDRrIbbewa0tYh/sQ2kCL+grx2vO4ezRZllWGzFK3tacJ/+BRUv1NcVR9jWnS/lbX3MKKKK9cwP//R+I6KKK4wCr2l6Zf61qVro+lQNc3t7MlvbwoMtJJIdqqPqT+FUa/Qn9jb4QYD/FrXoeW32+io47crNc8+vMaH/ePpXwniTx3hOEchrZzidZLSEf55v4Y/q+0U30PTyjLZ47Exw8Pm+y6v+up9a/B34Z2Hwp8DWXhi22yXZH2jULhR/r7uQDef91cBU/2QO+a+H/25dPni8beG9VIPk3GlSQK3bfBMzMPylFfplXzr+018Lbn4m/Dt/wCx4vN1nRJDfWSD70w24mhHu6cqO7Ko71/nT4Q8fvCeIVDPs7qX9tKaqTfR1E1d9kpNX6KK7I/Vs+yznyqWGw6+FKy9P+B+J+PNFKVZWKsCrKSCCMEEdQR2IpK/1RPxYKKKKACv0+/Yg0ia0+HmtaxKpCajqxWIn+JbaJVJH/AmI/Cvza8PeH9X8Va5ZeHNBt2ub/UJlggiXuzdyeyqMlj0ABNfuF8OvBdl8PPBOkeDrAh0023CSSYx5szEtLJ/wOQk+w4r+UfpZcWYfCcOU8hjK9avNSa7Qg73fa8uVLvaXZn23BGBnUxbxLXuxX4v/gHa0UUV/nafqwV83ftaf8kL1v8A6+LD/wBKY6+ka+bv2tP+SF63/wBfFh/6Ux1994V/8lnlX/YRR/8ATkTzM6/5F9b/AAy/I+Dv2Tv+S66F/wBcb/8A9JpK/YKvx9/ZO/5LroX/AFxv/wD0mkr9gq/Zfpcf8lnQ/wCweH/pyqfP8Df8i+X+J/kgooor+XD7M4b4n/8AJNvFf/YF1D/0nevwnX7o+lfux8T/APkm3iv/ALAuof8ApO9fhOv3R9K/vn6Hf/IqzL/r5D/0ln5lx7/Go+j/ADFooor+xz4AKKCQOtdZ4T8CeMfHV4LHwjo93qkhIBaCM+Ume7ynEaD3ZhXNjMbh8JRlicXUUIR3lJpJerdki6dOc5KEFdvojkyccmv0i/ZG+CF1ocY+Kfiu3MN5dQlNItpRh4oJBhrhgeQ0i/Kg6hCT/EMaPwX/AGRNO8M3Nv4m+Jbw6pqMREkGmxfPZwOOQ0rEDznU9BjYD/er7dr+GfHz6QeEzLCVOGuGJ81OelWqtFJdYQ6tP7UtmtFdNs/SOGOFp0prF4xWa2j+r/RH4w/tK/8AJc/Fv/X3D/6TxV4bXuX7Sv8AyXPxb/19w/8ApPFXhtf1/wCHn/JK5Z/2D0f/AE3E+DzX/fa3+KX5sKKKK+wOA//S+I6KKK4wOn8GaZoGseKNOsPFWpppGjvMDe3jhm2QLywUIrMXcDavHBOTwK/WXTf2iP2fNH0620nS/E1pbWdnEkEEKQXAWOOMBVUfuuwFfjnRX5F4meD2Xcb1aMs0xVWEKSfLCDgo3e8nzQk22rLeyS0Wrv7uT59Vy5SVGEW31d7+m6P2a/4aa+Bf/Q2W3/fi4/8AjVH/AA018C/+hstv+/Fx/wDGq/GWivy7/iULhP8A6C8R/wCBU/8A5We1/r3jv5I/j/mfafx0079nrx5dXHizwJ4wsNL12YmS5tpILhbS9fu2RD+6lPdsFWPUA5avi5l2sVyDgkZU5Bx6H0ptFf0DwZwrLh7L45asXUr046R9q4uUUvsqUYxbS6c12tk7WR8tmGNWKqutyKLe9r2f3thVuxtVvbuK1e4htVlYKZ7hisUYPVmKhmwPYE+gqpRX1c03FqLs+5xLfU/RX4Hax+zX8H7RtQm8YWmqeIrqPZcX5trhUiQ8mK3UxZVCfvMfmfvgcD6F/wCGmvgX/wBDZbf9+Lj/AONV+MtFfzfxH9GbJc+zCpmmbZhialae7cqfySSpJJLokkkfW4Ti/EYakqNClBRXk/8AM/Zr/hpr4F/9DZbf9+Lj/wCNUf8ADTXwL/6Gy2/78XH/AMar8ZaK8P8A4lC4T/6C8R/4FT/+VnT/AK947+SP4/5n7Nf8NNfAv/obLb/vxcf/ABqvDv2i/jf8K/Gnwl1Xw74X8QQ3+o3E1o0cCRTKzCOdHY5eNV4UE9a/NaivY4e+i5wzk+aYfNcPia7nRnGaTdOzcWpJO1NO11rZo58VxnjK9GdGUI2kmuvX5nt37OvinQPBnxb0jxF4nvFsNOt4rtZZ3VmVTJA6LwgZuWIHSv0s/wCGmvgX/wBDZbf9+Lj/AONV+MtFfT+I/gPkfGmaQzXMq9WE4wULQcErJylf3oSd7yfXsceU8S4nL6LoUYxabvrfy7Ndj9mv+GmvgX/0Nlt/34uP/jVH/DTXwL/6Gy2/78XH/wAar8ZaK+A/4lC4T/6C8R/4FT/+Vnqf6947+SP4/wCZ+xuo/tE/s/atp9zpWo+J7We0vIXgniaG5AeKVSrqcRA4IJHBrxnzP2F/7ul/986hX5sUV7eVfRnyvK4yhlua4yipatQqxgm/PlgrnNX4vrVmnWoU5W7pv82fpP5n7DH93S/++dQqQXH7DQ/g0n/v3ff4V+alFeo/ASL/AOZ7j/8Awo/+1Mf9Zn/0DUv/AAH/AIJ+oWmeJf2KdIlE9jHoIkByGlsZ58H282J69Qtf2j/gDZQLa2Xiayt4U4WOK2njRfoqwgCvxtorxMy+i9kuYtSzDMsXVa/nqRl/6VBnRR4yxFLSlRgvRNfqfs1/w018C/8AobLb/vxcf/GqP+GmvgX/ANDZbf8Afi4/+NV+MtFeX/xKFwn/ANBeI/8AAqf/AMrN/wDXvHfyR/H/ADPWPjn4h0bxX8WfEfiHw9dLeade3Eb286hlV1WGNSQGAYfMpHI7V5PRRX9N5LldLLMvoZbQbcKUIwTe7UIqKbskr2Wtkj47EVnWqyqy3k2/v1CiiivTMT//0/iOiiiuMAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD//1PiOiiiuMAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD//1fiOiiiuMAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD//1viOiiiuMAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD//2Q==",
"datetime" : "2019-12-12T09:00:11",
"details" : "SW11 8XY"
}
}],
"pricing": {
"net": "78.00",
"tax": "15.60",
"total": "93.60",
"currency_code": "USD",
"prices": [
{
"name": "Journey Mileage",
"type": "BASE",
"tax": "V20",
"amount": 30,
"rate": 2.5,
"unit": "miles",
"charge": "75.00"
},
{
"name": "Waiting Time",
"type": "WAIT",
"tax": "V20",
"amount": 20,
"rate": 0.25,
"unit": "minutes",
"charge": "5.00"
},
{
"name": "Admin",
"type": "ADMIN",
"tax": "V20",
"amount": 80,
"rate": 10,
"unit": "percent",
"charge": "8.00"
},
{
"name": "Promo Code",
"type": "ADJUST",
"tax": "V20",
"amount": -10,
"rate": 1,
"unit": "fixed",
"charge": "-10.00"
},
{
"name": "Parking",
"type": "EXTRA",
"tax": "0",
"amount": 1,
"charge": "2.50"
}
],
"taxes": [
{
"name": "V20",
"description": "VAT",
"rate": 20,
"net": "78.00",
"unit": "percent",
"charge": "15.60"
}
]
}
}
| Parameters | Description | Required |
|---|
| status | Current status | Yes |
| job.id | Quickbook API V2 booking ID | Yes |
| job.uuid | Quickbook API V3 booking ID | No |
| job.number | 6-digit booking number | Yes |
| job.vendor | Partner's booking reference | No |
| dates.event | Date and time when the event happened | Yes |
| dates.sent | Date and time when this status has been sent to the partner | Yes |
| stop_number | Stop number in which the driver or courier is on its way | Yes |
| journey.stop.type | The type of Stop. "ADDRESS", "AIRPORT". | Yes |
| journey.stop.wait | The waiting time. | Yes |
| journey.stop.address.formatted_address | The complete address formatted. | Yes |
| journey.stop.address.address_components.place_name | The place name like company name, airport name, shopping centre name, etc. | Yes |
| journey.stop.address.address_components.building | The flat number and building name, floor, for example | Yes |
| journey.stop.address.address_components.street | The street number and name | Yes |
| journey.stop.address.address_components.locality | The city or town | Yes |
| journey.stop.address.address_components.region | The region, state or county | Yes |
| journey.stop.address.address_components.postal_code | The postal code of the address | Yes |
| journey.stop.address.address_components.country | The country code (ISO 3166-2) | Yes |
| journey.stop.address.geo.lat | The location latitude | Yes |
| journey.stop.address.geo.long | The location longitude | Yes |
| signarures.signature.name [1] | Identifies the person who received the parcel | No |
| signatures.signature.image [1] | Image containing the proof of devivery in Base64 format | No |
| signatures.signature.datetime [1] | When the event occorred | No |
| signatures.signature.details [1] | Any additional information related to the proof of delivery | No |
| pricing.currency_code | The currency code. ISO 4217 Currency Code. Default GBP | No |
| pricing.net | The total net | Yes |
| pricing.tax | The total tax | Yes |
| pricing.total | The total pricing | Yes |
| pricing.prices.name | The description of the price | Yes |
| pricing.prices.type | The type of the price | Yes |
| pricing.prices.tax | The tax type applied over the price | Yes |
| pricing.prices.amount | The amount | Yes |
| pricing.prices.rate | The rate | No |
| pricing.prices.unit | The unit | No |
| pricing.prices.charge | The value charged | Yes |
| pricing.taxes.name | The name used as reference for the tax | Yes |
| pricing.taxes.description | The description of the tax | Yes |
| pricing.taxes.rate | The tax's rate | Yes |
| pricing.taxes.net | The tax's net | Yes |
| pricing.taxes.unit | The tax's unit | No |
| pricing.taxes.charge | The charge over the tax | Yes |
| [1] Only available for courier jobs
PRICED
{
"status": "PRICED",
"job": {
"id": "J685000000028967171",
"number": "914052",
"uuid": "6b17a0ec-3329-4f86-b80b-4931b4e16665",
"vendor": "A12345678"
},
"dates": {
"event": "2016-12-10T09:01:00+01:00",
"sent": "2016-12-12T09:01:20+01:00"
},
"pricing": {
"currency_code": "GBP",
"net": "78.00",
"tax": "15.60",
"total": "93.60",
"prices": [
{
"name": "Journey Mileage",
"type": "BASE",
"tax": "V20",
"amount": 30,
"rate": 2.5,
"unit": "miles",
"charge": 75.00
},
{
"name": "Waiting Time",
"type": "WAIT",
"tax": "V20",
"amount": 20,
"rate": 0.25,
"unit": "minutes",
"charge": 5.00
},
{
"name": "Admin",
"type": "ADMIN",
"tax": "V20",
"amount": 80,
"rate": 10,
"unit": "percent",
"charge": 8.00
},
{
"name": "Promo Code",
"type": "ADJUST",
"tax": "V20",
"amount": -10,
"rate": 1,
"unit": "fixed",
"charge": -10.00
},
{
"name": "Parking",
"type": "EXTRA",
"tax": "0",
"amount": 1,
"charge": 2.50
}
],
"taxes": [
{
"name": "V20",
"description": "VAT",
"rate": 20,
"unit": "percent",
"net": 78.00,
"charge": 15.60
}
]
}
}
| Parameters | Description | Required |
|---|
| status | Current status | Yes |
| job.id | Quickbook API V2 booking ID | Yes |
| job.uuid | Quickbook API V3 booking ID | No |
| job.number | 6-digit booking number | Yes |
| job.vendor | Partner's booking reference | No |
| dates.event | Date and time when the event happened | Yes |
| dates.sent | Date and time when this status has been sent to the partner | Yes |
| stop_number | Stop number in which the driver or courier is on its way | Yes |
| pricing.currency_code | ISO 4217 Currency Code. Default GBP | No |
| pricing.net | Total net | Yes |
| pricing.tax | Total tax | Yes |
| pricing.total | Total price | Yes |
| pricing.prices.name | Description of the price | Yes |
| pricing.prices.type | Type of the price | Yes |
| pricing.prices.tax | Tax type applied over the price | Yes |
| pricing.prices.amount | Amount | Yes |
| pricing.prices.rate | Rate | No |
| pricing.prices.unit | Unit | No |
| pricing.prices.charge | The value charged | Yes |
| taxes.name | Tax's name | Yes |
| taxes.description | Tax's description | Yes |
| taxes.rate | Tax's rate | Yes |
| taxes.unit | Tax's unit | No |
| taxes.net | Tax's net | Yes |
| taxes.charge | The charge over the tax | Yes |
CANCELLED
{
"status": "CANCELLED",
"job": {
"id": "J685000000028967171",
"number": "914052",
"uuid": "6b17a0ec-3329-4f86-b80b-4931b4e16665",
"vendor": "A12345678"
},
"dates": {
"event": "2016-12-10T09:01:00+01:00",
"sent": "2016-12-12T09:01:20+01:00"
},
"reasons": {
"cancel": "Job has been cancelled"
}
}
| Parameters | Description | Required |
|---|
| status | Current status | Yes |
| job.id | Quickbook API V2 booking ID | Yes |
| job.uuid | Quickbook API V3 booking ID | No |
| job.number | 6-digit booking number | Yes |
| job.vendor | Partner's booking reference | No |
| dates.event | Date and time when the event happened | Yes |
| dates.sent | Date and time when this status has been sent to the partner | Yes |
| reasons.cancel | The cancellation reason will always be Job has been cancelled | Yes |