Dispatch Document API

UploadUrlRequest

object

Details of the upload URL request.

fileNamestring

The actual file name of the document including the file extension.

Example:example.txt

parentIdstring(uuid)

The parent resource of the document if not only the dispatch ID or listing ID. If the document pertains to a vehicle (bill, inspection document, etc.) it will be the vehicle ID.

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

displayNamestring

The display name of the document. If not provided, fileName will be used.

Example:Example document

Example

UploadUrlsResponse

object

Details of the upload URL response.

fileNamestring

The actual file name of the document including the file extension.

Example:example.txt

uploadUrlstring

The fully qualified URL to which the document should be uploaded.

Example:https://dispatch-scan.amazonaws.com/a3aef90b-4708-44ff-8a27-5c8e2ac5d151/0079a34f-f831-4ed3-965d-2ec896d03360?X-Amz-Expires=86400&X-Amz-Security-Token=IQoJb3JpZ2luX2VjELj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJIMEYCIQDycNVhEDtpB1MpoRav6%2FBm8CJ5kjwWOrZrcn3TM0CZrgIhALl8E%2BIPf2L035ePqKRkGrnsne4sfPD0v9YM%2FzUiFAAzKoIECMH%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQAhoMMjc3Mjg0MTQ2OTU1IgyfSbrc16Ybau2dws4q1gMz%2BWHFdTqcha%2BRgWLuucTuDY%2FDUmaq9MW9%2BX2wg61tJG2x4GRGae%2FlGjcP65KykEpFBP2qIjHOmSYDqfBhKC0BJNiTLBTWgvtJg4%2FsAdP2rMiKF3cn%2BuWe2ZbRsGYrqecsdvgnNgqjEa7jJ4dWvl4iWDCkgWDUtZku3bPBkFxvBwb%2FMW2h87y82HWQ2LHY5jXV%2BAxG5BHumMD4tZgUpLyb12V8Dji8nug8UtasgBJMIpVcVOoJqlXRn277hBZrgsyfRu4Yywgr596LYtKMejL4etpXutrowDy9wrrzap75DuZdTBssYT2fkkcB9crKkCVk85znpb0Wc83nxZU3wIKQqKoPJO9EExBYE%2FgiCEoKcVan5P9PZUwq2HaiRvENmhLNmCBUHk6HtqtZ%2Bi%2FSii%2BCZjOfeW5VZT9kOstERlxLXpedbhdDQ5fGauAPUNrsV0PbShPW8P%2F%2F0hQocbwN5KYMCr4Tm9Ca9LKQMDk8%2FdyIo13fCyUQcbMiJ6Wr9Vaq0WiVrvFFPFYN0Iaq58xnIvfq9xNtNTRAroaqRsLkDs2XIGrPuJWihXy4EJeju6GkKUtQ4VQXdasJM9I6W457zkrNIWkmpobzeF%2FtIQBFVKDObtVGY7WIWzC82vO8BjqkAdAAENKGjkI4KdfxF7NVnBhy53raffoYPTHsbBr2h2g685PfDHzUY3Qs8gvItv521NslLcG0GplWmofphdwhZPT55Y01GiaiuwKFho1XQIIfnwkgDCZtjkPPrlyuOIdcLCqZE8IEb%2FbkeM9QoyttKzb7J%2Fi8HXFAcZDKunkbCwaTtLEmR0As9gIaYBY3Ra47IZr2d4rprhEGXPPI2jK6bdJEG1U6&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAUBD3MJ4F7BVYHI74/20250131/us-east-1/s3/aws4_request&X-Amz-Date=20250131T194251Z&X-Amz-SignedHeaders=host&X-Amz-Signature=7d5e80a5f1e25f7a31b88dabeca478faae5feb3db4d1e2433f160a9f2a408df1

expiresUtcstring

The expiration date and time of the URL, in UTC/ISO 8601 format.

Example:2025-11-05T20:45:37.284Z

Example

VehicleResponse

object

Details of the vehicle information related to a dispatch.

vehicleIdstring(uuid)

The ID of the vehicle.

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

pickupInspectionDoneboolean

Indicates whether the pick up inspection is complete.

Example:true

deliveryInspectionDoneboolean

Indicates whether the delivery inspection is complete.

Example:true

Example