Order Arrived · HyperTrack Docs

Order Arrived Webhook Payload

[
  {
   "created_at":"2021-01-01T14:01:00.000000Z",
   "recorded_at":"2021-01-01T14:00:00.000000Z",
   "device_id":"00112233-4455-6677-8899-AABBCCDDEEFF",
   "worker_handle": "Worker-1",
   "account_id":"6784e919-7168-4f61-b686-2020f547637f",
   "type":"order",
   "data":{
      "value":"arrived",
      "order_handle":"DGC127092",
      "route_handle":"4359cc65-90dd-4b2b-875b-26e6d2eba11d",
      "place_handle": "Store-North-Square",
      "arrival": {
        "location": {
           "coordinates": [-6.2785, 57.6388983, 0],
           "type": "Point"
          },
        "recorded_at": "2021-01-01T14:05:10.000000Z"
        },
      "status":"ongoing",
      "share_url":"https://trck.at/vr1RNLq",
			"scheduled_at":"2021-01-01T14:23:00.000000Z",
      "initial_eta":"2021-01-01T14:20:00.000000Z",
      "metadata":{
         "storeId":"123490809808",
         "customerName":"Andrew"
        }
     },
   "version":"3.0.0"
  }
]

Name	Type	Mandatory	Description
data.value	string	Yes	`arrived`
data.order_handle	string	Yes	Unique handle for the Order
data.route_handle	string	Yes	Unique identifier of the route containing the order
data.place_handle	string	No	Unique Identifier of the place for which exit is recorded. It will be present if order is associated with a place created via Places API
data.status	string	Yes	Status of the order - `ongoing`
data.share_url	string	Yes	Contains tracking url of the order to provide real time visibility of worker on route of this order
data.metadata	object	No	Metadata that you have assigned to this order
data.scheduled_at	timestamp	No	Timestamp indicating the provided scheduled time for order fulfilment
data.initial_eta	timestamp	No	Timestamp indicating the initial expected arrival time
data.arrival	object	Yes	Contains location and recorded_at timestamp of the arrival