Delivery Manifests

A manifest (also known as a route instance) will be created in the Maven system. For each shipment in the associatedShipments array, a shipment will be created in the Maven system along with its own stop.

Updates:

If a postManifest request is sent in with a manifestNumber that does not exist in the Maven system, a new manifest will be created. If a postManifest is sent in with a manifestNumber that does exist in the Maven system, this request will trigger an update operation.

During updates, if an associatedShipment object with a shipment PRO or REF number is sent in that already exists in the Maven system, this existing shipment will be placed on the request's manifest, so long as it is not in an active/running state (i.e. a driver is in the process of completing the shipment).

Route Information:
A route code (associatedRouteCode) must be provided in the request in order for this manifest to appear in the Grid View. This field must map to the same route record in the Maven System, and must be set up during the initial integration phase with Maven Machines.

Other Information:
Please note that a location is required for shipment types "pickup" and "checkstop". A location is either: an existing customerNumber or a customer name + address fields. The system will prefer the following fields, in order:

If pickup/checkstop:

  • shipperCustomerNumber - refers to an existing customer record. (customer record uploaded via postCustomer)
  • shipperCustomerName + address fields:
    • shipperCustomerAddress
    • shipperCustomerCity
    • shipperCustomerState
    • shipperCustomerZip
    • shipperCustomerCountry
  • Optional: a consigneeCustomerNumber can be sent in + stored, as well as the consigneeCustomerName + address fields. Not all consignee address fields are required.