POST /fulfillment/generic/events
Bearer auth

Update Delivery

This endpoint allows persisting updates from third-party delivery systems to Deliverect.

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

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

Delivery Job Statuses

Status Name Meaning Integer Value
EN_ROUTE_TO_PICKUP Courier approaching the pickup location 83
ARRIVED_AT_PICKUP The courier has arrived at the pickup location 85
EN_ROUTE_TO_DROPOFF Courier approaching the drop-off location 87
ARRIVED_AT_DROPOFF The courier has arrived at the drop-off location 89
DELIVERED Courier has delivered the order 90


All timestamps are in UTC format as per ISO8601

application/json

Body

object object

Responses

POST /fulfillment/generic/events 
curl \
 --request POST 'https://api.staging.deliverect.com/fulfillment/generic/events' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"deliveryJobId":"61********************b4","pickupTimeETA":"YYYY-MM-DDTHH:mm:ss.SSSSSSZ","transportType":"bicycle","trackingUrl":"https://example.com","courier":{"name":"Mac Miller","phone":"+3292331234","longitude":"51.05433703603857","latitude":"3.738214852809371"},"locations":[{"orderId":"61********************b4","status":83,"deliveryTimeETA":"YYYY-MM-DDTHH:mm:ss.SSSSSSZZ"}]}'
Request example 
{
  "deliveryJobId": "61********************b4",
  "pickupTimeETA": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
  "transportType": "bicycle",
  "trackingUrl": "https://example.com",
  "courier": {
    "name": "Mac Miller",
    "phone": "+3292331234",
    "longitude": "51.05433703603857",
    "latitude": "3.738214852809371"
  },
  "locations": [
    {
      "orderId": "61********************b4",
      "status": 83,
      "deliveryTimeETA": "YYYY-MM-DDTHH:mm:ss.SSSSSSZZ"
    }
  ]
}
Response examples (200) 
OK
Response examples (200) 
OK