Update Delivery

This webhook allows to persist updates from third party delivery systems to Deliverect.

Currently updates to following delivery information are supported. (See examples for technical details).

  • delivery status
  • pickup time & ETA
  • delivery time & ETA
  • courier information

Delivery Job Statuses:

Status NameMeaningInteger Value
EN_ROUTE_TO_PICKUPCourier approaching the pickup location83
ARRIVED_AT_PICKUPCourier has arrived at the pick up location85
EN_ROUTE_TO_DROPOFFCourier approaching the drop off location87
ARRIVED_AT_DROPOFFCourier has arrived at the drop off location89
DELIVEREDCourier has delivered the order90

NOTE

Please note, that here and later all dates and times, coming from/to Deliverect are UTC.

Example Payloads:

{
    "deliveryJobId": "602***66a",
    "externalJobId": "DJ1234567890",
    "locations": [
        {
            "orderId": "602***98b",
            "channelOrderDisplayId": "1234567890",
            "status":80,
            "deliveryTimeETA": "2021-05-13T14:13:00Z"
        }
    ]
}'
{
    "deliveryJobId": "602***66a",
    "externalJobId": "DJ1234567890",
    "pickupTimeETA": "2020-01-01T12:00:00.000+02:00"
}'
{
    "deliveryJobId": "602***66a",
    "pickupTimeETA": "2021-05-13T13:59:00Z",
    "transportType": "bicycle",
    "courier": {
        "name": "Mac Miller",
        "phone": "+3292331234",
        "longitude": "51.05433703603857",
        "latitude": "3.738214852809371"
    },
    "locations": [
        {
            "orderId": "602987dd539d9697c836198b",
            "status": 80,
            "deliveryTimeETA": "2021-05-13T14:13:00Z"
        }
    ]
}
Language
Authentication
OAuth2
Click Try It! to start a request and see the response here!