Events

Introduction

Events happening throughout the order life cycle, can be sent to your system by API webhook in a HTTP request with a JSON-request.
There are many events to listen to, but the most common are:

  • OrderAddedToRoute

  • OrderPickupCompleted

  • OrderDeliveryCompleted

  • OrderDeliveryFailed.

Authentication

The event will be sent through webhook, to a chosen URL of yours. The URL can be different per event.
If authentication is needed, a query parameter can be added to the URL, but no unique header parameters can be set.

All events contain an envelope that is always the same, and a data object which is unique per event. Events are versioned, where data objects are different in each version. New properties can be added without creating a new version, but existing properties can not be modified or deleted to ensure backward compability.

Event payloads


Table of contents

OrderAddedToRoute

{
  "id": "bc701c4d-a1bd-4c55-8bf5-742076351760",
  "type": "OrderAddedToRoute",
  "version": "2.0",
  "liveMode": false,
  "dateTime": "2021-06-25T07:03:02.412813Z",
  "data": {
    "order": {
      "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
      "creatorOrderId": "AB20201112",
      "creatorId": "71865f82-712a-4452-8b09-d6069092e774",
      "relationalId": "123123",
      "tags": [
        "Outbound",
        "Mainland"
      ]
    },
    "route": {
      "id": "a3cd18bd-3801-4623-b0cc-0b98b1f42dba",
      "slug": "M125689-43",
      "reference": "Route A 12",
      "tags": [
        "East",
        "CC"
      ],
      "executors": [
        "f2b5ba03-0059-4655-a66f-304994961204",
        "8b1edc27-02aa-4ff3-8c5b-bdad22338037"
      ]
    },
    "deliveryLocation": {
      "address": {
        "primary": "Artillerivej 86",
        "secondary": "2300 København"
      },
      "position": {
        "longitude": 12.577972,
        "latitude": 55.662128
      },
      "timeZone": "europe/copenhagen"
    },
    "pickupLocation": {
      "address": {
        "primary": "Søtorvet 5",
        "secondary": "1371 København K"
      },
      "position": {
        "longitude": 12.564829,
        "latitude": 55.685396
      },
      "timeZone": "europe/copenhagen"
    },
    "deliveryContact": {
      "preferredName": "Jane Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12345678",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "pickupContact": {
      "preferredName": "John Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12121212",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "pickupEta": "2020-07-20T10:32:25.4607648+02:00",
    "pickupTimeFrame": {
      "from": "2020-07-20T10:00:00+02:00",
      "to": "2020-07-20T11:00:00+02:00"
    },
    "deliveryEta": "2020-07-20T13:52:55.4507668+02:00",
    "deliveryTimeFrame": {
      "from": "2020-07-20T13:00:00+02:00",
      "to": "2020-07-20T15:00:00+02:00"
    },
    "correlationId":"",
    "timeOfEvent": "2020-07-09T11:40:38+02:00"
  }
}

OrderPickupArrived

{
  "id": "fe1961b6-41b3-4993-8a7e-15cd83f79427",
  "type": "OrderPickupArrived",
  "version": "2.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    "order": {
      "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
      "creatorOrderId": "AB20201112",
      "creatorId": "71865f82-712a-4452-8b09-d6069092e774",
      "relationalId": "123123",
      "tags": [
        "Outbound",
        "Mainland"
      ]
    },
    "route": {
      "id": "a3cd18bd-3801-4623-b0cc-0b98b1f42dba",
      "slug": "M125689-43",
      "reference": "Route A 12",
      "tags": [
        "East",
        "CC"
      ],
      "executors": [
        "f2b5ba03-0059-4655-a66f-304994961204",
        "8b1edc27-02aa-4ff3-8c5b-bdad22338037"
      ]
    },
    "deliveryLocation": {
      "address": {
        "primary": "Artillerivej 86",
        "secondary": "2300 København"
      },
      "position": {
        "longitude": 12.577972,
        "latitude": 55.662128
      },
      "timeZone": "europe/copenhagen"
    },
    "pickupLocation": {
      "address": {
        "primary": "Søtorvet 5",
        "secondary": "1371 København K"
      },
      "position": {
        "longitude": 12.564829,
        "latitude": 55.685396
      },
      "timeZone": "europe/copenhagen"
    },
    "deliveryContact": {
      "preferredName": "Jane Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12345678",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "pickupContact": {
      "preferredName": "John Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12121212",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "driver": {
      "preferredName": "Jack Driver",
      "fullName": "",
      "phone": {
        "countrycallingCode": "22",
        "nationalNumber": "24245242",
        "countryCode": ""
      },
      "email": "fffs@mover.dk",
      "executor": {
        "id": "8b1edc27-02aa-4ff3-8c5b-bdad22338037",
        "name": "Transport inc"
      }
    },
    "deliveryEta": "2020-07-20T13:52:55.4507668+02:00",
    "deliveryTimeFrame": {
      "from": "2020-07-20T13:00:00+02:00",
      "to": "2020-07-20T15:00:00+02:00"
    },
    "correlationId":"",
    "timeOfEvent": "2020-07-09T11:40:38+02:00"
  }
}

OrderPickupCompleted

{
  "id": "8f9255a5-9968-4efe-8f61-b0749cc1c8f1",
  "type": "OrderPickupCompleted",
  "version": "2.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    "order": {
      "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
      "creatorOrderId": "AB20201112",
      "creatorId": "71865f82-712a-4452-8b09-d6069092e774",
      "relationalId": "123123",
      "tags": [
        "Outbound",
        "Mainland"
      ]
    },
    "route": {
      "id": "a3cd18bd-3801-4623-b0cc-0b98b1f42dba",
      "slug": "M125689-43",
      "reference": "Route A 12",
      "tags": [
        "East",
        "CC"
      ],
      "executors": [
        "f2b5ba03-0059-4655-a66f-304994961204",
        "8b1edc27-02aa-4ff3-8c5b-bdad22338037"
      ]    },
    "deliveryLocation": {
      "address": {
        "primary": "Artillerivej 86",
        "secondary": "2300 København"
      },
      "position": {
        "longitude": 12.577972,
        "latitude": 55.662128
      },
      "timeZone": "europe/copenhagen"
    },
    "pickupLocation": {
      "address": {
        "primary": "Søtorvet 5",
        "secondary": "1371 København K"
      },
      "position": {
        "longitude": 12.564829,
        "latitude": 55.685396
      },
      "timeZone": "europe/copenhagen"
    },
    "deliveryContact": {
      "preferredName": "Jane Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12345678",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "pickupContact": {
      "preferredName": "John Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12121212",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "driver": {
      "preferredName": "Jack Driver",
      "fullName": "",
      "phone": {
        "countrycallingCode": "22",
        "nationalNumber": "24245242",
        "countryCode": ""
      },
      "email": "fffs@mover.dk",
      "executor": {
        "id": "8b1edc27-02aa-4ff3-8c5b-bdad22338037",
        "name": "Transport inc"
      }
    },
    "deliveryEta": "2020-07-20T13:52:55.4507668+02:00",
    "deliveryTimeFrame": {
      "from": "2020-07-20T13:00:00+02:00",
      "to": "2020-07-20T15:00:00+02:00"
    },
    "correlationId": "",
    "timeOfEvent": "2020-07-09T11:40:38+02:00"
  }
}

OrderPickupFailed

{
  "id": "31d9596e-15cf-4c2c-81a6-b4f838b1d085",
  "type": "OrderPickupFailed",
  "version": "1.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    "order": {
      "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
      "creatorOrderId": "AB20201112",
      "creatorId": "71865f82-712a-4452-8b09-d6069092e774",
      "relationalId": "123123",
      "tags": [
        "Outbound",
        "Mainland"
      ]
    },
    "route": {
      "id": "a3cd18bd-3801-4623-b0cc-0b98b1f42dba",
      "slug": "M125689-43",
      "reference": "Route A 12",
      "tags": [
        "East",
        "CC"
      ],
      "executors": [
        "f2b5ba03-0059-4655-a66f-304994961204",
        "8b1edc27-02aa-4ff3-8c5b-bdad22338037"
      ]
    },
    "deliveryLocation": {
      "address": {
        "primary": "Artillerivej 86",
        "secondary": "2300 København"
      },
      "position": {
        "longitude": 12.577972
        "latitude": 55.662128
      },
      "timeZone": "europe/copenhagen"
    },
    "pickupLocation": {
      "address": {
        "primary": "Søtorvet 5",
        "secondary": "1371 København K"
      },
      "position": {
        "longitude": 12.564829,
        "latitude": 55.685396
      },
      "timeZone": "europe/copenhagen"
    },
    "deliveryContact": {
      "preferredName": "Jane Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12345678",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "pickupContact": {
      "preferredName": "John Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12121212",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "driver": {
      "preferredName": "Jack Driver",
      "fullName": "",
      "phone": {
        "countrycallingCode": "22",
        "nationalNumber": "24245242",
        "countryCode": ""
      },
      "email": "fffs@mover.dk",
      "executor": {
        "id": "8b1edc27-02aa-4ff3-8c5b-bdad22338037",
        "name": "Transport inc"
      }
    },
    "deviation":{
      "description":"failed",
      "imageIds":[
        "id1",
        "id2"
      ]
    },
    "deliveryEta": "2020-07-20T13:52:55.4507668+02:00",
    "deliveryTimeFrame": {
      "from": "2020-07-20T13:00:00+02:00",
      "to": "2020-07-20T15:00:00+02:00"
    },
    "correlationId":"",
    "timeOfEvent": "2020-07-09T13:40:49+02:00"
  }
}

OrderDeliveryArrived

{
  "id": "3d09966e-7fdd-4b0e-bdde-aca74a0e9d09",
  "type": "OrderDeliveryArrived",
  "version": "2.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    "order": {
      "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
      "creatorOrderId": "AB20201112",
      "creatorId": "71865f82-712a-4452-8b09-d6069092e774",
      "relationalId": "123123",
      "tags": [
        "Outbound",
        "Mainland"
      ]
    },
    "route": {
      "id": "a3cd18bd-3801-4623-b0cc-0b98b1f42dba",
      "slug": "M125689-43",
      "reference": "Route A 12",
      "tags": [
        "East",
        "CC"
      ],
      "executors": [
        "f2b5ba03-0059-4655-a66f-304994961204",
        "8b1edc27-02aa-4ff3-8c5b-bdad22338037"
      ]
    },
    "deliveryLocation": {
      "address": {
        "primary": "Artillerivej 86",
        "secondary": "2300 København"
      },
      "position": {
        "longitude": 12.577972,
        "latitude": 55.662128
      },
      "timeZone": "europe/copenhagen"
    },
    "deliveryContact": {
      "preferredName": "Jane Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12345678",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "pickupContact": {
      "preferredName": "John Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12121212",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "driver": {
      "preferredName": "Jack Driver",
      "fullName": "",
      "phone": {
        "countrycallingCode": "22",
        "nationalNumber": "24245242",
        "countryCode": ""
      },
      "email": "fffs@mover.dk",
      "executor": {
        "id": "8b1edc27-02aa-4ff3-8c5b-bdad22338037",
        "name": "Transport inc"
      }
    },
    "correlationId":"",
    "timeOfEvent": "2020-07-09T11:40:38+02:00"
  }
}

OrderDeliveryCompleted

{
  "id": "7f70e0c9-cf9d-4b42-aeef-dd57da6cc9ca",
  "type": "OrderDeliveryCompleted",
  "version": "1.0",
  "liveMode": false,
  "dateTime": "2020-07-09T11:40:49.412813Z",
  "data": {
    "order": {
      "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
      "creatorOrderId": "AB20201112",
      "creatorId": "71865f82-712a-4452-8b09-d6069092e774",
      "relationalId": "123123",
      "tags": [
        "Outbound",
        "Mainland"
      ]
    },
    "route": {
      "id": "a3cd18bd-3801-4623-b0cc-0b98b1f42dba",
      "slug": "M125689-43",
      "reference": "Route A 12",
      "tags": [
        "East",
        "CC"
      ],
      "executors": [
        "f2b5ba03-0059-4655-a66f-304994961204",
        "8b1edc27-02aa-4ff3-8c5b-bdad22338037"
      ]
    },
    "deliveryLocation": {
      "address": {
        "primary": "Artillerivej 86",
        "secondary": "2300 København"
      },
      "position": {
        "longitude": 12.577972,
        "latitude": 55.662128
      },
      "timeZone": "europe/copenhagen"
    },
    "deliveryContact": {
      "preferredName": "Jane Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12345678",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "pickupContact": {
      "preferredName": "John Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12121212",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "driver": {
      "preferredName": "Jack Driver",
      "fullName": "",
      "phone": {
        "countrycallingCode": "22",
        "nationalNumber": "24245242",
        "countryCode": ""
      },
      "email": "fffs@mover.dk",
      "executor": {
        "id": "8b1edc27-02aa-4ff3-8c5b-bdad22338037",
        "name": "Transport inc"
      }
    },
    "correlationId":"",
    "timeOfEvent": "2020-07-09T13:40:49+02:00"
  }
}

OrderDeliveryFailed

{
  "id": "89a64888-815f-4522-bf27-9faed732ae6c",
  "type": "OrderDeliveryFailed",
  "version": "1.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    "order": {
      "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
      "creatorOrderId": "AB20201112",
      "creatorId": "71865f82-712a-4452-8b09-d6069092e774",
      "relationalId": "123123",
      "tags": [
        "Outbound",
        "Mainland"
      ]
    },
    "route": {
      "id": "a3cd18bd-3801-4623-b0cc-0b98b1f42dba",
      "slug": "M125689-43",
      "reference": "Route A 12",
      "tags": [
        "East",
        "CC"
      ],
      "executors": [
        "f2b5ba03-0059-4655-a66f-304994961204",
        "8b1edc27-02aa-4ff3-8c5b-bdad22338037"
      ]
    },
    "deliveryLocation": {
      "address": {
        "primary": "Artillerivej 86",
        "secondary": "2300 København"
      },
      "position": {
        "longitude": 12.577972,
        "latitude": 55.662128
      },
      "timeZone": "europe/copenhagen"
    },
    "deliveryContact": {
      "preferredName": "Jane Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12345678",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "pickupContact": {
      "preferredName": "John Doe",
      "fullName": "",
      "phone": {
        "countrycallingCode": "45",
        "nationalNumber": "12121212",
        "countryCode": ""
      },
      "email": "some@email.dk",
      "company": null
    },
    "driver": {
      "preferredName": "Jack Driver",
      "fullName": "",
      "phone": {
        "countrycallingCode": "22",
        "nationalNumber": "24245242",
        "countryCode": ""
      },
      "email": "fffs@mover.dk",
      "executor": {
        "id": "",
        "name": ""
      }
    },
    "deviation":{
      "description":"failed",
      "imageIds":[
        "id1",
        "id2"
      ]
    },
    "correlationId":"",
    "timeOfEvent": "2020-07-09T13:40:49+02:00"
  }
}

RouteOptimizationOrderUnscheduled

{
  "id": "89a64888-815f-4522-bf27-9faed732ae6c",
  "type": "RouteOptimizationOrderUnscheduled",
  "version": "1.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    "order": {
      "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
      "creatorOrderId": "AB20201112",
      "creatorId": "71865f82-712a-4452-8b09-d6069092e774",
      "relationalId": "123123",
      "tags": [
        "Outbound",
        "Mainland"
      ]
    },
    "reasons":[
        "max-order-count-exceeded",
        "no-routes-can-handle-tag"
    ],
    "correlationId":"",
    "timeOfEvent": "2020-07-09T13:40:49+02:00"
  }
}

NotificationOrderSmsSent

The contents of the nested data object vary depending on the originating trigger e.g. OrderScheduleTrigger; as of 23 September 2025, only OrderScheduleTrigger populates it with the data structure shown in the examples, while all other triggers (e.g. OrderDeliveryETAProvided) return data null.

Version: 1.0

{
  "id": "89a64888-815f-4522-bf27-9faed732ae6c",
  "type": "NotificationOrderSmsSent",
  "version": "1.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    "order": {
      "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
      "creatorOrderId": "AB20201112",
      "creatorId": "71865f82-712a-4452-8b09-d6069092e774",
      "relationalId": "123123",
      "tags": [
        "Outbound",
        "Mainland"
      ]
    },
    "sms": {
       "from":"1234567",
       "to": "1234567",
       "content": "smsContent"
    },
    "template":{
          "id": "3cab74ae-e992-4d7b-869a-7cabf0026c38",
          "name": "string",
          "triggerEvent": "OrderScheduleTrigger"
      },
    "data": {
       "deliveryEtaWindow": {
            "from": "2025-09-23T08:10:00+02:00",
            "to": "2025-09-23T08:50:00+02:00"
       },
       "updateDeliveryPromise": false
    },
    "correlationId":"",
    "timeOfEvent": "2020-07-09T13:40:49+02:00"
  }
}

Version: 2.0

{
  "id": "89a64888-815f-4522-bf27-9faed732ae6c",
  "type": "NotificationOrderSmsSent",
  "version": "2.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    "order": {
      "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
      "creatorOrderId": "AB20201112",
      "creatorId": "71865f82-712a-4452-8b09-d6069092e774",
      "relationalId": "123123",
      "tags": [
        "Outbound",
        "Mainland"
      ]
    },
    "sms": {
       "from":"1234567",
       "to": "1234567",
       "content": "smsContent"
    },
    "template":{
          "id": "3cab74ae-e992-4d7b-869a-7cabf0026c38",
          "name": "string",
          "triggerEvent": "OrderScheduleTrigger",
          "parameters": {
              "timeAddedToEstimate": 900,
              "timeSubtractedFromEstimate": 900,
              "scheduleId": "12312421312",
              "updatePickupPromise": false,
              "updateDeliveryPromise": true
          }
    },
    "data": {
       "deliveryEtaWindow": {
            "from": "2025-09-23T08:10:00+02:00",
            "to": "2025-09-23T08:50:00+02:00"
       },
       "pickupEtaWindow": {
            "from": "2025-09-23T08:10:00+02:00",
            "to": "2025-09-23T08:50:00+02:00"
       }
    },
    "correlationId":"",
    "timeOfEvent": "2020-07-09T13:40:49+02:00"
  }
}

OrderReturnCompleted

{
  "id": "89a64888-815f-4522-bf27-9faed732ae6c",
  "type": "OrderReturnCompleted",
  "version": "1.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    "orderId": "AB20201112",
    "orderTags": [
      "Outbound",
      "Mainland"
    ],
   "routeReference": "",
   "pickupContact": {
       "preferredName":"John Doe",
       "fullName": "",
       "phone": {
         "countrycallingCode": "45",
         "nationalNumber": "12121212",
         "countryCode": "" },
       "email": "some@email.dk",
       "company": null 
    },
    "deliveryContact": {
       "preferredName": "Jane Doe",
       "fullName": "",
       "phone": {
          "countrycallingCode": "45",
          "nationalNumber": "12345678",
          "countryCode": "" 
       },
       "email": "some@email.dk",
       "company": null 
    },
    "deliveryLocation": {
       "name": "",
       "position": {
          "longitude": 12.564829,
          "latitude": 55.685396 
       } 
    },
    "timeOfEvent": "2020-07-09T13:40:49+02:00"
  }
}

OrderGeoLocationFailed

{
  "id": "89a64888-815f-4522-bf27-9faed732ae6c",
  "type": "OrderGeoLocationFailed",
  "version": "1.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    "order": {
      "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
      "creatorOrderId": "AB20201112",
      "creatorId": "71865f82-712a-4452-8b09-d6069092e74",
      "relationalId": "123123",
      "tags": [
        "Outbound",
        "Mainland" 
      ] 
    },
    "location": {
      "address": {
        "primary": "Artillerivej 86",
        "secondary": "2300 København" 
      },
      "position": {
        "longitude": 0,
        "latitude": 0 
      },
      "timeZone": "europe/copenhagen" 
    },
    "correlationId":"",
    "timeOfEvent": "2020-07-09T13:40:49+02:00"
  }
}

Route Completed


{
  "id": "bc701c4d-a1bd-4c55-8bf5-742076351760",
  "type": "RouteCompleted",
  "version": "1.0",
  "liveMode": true,
  "dateTime": "2021-06-25T07:03:02.412813Z",
  "data": {
    "route": {
      "id": "a3cd18bd-3801-4623-b0cc-0b98b1f42dba",
      "slug": "M125689-43",
      "reference": "Route A 12",
      "tags": [
        "Handling:1person",
        "Fuel:Electric",
        "VehicleType:Truck"
      ],
      "executors": [
        "f2b5ba03-0059-4655-a66f-304994961204",
        "8b1edc27-02aa-4ff3-8c5b-bdad22338037"
      ]
    },
    "orders":[
        {
            "id": "531721db-6b15-4e81-a8d5-9e0843c75dd1",
            "creatorOrderId": "AB20201112", //Work order id
            "creatorId": "71865f82-712a-4452-8b09-d6069092e774",
            "relationalId": "123123", //Sales order id
            "tags": [
              "Outbound",
              "Sender:101"
            ]
        }
    ],
    "estimate":{
        "duration": 18000.00, //Seconds
        "distance": 84.12, //Km
        "startTime": "2021-14-05T08:00:00+02:00", 
        "endTime": "2021-14-05T13:00:00+02:00"
    },
    "actual":{
        "duration": 19430.44, //Seconds
        "distance": 85.7, //Km
        "startTime": "2021-14-05T08:03:00+02:00", 
        "endTime": "2021-14-05T13:23:40+02:00"
    },
    "correlationId":"aaa5ba03-0059-4655-a66f-304994961204",
    "timeOfEvent": "2021-14-05T13:23:40+02:00"
  }
}

ColloDeliveryCompleted

{
  "id": "89a64888-815f-4522-bf27-9faed732ae6c",
  "type": "ColloDeliveryCompleted",
  "version": "1.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    {
    "colloId": "ee9f4f00-aa93-4103-aa41-8e39000856ae",
    "barcode": "12312738",
    "colloTags": null,
    "internalOrderId": "08218e83-ced6-e2e4-1510-1a1b25274195",
    "ownerId": "a1003a94-d520-4d0c-959a-afb76bdc91f3",
    "ownerOrderId": "ABC1234",
    "timeOfEvent": "2021-12-21T08:01:20+01:00",
    "orderTags": [
        "VIP"
    ],
    "routeReference": "Route 001",
    "routeId": "520aac19-f073-4094-a0a8-b7cf96c015e3",
    "routeSlug": "M10000-01",
    "routeTags": [
        "TagA",
        "TagB"
    ],
    "fulfillerId": "c941dc37-4628-4c40-a9c9-35e69060e8cc",
    "driver": {
        "firstName": "Peter",
        "phone": {
            "countryPrefix": "45",
            "number": "11223344"
        },
        "email": "email@email.com",
        "company": "Company Name"
    },
    "deliveryLocation": {
        "address": {
            "primary": "Adelgade 12",
            "secondary": "1261 København"
        },
        "position": {
            "latitude": 55.6219769,
            "longitude": 12.4325993
        },
        "timeZone": "Europe/Copenhagen"
    },
    "pickupContact": {
        "firstName": null,
        "phone": {
            "countryPrefix": "45",
            "number": "66998877"
        },
        "email": null,
        "company": null
    },
    "deliveryContact": {
        "firstName": "Johan",
        "phone": {
            "countryPrefix": "45",
            "number": "22556688"
        },
        "email": "someemail@email.com",
        "company": null
    }
}

ColloPickupCompleted

{
  "id": "89a64888-815f-4522-bf27-9faed732ae6c",
  "type": "ColloPickupCompleted",
  "version": "1.0",
  "liveMode": false,
  "dateTime": "2021-05-25T07:03:02.412813Z",
  "data": {
    "colloId": "2f86465f-43cf-494f-a0bd-d0b7f9858a1a",
    "barcode": "1234567890123",
    "colloTags": null,
    "internalOrderId": "5e879c0b-4f9e-82a1-a5ef-579ff8503e07",
    "ownerId": "f1003e94-d520-4d0c-959a-afb76bdc91f3",
    "ownerOrderId": "ABC123",
    "timeOfEvent": "2021-12-21T08:06:53+01:00",
    "orderTags": [
        "TagA",
        "TagB"
    ],
    "route": {
        "id": "83e8e076-59b8-4915-8e70-be36c592a117",
        "reference": "Route 001",
        "slug": "M1000-01",
        "tags": [
            "RouteTagA"
        ],
        "executors": [
            "976ce014-3b59-4c5c-a332-11ed7ca58ef7",
            "93e0f583-b603-4e56-b2fb-c3458e12f791"
        ]
    },
    "driver": {
        "firstName": "Frederik",
        "phone": {
            "countryPrefix": "45",
            "number": "111111111111"
        },
        "email": "frederik@email.com",
        "company": ""
    },
    "pickupLocation": {
        "address": {
            "primary": "Adelgade 12",
            "secondary": "1371 København"
        },
        "position": {
            "latitude": 56.9960636,
            "longitude": 9.8653746
        },
        "timeZone": "Europe/Copenhagen"
    },
    "deliveryLocation": {
        "address": {
            "primary": "Søtorvet 5",
            "secondary": "1371 København K"
        },
        "position": {
            "latitude": 56.48172393,
            "longitude": 9.89449963
        },
        "timeZone": "Europe/Copenhagen"
    },
    "deliveryTimeFrame": {
        "from": "2021-12-21T09:00:00+01:00",
        "to": "2021-12-21T11:00:00+01:00"
    },
    "deliveryEta": "2021-12-21T09:00:00+01:00",
    "pickupContact": {
        "firstName": null,
        "phone": null,
        "email": null,
        "company": null
    },
    "deliveryContact": {
        "firstName": "Niels",
        "phone": {
            "countryPrefix": "45",
            "number": "11223344"
        },
        "email": "email@email.com",
        "company": null
    }
}
    

ColloLoadedOnLinehaul

{
    "id": "00004888-815f-4522-bf27-9faed7320000",
    "type": "ColloLoadedOnLinehaul",
    "version": "1.0",
    "liveMode": false,
    "dateTime": "2021-05-25T07:03:02.412813Z",
    "data": {
        "LinehaulId": "00001234-7f26-4de3-96de-affa14ba86a4",
        "OwnerId": "1234000-d520-4d0c-959a-afb76bdc91f3",
        "Collo": {
            "Barcode": "127817281",
            "OrderId": "ABC123",
            "OrderOwnerId": "1234000-d520-4d0c-959a-afb76bdc91f3",
            "Status": 1,
            "Location": {
                "Address": {
                    "Primary": "Adelgade 12",
                    "Secondary": "1371 Copenhagen"
                },
                "Position": {
                    "Latitude": 55.123123,
                    "Longitude": 12.44444
                },
                "TimeZone": "Europe/Copenhagen"
            },
            "OrderTags": [
                "TagA",
                "TabB"
            ],
            "ActionBy": "00003e94-d520-4d0c-959a-afb76bdc91f3",
            "Deviation": null
        },
        "TimeOfEvent": "2022-01-03T16:35:22.6891497+00:00"
    }
}

ColloDeliveryFailed

{
    "id": "00004888-815f-4522-bf27-9faed7320000",
    "type": "ColloDeliveryFailed",
    "version": "1.0",
    "liveMode": false,
    "dateTime": "2021-05-25T07:03:02.412813Z",
    "data": {
        "colloId": "00005078-d548-4628-a011-bf2467b9c9b4",
        "barcode": "12345678",
        "colloTags": null,
        "internalOrderId": "ef9a0a47-71c1-45dc-0684-5446c3379b5a",
        "ownerId": "00001234-d520-4d0c-959a-afb76bdc91f3",
        "ownerOrderId": "ABC123",
        "timeOfEvent": "2022-01-03T14:41:39+01:00",
        "orderTags": [
            "TagA"
        ],
        "route": {
            "id": "00005275-5a17-4453-802c-5ac2ee9b4190",
            "reference": "Route 001",
            "slug": "M1234-01",
            "tags": [
                "RouteTagA",
                "RouteTagB"
            ],
            "executors": [
                "00000014-3b59-4c5c-a332-11ed7ca58ef7",
                "00000c37-4628-4c40-a9c9-35e69060e8cc"
            ]
        },
        "driver": {
            "firstName": "Peter",
            "phone": {
                "countryPrefix": "45",
                "number": "12345678"
            },
            "email": "email@gmail.com",
            "company": ""
        },
        "deliveryLocation": {
            "address": {
                "primary": "Adelgade 12",
                "secondary": "1371 Copenhagen"
            },
            "position": {
                "latitude": 55.6628418,
                "longitude": 12.6269148
            },
            "timeZone": "Europe/Copenhagen"
        },
        "deliveryContact": {
            "firstName": "Rene Larsen",
            "phone": {
                "countryPrefix": "45",
                "number": "12345678"
            },
            "email": "rene@email.com",
            "company": "Company A/S"
        },
        "reasonId": "99",
        "reason": "Other"
    }
}

ColloDeliveryArrived

{
    "id": "00004888-815f-4522-bf27-9faed7320000",
    "type": "ColloDeliveryArrived",
    "version": "1.0",
    "liveMode": false,
    "dateTime": "2021-05-25T07:03:02.412813Z",
    "data": {
        "colloId": "c48ba9d8-af29-430a-888f-159cc27c35e8",
        "barcode": "1234567",
        "colloTags": null,
        "internalOrderId": "00001537-8621-c3e6-4991-4084d7032058",
        "ownerId": "00003e94-d520-4d0c-959a-afb76bdc91f3",
        "ownerOrderId": "ABC12345",
        "timeOfEvent": "2022-01-03T17:52:01+01:00",
        "orderTags": [
            "TagA"
        ],
        "route": {
            "id": "00000000-c4e7-4f7b-9fb4-c799c97b5fb2",
            "reference": "Route A",
            "slug": "M1234-02",
            "tags": [
                "RouteTag"
            ],
            "executors": [
                "00001234-3b59-4c5c-a332-11ed7ca58ef7",
                "00001234-4628-4c40-a9c9-35e69060e8cc"
            ]
        },
        "driver": {
            "firstName": "Peter",
            "phone": {
                "countryPrefix": "45",
                "number": "12345678"
            },
            "email": "email@email.com",
            "company": "TSP A/B"
        },
        "deliveryTimeFrame": {
            "from": "2022-01-03T18:00:00+01:00",
            "to": "2022-01-03T19:00:00+01:00"
        },
        "deliveryLocation": {
            "address": {
                "primary": "Adelgade 12, 1371 Copenhagen",
                "secondary": null
            },
            "position": {
                "latitude": 54.7599963,
                "longitude": 11.884732
            },
            "timeZone": "Europe/Copenhagen"
        },
        "pickupContact": null,
        "deliveryContact": {
            "firstName": "Rene",
            "phone": {
                "countryPrefix": "45",
                "number": "11223344"
            },
            "email": null,
            "company": null
        }
    }
}

CollectionPointColloCollected

{
    "id": "00004888-815f-4522-bf27-9faed7320000",
    "type": "CollectionPointColloCollected",
    "version": "1.0",
    "liveMode": false,
    "dateTime": "2021-05-25T07:03:02.412813Z",
    "data": {
        "collectionPointId": "00001234-a672-49d1-a46d-04fb34205502",
        "collo": {
            "id": "00001234-1f59-4f6b-8488-a3775b15ed61",
            "barcode": "123456789",
            "tags": [
                "TagA"
            ]
        },
        "order": {
            "id": "00001234-8803-d11c-f1ef-3cfb0f3783b0",
            "creatorOrderId": "ABC1234",
            "creatorId": "00001234-d520-4d0c-959a-afb76bdc91f3",
            "tags": [
                "TagA"
            ],
            "relationalId": "111111111"
        },
        "location": {
            "address": {
                "primary": "Adelgade 12, 1371 Copenhagen"
            },
            "position": {
                "latitude": 55.254545,
                "longitude": 11.778882
            },
            "timeZone": "Europe/Copenhagen"
        },
        "signature": {
            "imageId": "abc1623721638721362173678",
            "name": "Rene Larsen",
            "date": "2022-01-03T17:59:45+01:00"
        },
        "actionById": "00000000-0000-0000-0000-000000765914",
        "colloValidationMethod": "scanned",
        "timeOfEvent": "2022-01-03T18:00:03.9707682+01:00",
        "correlationId": "a379ea14-52eb-4120-9f10-dbe15f7ce2d7"
    }
}

CollectionPointColloNotCollected

{
    "id": "00004888-815f-4522-bf27-9faed7320000",
    "type": "CollectionPointColloNotCollected",
    "version": "1.0",
    "liveMode": false,
    "dateTime": "2021-05-25T07:03:02.412813Z",
    "data": {
        "collo": {
            "id": "00001245-66a0-449d-bbbe-59748adb5699",
            "barcode": "12345678",
            "tags": []
        },
        "collectionPointId": "00001245-62df-4b3f-8a51-f3957f6d1261",
        "order": {
            "id": "00001458-3cb9-5009-3c3e-a53735b4ab90",
            "creatorOrderId": "ABC1234",
            "creatorId": "00001234-d520-4d0c-959a-afb76bdc91f3",
            "tags": [
                "TagA"
            ],
            "relationalId": "1122445588"
        },
        "location": {
            "address": {
                "primary": "Adelgade 13, Copenhagen"
            },
            "position": {
                "latitude": 56.1202,
                "longitude": 8.9432
            },
            "timeZone": "Europe/Copenhagen"
        },
        "deviation": {
            "imageIds": [],
            "description": "Ikke afhentet"
        },
        "actionById": "00000000-0000-0000-0000-000000438068",
        "timeOfEvent": "2022-01-03T18:00:56.7097567+B01:00",
        "correlationId": "00004455-6046-4cad-90b4-337a7631070e"
    }
}

CollectionPointColloRejected

{
    "id": "00004888-815f-4522-bf27-9faed7320000",
    "type": "CollectionPointColloRejected",
    "version": "1.0",
    "liveMode": false,
    "dateTime": "2021-05-25T07:03:02.412813Z",
    "data": {
        "collo": {
            "id": "00001234-572c-4c2e-a099-2ffa15b8e5cb",
            "barcode": "12345678",
            "tags": []
        },
        "collectionPointId": "00001245-23fc-4792-9108-daa69bbcb692",
        "order": {
            "id": "00001245-48f6-e93c-9dd5-f78ebbb224f7",
            "creatorOrderId": "ABC1234",
            "creatorId": "00001234-d520-4d0c-959a-afb76bdc91f3",
            "tags": [
                "TagA"
            ],
            "relationalId": "11223344"
        },
        "location": {
            "address": {
                "primary": "Adelgade 12, Copenhagen"
            },
            "position": {
                "latitude": 56.2024225,
                "longitude": 9.5984233
            },
            "timeZone": "Europe/Copenhagen"
        },
        "deviation": {
            "imageIds": [],
            "description": "Customer did not want it"
        },
        "actionById": "00000000-0000-0000-0000-000000433354",
        "timeOfEvent": "2021-12-29T17:42:33.4173432+01:00",
        "correlationId": "00001234-702b-4250-b76d-02a3dc23b7b6"
    }
}

RouteOptimizationJobApproved

{
    "id": "00004888-815f-4522-bf27-9faed7320000",
    "type": "RouteOptimizationJobApproved",
    "version": "1.0",
    "liveMode": false,
    "dateTime": "2024-12-01T08:00:00.000000Z",
    "data": {
        "id": "50485790-dd28-478c-8f23-f21affb169ef",
        "ownerId": "9d78b2e0-71d0-43f6-9e73-4a5a4864916e",
        "name": "Route optimization job name",
        "settingsId": "838b77be-aaef-49f1-b718-bf83a383f5de",
        "schedulerId": "0317a81d-3231-4eb0-8c11-261fe526e372",
        "availableVehicleGroups": [
            {
                "id": "98f9feaa-79c0-4a55-acd2-01fa0eaf29a1",
                "name": "Van",
                "vehicleType": "Van",
                "tags": [],
                "limits": {
                    "volume": 10,
                    "weight": 1125,
                    "colli": 155,
                    "stops": 40,
                    "duration": 39600,
                    "distance": 550000
                }
            }
        ],
        "availableGates": [
            {
                "gateName": "Gate 1",
                "timeSlots": [
                    {
                        "from": "2024-12-02T06:00:00+02:00",
                        "to": "2024-12-02T07:00:00+02:00"
                    },
                    {
                        "from": "2024-12-02T07:00:00+02:00",
                        "to": "2024-12-02T08:00:00+02:00"
                    }
                ]
            }
        ],
        "meta": {
            "routesCount": 2,
            "shipmentsCount": 40,
            "servicesCount": 0,
            "duration": 35100,
            "distance": 516.9477596837038,
            "drivingDuration": 18000,
            "waitingTime": 4500,
            "taskTime": 8100,
            "breakTime": 4500,
            "weight": 1242.6709999999996,
            "volume": 4.021651919999999,
            "unscheduledTasks": 0
        },
        "routes": [
            {
                "route": {
                    "id": "c76da4a9-66b8-4d9a-b312-35098d2c35d9",
                    "slug": "M100000-01",
                    "reference": "Reference 1",
                    "tags": ["Flex:10", "Morning", "PostGateAllocationV2:1"],
                    "executors": []
                },
                "vehicleGroupId": "Van",
                "vehicleTypeId": "2321cbd7-5bed-4035-a827-2bfea31bb8e8",
                "gate": "Gate 1",
                "stopsCount": 10,
                "startTime": "2024-12-02T06:00:00+02:00",
                "firstStopTaskTime": 1200,
                "duration": 14400,
                "distance": 231.4738798418519,
                "drivingDuration": 7200,
                "waitingTime": 1800,
                "taskTime": 3600,
                "breakTime": 1800,
                "weight": 666.0669999999999,
                "volume": 2.7914995679999994
            },
            {
                "route": {
                    "id": "c9c85359-1c89-4061-be13-2692e987b923",
                    "slug": "M100000-02",
                    "reference": "Reference 2",
                    "tags": ["Flex:10", "Morning", "PostGateAllocationV2:1"],
                    "executors": []
                },
                "vehicleGroupId": "Van",
                "vehicleTypeId": "2321cbd7-5bed-4035-a827-2bfea31bb8e8",
                "gate": "Gate 1",
                "stopsCount": 6,
                "startTime": "2024-12-02T07:00:00.000000+02:00",
                "firstStopTaskTime": 1200,
                "duration": 20700,
                "distance": 285.4738798418519,
                "drivingDuration": 10800,
                "waitingTime": 2700,
                "taskTime": 4500,
                "breakTime": 2700,
                "weight": 576.6039999999997,
                "volume": 1.2301523520000002
            }
        ],
        "correlationId": "5d1a00b1-13cb-4970-b647-4cd865bf8436",
        "timeOfEvent": "2024-12-01T08:00:00.0000000+00:00"
    }
}

Notes

Meta

  • RoutesCount: total number of routes in the route plan.

  • ShipmentCount: total number of shipments in the route plan.

  • ServicesCount: total number of services in the route plan.

  • Duration: total duration for all routes combined, in seconds.

  • Distance: total distance covered by all routes, in kilometers.

  • DrivingDuration: total driving duration for all routes, in seconds.

  • WaitingTime: total waiting time for stops on all routes, in seconds.

  • TaskTime: total time spent on tasks at all stops, excluding breaks, in seconds.

  • BreakTime: total break time for all routes, in seconds.

  • Weight: total weight for all orders on all routes, in kilograms.

  • Volume: total volume for all orders on all routes in m3.

Routes

  • VehicleGroupId: name of the vehicle group

  • FirstStopTaskTime: loading time at the first stop, in seconds

  • Duration: duration for the route, in seconds.

  • Distance: distance covered by the route, in kilometers.

  • DrivingDuration: driving duration for the route, in seconds.

  • WaitingTime: total waiting time for stops on a route, in seconds.

  • TaskTime: time spent on tasks at all stops, excluding breaks, in seconds.

  • BreakTime: total break time for a route, in seconds.

  • Weight: total weight for all orders on a route, in kilograms.

  • Volume: total volume for all orders on a route in m3.