Overview

This document contains all of the return events that are related to Maven's linehaul and dock application for LTL.

Refer to the overview page for general information on return events.

Manifest Return Events

Manifest Details Updated

Event Type

ManifestDetailsUpdated

Details

The manifest details updated return event fires anytime the header information of a manifest is updated. The return event will include the time the event was generated, along with all fields that were modified; including the previous and updated values. For a list of all possible fields that can be updated, please refer to the table in the UpdateManifestDetails command found here.

The header information of a manifest does not include updates to status or associated shipments.

For each field that is updated, an object containing the previous and updated values is provided. The previous and updated value can be null implying the field was added or removed respectively.

Sample Payload

{
  id: "ac5548f2-2b7c-4721-bf64-69074ffd181b",
  timestamp: "2025-07-25T11:58:44.987Z",
  uploadedTimestamp: "2025-07-25T11:58:44.987Z",
  createdTimestamp: "2025-07-25T11:58:44.921Z",
  eventType: "manifestDetailsUpdated",
  data: {
    changedFields: {
      trailerNumber: {
        previous: "729029",
        updated: "7909726"
      }
    },
    currentManifest: {
      actualStartUnloadingTime: "2025-07-25T00:15:56.000Z",
      destinationLocationCode: "PGH",
      poison: false,
      scheduledCloseTime: "2025-07-25T00:15:56.000Z",
      trailerNumber: "HT48792",
      originDoorNumber: "63",
      actualFinishUnloadingTime: null,
      manifestNumber: "R0320985",
      manifestType: "LINEHAUL",
      currentLocationCode: null,
      food: false,
      tags: [
        "Placarded Load"
      ],
      destinationDoorNumber: null,
      scheduledStartLoadingTime: null,
      actualStartLoadingTime: null,
      scheduledFinishUnloadingTime: null,
      hazmat: false,
      originLocationCode: "PGH",
      scheduledStartUnloadingTime: null,
      manifestCreatedOn: "2025-07-24T16:28:20.580Z",
      attributes: {},
      currentLocationDoorNumber: null,
      actualCloseTime: null,
      status: "PLANNING"
    }
  },
  eventSource: {
    userId: "513247",
    displayName: "Camp, Joshua",
    system: "Dock App"
  },
  referenceIds: {
    manifestNumber: "R0320985"
  }
}

Started Unloading Manifest

Event Type

StartedUnloadingManifest

Details

The started unloading manifest event is fired anytime a manifest is transitioned into an unloading status. The event includes the time the event was generated, the dock location of the manifest where unloading is taking place, as well as the set of shipments that are currently loaded onto the manifest.

Sample Payload

{
  id: "cdc29eac5-2946-4ff4-bce3-a96be4985e8f",
  timestamp: "2024-12-10T13:47:00",
  eventType: "StartedUnloadingManifest",
  data: {
    eventTime: "2024-12-10T13:46:01", 
    locationCode: "PGH",
    doorNumber: "15",
    loadedShipments: [{
      proNumber: "91203901",
      BOLNumber: "XX1",
      PONumber: "YY2",
      PUNumber: "ZZ3"
    }, {
      proNumber: "91203902",
      BOLNumber: "XX1",
      PONumber: "YY2",
      PUNumber: "ZZ3"
    }, {
      proNumber: "91203903",
      BOLNumber: "XX1",
      PONumber: "YY2",
      PUNumber: "ZZ3"
    }, {
      proNumber: "91203904",
      BOLNumber: "XX1",
      PONumber: "YY2",
      PUNumber: "ZZ3"
    }]
  },
  referenceIds: {
    manifestId: "2024-12-06-D828078"
  }
}

Finished Unloading Manifest

Event Type

FinishedUnloadingManifest

Details

The finished unloading manifest event is fired anytime a manifest is marked as completed unloading. The event includes the time the event was generated, the dock location of the manifest where unloading is taking place, as well as any shipments that remained on the manifest after unloading was complete. If no shipments remained on the manifest, the loadedShipments array will be empty.

Sample Payload

{
  id: "77b3013d-0fc2-408f-ac3c-d76fcb81db1b",
  timestamp: "2024-12-10T13:47:00",
  eventType: "FinishedUnloadingManifest",
  data: {
    eventTime: "2024-12-10T13:46:01", 
    locationCode: "PGH",
    doorNumber: "15",
    loadedShipments: [{
      proNumber: "91203901",
      BOLNumber: "XX1",
      PONumber: "YY2",
      PUNumber: "ZZ3"
    }]
  },
  referenceIds: {
    manifestId: "2024-12-06-D828078"
  }
}

Movement Return Events

Movement Assigned

Event Type

MovementAssigned

Details

The movement assigned event is fired whenever a user assigns a movement to a driver or team of drivers in the Maven product. This will contain the reference ids to the movement and the driver code or codes the movement is assigned to. If a dispatcher reassigns a movement to a driver, a new MovementAssigned event will be generated to reflect the most updated assignment of the movement.

Sample Payload

{
  id: "77b3013d-0fc2-408f-ac3c-d76fcb81db1b",
  timestamp: "2024-12-10T13:47:00",
  eventType: "MovementAssigned",
  data: {
    eventTime: "2024-12-10T13:46:01", 
    driverCodes: ["EK234","GO9829"]
  },
  referenceIds: {
    movementId: "2024-12-06-D828078"
  }
}

Movement Unassigned

Event Type

MovementUnassigned

Details

The movement unassigned event is fired whenever a user unassigns a movement from a driver or team of drivers in the Maven product. This will contain the reference ids to the movement.

Sample Payload

{
  id: "77b3013d-0fc2-408f-ac3c-d76fcb81db1b",
  timestamp: "2024-12-10T13:47:00",
  eventType: "MovementDetailsUpdated",
  data: {
    eventTime: "2024-12-10T13:46:01", 
  },
  referenceIds: {
    movementId: "2024-12-06-D828078"
  }
}

Movement Details Updated

Event Type

MovementDetailsUpdated

Details

The movement details updated will be triggered when a user updates the details of a movement. For example, a user could update the origin, destination, scheduled departure time, scheduled arrival time, or vehicle on a movement, or make multiple changes that would be contained in this event.

Sample Payload

{
  id: "77b3013d-0fc2-408f-ac3c-d76fcb81db1b",
  timestamp: "2024-12-10T13:47:00",
  eventType: "MovementDetailsUpdated",
  data: {
    eventTime: "2024-12-10T13:46:01",
    changedFields: {
       vehicleNumber: {
       previous: "34232",
       updated: "T243343"
                    }
  },
  referenceIds: {
    movementId: "2024-12-06-D828078"
  }
}