Courier Update Event

Introduction

Where delivery platforms provide courier statuses or a 3rd party 'Dispatch' service is enabled, the details of the delivery progress will be sent whenever they change

Delivery job statuses

Status name	Meaning	Integer value
EN_ROUTE_TO_PICKUP	Courier approaching the pickup location	`83`
ARRIVED_AT_PICKUP	Courier has arrived at the pickup location	`85`
EN_ROUTE_TO_DROPOFF	Courier approaching the drop-off location	`87`
ARRIVED_AT_DROPOFF	Courier has arrived at the drop-off location	`89`
DELIVERED	Courier has delivered the order	`90`

Parameters

Parameter	Meaning	Type
`received`	Timestamp of when the update was generated	str
`orderId`	Unique Deliverect order ID	str
`rawDriverUpdate`	An empty array not currently in use	array of str
`updatedOrigin`	—	int
courier	—	array of str
courier.`firstName`	—	str
courier.`lastName`	—	str
courier.`phoneNumber`	—	str
courier.`deliveryBy`	The delivery party responsible	str
courier.`status`	See Delivery job statuses	int
`pickupTime`	The correct `pickupTime` for the order when the status was generated	str
`deliveryTime`	The anticipated order delivery time	str
`location`	The unique ID of the Deliverect location	str

Sample Data

Data differs between orders delivered by DSP (Delivery Service Providers) and those delivered via integrated 3rd party dispatch platforms;

{
  "received": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
  "orderId": "62********************e4",
  "pickupTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
  "deliveryTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
  "location": "61********************r2",
  "courier": {
    "firstName": "",
    "lastName": "",
    "phoneNumber": "",
    "deliveryBy": "Uber Eats",
    "status": 83,
    "lastKnownLocation": {
      "coordinates": [
        -84.1187,
        34.4212
      ]
    },
    "vehicle": {
      "type": "CAR",
      "make": "Volkswagen",
      "model": "Passat",
      "color": "Silver",
      "licensePlate": "H808AGE",
      "isAutonomous": false
    }
  },
  "handoffInstructions": "",
  "passcode": "",
  "updatedOrigin": 2,
  "rawDriverUpdate": "{}"
}

{
    "received": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
    "orderId": "62********************e4",
    "pickupTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
    "courier": {
        "firstName": "",
        "lastName": "",
        "phoneNumber": "",
        "status": 83
    },
    "updatedOrigin": 6,
    "rawDriverUpdate": "{}",
    "deliveryTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
    "location": "65********************a4",
    "deliverySystem": 10,
    "deliveryJobId": "62********************e4"
}