Skip to main content
↓ Download as Markdown

Courier statuses

Courier statuses provide guests and integrations with information about delivery progress.

Endpoint​

POST delivery/{orderId}/courier-status

En-route to pickup location​

{
  "courierStatus": "EnRouteToPickup",
  "courier": {
    "name": "Alex Johnson"
  },
  "courierPosition": {
    "latitude": "59.3310",
    "longitude": "18.0650",
    "format": "dd"
  },
  "estimatedPickupTime": "2026-04-17T11:10:00+00:00",
  "estimatedDropOffTime": "2026-04-17T11:45:00+00:00",
  "message": null
}

Arrived at pickup location​

{
  "courierStatus": "ArrivedAtPickup",
  "courier": {
    "name": "Alex Johnson"
  },
  "courierPosition": {
    "latitude": "59.3340",
    "longitude": "18.0620",
    "format": "dd"
  },
  "estimatedPickupTime": "2026-04-17T11:10:00+00:00",
  "estimatedDropOffTime": "2026-04-17T11:40:00+00:00",
  "message": null
}

En-route to drop-off location​

{
  "courierStatus": "EnRouteToDropOff",
  "courier": {
    "name": "Alex Johnson"
  },
  "courierPosition": {
    "latitude": "59.3320",
    "longitude": "18.0700",
    "format": "dd"
  },
  "estimatedPickupTime": null,
  "estimatedDropOffTime": "2026-04-17T11:35:00+00:00",
  "message": null
}

Delivered​

{
  "courierStatus": "Delivered",
  "courier": {
    "name": "Alex Johnson"
  },
  "courierPosition": {
    "latitude": "59.3293",
    "longitude": "18.0686",
    "format": "dd"
  },
  "estimatedPickupTime": null,
  "estimatedDropOffTime": null,
  "message": "Delivered to front door"
}

Cancelled​

{
  "courierStatus": "Cancelled",
  "courier": {
    "name": "Alex Johnson"
  },
  "courierPosition": {
    "latitude": "59.3315",
    "longitude": "18.0660",
    "format": "dd"
  },
  "estimatedPickupTime": null,
  "estimatedDropOffTime": null,
  "message": "Customer requested cancellation"
}