Dispatch Document API

ebolUrlResponse

object

Details of the Electronic Bill of Lading (eBOL).

hrefstring

The fully qualified URL of the dispatch.

Example:https://fulfillment-api.manheim.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000

dispatchIdstring

The ID of the dispatch.

Example:d159acc0-e89b-12d3-a456-426614174000

marketplaceIdinteger(int32)

The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:

  • Public: The public Marketplace ID is 10000.
  • Test: Test Marketplace IDs will be provided to you by Central Dispatch.
  • Private: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.

>= 3000

Example:10000

ebolUrlstring

The download URL of the eBOL PDF.

Example:https://ebol-app.manheim.com/ebol/pdf/id/d159acc0-e89b-12d3-a456-426614174000

vehiclesarray[object]

Details of the vehicle information related to a dispatch.

Show Child Parameters
pickupInspectionCompletedBystring(uuid)

The Central Dispatch user ID of the user who completed the pick up inspection.

Example:d71b5750-e89b-12d3-a456-426614174000

dropoffInspectionCompletedBystring(uuid)

The Central Dispatch user ID of the user who completed the delivery inspection.

Example:3ca6e1c2-98fb-4b4e-bfd8-ffaec58fb347

Example

ebolUrlResponseCollection

object

Details of the Electronic Bill of Lading (eBOL) URL response.

itemsarray[object]

Details of the Electronic Bill of Lading (eBOL).

Show Child Parameters
countinteger(int32)

The total count of resources in the collection.

>= 1

Example:1

Example

EmptyResponse

object

No response.

Error

object

Details of an error or issue.

codestring

The code used for the issue.

Example:resource.issue_type

descriptionstring

A detailed message.

Example:The issue happened because something is wrong.

propertystring

The property to which the issue is associated.

Example:person

propertiesobject

Additional properties related to the issue.

Example:{"firstName":"D0nn@","lastName":"Sm!th"}

Example

ErrorMessage

object

An error occurred, and the request could not be completed.

messagestring

A message about the error.

Example