Guides
Start typing to search…

P&D Return Events

P&D Return Events List

In total, there are 32 different event types that can be subscribed to covering updates made in the integration layer, the Dispatch web portal, and in the Maven driver application. The full list of return events is listed below.

  • manifestCreated
  • manifestPlanned
  • manifestClosed
  • manifestDispatched
  • manifestRouteUpdated
  • manifestUpdated
  • routeStart
  • departTerminal
  • geofenceTerminalDeparture
  • routeETAUpdate
  • routeStopListUpdated
  • routeReturn
  • geofenceTerminalArrival
  • arriveTerminal
  • routeComplete
  • stopArrival
  • stopBegin
  • stopComplete
  • stopDeparture
  • geofenceStopDeparture
  • stopRouteUpdated
  • parentStopMerged
  • shipmentCreated
  • shipmentUpdated
  • shipmentUpdatedInMaven
  • shipmentAssignment
  • shipmentComplete
  • shipmentRecomplete
  • shipmentUnassignment
  • stopAssignment
  • stopUnassignment
  • customerCreated
  • customerUpdated

Fleets have the option to subscribe to whichever return events they deem necessary for receiving updates from Maven.

Standard Data Objects

The format for the data section of various eventType values for return events is standardized based on the underlying data object that is being reported on. For instance, return events that report on manifest data will all share the same basic manifest attributes. In this manner, return events that share a similar base level data type can be parsed in identical fashion, for ease of integration. The various standard data object classifications, and the data they contain, are described below.

Customer Level Data

Attribute Name

Type

Description

customerTerminal

string

Identifier for terminal associated with this customer.

customerName

string

Display name of customer.

customerName2

string

Secondary/alternate name of customer.

createdOn

string
ISO8601 format, UTC

Timestamp of record creation.

lastUpdated

string
ISO8601 format, UTC

Timestamp of record update.

customerPhoneDay

string

Day phone for customer.

customerPhoneNight

string

Night phone for customer.

addressStreet

string

Street address for customer

addressStreet2

string

Secondary address information for customer.

addressCity

string

City for customer.

addressState

string2-char
ISO abbreviation

State for customer.

addressZip

string

Zip/postal code for customer.

addressCountry

string
2-char or 3-char ISO abbreviation

Country for customer.

isGeocoded

boolean

Whether the address record could be geocoded into lat/lng coordinates.

geocodedAddress

string

Full geocoded address.

geocodeLat

float

Geocoded latitude.

geocodeLng

float

Geocoded latitude.

timezone

string

Timezone observed at customer location.

Timezone will be set by the geocoded location if not specified in the integrations API request.

Manifest Level Data

Attribute Name

Type

Description

manifestNumber

string

Manifest number for this manifest.

A manifest number is unique identifier for the manifest and can be set with a request to the integrations POST /manifestNumber endpoint.

manifestName

string

Display name for this manifest.

associatedRouteCode

string

Identifier for route code associated with manifest.
In the Maven system, manifests can be grouped geographically into ‘routes’. This functionality must be set up separately during the integration process.

prevRouteCode

string

If this manifest has changed route designations, previous route code that this manifest belonged to.

terminalCode

string

Identifier for terminal associated with manifest.

date

string
YYYY-MM-DD format

Date that manifest will be dispatched.

routeActualStartTime

string
HH:mm:ss format
timezone of terminal

Actual start time for driver operating this manifest.

routeReturnTime

string
HH:mm:ss format
timezone of terminal

Timestamp that driver indicates the intention to begin to return to the terminal for the the manifest.

routeEstimatedEndTime

string
HH:mm:ss format
timezone of terminal

Estimated completion time for driver operating this manifest.

routeActualEndTime

string
HH:mm:ss format
timezone of terminal

Actual completion time for driver operating this manifest.

geofenceDepartureTime

string
HH:mm:ss format
timezone of terminal

Timestamp that driver breaks the geofence when initially departing the terminal.

geofenceDepartureLat

float

Recorded latitude of geofence exit for terminal.

geofenceDepartureLng

float

Recorded longitude of geofence exit for terminal.

geofenceArrivalTime

string
HH:mm:ss format
timezone of terminal

Timestamp that driver breaks the geofence when arriving back at the terminal.

geofenceArrivalLat

float

Recorded latitude of geofence entrance for terminal.

geofenceArrivalLng

float

Recorded longitude of geofence entrance for terminal.

driverDepartureTime

string
HH:mm:ss format
timezone of terminal

Timestamp that driver indicates the departure from the terminal.

driverDepartureLat

float

Recorded latitude of driver indicating departure from the terminal.

driverDepartureLat

float

Recorded longitude of driver indiciating departure from the terminal.

didAutoDepartTerminal

boolean

Whether the vehicle was departed from the terminal via automatic trigger

didAutoArriveTerminal

boolean

Whether the vehicle was arrived at the terminal via automatic trigger

driverArrivalTime

string
HH:mm:ss format
timezone of terminal

Timestamp that driver indicates the arrival to the terminal.

driverArrivalLat

float

Recorded latitude of driver indicating arrival to the terminal.

driverArrivalLng

float

Recorded longitude of driver indicating arrival to the terminal.

routeStartOdometer

string
2 decimal places

Odometer value recorded when driver begins this manifest.

routeEndOdometer

string
2 decimal places

Odometer value recorded when driver ends this manifest.

userId

string

Identifier for driver operating this manifest.

userName

string

Display name for driver operating this manifest.

vehicleNumber

string

Vehicle number associated with this manifest.

pullingTrailer

boolean

Whether this vehicle is pulling a trailer.

trailerNumber

string

Trailer number associated with this manifest.

dockLocation

string

Manifest location on the dock.

shipmentsPickedUpCount

int

Current count of shipments picked up on this manifest.

shipmentsNotPickedUpCount

int

Current count of failed pickups on this manifest.

shipmentsDeliveredCount

int

Current count of shipments delivered on this manifest.

shipmentsNotDeliveredCount

int

Current count of failed deliveries on this manifest.

note

string

Driver-entered notes associated with this manifest.

mavenRouteInstanceId

int

Maven’s internal identifier for this manifest.

Sent back as NULL if there is a manifestNumber (external identifier) set on the manifest.

associatedStops

array

List of stops associated with this manifest. If there are no stops on the route, an empty array is returned. For the manifestDelete return event, no associatedStops are provided.

Please reference “Stop Level Data” for documentation.

Stop Level Data

Attribute Name

Type

Description

sequenceNumber

int

Sequence number of stop on associated manifest.

associatedManifestNumber

string

Manifest that stop is assigned to.

associatedRouteCode

string

Identifier for route code associated with stop.
In the Maven system, stops can be grouped geographically into ‘routes’.
This functionality must be set up separately during the integration process.

prevRouteCode

string

If this stop has changed route designations, previous route code that this stop belonged to.

terminalCode

string

Identifier for terminal associated with stop.

date

string
YYYY-MM-DD format

Service date scheduled for this stop.

customerName

string

Name of customer being serviced at this stop.

customerName2

string

Secondary/alternate name of customer being serviced at this stop.

customerAddress

string

Full address for customer.

customerAddress1

string

Street address for customer.

customerAddress2

string

Secondary address information for customer.

customerCity

string

City for customer.

customerState

string
2-char ISO abbreviation

State for customer.

customerZip

string

Zip/postal code for customer.

customerCountry

string
2-char or 3-char ISO abbreviation

Country for customer.

customerLat

float

Latitude coordinates for customer.

customerLng

float

Longitude coordinates for customer.

stopNote

string

Driver or dispatcher entered note for stop completion.

geofenceStartTime

string
HH:mm:ss format
timezone of terminal

Timestamp of geofence entry for stop.

geofenceStartLat

float

Recorded latitude of geofence entry for stop.

geofenceStartLng

float

Recorded longitude of geofence entry for stop.

driverStartTime

string
HH:mm:ss format
timezone of terminal

Timestamp of stop arrival.

driverStartLat

float

Recorded latitude of stop arrival.

driverStartLng

float

Recorded longitude of stop arrival.

driverBeginExchange

string
HH:mm:ss format
timezone of terminal

Timestamp of begin exchange of goods for stop.

driverBeginExchangeLat

float

Recorded latitude of begin exchange of goods for stop.

driverBeginExchangeLng

float

Recorded longitude of begin exchange of goods for stop.

driverEndTime

string
HH:mm:ss format
timezone of terminal

Timestamp of stop completion.

driverEndLat

float

Recorded latitude of stop completion.

driverEndLng

float

Recorded longitude of stop completion.

driverDepartureTime

string
HH:mm:ss format
timezone of terminal

Timestamp of stop departure.

driverDepartureLat

float

Recorded latitude of stop departure.

driverDepartureLng

float

Recorded latitude of stop departure.

geofenceEndTime

string
HH:mm:ss format
timezone of terminal

Timestamp of geofence exit for stop.

geofenceEndLat

float

Recorded latitude of geofence exit for stop.

geofenceEndLng

float

Recorded longitude of geofence exit for stop.

estimatedArrivalTime

string
HH:mm:ss format
timezone of terminal

Timestamp of estimated arrival time for the driver at this stop.

estimatedDepartureTime

string
HH:mm:ss format
timezone of terminal

Timestamp of estimated departure time for the driver at this stop.

userId

string

Identifier for driver assigned to this stop.

userName

string

Display name for driver assigned to this stop.

vehicleNumber

string

Vehicle number associated with this stop.

trailerNumber

string

Trailer number associated with this stop.

trailerSwapOccurred

boolean

Indicates whether a trailer swap occurred at this stop location.

trailerSwapName

string

If a trailer swap occurred, driver-entered name of swap partner.

originalTrailerNumber

string

If a trailer swap occurred, trailer number that was dropped off.

stopReferenceNumber

string

Identifier for stop.(Reserved for future use.)

stopRunningStatus

“pending”
”running”
”complete”
”canceled”

Description of the stop’s current completion status.

stopType

“lunch”
”checkstop”
”pdStop”

Description of the type of stop being serviced.

stopSignerName

string

Signature entered for acknowledgement of stop completion, if required.

stopCode

int

Completion code assigned to the stop.

This functionality must be set up separately during the integration process.

performedByUserCode

string

Identifier for driver or dispatcher who performed the action which triggered this stop event.

performedByUserName

string

Display name for driver or dispatcher who performed the action which triggered this stop event.

lunchTaken

boolean

If stop is of type “lunch”, indication whether a lunch break was taken.

lunchNotTakenReason

string

If stop is of type “lunch”, enumerated description for why a lunch break was not taken.

lunchNotes

string

If stop is of type “lunch”, driver-entered notes for lunch break.

associatedShipments

array

list of shipments associated with this stop.

Please reference “Shipment Level Data” for documentation.

Shipment Level Data

Attribute Name

Type

Description

shipmentType

“pickup”
“delivery”

Description of the shipment type.

addOnPickup

boolean

For shipments of type “pickup”, indication of whether this pickup was generated by the driver during the course of completing a stop.

date

string
YYYY-MM-DD format

Service date scheduled for pickup or delivery.

completionCode

string

Shipment’s completion status, as set by the driver or dispatcher.

Completion codes can be configured during the integration process.

completionNotes

string

Driver or dispatcher entered note for shipment completion.

shipmentProNumber

string

Pro Number for shipment.

In the Maven system, a Pro Number is used as an external identifier for a delivery.

shipmentRefNumber

string

Reference Number for shipment.

In the Maven system, a Reference Number is used as an external identifier for a pickup.

pickupSequenceNumber

number

The pickup sequence number of the shipment. If not provided by the integration, this value will be null.

shipperCustomerName

string

Name of customer which has been designated as the shipper for this shipment.

shipperCustomerName2

string

Secondary/alternate name of shipper.

shipperCustomerNumber

string

Identifier for customer which has been designated as the shipper for this shipment.

consigneeCustomerName

string

Name of customer which has been designated as the consignee for this shipment.

consigneeCustomerName2

string

Secondary/alternate name of consignee.

consigneeCustomerNumber

string

Identifier for customer which has been designated as the consignee for this shipment.

addedAccessorials

array of strings

Accessorials which have been marked for this shipment.

Accessorial types can be configured during the integration process.

shipmentRestrictions

array of strings

Restrictions which have been marked for this shipment.

Restriction types can be configured during the integration process.

shipmentTags

array of strings

Tags which are related to this shipment.

Tag types can be configured during the integration process.

shipmentTotalWeight

float

Total weight of the shipment.

shipmentTotalPieces

int

Total pieces of the shipment.

shipmentTotalPalletCount

float

Total pallet equivalents of the shipment.

shipmentTotalPalletSpaces

float

Total volume of the shipment, in pallets.

shipmentTotalHandlingUnits

float

Total handling units of the shipment.

refusedPieces

int

Total pieces which were refused for pickup or delivery.

refusedPalletCount

float

Total pallet equivalents which were refused for pickup or delivery.

signerName

string

Signature entered for acknowledgement of pickup or delivery, if required.

destinationZipCode

string

Zip code indicated for delivery destination.

destinationSIC

string

Terminal code indicated for delivery destination.

associatedStop

object

For event types that are classified as “shipment-level”.

Information about stop that is associated with this shipment.

Please reference “Stop Level Data” for documentation.

shipmentSequenceNumber

number

Deprecated. Duplicate of pickupSequenceNumber.

documents

array

List of documents associated with this shipment (bill of lading, shipment photo, signature, etc). If there are no documents, an empty array is returned.

Please reference Retrieving Documents from Return Events for documentation.

Return Event Types

manifestCreated

Description

The manifestCreated event is produced when a manifest is created within the Maven system.

Triggers

  1. In the Inbound Planning board, shipments are selected and added to plan. This will generate one or more manifests in the Maven system, and each will produce a manifestCreated event.
  2. In the Maven Dispatch board for inbound planning, a new blank manifest is created.
  3. A new manifest is sent in through the integrations POST /manifests endpoint, and is successfully created.

Documentation

  • The manifestCreated event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the manifestCreated event is to communicate the state of the manifest in the Maven system at the time it was created.

Example

{
   "timestamp":"2022-01-01 12:00:00",
   "eventType":"manifestCreated",
   "data":{
      "manifestNumber":null,
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":null,
      "routeReturnTime":null,
      "routeEstimatedEndTime":null,
      "routeActualEndTime":null,
      "geofenceDepartTime":null,
      "geofenceArriveTime":null,
      "routeStartOdometer":null,
      "routeEndOdometer":null,
      "userId":null,
      "userName":null,
      "vehicleNumber":null,
      "pullingTrailer":false,
      "trailerNumber":null,
      "dockLocation":null,
      "shipmentsPickedUpCount":0,
      "shipmentsNotPickedUpCount":0,
      "shipmentsDeliveredCount":0,
      "shipmentsNotDeliveredCount":0,
      "note":null,
      "mavenRouteInstanceId":1234567,
      "associatedStops":[]
   }
}

manifestPlanned

Description

A manifestPlanned event is produced when a planned inbound manifest is submitted to dock in the Maven system.

Triggers

  1. In the Maven Dispatch board for inbound planning, the menu option for “Submit to Dock” is chosen and one or more manifests are selected to submit to dock. This will produce a manifestPlanned event for each manifest selected.

Documentation

  • The manifestPlanned event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the manifestPlanned event is to communicate the state of the manifest in the Maven system at the time it was planned.

Example

{
   "timestamp":"2022-01-01 12:00:00",
   "eventType":"manifestPlanned",
   "data":{
      "manifestNumber":null,
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":null,
      "routeReturnTime":null,
      "routeEstimatedEndTime":null,
      "routeActualEndTime":null,
      "geofenceDepartTime":null,
      "geofenceArriveTime":null,
      "routeStartOdometer":null,
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":0,
      "shipmentsNotPickedUpCount":0,
      "shipmentsDeliveredCount":0,
      "shipmentsNotDeliveredCount":0,
      "note":null,
      "mavenRouteInstanceId":1234567,
      "associatedStops":[]
   }
}

manifestClosed

Description

The manifestClosed event is produced when a manifest is marked as closed by an inbound planner.

Triggers

  1. In the Maven Dispatch board for inbound planning, the menu option for “Close Routes” is chosen and one or more manifests are selected to be closed. This will produce a manifestClosed event for each manifest selected.

Documentation

  • The manifestClosed event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the manifestClosed event is to communicate the state of the manifest at the time it was marked as closed by the inbound planner.

Example

{
   "timestamp":"2022-01-01 12:00:00",
   "eventType":"manifestClosed",
   "data":{
      "manifestNumber":null,
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":null,
      "routeReturnTime":null,
      "routeEstimatedEndTime":null,
      "routeActualEndTime":null,
      "geofenceDepartTime":null,
      "geofenceArriveTime":null,
      "routeStartOdometer":null,
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":0,
      "shipmentsNotPickedUpCount":0,
      "shipmentsDeliveredCount":0,
      "shipmentsNotDeliveredCount":0,
      "note":null,
      "mavenRouteInstanceId":1234567,
      "associatedStops":[]
   }
}

manifestDispatched

Description

The manifestDispatched event is produced when a planned inbound manifest is marked for dispatch in the Maven system.

Triggers

  1. In the Maven Dispatch board for inbound planning, the menu option for “Submit to Dispatch” is chosen and one or more manifests are selected to be dispatched. This will produce a manifestDispatched event for each manifest selected.

Documentation

  • The manifestDispatched event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the manifestDispatched event is to communicate the state of the manifest in the Maven system at the time it was dispatched.

Example

{
   "timestamp":"2022-01-01 12:00:00",
   "eventType":"manifestDispatched",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":null,
      "routeReturnTime":null,
      "routeEstimatedEndTime":null,
      "routeActualEndTime":null,
      "geofenceDepartTime":null,
      "geofenceArriveTime":null,
      "routeStartOdometer":null,
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":0,
      "shipmentsNotPickedUpCount":0,
      "shipmentsDeliveredCount":0,
      "shipmentsNotDeliveredCount":0,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

manifestRouteUpdated

Description

The manifestRouteUpdated event is produced when the geographical route for a manifest is updated in the Maven system.

Triggers

  1. In the Maven dispatch portal, the dispatcher moves a manifest from one geographical route to another.

Documentation

  • The manifestRouteUpdated event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the manifestRouteUpdated event is to communicate the associatedRouteCode and prevRouteCode for the manifest.

Example

{
   "timestamp":"2022-01-01 12:00:00",
   "eventType":"manifestRouteUpdated",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"SOUTH1",
      "prevRouteCode":"NORTH1",
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":null,
      "routeReturnTime":null,
      "routeEstimatedEndTime":null,
      "routeActualEndTime":null,
      "geofenceDepartTime":null,
      "geofenceArriveTime":null,
      "routeStartOdometer":null,
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":0,
      "shipmentsNotPickedUpCount":0,
      "shipmentsDeliveredCount":0,
      "shipmentsNotDeliveredCount":0,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

manifestUpdated

Description

A manifestUpdated event is produced when the integrations system successfully processes an update for a manifest.

Triggers

  1. An existing manifest is sent in through the integrations POST /manifests endpoint, and is successfully updated.

Documentation

  • The manifestUpdated event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the manifestUpdated event is to communicate the state of the manifest in the Maven system at the time it was updated.

Example

{
   "timestamp":"2022-01-01 12:00:00",
   "eventType":"manifestUpdated",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":null,
      "routeReturnTime":null,
      "routeEstimatedEndTime":null,
      "routeActualEndTime":null,
      "geofenceDepartTime":null,
      "geofenceArriveTime":null,
      "routeStartOdometer":null,
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":0,
      "shipmentsNotPickedUpCount":0,
      "shipmentsDeliveredCount":0,
      "shipmentsNotDeliveredCount":0,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

routeStart

Description

The routeStart event is produced when a driver begins the route for a manifest in the Maven system.

Triggers

  1. In the Maven driver application, the driver fills out the required information when a manifest is selected, and clicks the button for “Begin Route”.

Documentation

  • The routeStart event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the routeStart event is to communicate information captured by the driver when starting a route for a manifest, including routeActualStartTime and routeStartOdometer.

Example

{
   "timestamp":"2022-01-01 12:00:00",
   "eventType":"routeStart",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":"07:00:00",
      "routeEstimatedEndTime":null,
      "routeReturnTime":null,
      "routeActualEndTime":null,
      "geofenceDepartTime":null,
      "geofenceArriveTime":null,
      "routeStartOdometer":"12345.00",
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":0,
      "shipmentsNotPickedUpCount":0,
      "shipmentsDeliveredCount":0,
      "shipmentsNotDeliveredCount":0,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

departTerminal

Description

The departTerminal event is produced when a driver indicates departing the terminal for an active manifest.

Triggers

  1. In the Maven driver application, the driver presses the button for “Depart Terminal” after starting the route for a manifest.
  2. In the Maven driver application, custom configuration can be made to automatically trigger terminal departures based upon vehicle speed and/or breaking a geofence.

Documentation

  • The departTerminal event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the departTerminal event is to communicate the driverDepartureTime for a given manifest.

Example

{
   "timestamp":"2022-01-01 12:10:00",
   "eventType":"departTerminal",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":"07:00:00",
      "routeReturnTime":null,
      "routeEstimatedEndTime":null,
      "routeActualEndTime":null,
      "didAutoDepartTerminal": false,
      "driverDepartureTime": "07:10:00",
      "driverDepartureLat": 40.463657,
      "driverDepatureLng": -79.953842,
      "geofenceDepartureTime": null,
      "geofenceDepartureLat": null,
      "geofenceDepartureLng":null,
      "didAutoArriveTerminal": null,
      "geofenceArrivalTime": null,
      "geofenceArrivalLat": null,
      "geofenceArrivalLng":null,
      "driverArrivalTime": null,
      "driverArrivalLat": null,
      "driverArrivalLng": null,
      "routeStartOdometer":"12345.00",
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":0,
      "shipmentsNotPickedUpCount":0,
      "shipmentsDeliveredCount":0,
      "shipmentsNotDeliveredCount":0,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

geofenceTerminalDeparture

Description

The geofenceTerminalDeparture event is produced when a driver exits the terminal's geofence

Triggers

  1. In the Maven driver application, this is automatically triggered based upon breaking the terminal geofence.

Documentation

  • The geofenceTerminalDeparture event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the geofenceTerminalDeparture event is to communicate the geofenceDepartureTime for a given manifest.

Example

{
   "timestamp":"2022-01-01 12:10:00",
   "eventType":"geofenceTerminalDeparture",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":"07:00:00",
      "routeReturnTime":null,
      "routeEstimatedEndTime":"13:30:00",
      "routeActualEndTime":null,
      "didAutoDepartTerminal": false,
      "driverDepartureTime": "07:10:00",
      "driverDepartureLat": 40.463657,
      "driverDepatureLng": -79.953842,
      "geofenceDepartureTime": "07:15:00",
      "geofenceDepartureLat": 40.463657,
      "geofenceDepartureLng": -78.134345,
      "didAutoArriveTerminal": null,
      "geofenceArrivalTime": null,
      "geofenceArrivalLat": null,
      "geofenceArrivalLng":null,
      "driverArrivalTime": null,
      "driverArrivalLat": null,
      "driverArrivalLng": null,
      "routeStartOdometer":"12345.00",
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":0,
      "shipmentsNotPickedUpCount":0,
      "shipmentsDeliveredCount":0,
      "shipmentsNotDeliveredCount":0,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

routeETAUpdate

Description

The routeETAUpdate event is produced when a driver’s route receives updated ETAs from the Maven system.

Triggers

  1. ETAs for routes that are in progress are frequently updated throughout the day as the Maven system processes information about the state of the driver’s progress.
  2. ETAs are also recalculated periodically after any period of inactivity on a driver’s route totaling 15 minutes.

Documentation

  • The routeETAUpdate event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the routeETAUpdate event is to communicate the updated estimatedArrivalTime and estimatedDepartureTime for each stop on the manifest, as well as the updated routeEstimatedEndTime for the manifest.
  • Routes that are not yet begun by the driver do not generate routeETAUpdates.

Example

{
   "timestamp":"2022-01-01 12:10:00",
   "eventType":"routeETAUpdate",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":"07:00:00",
      "routeReturnTime":null,
      "routeEstimatedEndTime":"13:30:00",
      "routeActualEndTime":null,
      "didAutoDepartTerminal": false,
      "driverDepartureTime": "07:10:00",
      "driverDepartureLat": 40.463657,
      "driverDepatureLng": -79.953842,
      "geofenceDepartureTime": "07:15:00",
      "geofenceDepartureLat": 40.463657,
      "geofenceDepartureLng": -78.134345,
      "didAutoArriveTerminal": null,
      "geofenceArrivalTime": null,
      "geofenceArrivalLat": null,
      "geofenceArrivalLng":null,
      "driverArrivalTime": null,
      "driverArrivalLat": null,
      "driverArrivalLng": null,
      "routeStartOdometer":"12345.00",
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":0,
      "shipmentsNotPickedUpCount":0,
      "shipmentsDeliveredCount":0,
      "shipmentsNotDeliveredCount":0,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

routeStopListUpdated

Description

The routeStopListUpdated event is produced when a route's list of stops is changed. This can occur because a stop is assigned, a stop is unassigned, or the order of stops is changed.

Triggers

  1. A stop is assigned to the route by a user using Maven Dispatch.
  2. A stop is unassigned from the route by a user using Maven Dispatch.
  3. The route is reordered using Maven Dispatch.
  4. The route is reorder by the driver using Maven Driver App.

Documentation

  • The routeStopListUpdated event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • A routeStopListUpdatedeven is produced for all routes, regardless of their lifecycle status.

Example

{
   "timestamp":"2022-01-01 12:10:00",
   "eventType":"routeStopListUpdated",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":"07:00:00",
      "routeReturnTime":null,
      "routeEstimatedEndTime":"13:30:00",
      "routeActualEndTime":null,
      "didAutoDepartTerminal": false,
      "driverDepartureTime": "07:10:00",
      "driverDepartureLat": 40.463657,
      "driverDepatureLng": -79.953842,
      "geofenceDepartureTime": "07:15:00",
      "geofenceDepartureLat": 40.463657,
      "geofenceDepartureLng": -78.134345,
      "didAutoArriveTerminal": null,
      "geofenceArrivalTime": null,
      "geofenceArrivalLat": null,
      "geofenceArrivalLng":null,
      "driverArrivalTime": null,
      "driverArrivalLat": null,
      "driverArrivalLng": null,
      "routeStartOdometer":"12345.00",
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":0,
      "shipmentsNotPickedUpCount":0,
      "shipmentsDeliveredCount":0,
      "shipmentsNotDeliveredCount":0,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

routeReturn

Description

The routeReturn event is produced when the driver indicates that all stops on the manifest have been completed, and the driver is ready to begin returning to the terminal.

Triggers

  1. In the Maven driver application, the driver completes all stops on the manifest, then clicks the button for “Return to Terminal” to begin the journey back to the terminal for the manifest.

Documentation

  • The routeReturn event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the routeReturn event is to communicate the routeReturnTime for a given manifest.

Example

{
   "timestamp":"2022-01-01 17:20:00",
   "eventType":"routeReturn",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":"07:00:00",
      "routeReturnTime":"12:20:00",
      "routeEstimatedEndTime":"13:30:00",
      "routeActualEndTime":null,
      "didAutoDepartTerminal": false,
      "driverDepartureTime": "07:10:00",
      "driverDepartureLat": 40.463657,
      "driverDepatureLng": -79.953842,
      "geofenceDepartureTime": "07:15:00",
      "geofenceDepartureLat": 40.463657,
      "geofenceDepartureLng": -78.134345,
      "didAutoArriveTerminal": null,
      "geofenceArrivalTime": null,
      "geofenceArrivalLat": null,
      "geofenceArrivalLng":null,
      "driverArrivalTime": null,
      "driverArrivalLat": null,
      "driverArrivalLng": null,
      "routeStartOdometer":"12345.00",
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":10,
      "shipmentsNotPickedUpCount":1,
      "shipmentsDeliveredCount":8,
      "shipmentsNotDeliveredCount":1,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

geofenceTerminalArrival

Description

The geofenceTerminalArrival event is produced when a driver enters the terminal's geofence

Triggers

  1. In the Maven driver application, this is automatically triggered based upon breaking the terminal geofence.

Documentation

  • The geofenceTerminalArrival event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the geofenceTerminalArrival event is to communicate the geofenceArrivalTime for a given manifest.
{
   "timestamp":"2022-01-01 17:20:00",
   "eventType":"routeReturn",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":"07:00:00",
      "routeReturnTime":"12:20:00",
      "routeEstimatedEndTime":"13:30:00",
      "routeActualEndTime":null,
      "didAutoDepartTerminal": false,
      "driverDepartureTime": "07:10:00",
      "driverDepartureLat": 40.463657,
      "driverDepatureLng": -79.953842,
      "geofenceDepartureTime": "07:15:00",
      "geofenceDepartureLat": 40.463657,
      "geofenceDepartureLng": -78.134345,
      "didAutoArriveTerminal": false,
      "geofenceArrivalTime": "13:20:00",
      "geofenceArrivalLat": 40.463657,
      "geofenceArrivalLng": -78.134345,
      "driverArrivalTime": null,
      "driverArrivalLat": null,
      "driverArrivalLng": null,
      "routeStartOdometer":"12345.00",
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":10,
      "shipmentsNotPickedUpCount":1,
      "shipmentsDeliveredCount":8,
      "shipmentsNotDeliveredCount":1,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

arriveTerminal

Description

The arriveTerminal event is produced when a driver returns to the terminal for an active manifest.

Triggers

  1. In the Maven driver application, the driver presses the button for “Arrive Terminal” after completing all stops on the route for a manifest.
  2. In the Maven driver application, custom configuration can be made to automatically trigger terminal arrivals based on vehicle speed and/or breaking a geofence.

Documentation

  • The arriveTerminal event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the arriveTerminal event is to communicate the driverArrivalTime for a given manifest.

Example

{
   "timestamp":"2022-01-01 18:20:00",
   "eventType":"arriveTerminal",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":"07:00:00",
      "routeReturnTime":null,
      "routeEstimatedEndTime":"13:30:00",
      "routeActualEndTime":null,
      "didAutoDepartTerminal": false,
      "driverDepartureTime": "07:10:00",
      "driverDepartureLat": 40.463657,
      "driverDepatureLng": -79.953842,
      "geofenceDepartureTime": "07:15:00",
      "geofenceDepartureLat": 40.463657,
      "geofenceDepartureLng": -78.134345,
      "didAutoArriveTerminal": false,
      "geofenceArrivalTime": "13:20:00",
      "geofenceArrivalLat": 40.463657,
      "geofenceArrivalLng": -78.134345,
      "driverArrivalTime": "13:30:00",
      "driverArrivalLat": 40.463657,
      "driverArrivalLng": -79.953842,
      "routeStartOdometer":"12345.00",
      "routeEndOdometer":null,
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":10,
      "shipmentsNotPickedUpCount":1,
      "shipmentsDeliveredCount":8,
      "shipmentsNotDeliveredCount":1,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

routeComplete

Description

The routeComplete event is produced when a driver ends the route for a manifest in the Maven system.

Triggers

  1. In the Maven driver application, the driver fills out the required information for a completed manifest, and clicks the button for “Finish Route”.

Documentation

  • The routeComplete event is a manifest-level return event. See the documentation for “Manifest Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the routeComplete event is to communicate information captured by the driver when ending a route for a manifest, such as routeActualEndTime and routeEndOdometer.

Example

{
   "timestamp":"2022-01-01 18:30:00",
   "eventType":"routeComplete",
   "data":{
      "manifestNumber":"M100001",
      "manifestName":"MAVEN1",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "routeActualStartTime":"07:00:00",
      "routeReturnTime":"12:20:00",
      "routeEstimatedEndTime":"13:30:00",
      "routeActualEndTime":"13:30:00",
      "didAutoDepartTerminal": false,
      "driverDepartureTime": "07:10:00",
      "driverDepartureLat": 40.463657,
      "driverDepatureLng": -79.953842,
      "geofenceDepartureTime": "07:15:00",
      "geofenceDepartureLat": 40.463657,
      "geofenceDepartureLng": -78.134345,
      "didAutoArriveTerminal": false,
      "geofenceArrivalTime": "13:20:00",
      "geofenceArrivalLat": 40.463657,
      "geofenceArrivalLng": -78.134345,
      "driverArrivalTime": "13:30:00",
      "driverArrivalLat": 40.463657,
      "driverArrivalLng": -79.953842,
      "routeStartOdometer":"12345.00",
      "routeEndOdometer":"12456.00",
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "pullingTrailer":true,
      "trailerNumber":"T12345",
      "dockLocation":"1",
      "shipmentsPickedUpCount":10,
      "shipmentsNotPickedUpCount":1,
      "shipmentsDeliveredCount":8,
      "shipmentsNotDeliveredCount":1,
      "note":null,
      "mavenRouteInstanceId":null,
      "associatedStops":[]
   }
}

stopArrival

Description

The stopArrival event is produced when a driver arrives at a stop in the Maven system.

Triggers

  1. In the Maven driver application, the driver presses the button for “Mark as Arrived” when viewing the next stop on the route for a manifest.
  2. In the Maven driver application, custom configuration can be made to automatically trigger stop arrivals based on vehicle speed and/or breaking a geofence.

Documentation

  • The stopArrival event is a stop-level return event. See the documentation for “Stop Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the stopArrival event is to communicate the driverStartTime, driverStartLat, and driverStartLng for a given stop.

Example

{
   "timestamp":"2022-01-01 13:30:00",
   "eventType":"stopArrival",
   "data":{
      "sequenceNumber":1,
      "associatedManifestNumber":"M100001",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "customerName":"Maven Machines",
      "customerName2":null,
      "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
      "customerAddress1":"4117 Liberty Ave",
      "customerAddress2":null,
      "customerCity":"Pittsburgh",
      "customerState":"PA",
      "customerZip":"15224",
      "customerCountry":"US",
      "customerLat":40.463657,
      "customerLng":-79.953842,
      "stopNote":null,
      "geofenceStartTime":null,
      "geofenceStartLat":null,
      "geofenceStartLng":null,
      "driverStartTime":"08:30:00",
      "driverStartLat":40.463657,
      "driverStartLng":-79.953842,
      "driverBeginExchange":null,
      "driverBeginExchangeLat":null,
      "driverBeginExchangeLng":null,
      "driverEndTime":null,
      "driverEndLat":null,
      "driverEndLng":null,
      "driverDepartureTime":null,
      "driverDepartureLat":null,
      "driverDepartureLng":null,
      "geofenceEndTime":null,
      "geofenceEndLat":null,
      "geofenceEndLng":null,
      "estimatedArrivalTime":"13:31:00",
      "estimatedDepartureTime":"13:46:00",
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "trailerNumber":"T12345",
      "trailerSwapOccurred":false,
      "trailerSwapName":null,
      "originalTrailerNumber":"",
      "stopReferenceNumber":null,
      "stopRunningStatus":"running",
      "stopType":"pdStop",
      "stopSignerName":null,
      "stopCode":null,
      "associatedShipments":[
         {
            "shipmentType":"delivery",
            "date":"2022-01-01",
            "completionCode":"0",
            "completionNotes":null,
            "shipmentProNumber":"D100000001",
            "shipmentRefNumber":null,
            "shipperCustomerName":null,
            "shipperCustomerName2":null,
            "shipperCustomerNumber":null,
            "consigneeCustomerName":"MavenMachines",
            "consigneeCustomerName2":null,
            "consigneeCustomerNumber":"C1000001",
            "addedAccessorials":[],
            "shipmentRestrictions":[],
            "shipmentTags":["HAZ"],
            "shipmentTotalWeight":100,
            "shipmentTotalPieces":10,
            "shipmentTotalPalletCount":1,
            "shipmentTotalPalletSpaces":1,
            "shipmentTotalHandlingUnits":10,
            "refusedPieces":0,
            "refusedPalletCount":0,
            "signerName":null,
            "destinationZipCode":"15224",
            "destinationSIC":"PGH"
         }
      ]
   }
}

stopBegin

Description

The stopBegin event is produced when a driver begins the exchange of goods at a stop in the Maven system.

Triggers

  1. In the Maven driver application, the driver presses the button for “Begin Loading/Unloading” after arriving at the next stop on the route for a manifest.

Documentation

  • The stopBegin event is a stop-level return event. See the documentation for “Stop Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the stopBegin event is to communicate the driverBeginExchange, driverBeginExchangeLat, and driverBeginExchangeLng for a given stop.

Example

{
   "timestamp":"2022-01-01 13:32:00",
   "eventType":"stopBegin",
   "data":{
      "sequenceNumber":1,
      "associatedManifestNumber":"M100001",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "customerName":"Maven Machines",
      "customerName2":null,
      "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
      "customerAddress1":"4117 Liberty Ave",
      "customerAddress2":null,
      "customerCity":"Pittsburgh",
      "customerState":"PA",
      "customerZip":"15224",
      "customerCountry":"US",
      "customerLat":40.463657,
      "customerLng":-79.953842,
      "stopNote":null,
      "geofenceStartTime":null,
      "geofenceStartLat":null,
      "geofenceStartLng":null,
      "driverStartTime":"08:30:00",
      "driverStartLat":40.463657,
      "driverStartLng":-79.953842,
      "driverBeginExchange":"08:32:00",
      "driverBeginExchangeLat":40.463648,
      "driverBeginExchangeLng":-79.953833,
      "driverEndTime":null,
      "driverEndLat":null,
      "driverEndLng":null,
      "driverDepartureTime":null,
      "driverDepartureLat":null,
      "driverDepartureLng":null,
      "geofenceEndTime":null,
      "geofenceEndLat":null,
      "geofenceEndLng":null,
      "estimatedArrivalTime":"13:31:00",
      "estimatedDepartureTime":"13:46:00",
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "trailerNumber":"T12345",
      "trailerSwapOccurred":false,
      "trailerSwapName":null,
      "originalTrailerNumber":"",
      "stopReferenceNumber":null,
      "stopRunningStatus":"running",
      "stopType":"pdStop",
      "stopSignerName":null,
      "stopCode":null,
      "associatedShipments":[
         {
            "shipmentType":"delivery",
            "date":"2022-01-01",
            "completionCode":"0",
            "completionNotes":null,
            "shipmentProNumber":"D100000001",
            "shipmentRefNumber":null,
            "shipperCustomerName":null,
            "shipperCustomerName2":null,
            "shipperCustomerNumber":null,
            "consigneeCustomerName":"MavenMachines",
            "consigneeCustomerName2":null,
            "consigneeCustomerNumber":"C1000001",
            "addedAccessorials":[],
            "shipmentRestrictions":[],
            "shipmentTags":["HAZ"],
            "shipmentTotalWeight":100,
            "shipmentTotalPieces":10,
            "shipmentTotalPalletCount":1,
            "shipmentTotalPalletSpaces":1,
            "shipmentTotalHandlingUnits":10,
            "refusedPieces":0,
            "refusedPalletCount":0,
            "signerName":null,
            "destinationZipCode":"15224",
            "destinationSIC":"PGH"
         }
      ]
   }
}

stopComplete

Description

The stopComplete event is produced when a driver completes the exchange of goods at a stop in the Maven system.

Triggers

  1. In the Maven driver application, the driver completes all shipments, then presses the button for “Mark Stop as Complete”.
  2. In the Maven dispatch portal, the dispatcher marks a stop as completed or canceled.

Documentation

  • The stopComplete event is a stop-level return event. See the documentation for “Stop Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the stopComplete event is to communicate the driverEndTime, driverEndLat, and driverEndLng for a given stop.

Example

{
   "timestamp":"2022-01-01 13:42:00",
   "eventType":"stopComplete",
   "data":{
      "sequenceNumber":1,
      "associatedManifestNumber":"M100001",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "customerName":"Maven Machines",
      "customerName2":null,
      "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
      "customerAddress1":"4117 Liberty Ave",
      "customerAddress2":null,
      "customerCity":"Pittsburgh",
      "customerState":"PA",
      "customerZip":"15224",
      "customerCountry":"US",
      "customerLat":40.463657,
      "customerLng":-79.953842,
      "stopNote":null,
      "geofenceStartTime":null,
      "geofenceStartLat":null,
      "geofenceStartLng":null,
      "driverStartTime":"08:30:00",
      "driverStartLat":40.463657,
      "driverStartLng":-79.953842,
      "driverBeginExchange":"08:32:00",
      "driverBeginExchangeLat":40.463648,
      "driverBeginExchangeLng":-79.953833,
      "driverEndTime":"08:42:00",
      "driverEndLat":40.463649,
      "driverEndLng":-79.953834,
      "driverDepartureTime":null,
      "driverDepartureLat":null,
      "driverDepartureLng":null,
      "geofenceEndTime":null,
      "geofenceEndLat":null,
      "geofenceEndLng":null,
      "estimatedArrivalTime":"13:31:00",
      "estimatedDepartureTime":"13:46:00",
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "trailerNumber":"T12345",
      "trailerSwapOccurred":false,
      "trailerSwapName":null,
      "originalTrailerNumber":"",
      "stopReferenceNumber":null,
      "stopRunningStatus":"complete",
      "stopType":"pdStop",
      "stopSignerName":null,
      "stopCode":null,
      "associatedShipments":[
         {
            "shipmentType":"delivery",
            "date":"2022-01-01",
            "completionCode":"1000",
            "completionNotes":"Signer was really happy to receive delivery!",
            "shipmentProNumber":"D100000001",
            "shipmentRefNumber":null,
            "shipperCustomerName":null,
            "shipperCustomerName2":null,
            "shipperCustomerNumber":null,
            "consigneeCustomerName":"MavenMachines",
            "consigneeCustomerName2":null,
            "consigneeCustomerNumber":"C1000001",
            "addedAccessorials":["guaranteed"],
            "shipmentRestrictions":["liftgate"],
            "shipmentTags":["HAZ"],
            "shipmentTotalWeight":100,
            "shipmentTotalPieces":10,
            "shipmentTotalPalletCount":1,
            "shipmentTotalPalletSpaces":1,
            "shipmentTotalHandlingUnits":10,
            "refusedPieces":0,
            "refusedPalletCount":0,
            "signerName":"Joe",
            "destinationZipCode":"15224",
            "destinationSIC":"PGH"
         }
      ]
   }
}

stopDeparture

Description

The stopDeparture event is produced when a driver is departing from a stop in the Maven system.

Triggers

  1. In the Maven driver application, the driver completes a stop, then presses the button for “Begin Next Stop” (or “Return to Terminal” for the final stop on the route).

Documentation

  • The stopDeparture event is a stop-level return event. See the documentation for “Stop Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the stopDeparture event is to communicate the driverDepartureTime, driverDepartureLat, and driverDepartureLng for a given stop.

Example

{
   "timestamp":"2022-01-01 13:43:00",
   "eventType":"stopDeparture",
   "data":{
      "sequenceNumber":1,
      "associatedManifestNumber":"M100001",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "customerName":"Maven Machines",
      "customerName2":null,
      "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
      "customerAddress1":"4117 Liberty Ave",
      "customerAddress2":null,
      "customerCity":"Pittsburgh",
      "customerState":"PA",
      "customerZip":"15224",
      "customerCountry":"US",
      "customerLat":40.463657,
      "customerLng":-79.953842,
      "stopNote":null,
      "geofenceStartTime":null,
      "geofenceStartLat":null,
      "geofenceStartLng":null,
      "driverStartTime":"08:30:00",
      "driverStartLat":40.463657,
      "driverStartLng":-79.953842,
      "driverBeginExchange":"08:32:00",
      "driverBeginExchangeLat":40.463648,
      "driverBeginExchangeLng":-79.953833,
      "driverEndTime":"08:42:00",
      "driverEndLat":40.463649,
      "driverEndLng":-79.953834,
      "driverDepartureTime":"08:43:00",
      "driverDepartureLat":40.463649,
      "driverDepartureLng":-79.953834,
      "geofenceEndTime":null,
      "geofenceEndLat":null,
      "geofenceEndLng":null,
      "estimatedArrivalTime":"13:31:00",
      "estimatedDepartureTime":"13:46:00",
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "trailerNumber":"T12345",
      "trailerSwapOccurred":false,
      "trailerSwapName":null,
      "originalTrailerNumber":"",
      "stopReferenceNumber":null,
      "stopRunningStatus":"complete",
      "stopType":"pdStop",
      "stopSignerName":null,
      "stopCode":null,
      "associatedShipments":[
         {
            "shipmentType":"delivery",
            "date":"2022-01-01",
            "completionCode":"1000",
            "completionNotes":"Signer was really happy to receive delivery!",
            "shipmentProNumber":"D100000001",
            "shipmentRefNumber":null,
            "shipperCustomerName":null,
            "shipperCustomerName2":null,
            "shipperCustomerNumber":null,
            "consigneeCustomerName":"MavenMachines",
            "consigneeCustomerName2":null,
            "consigneeCustomerNumber":"C1000001",
            "addedAccessorials":["guaranteed"],
            "shipmentRestrictions":["liftgate"],
            "shipmentTags":["HAZ"],
            "shipmentTotalWeight":100,
            "shipmentTotalPieces":10,
            "shipmentTotalPalletCount":1,
            "shipmentTotalPalletSpaces":1,
            "shipmentTotalHandlingUnits":10,
            "refusedPieces":0,
            "refusedPalletCount":0,
            "signerName":"Joe",
            "destinationZipCode":"15224",
            "destinationSIC":"PGH"
         }
      ]
   }
}

geofenceStopDeparture

Description

The geofenceStopDeparture event is produced when a driver breaks the geofence while departing from a stop in the Maven system.

Triggers

  1. In the Maven driver application, custom configuration can be made to automatically trigger stop departures based on vehicle speed and/or breaking a geofence.

Documentation

  • The geofenceStopDeparture event is a stop-level return event. See the documentation for “Stop Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the geofenceStopDeparture event is to communicate the geofenceEndTime, geofenceEndLat, and geofenceEndLng for a given stop.

Example

{
   "timestamp":"2022-01-01 13:44:00",
   "eventType":"geofenceStopDeparture",
   "data":{
      "sequenceNumber":1,
      "associatedManifestNumber":"M100001",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "customerName":"Maven Machines",
      "customerName2":null,
      "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
      "customerAddress1":"4117 Liberty Ave",
      "customerAddress2":null,
      "customerCity":"Pittsburgh",
      "customerState":"PA",
      "customerZip":"15224",
      "customerCountry":"US",
      "customerLat":40.463657,
      "customerLng":-79.953842,
      "stopNote":null,
      "geofenceStartTime":null,
      "geofenceStartLat":null,
      "geofenceStartLng":null,
      "driverStartTime":"08:30:00",
      "driverStartLat":40.463657,
      "driverStartLng":-79.953842,
      "driverBeginExchange":"08:32:00",
      "driverBeginExchangeLat":40.463648,
      "driverBeginExchangeLng":-79.953833,
      "driverEndTime":"08:42:00",
      "driverEndLat":40.463649,
      "driverEndLng":-79.953834,
      "driverDepartureTime":"08:43:00",
      "driverDepartureLat":40.463649,
      "driverDepartureLng":-79.953834,
      "geofenceEndTime":"08:44:00",
      "geofenceEndLat":40.463657,
      "geofenceEndLng":-79.953842,
      "estimatedArrivalTime":"13:31:00",
      "estimatedDepartureTime":"13:46:00",
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "trailerNumber":"T12345",
      "trailerSwapOccurred":false,
      "trailerSwapName":null,
      "originalTrailerNumber":"",
      "stopReferenceNumber":null,
      "stopRunningStatus":"complete",
      "stopType":"pdStop",
      "stopSignerName":null,
      "stopCode":null,
      "associatedShipments":[
         {
            "shipmentType":"delivery",
            "date":"2022-01-01",
            "completionCode":"1000",
            "completionNotes":"Signer was really happy to receive delivery!",
            "shipmentProNumber":"D100000001",
            "shipmentRefNumber":null,
            "shipperCustomerName":null,
            "shipperCustomerName2":null,
            "shipperCustomerNumber":null,
            "consigneeCustomerName":"MavenMachines",
            "consigneeCustomerName2":null,
            "consigneeCustomerNumber":"C1000001",
            "addedAccessorials":["guaranteed"],
            "shipmentRestrictions":["liftgate"],
            "shipmentTags":["HAZ"],
            "shipmentTotalWeight":100,
            "shipmentTotalPieces":10,
            "shipmentTotalPalletCount":1,
            "shipmentTotalPalletSpaces":1,
            "shipmentTotalHandlingUnits":10,
            "refusedPieces":0,
            "refusedPalletCount":0,
            "signerName":"Joe",
            "destinationZipCode":"15224",
            "destinationSIC":"PGH",
            "shipmentSequenceNumber":null
         }
      ]
   }
}

stopRouteUpdated

Description

The stopRouteUpdated event is produced when the geographical route for a stop is updated in the Maven system.

Triggers

  1. In the Maven dispatch portal, the dispatcher moves a stop from one geographical route to another.

Documentation

  • The stopRouteUpdated event is a stop-level return event. See the documentation for “Stop Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the stopRouteUpdated event is to communicate the associatedRouteCode and prevRouteCode for a given stop.

Example

{
   "timestamp":"2022-01-01 14:00:00",
   "eventType":"stopRouteUpdated",
   "data":{
      "sequenceNumber":null,
      "associatedManifestNumber":null,
      "associatedRouteCode":"SOUTH1",
      "prevRouteCode":"NORTH1",
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "customerName":"Maven Machines",
      "customerName2":null,
      "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
      "customerAddress1":"4117 Liberty Ave",
      "customerAddress2":null,
      "customerCity":"Pittsburgh",
      "customerState":"PA",
      "customerZip":"15224",
      "customerCountry":"US",
      "customerLat":40.463657,
      "customerLng":-79.953842,
      "stopNote":null,
      "geofenceStartTime":null,
      "geofenceStartLat":null,
      "geofenceStartLng":null,
      "driverStartTime":null,
      "driverStartLat":null,
      "driverStartLng":null,
      "driverBeginExchange":null,
      "driverBeginExchangeLat":null,
      "driverBeginExchangeLng":null,
      "driverEndTime":null,
      "driverEndLat":null,
      "driverEndLng":null,
      "driverDepartureTime":null,
      "driverDepartureLat":null,
      "driverDepartureLng":null,
      "geofenceEndTime":null,
      "geofenceEndLat":null,
      "geofenceEndLng":null,
      "estimatedArrivalTime":null,
      "estimatedDepartureTime":null,
      "userId":null,
      "userName":null,
      "vehicleNumber":null,
      "trailerNumber":null,
      "trailerSwapOccurred":false,
      "trailerSwapName":null,
      "originalTrailerNumber":"",
      "stopReferenceNumber":null,
      "stopRunningStatus":"pending",
      "stopType":"pdStop",
      "stopSignerName":null,
      "stopCode":null,
      "associatedShipments":[
         {
            "shipmentType":"pickup",
            "date":"2022-01-01",
            "completionCode":"0",
            "completionNotes":null,
            "shipmentProNumber":null,
            "shipmentRefNumber":"P1000001",
            "shipperCustomerName":"Maven Machines",
            "shipperCustomerName2":null,
            "shipperCustomerNumber":"C1000001",
            "consigneeCustomerName":null,
            "consigneeCustomerName2":null,
            "consigneeCustomerNumber":null,
            "addedAccessorials":[],
            "shipmentRestrictions":[],
            "shipmentTags":["PRIORITY"],
            "shipmentTotalWeight":100,
            "shipmentTotalPieces":10,
            "shipmentTotalPalletCount":1,
            "shipmentTotalPalletSpaces":1,
            "shipmentTotalHandlingUnits":10,
            "refusedPieces":0,
            "refusedPalletCount":0,
            "signerName":null,
            "destinationZipCode":null,
            "destinationSIC":null
         }
      ]
   }
}

parentStopMerged

Description

The parentStopMerged event is produced when shipments from two or more stops are merged into a single stop in the Maven system. The resulting stop containing all of the affected shipments is referred to as the ‘parent’ stop.

Triggers

  1. In the Maven dispatch portal, a dispatcher identifies two or more stops which share shipments which can be performed in the course of a single stop. The dispatcher selects these stops and chooses a parent stop as the merge target.
  2. In the Maven driver application, custom configuration can be made to allow drivers the ability to merge two stops together.

Documentation

  • The parentStopMerged event is a stop-level return event. See the documentation for “Stop Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the parentStopUpdated event is to communicate the state of the shipments being merged together onto a parent stop.

Example

{
   "timestamp":"2022-01-01 14:00:00",
   "eventType":"parentStopMerged",
   "data":{
      "sequenceNumber":null,
      "associatedManifestNumber":null,
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-12",
      "customerName":"Maven Machines",
      "customerName2":null,
      "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
      "customerAddress1":"4117 Liberty Ave",
      "customerAddress2":null,
      "customerCity":"Pittsburgh",
      "customerState":"PA",
      "customerZip":"15224",
      "customerCountry":"US",
      "customerLat":40.463657,
      "customerLng":-79.953842,
      "stopNote":null,
      "geofenceStartTime":null,
      "geofenceStartLat":null,
      "geofenceStartLng":null,
      "driverStartTime":null,
      "driverStartLat":null,
      "driverStartLng":null,
      "driverBeginExchange":null,
      "driverBeginExchangeLat":null,
      "driverBeginExchangeLng":null,
      "driverEndTime":null,
      "driverEndLat":null,
      "driverEndLng":null,
      "driverDepartureTime":null,
      "driverDepartureLat":null,
      "driverDepartureLng":null,
      "geofenceEndTime":null,
      "geofenceEndLat":null,
      "geofenceEndLng":null,
      "estimatedArrivalTime":null,
      "estimatedDepartureTime":null,
      "userId":null,
      "userName":null,
      "vehicleNumber":null,
      "trailerNumber":null,
      "trailerSwapOccurred":false,
      "trailerSwapName":null,
      "originalTrailerNumber":"",
      "stopReferenceNumber":null,
      "stopRunningStatus":"pending",
      "stopType":"pdStop",
      "stopSignerName":null,
      "stopCode":null,
      "performedByUserCode":"DISPATCHER123",
      "performedByUserName":"Williams, Bob",
      "associatedShipments":[
         {
            "shipmentType":"pickup",
            "addOnPickup":false,
            "date":"2022-01-01",
            "completionCode":"0",
            "completionNotes":null,
            "shipmentProNumber":null,
            "shipmentRefNumber":"P1000001",
            "shipperCustomerName":"Maven Machines",
            "shipperCustomerName2":null,
            "shipperCustomerNumber":"C1000001",
            "consigneeCustomerName":null,
            "consigneeCustomerName2":null,
            "consigneeCustomerNumber":null,
            "addedAccessorials":[],
            "shipmentRestrictions":[],
            "shipmentTags":["PRIORITY"],
            "shipmentTotalWeight":100,
            "shipmentTotalPieces":10,
            "shipmentTotalPalletCount":1,
            "shipmentTotalPalletSpaces":1,
            "shipmentTotalHandlingUnits":10,
            "refusedPieces":0,
            "refusedPalletCount":0,
            "destinationZipCode":null,
            "destinationSIC":null,
            "shipmentSequenceNumber":null
         },
         {
            "shipmentType":"pickup",
            "addOnPickup":false,
            "date":"2022-01-01",
            "completionCode":"0",
            "completionNotes":null,
            "shipmentProNumber":null,
            "shipmentRefNumber":"P1000002",
            "shipperCustomerName":"Maven Machines",
            "shipperCustomerName2":null,
            "shipperCustomerNumber":"C1000002",
            "consigneeCustomerName":null,
            "consigneeCustomerName2":null,
            "consigneeCustomerNumber":null,
            "addedAccessorials":[],
            "shipmentRestrictions":[],
            "shipmentTags":[],
            "shipmentTotalWeight":200,
            "shipmentTotalPieces":20,
            "shipmentTotalPalletCount":2,
            "shipmentTotalPalletSpaces":2,
            "shipmentTotalHandlingUnits":20,
            "refusedPieces":0,
            "refusedPalletCount":0,
            "destinationZipCode":null,
            "destinationSIC":null,
            "shipmentSequenceNumber":null
         }
      ]
   }
}

shipmentCreated

Description

A shipmentCreated event is produced when the integrations system successfully processes the creation of a new shipment.

Triggers

  1. A new shipment is sent in through the integrations POST /shipments endpoint, and is successfully created.

Documentation

  • The shipmentCreated event is a shipment-level return event. See the documentation for “Shipment Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the shipmentCreated event is to communicate the state of the shipment in the Maven system at the time it was updated.

Example

{
   "timestamp":"2022-01-01 13:00:00",
   "eventType":"shipmentCreated",
   "data":{
      "shipmentType":"pickup",
      "addOnPickup":false,
      "date":"2022-01-01",
      "completionCode":"0",
      "completionNotes":null,
      "shipmentProNumber":null,
      "shipmentRefNumber":"P1000001",
      "shipperCustomerName":"Maven Machines",
      "shipperCustomerName2":null,
      "shipperCustomerNumber":"C1000001",
      "consigneeCustomerName":null,
      "consigneeCustomerName2":null,
      "consigneeCustomerNumber":null,
      "addedAccessorials":[],
      "shipmentRestrictions":[],
      "shipmentTags":["PRIORITY"],
      "shipmentTotalWeight":100,
      "shipmentTotalPieces":10,
      "shipmentTotalPalletCount":1,
      "shipmentTotalPalletSpaces":1,
      "shipmentTotalHandlingUnits":10,
      "refusedPieces":0,
      "refusedPalletCount":0,
      "destinationZipCode":null,
      "destinationSIC":null,
      "associatedStop":{
         "sequenceNumber":null,
         "associatedManifestNumber":null,
         "associatedRouteCode":"NORTH1",
         "prevRouteCode":null,
         "terminalCode":"PGH",
         "date":"2022-01-01",
         "customerName":"Maven Machines",
         "customerName2":null,
         "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
         "customerAddress1":"4117 Liberty Ave",
         "customerAddress2":null,
         "customerCity":"Pittsburgh",
         "customerState":"PA",
         "customerZip":"15224",
         "customerCountry":"US",
         "customerLat":40.463657,
         "customerLng":-79.953842,
         "stopNote":null,
         "geofenceStartTime":null,
         "geofenceStartLat":null,
         "geofenceStartLng":null,
         "driverStartTime":null,
         "driverStartLat":null,
         "driverStartLng":null,
         "driverBeginExchange":null,
         "driverBeginExchangeLat":null,
         "driverBeginExchangeLng":null,
         "driverEndTime":null,
         "driverEndLat":null,
         "driverEndLng":null,
         "driverDepartureTime":null,
         "driverDepartureLat":null,
         "driverDepartureLng":null,
         "geofenceEndTime":null,
         "geofenceEndLat":null,
         "geofenceEndLng":null,
         "estimatedArrivalTime":null,
         "estimatedDepartureTime":null,
         "userId":null,
         "userName":null,
         "vehicleNumber":null,
         "trailerNumber":null,
         "trailerSwapOccurred":false,
         "trailerSwapName":null,
         "originalTrailerNumber":"",
         "stopReferenceNumber":null,
         "stopRunningStatus":"pending",
         "stopType":"pdStop",
         "stopSignerName":null,
         "stopCode":null,
         "performedByUserCode":null,
         "performedByUserName":null
      }
   }
}

shipmentUpdated

Description

A shipmentUpdated event is produced when the integrations system successfully processes an update for a shipment.

Triggers

  1. An existing shipment is sent in through the integrations POST /shipments endpoint, and is successfully updated.
  2. An existing shipment is edited from the available freight screen.

Documentation

  • The shipmentUpdated event is a shipment-level return event. See the documentation for “Shipment Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the shipmentUpdated event is to communicate the state of the shipment in the Maven system at the time it was updated.

Example

{
   "timestamp":"2022-01-01 13:00:00",
   "eventType":"shipmentUpdated",
   "data":{
      "shipmentType":"pickup",
      "addOnPickup":false,
      "date":"2022-01-01",
      "completionCode":"0",
      "completionNotes":null,
      "shipmentProNumber":null,
      "shipmentRefNumber":"P1000001",
      "shipperCustomerName":"Maven Machines",
      "shipperCustomerName2":null,
      "shipperCustomerNumber":"C1000001",
      "consigneeCustomerName":null,
      "consigneeCustomerName2":null,
      "consigneeCustomerNumber":null,
      "addedAccessorials":[],
      "shipmentRestrictions":[],
      "shipmentTags":["PRIORITY"],
      "shipmentTotalWeight":100,
      "shipmentTotalPieces":10,
      "shipmentTotalPalletCount":1,
      "shipmentTotalPalletSpaces":1,
      "shipmentTotalHandlingUnits":10,
      "refusedPieces":0,
      "refusedPalletCount":0,
      "destinationZipCode":null,
      "destinationSIC":null,
      "associatedStop":{
         "sequenceNumber":null,
         "associatedManifestNumber":null,
         "associatedRouteCode":"NORTH1",
         "prevRouteCode":null,
         "terminalCode":"PGH",
         "date":"2022-01-01",
         "customerName":"Maven Machines",
         "customerName2":null,
         "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
         "customerAddress1":"4117 Liberty Ave",
         "customerAddress2":null,
         "customerCity":"Pittsburgh",
         "customerState":"PA",
         "customerZip":"15224",
         "customerCountry":"US",
         "customerLat":40.463657,
         "customerLng":-79.953842,
         "stopNote":null,
         "geofenceStartTime":null,
         "geofenceStartLat":null,
         "geofenceStartLng":null,
         "driverStartTime":null,
         "driverStartLat":null,
         "driverStartLng":null,
         "driverBeginExchange":null,
         "driverBeginExchangeLat":null,
         "driverBeginExchangeLng":null,
         "driverEndTime":null,
         "driverEndLat":null,
         "driverEndLng":null,
         "driverDepartureTime":null,
         "driverDepartureLat":null,
         "driverDepartureLng":null,
         "geofenceEndTime":null,
         "geofenceEndLat":null,
         "geofenceEndLng":null,
         "estimatedArrivalTime":null,
         "estimatedDepartureTime":null,
         "userId":null,
         "userName":null,
         "vehicleNumber":null,
         "trailerNumber":null,
         "trailerSwapOccurred":false,
         "trailerSwapName":null,
         "originalTrailerNumber":"",
         "stopReferenceNumber":null,
         "stopRunningStatus":"pending",
         "stopType":"pdStop",
         "stopSignerName":null,
         "stopCode":null,
         "performedByUserCode":null,
         "performedByUserName":null
      }
   }
}

shipmentUpdatedInMaven

Description

A shipmentUpdatedInMaven event is produced when a user successfully updates a shipment in Maven

Triggers

  1. An existing shipment is edited from the available freight screen.

Documentation

  • The shipmentUpdatedInMaven event is a shipment-level return event. See the documentation for “Shipment Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The associatedStop attribute may be null if the shipment is not assigned to a stop at the time of update.

Example

{
   "timestamp":"2022-01-01 13:00:00",
   "eventType":"shipmentUpdatedInMaven",
   "data":{
      "shipmentType":"pickup",
      "addOnPickup":false,
      "date":"2022-01-01",
      "completionCode":"0",
      "completionNotes":null,
      "shipmentProNumber":null,
      "shipmentRefNumber":"P1000001",
      "shipperCustomerName":"Maven Machines",
      "shipperCustomerName2":null,
      "shipperCustomerNumber":"C1000001",
      "consigneeCustomerName":null,
      "consigneeCustomerName2":null,
      "consigneeCustomerNumber":null,
      "addedAccessorials":[],
      "shipmentRestrictions":[],
      "shipmentTags":["PRIORITY"],
      "shipmentTotalWeight":100,
      "shipmentTotalPieces":10,
      "shipmentTotalPalletCount":1,
      "shipmentTotalPalletSpaces":1,
      "shipmentTotalHandlingUnits":10,
      "refusedPieces":0,
      "refusedPalletCount":0,
      "destinationZipCode":null,
      "destinationSIC":null,
      "associatedStop":{
         "sequenceNumber":null,
         "associatedManifestNumber":null,
         "associatedRouteCode":"NORTH1",
         "prevRouteCode":null,
         "terminalCode":"PGH",
         "date":"2022-01-01",
         "customerName":"Maven Machines",
         "customerName2":null,
         "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
         "customerAddress1":"4117 Liberty Ave",
         "customerAddress2":null,
         "customerCity":"Pittsburgh",
         "customerState":"PA",
         "customerZip":"15224",
         "customerCountry":"US",
         "customerLat":40.463657,
         "customerLng":-79.953842,
         "stopNote":null,
         "geofenceStartTime":null,
         "geofenceStartLat":null,
         "geofenceStartLng":null,
         "driverStartTime":null,
         "driverStartLat":null,
         "driverStartLng":null,
         "driverBeginExchange":null,
         "driverBeginExchangeLat":null,
         "driverBeginExchangeLng":null,
         "driverEndTime":null,
         "driverEndLat":null,
         "driverEndLng":null,
         "driverDepartureTime":null,
         "driverDepartureLat":null,
         "driverDepartureLng":null,
         "geofenceEndTime":null,
         "geofenceEndLat":null,
         "geofenceEndLng":null,
         "estimatedArrivalTime":null,
         "estimatedDepartureTime":null,
         "userId":null,
         "userName":null,
         "vehicleNumber":null,
         "trailerNumber":null,
         "trailerSwapOccurred":false,
         "trailerSwapName":null,
         "originalTrailerNumber":"",
         "stopReferenceNumber":null,
         "stopRunningStatus":"pending",
         "stopType":"pdStop",
         "stopSignerName":null,
         "stopCode":null,
         "performedByUserCode":null,
         "performedByUserName":null
      }
   }
}

shipmentAssignment

Description

The shipmentAssignment event is produced when a shipment is assigned to a manifest in the Maven system.

Triggers

  1. In the Maven dispatch portal or inbound planning board, A dispatcher or planner assigns one or more stops to a manifest. This will produce one shipmentAssignment event for every shipment associated with the assigned stop(s).
  2. In the Maven dispatch portal or inbound planning board, if a dispatcher or planner chooses to merge an unassigned stop into an assigned parent stop, one shipmentAssignment event will be produced for each shipment being included in the merge.
  3. A request is sent in through the integrations POST /shipment endpoint which specifies a manifestNumber for assignment.
  4. A request is sent in through the integrations POST /manifests endpoint which specifies additional shipment(s) to assign to an existing manifest. This will produce one shipmentAssignment event for every additional shipment.

Documentation

  • The shipmentAssignment event is a shipment-level return event. See the documentation for “Shipment Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the shipmentAssignment event is to communicate the information about the associatedStop on the manifest where the shipment has been assigned.

Example

{
   "timestamp":"2022-01-01 13:00:00",
   "eventType":"shipmentAssignment",
   "data":{
      "shipmentType":"pickup",
      "addOnPickup":false,
      "date":"2022-01-01",
      "completionCode":"0",
      "completionNotes":null,
      "shipmentProNumber":null,
      "shipmentRefNumber":"P1000001",
      "shipperCustomerName":"Maven Machines",
      "shipperCustomerName2":null,
      "shipperCustomerNumber":"C1000001",
      "consigneeCustomerName":null,
      "consigneeCustomerName2":null,
      "consigneeCustomerNumber":null,
      "addedAccessorials":[],
      "shipmentRestrictions":[],
      "shipmentTags":["PRIORITY"],
      "shipmentTotalWeight":100,
      "shipmentTotalPieces":10,
      "shipmentTotalPalletCount":1,
      "shipmentTotalPalletSpaces":1,
      "shipmentTotalHandlingUnits":10,
      "refusedPieces":0,
      "refusedPalletCount":0,
      "destinationZipCode":null,
      "destinationSIC":null,
      "associatedStop":{
         "sequenceNumber":2,
         "associatedManifestNumber":"M100001",
         "associatedRouteCode":"NORTH1",
         "prevRouteCode":null,
         "terminalCode":"PGH",
         "date":"2022-01-01",
         "customerName":"Maven Machines",
         "customerName2":null,
         "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
         "customerAddress1":"4117 Liberty Ave",
         "customerAddress2":null,
         "customerCity":"Pittsburgh",
         "customerState":"PA",
         "customerZip":"15224",
         "customerCountry":"US",
         "customerLat":40.463657,
         "customerLng":-79.953842,
         "stopNote":null,
         "geofenceStartTime":null,
         "geofenceStartLat":null,
         "geofenceStartLng":null,
         "driverStartTime":null,
         "driverStartLat":null,
         "driverStartLng":null,
         "driverBeginExchange":null,
         "driverBeginExchangeLat":null,
         "driverBeginExchangeLng":null,
         "driverEndTime":null,
         "driverEndLat":null,
         "driverEndLng":null,
         "driverDepartureTime":null,
         "driverDepartureLat":null,
         "driverDepartureLng":null,
         "geofenceEndTime":null,
         "geofenceEndLat":null,
         "geofenceEndLng":null,
         "estimatedArrivalTime":"14:00:00",
         "estimatedDepartureTime":"14:15:00",
         "userId":"DRIVER123",
         "userName":"Smith, John",
         "vehicleNumber":"V1234",
         "trailerNumber":"T12345",
         "trailerSwapOccurred":false,
         "trailerSwapName":null,
         "originalTrailerNumber":"",
         "stopReferenceNumber":null,
         "stopRunningStatus":"pending",
         "stopType":"pdStop",
         "stopSignerName":null,
         "stopCode":null,
         "performedByUserCode":"DISPATCHER123",
         "performedByUserName":"Williams, Bob"
      }
   }
}

shipmentComplete

Description

The shipmentComplete event is produced when a pickup or delivery request for a shipment has been marked as processed in the Maven system. The action of ‘completing’ a shipment, in this sense, can refer to either a successful pickup/delivery, a refusal, or a cancelation.

Triggers

  1. In the Maven driver application, during the course of the exchange of goods at a stop, the driver processes a pickup or delivery, then presses the button for “Finish Shipment”.
  2. In the Maven driver application, the driver marks a stop as canceled. This will produce a shipmentComplete event for each shipment associated with the canceled stop.
  3. In the Maven dispatch portal, the dispatcher marks a stop as complete or canceled. This will produce a shipmentComplete event for each shipment associated with the stop.
  4. A request is sent in through the integrations POST /pickupRequests/cancel endpoint which specifies a pickup Reference Number to be canceled.

Documentation

  • The shipmentComplete event is a shipment-level return event. See the documentation for “Shipment Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the shipmentComplete event is to communicate the information about the state of the shipment at the time it was completed.

Example

{
   "timestamp":"2022-01-01 13:40:00",
   "eventType":"shipmentComplete",
   "data":{
      "shipmentType":"delivery",
      "addOnPickup":false,
      "date":"2022-01-01",
      "completionCode":"1201",
      "completionNotes":"I lost it",
      "shipmentProNumber":"D100000001",
      "shipmentRefNumber":null,
      "shipperCustomerName":null,
      "shipperCustomerName2":null,
      "shipperCustomerNumber":null,
      "consigneeCustomerName":"Maven Machines",
      "consigneeCustomerName2":null,
      "consigneeCustomerNumber":"C1000001",
      "addedAccessorials":["guaranteed"],
      "shipmentRestrictions":["liftgate"],
      "shipmentTags":["HAZ"],
      "shipmentTotalWeight":100,
      "shipmentTotalPieces":10,
      "shipmentTotalPalletCount":1,
      "shipmentTotalPalletSpaces":1,
      "shipmentTotalHandlingUnits":10,
      "refusedPieces":10,
      "refusedPalletCount":1,
      "destinationZipCode":"15224",
      "destinationSIC":"PGH",
      "associatedStop":{
         "sequenceNumber":1,
         "associatedManifestNumber":"M100001",
         "associatedRouteCode":"NORTH1",
         "prevRouteCode":null,
         "terminalCode":"PGH",
         "date":"2022-01-01",
         "customerName":"Maven Machines",
         "customerName2":null,
         "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
         "customerAddress1":"4117 Liberty Ave",
         "customerAddress2":null,
         "customerCity":"Pittsburgh",
         "customerState":"PA",
         "customerZip":"15224",
         "customerCountry":"US",
         "customerLat":40.463657,
         "customerLng":-79.953842,
         "stopNote":null,
         "geofenceStartTime":null,
         "geofenceStartLat":null,
         "geofenceStartLng":null,
         "driverStartTime":"08:30:00",
         "driverStartLat":40.463657,
         "driverStartLng":-79.953842,
         "driverBeginExchange":"08:32:00",
         "driverBeginExchangeLat":40.463648,
         "driverBeginExchangeLng":-79.953833,
         "driverEndTime":null,
         "driverEndLat":null,
         "driverEndLng":null,
         "driverDepartureTime":null,
         "driverDepartureLat":null,
         "driverDepartureLng":null,
         "geofenceEndTime":null,
         "geofenceEndLat":null,
         "geofenceEndLng":null,
         "estimatedArrivalTime":"13:31:00",
         "estimatedDepartureTime":"13:46:00",
         "userId":"DRIVER123",
         "userName":"Smith, John",
         "vehicleNumber":"V1234",
         "trailerNumber":"T12345",
         "trailerSwapOccurred":false,
         "trailerSwapName":null,
         "originalTrailerNumber":"",
         "stopReferenceNumber":null,
         "stopRunningStatus":"running",
         "stopType":"pdStop",
         "stopSignerName":null,
         "stopCode":null
      }
   }
}

shipmentRecomplete

Description

The shipmentRecomplete event is produced when a pickup or delivery request for a shipment has been marked as re-processed in the Maven system. The action of ‘completing’ a shipment, in this sense, can refer to either a successful pickup/delivery, a refusal, or a cancelation.

Triggers

  1. In the Maven driver application, the driver has the option to select a completed shipment and press a button to “Complete Again”. This will reopen the shipment to be processed again. Once the shipment is processed, the driver presses the button for “Finish Shipment”, which will trigger a shipmentRecomplete event.

Documentation

  • The shipmentRecomplete event is a shipment-level return event. See the documentation for “Shipment Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the shipmentRecomplete event is to communicate the information about the state of the shipment at the time it was re-completed.

Example

{
   "timestamp":"2022-01-01 13:41:00",
   "eventType":"shipmentRecomplete",
   "data":{
      "shipmentType":"delivery",
      "addOnPickup":false,
      "date":"2022-01-01",
      "completionCode":"1000",
      "completionNotes":"I found it",
      "shipmentProNumber":"D100000001",
      "shipmentRefNumber":null,
      "shipperCustomerName":null,
      "shipperCustomerName2":null,
      "shipperCustomerNumber":null,
      "consigneeCustomerName":"Maven Machines",
      "consigneeCustomerName2":null,
      "consigneeCustomerNumber":"C1000001",
      "addedAccessorials":["guaranteed"],
      "shipmentRestrictions":["liftgate"],
      "shipmentTags":["HAZ"],
      "shipmentTotalWeight":100,
      "shipmentTotalPieces":10,
      "shipmentTotalPalletCount":1,
      "shipmentTotalPalletSpaces":1,
      "shipmentTotalHandlingUnits":10,
      "refusedPieces":0,
      "refusedPalletCount":0,
      "destinationZipCode":"15224",
      "destinationSIC":"PGH",
      "associatedStop":{
         "sequenceNumber":1,
         "associatedManifestNumber":"M100001",
         "associatedRouteCode":"NORTH1",
         "prevRouteCode":null,
         "terminalCode":"PGH",
         "date":"2022-01-01",
         "customerName":"Maven Machines",
         "customerName2":null,
         "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
         "customerAddress1":"4117 Liberty Ave",
         "customerAddress2":null,
         "customerCity":"Pittsburgh",
         "customerState":"PA",
         "customerZip":"15224",
         "customerCountry":"US",
         "customerLat":40.463657,
         "customerLng":-79.953842,
         "stopNote":null,
         "geofenceStartTime":null,
         "geofenceStartLat":null,
         "geofenceStartLng":null,
         "driverStartTime":"08:30:00",
         "driverStartLat":40.463657,
         "driverStartLng":-79.953842,
         "driverBeginExchange":"08:32:00",
         "driverBeginExchangeLat":40.463648,
         "driverBeginExchangeLng":-79.953833,
         "driverEndTime":null,
         "driverEndLat":null,
         "driverEndLng":null,
         "driverDepartureTime":null,
         "driverDepartureLat":null,
         "driverDepartureLng":null,
         "geofenceEndTime":null,
         "geofenceEndLat":null,
         "geofenceEndLng":null,
         "estimatedArrivalTime":"13:31:00",
         "estimatedDepartureTime":"13:46:00",
         "userId":"DRIVER123",
         "userName":"Smith, John",
         "vehicleNumber":"V1234",
         "trailerNumber":"T12345",
         "trailerSwapOccurred":false,
         "trailerSwapName":null,
         "originalTrailerNumber":"",
         "stopReferenceNumber":null,
         "stopRunningStatus":"running",
         "stopType":"pdStop",
         "stopSignerName":null,
         "stopCode":null
      }
   }
}

stopAssignment

Description

The stopAssignment event is produced when a stops is assigned to a manifest in the Maven system.

Triggers

  1. In the Maven dispatch portal, a dispatcher or planner assigns one or more stops to a manifest. This will produce one stopAssignment event for every stop.

Documentation

  • The stopAssignment event is a stop-level return event. See the documentation for “Stop Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.

Example

{
   "timestamp":"2022-01-01 13:30:00",
   "eventType":"stopAssignment",
   "data":{
      "sequenceNumber":1,
      "associatedManifestNumber":"M100001",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "customerName":"Maven Machines",
      "customerName2":null,
      "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
      "customerAddress1":"4117 Liberty Ave",
      "customerAddress2":null,
      "customerCity":"Pittsburgh",
      "customerState":"PA",
      "customerZip":"15224",
      "customerCountry":"US",
      "customerLat":40.463657,
      "customerLng":-79.953842,
      "stopNote":null,
      "geofenceStartTime":null,
      "geofenceStartLat":null,
      "geofenceStartLng":null,
      "driverStartTime":"08:30:00",
      "driverStartLat":40.463657,
      "driverStartLng":-79.953842,
      "driverBeginExchange":null,
      "driverBeginExchangeLat":null,
      "driverBeginExchangeLng":null,
      "driverEndTime":null,
      "driverEndLat":null,
      "driverEndLng":null,
      "driverDepartureTime":null,
      "driverDepartureLat":null,
      "driverDepartureLng":null,
      "geofenceEndTime":null,
      "geofenceEndLat":null,
      "geofenceEndLng":null,
      "estimatedArrivalTime":"13:31:00",
      "estimatedDepartureTime":"13:46:00",
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "trailerNumber":"T12345",
      "trailerSwapOccurred":false,
      "trailerSwapName":null,
      "originalTrailerNumber":"",
      "stopReferenceNumber":null,
      "stopRunningStatus":"running",
      "stopType":"pdStop",
      "stopSignerName":null,
      "stopCode":null,
      "associatedShipments":[
         {
            "shipmentType":"delivery",
            "date":"2022-01-01",
            "completionCode":"0",
            "completionNotes":null,
            "shipmentProNumber":"D100000001",
            "shipmentRefNumber":null,
            "shipperCustomerName":null,
            "shipperCustomerName2":null,
            "shipperCustomerNumber":null,
            "consigneeCustomerName":"MavenMachines",
            "consigneeCustomerName2":null,
            "consigneeCustomerNumber":"C1000001",
            "addedAccessorials":[],
            "shipmentRestrictions":[],
            "shipmentTags":["HAZ"],
            "shipmentTotalWeight":100,
            "shipmentTotalPieces":10,
            "shipmentTotalPalletCount":1,
            "shipmentTotalPalletSpaces":1,
            "shipmentTotalHandlingUnits":10,
            "refusedPieces":0,
            "refusedPalletCount":0,
            "signerName":null,
            "destinationZipCode":"15224",
            "destinationSIC":"PGH"
         }
      ]
   }
}

stopUnassignment

Description

The stopUnassignment event is produced when a stop is unassigned to a manifest in the Maven system.

Triggers

  1. In the Maven dispatch portal, a dispatcher or planner unassigns one or more stops to a manifest. This will produce one stopUnassignment event for every stop.

Documentation

  • The stopUnassignment event is a stop-level return event. See the documentation for “Stop Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.

Example

{
   "timestamp":"2022-01-01 13:30:00",
   "eventType":"stopUnassignment",
   "data":{
      "sequenceNumber":1,
      "associatedManifestNumber":"M100001",
      "associatedRouteCode":"NORTH1",
      "prevRouteCode":null,
      "terminalCode":"PGH",
      "date":"2022-01-01",
      "customerName":"Maven Machines",
      "customerName2":null,
      "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
      "customerAddress1":"4117 Liberty Ave",
      "customerAddress2":null,
      "customerCity":"Pittsburgh",
      "customerState":"PA",
      "customerZip":"15224",
      "customerCountry":"US",
      "customerLat":40.463657,
      "customerLng":-79.953842,
      "stopNote":null,
      "geofenceStartTime":null,
      "geofenceStartLat":null,
      "geofenceStartLng":null,
      "driverStartTime":"08:30:00",
      "driverStartLat":40.463657,
      "driverStartLng":-79.953842,
      "driverBeginExchange":null,
      "driverBeginExchangeLat":null,
      "driverBeginExchangeLng":null,
      "driverEndTime":null,
      "driverEndLat":null,
      "driverEndLng":null,
      "driverDepartureTime":null,
      "driverDepartureLat":null,
      "driverDepartureLng":null,
      "geofenceEndTime":null,
      "geofenceEndLat":null,
      "geofenceEndLng":null,
      "estimatedArrivalTime":"13:31:00",
      "estimatedDepartureTime":"13:46:00",
      "userId":"DRIVER123",
      "userName":"Smith, John",
      "vehicleNumber":"V1234",
      "trailerNumber":"T12345",
      "trailerSwapOccurred":false,
      "trailerSwapName":null,
      "originalTrailerNumber":"",
      "stopReferenceNumber":null,
      "stopRunningStatus":"running",
      "stopType":"pdStop",
      "stopSignerName":null,
      "stopCode":null,
      "associatedShipments":[
         {
            "shipmentType":"delivery",
            "date":"2022-01-01",
            "completionCode":"0",
            "completionNotes":null,
            "shipmentProNumber":"D100000001",
            "shipmentRefNumber":null,
            "shipperCustomerName":null,
            "shipperCustomerName2":null,
            "shipperCustomerNumber":null,
            "consigneeCustomerName":"MavenMachines",
            "consigneeCustomerName2":null,
            "consigneeCustomerNumber":"C1000001",
            "addedAccessorials":[],
            "shipmentRestrictions":[],
            "shipmentTags":["HAZ"],
            "shipmentTotalWeight":100,
            "shipmentTotalPieces":10,
            "shipmentTotalPalletCount":1,
            "shipmentTotalPalletSpaces":1,
            "shipmentTotalHandlingUnits":10,
            "refusedPieces":0,
            "refusedPalletCount":0,
            "signerName":null,
            "destinationZipCode":"15224",
            "destinationSIC":"PGH"
         }
      ]
   }
}

shipmentUnassignment

Description

The shipmentUnassignment event is produced when a shipment is removed from a manifest in the Maven system.

Triggers

  1. In the Maven dispatch portal or inbound planning board, A dispatcher or planner unassigns one or more stops from a manifest. This will produce one shipmentUnassignment event for every shipment associated with the unassigned stop(s).
  2. In the Maven dispatch portal or inbound planning board, if a dispatcher or planner chooses to merge an assigned stop into an assigned parent stop, one shipmentUnassignment event will be produced for each shipment being included in the merge.
  3. A request is sent in through the integrations POST /shipment endpoint which specifies a NULL manifestNumber for unassignment from an existing manifest.
  4. A request is sent in through the integrations POST /manifests endpoint which does NOT specify one or more delivery Pro Numbers that are currently assigned to the manifest in the Maven system. This will produce one shipmentUnassignment event for every delivery being removed from the manifest.

Documentation

  • The shipmentUnassignment event is a shipment-level return event. See the documentation for “Shipment Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the shipmentUnassignment event is to communicate the information about the associatedStop on the manifest where the shipment has been unassigned.

Example

{
   "timestamp":"2022-01-01 13:00:00",
   "eventType":"shipmentUnassignment",
   "data":{
      "shipmentType":"pickup",
      "addOnPickup":false,
      "date":"2022-01-01",
      "completionCode":"0",
      "completionNotes":null,
      "shipmentProNumber":null,
      "shipmentRefNumber":"P1000001",
      "shipperCustomerName":"Maven Machines",
      "shipperCustomerName2":null,
      "shipperCustomerNumber":"C1000001",
      "consigneeCustomerName":null,
      "consigneeCustomerName2":null,
      "consigneeCustomerNumber":null,
      "addedAccessorials":[],
      "shipmentRestrictions":[],
      "shipmentTags":["PRIORITY"],
      "shipmentTotalWeight":100,
      "shipmentTotalPieces":10,
      "shipmentTotalPalletCount":1,
      "shipmentTotalPalletSpaces":1,
      "shipmentTotalHandlingUnits":10,
      "refusedPieces":0,
      "refusedPalletCount":0,
      "destinationZipCode":null,
      "destinationSIC":null,
      "associatedStop":{
         "sequenceNumber":2,
         "associatedManifestNumber":"M100001",
         "associatedRouteCode":"NORTH1",
         "prevRouteCode":null,
         "terminalCode":"PGH",
         "date":"2022-01-01",
         "customerName":"Maven Machines",
         "customerName2":null,
         "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
         "customerAddress1":"4117 Liberty Ave",
         "customerAddress2":null,
         "customerCity":"Pittsburgh",
         "customerState":"PA",
         "customerZip":"15224",
         "customerCountry":"US",
         "customerLat":40.463657,
         "customerLng":-79.953842,
         "stopNote":null,
         "geofenceStartTime":null,
         "geofenceStartLat":null,
         "geofenceStartLng":null,
         "driverStartTime":null,
         "driverStartLat":null,
         "driverStartLng":null,
         "driverBeginExchange":null,
         "driverBeginExchangeLat":null,
         "driverBeginExchangeLng":null,
         "driverEndTime":null,
         "driverEndLat":null,
         "driverEndLng":null,
         "driverDepartureTime":null,
         "driverDepartureLat":null,
         "driverDepartureLng":null,
         "geofenceEndTime":null,
         "geofenceEndLat":null,
         "geofenceEndLng":null,
         "estimatedArrivalTime":"14:00:00",
         "estimatedDepartureTime":"14:15:00",
         "userId":"DRIVER123",
         "userName":"Smith, John",
         "vehicleNumber":"V1234",
         "trailerNumber":"T12345",
         "trailerSwapOccurred":false,
         "trailerSwapName":null,
         "originalTrailerNumber":"",
         "stopReferenceNumber":null,
         "stopRunningStatus":"pending",
         "stopType":"pdStop",
         "stopSignerName":null,
         "stopCode":null,
         "performedByUserCode":"DISPATCHER123",
         "performedByUserName":"Williams, Bob"
      }
   }

shipmentAssignment

Description

The shipmentAssignment event is produced when a shipment is assigned to a manifest in the Maven system.

Triggers

  1. In the Maven dispatch portal or inbound planning board, A dispatcher or planner assigns one or more stops to a manifest. This will produce one shipmentAssignment event for every shipment associated with the assigned stop(s).
  2. In the Maven dispatch portal or inbound planning board, if a dispatcher or planner chooses to merge an unassigned stop into an assigned parent stop, one shipmentAssignment event will be produced for each shipment being included in the merge.
  3. A request is sent in through the integrations POST /shipment endpoint which specifies a manifestNumber for assignment.
  4. A request is sent in through the integrations POST /manifests endpoint which specifies additional shipment(s) to assign to an existing manifest. This will produce one shipmentAssignment event for every additional shipment.

Documentation

  • The shipmentAssignment event is a shipment-level return event. See the documentation for “Shipment Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the shipmentAssignment event is to communicate the information about the associatedStop on the manifest where the shipment has been assigned.

Example

{
   "timestamp":"2022-01-01 13:00:00",
   "eventType":"shipmentAssignment",
   "data":{
      "shipmentType":"pickup",
      "addOnPickup":false,
      "date":"2022-01-01",
      "completionCode":"0",
      "completionNotes":null,
      "shipmentProNumber":null,
      "shipmentRefNumber":"P1000001",
      "shipperCustomerName":"Maven Machines",
      "shipperCustomerName2":null,
      "shipperCustomerNumber":"C1000001",
      "consigneeCustomerName":null,
      "consigneeCustomerName2":null,
      "consigneeCustomerNumber":null,
      "addedAccessorials":[],
      "shipmentRestrictions":[],
      "shipmentTags":["PRIORITY"],
      "shipmentTotalWeight":100,
      "shipmentTotalPieces":10,
      "shipmentTotalPalletCount":1,
      "shipmentTotalPalletSpaces":1,
      "shipmentTotalHandlingUnits":10,
      "refusedPieces":0,
      "refusedPalletCount":0,
      "destinationZipCode":null,
      "destinationSIC":null,
      "associatedStop":{
         "sequenceNumber":2,
         "associatedManifestNumber":"M100001",
         "associatedRouteCode":"NORTH1",
         "prevRouteCode":null,
         "terminalCode":"PGH",
         "date":"2022-01-01",
         "customerName":"Maven Machines",
         "customerName2":null,
         "customerAddress":"4117 Liberty Ave,Pittsburgh,PA,15224,US",
         "customerAddress1":"4117 Liberty Ave",
         "customerAddress2":null,
         "customerCity":"Pittsburgh",
         "customerState":"PA",
         "customerZip":"15224",
         "customerCountry":"US",
         "customerLat":40.463657,
         "customerLng":-79.953842,
         "stopNote":null,
         "geofenceStartTime":null,
         "geofenceStartLat":null,
         "geofenceStartLng":null,
         "driverStartTime":null,
         "driverStartLat":null,
         "driverStartLng":null,
         "driverBeginExchange":null,
         "driverBeginExchangeLat":null,
         "driverBeginExchangeLng":null,
         "driverEndTime":null,
         "driverEndLat":null,
         "driverEndLng":null,
         "driverDepartureTime":null,
         "driverDepartureLat":null,
         "driverDepartureLng":null,
         "geofenceEndTime":null,
         "geofenceEndLat":null,
         "geofenceEndLng":null,
         "estimatedArrivalTime":"14:00:00",
         "estimatedDepartureTime":"14:15:00",
         "userId":"DRIVER123",
         "userName":"Smith, John",
         "vehicleNumber":"V1234",
         "trailerNumber":"T12345",
         "trailerSwapOccurred":false,
         "trailerSwapName":null,
         "originalTrailerNumber":"",
         "stopReferenceNumber":null,
         "stopRunningStatus":"pending",
         "stopType":"pdStop",
         "stopSignerName":null,
         "stopCode":null,
         "performedByUserCode":"DISPATCHER123",
         "performedByUserName":"Williams, Bob"
      }
   }
}

customerCreated

Description

The customerCreated event is produced when the integrations system successfully processes a new customer record.

Triggers

  1. A new customer is sent in through the integrations POST /customers endpoint, and is successfully created.

Documentation

  • The customerCreated event is a customer-level return event. See the documentation for “Customer Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the customerCreated is to communicate the state of the customer in the Maven system at the time it was updated.

Example

{
   "timestamp":"2022-01-01 12:00:00",
   "eventType":"customerCreated",
   "data":{
      "customerTerminal":"PGH",
      "customerName":"Maven Machines",
      "customerName2":null,
      "customerNumber":"C1000001",
      "createdOn":"2022-01-01T12:00:00Z",
      "lastUpdated":"2022-01-01T12:00:00Z",
      "customerPhoneDay":"4125555555",
      "customerPhoneNight":null,
      "addressStreet":"4117 Liberty Ave",
      "addressStreet2":null,
      "addressCity":"Pittsburgh",
      "addressState":"PA",
      "addressZip":"15224",
      "addressCountry":"US",
      "isGeocoded":true,
      "geocodedAddress":"4117 Liberty Ave, Pittsburgh, PA 15224, USA",
      "geocodeLat":40.463657,
      "geocodeLng":-79.953842,
      "timezone": "America/New_York"
   }
}

customerUpdated

Description

The customerUpdated event is produced when the integrations system successfully processes an update to a customer record.

Triggers

  1. An existing customer is sent in through the integrations POST /customers endpoint, and is successfully updated.

Documentation

  • The customerUpdated event is a customer-level return event. See the documentation for “Customer Level Data” for documentation.
  • Attributes will be returned with a default NULL value in the event that there is no value currently set in the Maven system.
  • The primary purpose of the customerUpdated is to communicate the state of the customer in the Maven system at the time it was updated.

Example

{
   "timestamp":"2022-01-01 13:00:00",
   "eventType":"customerUpdated",
   "data":{
      "customerTerminal":"PGH",
      "customerName":"Maven Machines",
      "customerName2":null,
      "customerNumber":"C1000001",
      "createdOn":"2022-01-01T12:00:00Z",
      "lastUpdated":"2022-01-01T13:00:00Z",
      "customerPhoneDay":"4125555555",
      "customerPhoneNight":null,
      "addressStreet":"4117 Liberty Ave",
      "addressStreet2":null,
      "addressCity":"Pittsburgh",
      "addressState":"PA",
      "addressZip":"15224",
      "addressCountry":"US",
      "isGeocoded":true,
      "geocodedAddress":"4117 Liberty Ave, Pittsburgh, PA 15224, USA",
      "geocodeLat":40.463657,
      "geocodeLng":-79.953842,
      "timezone": "America/New_York"
   }
}

Updated 3 months ago