Overview

This document lays out all of the commands and payloads for each command.

Skeleton Request

A skeleton API request looks like the following:

{
  "commands": [{
    "commandType": "NameOfCommand",
    "payload": {
      // payload fields
    },
    "referenceIds": {
      // reference IDs
    },
    "eventSource": {
      // event source fields
    }
  }]
}

An example payload of creating a manifest would look like the following:

{
  "commands": [{
    "commandType": "CreateManifest",
    "payload": {
      "originLocationCode": "PIT",
      "destinationLocationCode": "CLT",
      "manifestNumber": "823923"
    },
    "referenceIds": {
      "loadNumber": "20240704-101023801"
    },
    "eventSource": {
      "system": "Scheduler
    }
  }]
}

Multiple Commands

Multiple commands can be sent by adding to the commands array.

{
  "commands": [{
    "commandType": "CreateManifest",
    "payload": {
      "originLocationCode": "PIT",
      "destinationLocationCode": "CLT",
      "manifestNumber": "823923"
    },
    "referenceIds": {
      "loadNumber": "20240704-101023801"
    },
    "eventSource": {
      "system": "Scheduler"
    }
  }, {
    "commandType": "CreateManifest",
    "payload": {
      "originLocationCode": "CLT",
      "destinationLocationCode": "ATL",
      "manifestNumber": "129340"
    },
    "referenceIds": {
      "loadNumber": "20240704-230840"
    },
    "eventSource": {
      "system": "Scheduler"
    }
  }]
}

Empty Values

When calling a command, only the required fields need to be sent in. If your system does not have a value for a field (i.e. empty string, null, etc), do not pass it in or else it will be overwritten. For example:

❗️
Bad Request
The value of manifestNumber will get replaced with an empty string

{
  "commands": [{
    "commandType": "UpdateManifestDetails",
    "payload": {
      "scheduledStartLoadingTime": "2024-06-12T00:54:10.810Z",
      "manifestNumber": "      "
    },
    "referenceIds": {
      "loadNumber": "20240704-101023801"
    },
    "eventSource": {
      "system": "Scheduler"
    }
  }]
}

👍
Good Request
Omit all empty fields so values are not mistakenly overwritten

{
  "commands": [{
    "commandType": "UpdateManifestDetails",
    "payload": {
      "scheduledStartLoadingTime": "2024-06-12T00:54:10.810Z",
    },
    "referenceIds": {
      "loadNumber": "20240704-101023801"
    },
    "eventSource": {
      "system": "Scheduler"
    }
  }]
}

Clearing / Nulling Values

For the create and update commands, passing in null values in the payload will clear the respective field out. For example, if you wanted to remove the schedule loading time of a manifest, pass in null

{
  "commands": [{
    "commandType": "UpdateManifestDetails",
    "payload": {
      "scheduledStartLoadingTime": null
    },
    "referenceIds": {
      "loadNumber": "20240704-101023801"
    },
    "eventSource": {
      "system": "Scheduler"
    }
  }]
}

Similar to empty values, if your data feed has null values, it is recommended to not pass those into the commands unless you are intentionally trying to clear those fields out.

Manifest Commands

Create Manifest

Creates a new manifest.

Command Type

CreateManifest

Payload Fields

Name	Type	Description	Example	Required?
manifestNumber	string	Manifest Number	MVN1234	N
trailerNumber	string	Trailer # of assigned to manifest	HH53690	N
originLocationCode	string	Company location code identifier for the manifest origin	PGH	N
originDoorNumber	string	Origin location door number	11	N
destinationLocationCode	string	Company location code identifier for the manifest destination	CLV	N
destinationDoorNumber	string	Destination location door number	20	N
status	enum string	Defines the initial status of the manifest. Can be one of: PLANNING LOADING CLOSED DEPARTED_ORIGIN ARRIVED_DESTINATION UNLOADING COMPLETED OTHER	PLANNING	N
currentLocation	string	Defines the current location of a manifest. Can either be a company location code identifier or IN_TRANSIT	PGH or IN_TRANSIT	N
scheduledStartLoadingTime	ISO8601 string	Time when manifest is scheduled to begin loading	2024-06-12T00:54:10.810Z	N
scheduledCloseTime	ISO8601 string	Time when manifest is scheduled to be finished loading / trailer closed	2024-06-12T00:54:10.810Z	N
scheduledStartUnloadingTime	ISO8601 string	Time when manifest if scheduled to begin unloading	2024-06-12T00:54:10.810Z	N
scheduledFinishUnloadingTime	ISO8601 string	Time when manifest is scheduled to finish unloading	2024-06-12T00:54:10.810Z	N
associatedMovements	array of objects	Optionally define an array containing references to the movements associated to the manifest. See below for example	See Below	N
associatedShipments	array of objects	Array containing any shipments that exist on the manifest at the time of creation. See below for example	See Below	N
tags	array of strings	Array containing tags to associate to the manifest	["HIGH PRIORITY", "SHUTTLE"]	N
hazmat	bool	Does the manifest contain hazmat materials	true	N
poison	bool	Does the manifest contain poisonous materials	true	N
food	bool	Does the manifest contain food stuffs	true	N

associatedMovements

The associatedMovements field allows you to associate one or more movements when creating a manifest by passing in the reference IDs of the movements. The inverse operation (i.e. associating a manifest when creating a movement) is also supported in the CreateMovement command. If associatedMovements is used when creating a manifest, then the associatedManifest field does not need to be used when calling CreateMovement

The example below creates a manifest and defines 2 associated movements to the manifest.

{
  "commands": [{
    "commandType": "CreateManifest",
    "payload": {
      "originLocationCode": "PIT",
      "destinationLocationCode": "CLT",
      "manifestNumber": "823923",
      "associatedMovements": [{
        "referenceIds": {
          "legId": "20240704-leg-192389"
        }
      }, {
        referenceIds: {
          "legId": "20240704-leg-192390"
        }
      }]
    },
    "referenceIds": {
      "loadNumber": "20240704-101023801"
    },
  }]
}

associatedShipments

In most cases, manifests start our as empty shells with no shipments on them. When it comes time to plan/load/unload shipments on a manifest, you will be using the shipment level commands (i.e. PlanShipmentsOnManifest, LoadShipmentsOnManifest, etc..).

However, if you are creating a manifest with a known set of initial shipments, you can use the associatedShipments field to directly specify these initial shipments on manifest creation.

The assocaitedShipments field is an optional array of objects that contain the following fields:

proNumberThe PRO number of the shipment being sent. PRO numbers must exist in Maven's system prior to being added to manifests. POST /shipment
statusThe status of the shipment as it relates to the manifest. Possible values are "PLANNED", "LOADED", "UNLOADED"
locationAn optional field that allows you to specify the current location of the shipment if it is not yet loaded onto the manifest. This object contains three fields:
- locationCode - the company location code
- name - the facility location name (i.e. 22)
- type- the facility location type. Possible values are "door", "bay", "aisle"

{
  "commands": [{
    "commandType": "CreateManifest",
    "payload": {
      "originLocationCode": "PIT",
      "destinationLocationCode": "CLT",
      "manifestNumber": "823923",
      "status": "PLANNING",
      "associatedShipments": [{ 
        "proNumber": "91203901",
        "status": "PLANNED",
        "location": { // optional
          "locationCode": "PIT",
          "name": "22",
          "type": "aisle"
        }
      }, {
        "proNumber": "98123018",
        "status": "PLANNED",
        "location": { // optional
          "locationCode": "PIT",
          "name": "23",
          "type": "aisle"
        }
      }],
    },
    "referenceIds": {
      "loadNumber": "20240704-101023801"
    },
  }]
}

Once a manifest is created, further updates to shipments on manifests must be made using the respective commands.

Update Manifest Details

Updates the details of a manifest.

Command Type

UpdateManifestDetails

Payload Fields

Name	Type	Description	Example	Required?
manifestNumber	string	Manifest Number	MVN1234	N
trailerNumber	string	Trailer # of assigned to manifest	HH53690	N
originLocationCode	string	Company location code identifier for the manifest origin	PGH	N
originDoorNumber	string	Origin location door number	11	N
destinationLocationCode	string	Company location code identifier for the manifest destination	CLV	N
destinationDoorNumber	string	Destination location door number	20	N
currentLocation	string	Defines the current location of a manifest. Can either be a company location code identifier or IN_TRANSIT	PGH or IN_TRANSIT	N
scheduledStartLoadingTime	ISO8601 string	Time when manifest is scheduled to begin loading	2024-06-12T00:54:10.810Z	N
scheduledCloseTime	ISO8601 string	Time when manifest is scheduled to be finished loading / trailer closed	2024-06-12T00:54:10.810Z	N
scheduledStartUnloadingTime	ISO8601 string	Time when manifest if scheduled to begin unloading	2024-06-12T00:54:10.810Z	N
scheduledFinishUnloadingTime	ISO8601 string	Time when manifest is scheduled to finish unloading	2024-06-12T00:54:10.810Z	N
tags	array of strings	Array containing tags to associate to the manifest	["HIGH PRIORITY", "SHUTTLE"]	N
hazmat	bool	Does the manifest contain hazmat materials	true	N
poison	bool	Does the manifest contain poisonous materials	true	N
food	bool	Does the manifest contain food stuffs	true	N

Plan Shipments On Manifest

Associates planned shipments to a Manifest

Command Type

PlanShipmentsOnManifest

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N
shipments	array of objects	Array containing any shipments PLANNED on the Manifest. Option to provide details of the current location for each shipment. See below for example. locationCode = Terminal Code name = Name of the facility location where the shipment currently is (example: D18) type = Type of location (door, aisle)	See Below	N

Additional Details

Shipments will be added to the Manifest in a "PLANNED" Status

The shipments field is an optional array of objects that contain the following fields:

proNumberThe PRO number of the shipment being sent. PRO numbers must exist in Maven's system prior to being added to manifests. POST /shipment If a pro number does not exist in our system, the command will be rejected.
locationCode - the company location code
name - the facility location name (i.e. 22)
type- the facility location type. Possible values are "door", "bay", "aisle"

Example

{
  commandType: "PlanShipmentsOnManifest",
  payload: {
    eventTime: "ISO8601",
    shipments: [{
       proNumber: "string", 
       location:{
          locationCode: "string",
          name: "string",
          type: "string"
       }
       ]
  },
  referenceIds: {
    loadNumber: "2024-4-20-08234",
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Remove Shipments From Manifest

Removes a shipment's association to the referenced Manifest

Command Type

RemoveShipmentsFromManifest

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N
proNumbers	array of strings	Array of Pro Numbers for the shipments being removed	See Below	N

Additional Details

proNumberThe PRO number of the shipment being sent. PRO numbers must exist in Maven's system prior to being added to manifests. POST /shipment If a pro number does not exist in our system, the command will be rejected.

Example


{
  commandType: "RemoveShipmentsFromManifest",
  payload: {
    eventTime: "ISO8601",
    proNumbers: ["string", "string"]
  },
  referenceIds: {
    loadNumber: "2024-4-20-08234",
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Load Shipments On Manifest

Associates a proNumber in a "loaded" status to the referenced Manifest

Command Type

LoadShipmentsOnManifest

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N
ProNumbers	Array of strings	Array of Pro Numbers for the shipments being loaded on the manifest	["123423A"]	N
location	Object	Object indicating the locationCode and doorNumber of the manifest	See Below	N

Additional Details

Example


{
  commandType: "LoadShipmentsOnManifest",
  payload: {
    eventTime: "ISO8601",
    proNumbers: ["string", "string"],
    location: {
        locationCode: "string",
         doorNumber: "string"
    }
  
  },
  referenceIds: {
    loadNumber: "2024-4-20-08234",
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Unload Shipments On Manifest

Associates a proNumber in a "unloaded" status to the referenced Manifest

Command Type

UnloadShipmentsFromManifest

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N
ProNumbers	Array of strings	Array of Pro Numbers for the shipments being loaded on the manifest	["123423A"]	N
shipments	Array of Objects	Array containing shipments UNLOADED from the Manifest. Option to provide details of the current location for each shipment. See below for example.	See Below	N

Additional Details

The shipments field is an optional array of objects that contain the following fields:

proNumberThe PRO number of the shipment being sent. PRO numbers must exist in Maven's system prior to being added to manifests. POST /shipment If a pro number does not exist in our system, the command will be rejected.
locationCode - the company location code
name - the facility location name (i.e. 22)
type- the facility location type. Possible values are "door", "bay", "aisle"

Example


{
  commandType: "UnloadShipmentsOnManifest",
  payload: {
    eventTime: "ISO8601",
    shipments: {
        locationCode: "string",
         name: "string",
         type: "string"
    }
  
  },
  referenceIds: {
    loadNumber: "2024-4-20-08234",
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Start Loading Manifest

Updates manifest status to 'Loading' and can be used to update the location where the Manifest is being loaded.

Command Type

StartLoadingManifest

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N
location	Object	Location where the trailer is being loaded	See Below	N

Additional Details

The location field is an optional object that contain the following fields:

locationCode - the company location code
doorNumber - the facility location name (i.e. 22)

Example

{
  commandType: "StartLoadingManifest",
  payload: {
    eventTime: "ISO8601",
    location: {
      locationCode: "string",
      doorNumber: "string"
    }
  },
  referenceIds: {
    loadNumber: "2024-4-20-08234",
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Close Manifest

Updates manifest status to 'Closed' and can be used to update the location where the Manifest is closed.

Command Type

CloseManifest

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N
location	Object	Location where the trailer is being loaded	See Below	N

Additional Details

The location field is an optional object that contain the following fields:

locationCode - the company location code
doorNumber - the facility location name (i.e. 22)

Example

{
  commandType: "CloseManifest",
  payload: {
    eventTime: "ISO8601",
    location: {
       locationCode: "string",
       doorNumber: "string"
    }
  },
  referenceIds: {
    hookNumber: "123-2024-03-28",
    loadNumber: "CLT-KNV-101-2024-03-28"
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Cancel Manifest

Used to cancel the Manifest and any associated Movements. This will remove the Manifest from the Maven User Interface.

Command Type

CancelManifest

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N
Reason	string	Description of why the manifest was canceled	"No longer needed"	N

Additional Details

Canceling a manifest will result in the manifest and its movements to be canceled and no longer visible in the Maven UI. A canceled Manifest can be updated utilizing other commands and as a result will be visible in the User Interface.
New Movements cannot be added to a canceled manifest.

Example

{
  commandType: "CancelManifest",
  payload: {
    eventTime: "ISO8601",
    reason: "string" // optional
  },
  referenceIds: {
    loadNumber: "2024-4-20-08234",
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Start Unloading Manifest

Used when the trailer begins unloading to update the status of the manifest to 'unloading'

Command Type

StartUnloadingManifest

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N
Location	Object	Object indicating the unloading location of the trailer	See Below.	N

Additional Details

The location field is an optional object that contain the following fields:

locationCode - the company location code
doorNumber - the facility location name (i.e. 22)

Example

{
  commandType: "StartUnloadingManifest",
  payload: {
    eventTime: "ISO8601",
    location: {
     locationCode: "string",
     doorNumber: "string"
    }
  },
  referenceIds: {
    loadNumber: "2024-4-20-08234",
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Finish Unloading Manifest

Used when the unloading of the manifest is completed and sets the status of the manifest to 'unloaded'

Command Type

FinishUnloadingManifest

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N

Additional Details

Example

{
  commandType: "FinishUnloadingManifest",
  payload: {
    eventTime: "ISO8601"
  },
  referenceIds: {
    loadNumber: "2024-4-20-08234",
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Complete Manifest

Used when the Manifest is complete and updates the status of the manifest to be 'Completed'

Command Type

CompletedManifest

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N

Additional Details

Example

{
  commandType: "CompleteManifest",
  payload: {
    eventTime: "ISO8601"
  },
  referenceIds: {
    loadNumber: "2024-4-20-08234",
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Movement Commands

Create Movement

Command Type

CreateMovement

Payload Fields

Name	Type	Description	Example	Required?
originLocationCode	string	Company location code identifier for the movement origin	PGH	N
originDoorNumber	string	Origin location door number	11	N
destinationLocationCode	string	Company location code identifier for the movement destination	CLV	N
destinationDoorNumber	string	Destination location door number	20	N
sequenceNumber	int	Sequence number of movement	1	N
driverCodes	array of strings	ID of the drivers who are assigned to the movement. If this field is omitted or `null` is passed in, the movement is assumed to be unassigned.	["8012"]	N
vehicleNumber	string	Vehicle number assigned to the movement.	10293	N
scheduledAvailableTime	ISO8601 string	Time when the movement is scheduled to become available to the driver.	2024-06-12T00:54:10.810Z	N
scheduledDepartureTime	ISO8601 string	The time when the movement is scheduled to depart the origin location.	2024-06-12T00:54:10.810Z	N
scheduledArrivalTime	ISO8601 string	The time when the movement is scheduled to arrive at the destination location.	2024-06-12T00:54:10.810Z	N
associatedManifest	object	An object containing the associated manifest.	See Below	N
creationSource	string	Meta data about how the movement was created (i.e. from a schedule or adhoc)	scheduled	N

associatedManifest

The associatedManifest field allows you to associate a manifest when creating the movement by passing in the reference ID(s) of the manifest. The inverse operation (i.e. associating a movement when creating a manifest) is also supported in the CreateManifest command .

If associatedManifest is used when creating a movement, then the associatedMovements field does not need to be used when calling CreateManifest

Below is an example of associated a manifest when creating a movement.

{
  "commands": [{
    "commandType": "CreateMovement",
    "payload": {
      "originLocationCode": "PIT",
      "destinationLocationCode": "CLT",
      "associatedManifest": {
        "referenceIds": {
          "loadNumber": "20240704-101023801"
        }
      }
    },
    "referenceIds": {
      "legId": "20240704-leg-192389"
    },
  }]
}

Update Movement Details

Command Type

UpdateMovementDetails

Payload Fields

Name	Type	Description	Example	Required?
originLocationCode	string	Company location code identifier for the movement origin	PGH	N
originDoorNumber	string	Origin location door number	11	N
destinationLocationCode	string	Company location code identifier for the movement destination	CLV	N
destinationDoorNumber	string	Destination location door number	20	N
sequenceNumber	int	Sequence number of movement	1	N
vehicleNumber	string	Vehicle number assigned to the movement. Must exist in Maven.	10293	N
scheduledAvailableTime	ISO8601 string	Time when the movement is scheduled to become available to the driver.	2024-06-12T00:54:10.810Z	N
scheduledDepartureTime	ISO8601 string	The time when the movement is scheduled to depart the origin location.	2024-06-12T00:54:10.810Z	N
scheduledArrivalTime	ISO8601 string	The time when the movement is scheduled to arrive at the destination location.	2024-06-12T00:54:10.810Z	N
creationSource	string	Meta data about how the movement was created (i.e. from a schedule or adhoc)	scheduled	N

Assign Movement

Assigns a movement to a driver or array of drivers.

Command Type

AssignMovement

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N
driverCodes	Array of Strings	Driver codes to be assigned to the Movement. Must exist in Maven.	["ALEXA", "DG1"]	Y

Additional Details

driverCodes passed in must exist in Maven or the command will be rejected.
Command must contain all driver codes to be assigned to the Movement in a single command. For example, if the AssignMovement contains driverCodes ["ALEXA", "DG1"], both drivers will be assigned. If a second command is sent for the same Movement in this example (ie. ["ALEXA"]), the movement will ONLY be assigned to user with driverCode: ALEXA.

Example

{
  commandType: "AssignMovement",
  payload: {
    driverCodes: ["string","string"],
    eventTime: "ISO8601"
  },
  referenceIds: {
    legId: "2024-4-20-L230984"
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Unassign Movement

Unassigns a movement from all drivers.

Command Type

UnassignMovement

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N

Additional Details

This command will unassign the movement from all drivers previously assigned.

Example

{
  commandType: "UnassignMovement",
  payload: {
    eventTime: "ISO8601"
  },
  referenceIds: {
    legId: "2024-4-20-L230984"
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Mark Movement as Available

Indicates that the movement (and its associated Manifest) is ready to move from the movement's origin location.

Command Type

MarkMovementAsAvailable

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N

Additional Details

This movement is used to indicate when the trailer is available for this Movement. Most typically, this denotes loading of the manifest is completed or the manifest has arrived at a relay location (on a previous movement) and is ready for this movement to begin.

Example

{
  commandType: "MarkMovementAsAvailable",
  payload: {
    driverCode: "string",
    eventTime: "ISO8601"
  },
  referenceIds: {
    legId: "2024-4-20-L230984"
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Depart Movement

When the Movement has departed the origin location.

Command Type

DepartMovement

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N

Additional Details

Example

{
  commandType: "DepartMovement",
  payload: {
    eventTime: "ISO8601"
  },
  referenceIds: {
    legId: "2024-4-20-L230984"
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Arrive Movement

When the Movement arrives at its destination location.

Command Type

ArriveMovement

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N

Additional Details

Example

{
  commandType: "ArriveMovement",
  payload: {
    eventTime: "ISO8601"
  },
  referenceIds: {
    legId: "2024-4-20-L230984"
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Delete Movement

Used to delete a Movement.

Command Type

DeleteMovement

Payload Fields

Name	Type	Description	Example	Required?
eventTime	ISO8601 string	Time of the Event	2024-06-12T00:54:10.810Z	N

Additional Details

Deleting a Movement will result in the movement not being visible in the Maven User Interface.

Example

{
  commandType: "DeleteMovement",
  payload: {
    eventTime: "ISO8601"
  },
  referenceIds: {
    legId: "2024-4-20-L230984"
  },
  eventSource: {
    userId: "Gorziglia, Daniel",
    displayName: "Gorziglia, Daniel",
    system: "AS400"
  }
}

Overview

Skeleton Request

Multiple Commands

Empty Values

❗️Bad Request

👍Good Request

Clearing / Nulling Values

Manifest Commands

Create Manifest

Command Type

Payload Fields

associatedMovements

associatedShipments

Update Manifest Details

Command Type

Payload Fields

Plan Shipments On Manifest

Command Type

Payload Fields

Additional Details

Example

Remove Shipments From Manifest

Command Type

Payload Fields

Additional Details

Example

Load Shipments On Manifest

Command Type

Payload Fields

Additional Details

Example

Unload Shipments On Manifest

Command Type

Payload Fields

Additional Details

Example

Start Loading Manifest

Command Type

Payload Fields

Additional Details

Example

Close Manifest

Command Type

Payload Fields

Additional Details

Example

Cancel Manifest

Command Type

Payload Fields

Additional Details

Example

Start Unloading Manifest

Command Type

Payload Fields

Additional Details

Example

Finish Unloading Manifest

Command Type

Payload Fields

Additional Details

Example

Complete Manifest

Command Type

Payload Fields

Additional Details

Example

Movement Commands

Create Movement

Command Type

Payload Fields

associatedManifest

Update Movement Details

Command Type

Payload Fields

Assign Movement

Command Type

Payload Fields

Additional Details

Example

Unassign Movement

❗️
Bad Request

👍
Good Request