POST /manifests

post

https://integrations.mavenmachines.com/companies/{companyKey}/manifests

Creates or updates a manifest in the Maven system

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

associatedRouteCode

string

Route code this manifest is associated with. Required field for manifests to be shown on Grid View. Must be set up beforehand during integration phase.

manifestStatus

string

enum

required

Status of the manifest

Allowed:

manifestNumber

string

required

External identifier of the manifest. Will trigger an update operation if request is sent in with a manifestNumber that already exists in the Maven system.

routeUniqueId

string

The unique ID generated when a route is created. This is an auto-generated field that can be used to uniquely identify a route.

manifestName

string

Displayed name for this manifest in the driver app and dispatcher portal.

manifestDate

date

The day that the manifest is going to be started. Defaults to the current date.

terminalCode

string

required

The terminal that owns the manifest.

driverCode

string

The driver assigned to the manifest.

driverName

string

The name of the driver on the manifest. If a driverCode is present, this field will be ignored.

vehicleNumber

string

The vehicle assigned to the manifest.

trailerNumber

string

The trailer assigned to the manifest

dock

int32

The dock number where the manifest is loaded.

associatedShipments

array of objects

Shipments associated with the manifest

associatedShipments

optimizeStops

boolean

If enabled, Maven route optimization will be used to set the recommended order in which shipments on the manifest should be completed.

optimizationOptions

object

Additional options that can be configured for Maven route optimization.

beginDwellTimeMin

int32

The number of minutes a driver will spend at the terminal between starting their route and departing the terminal.

endDwellTimeMin

int32

The number of minutes a driver will spend at the terminal between arriving at the terminal and ending their route.

Responses

200200

400400

500500