Get a temporary URL (or URLs) to upload a document.
curl {uploadUrl} --upload-file {filename}
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
CreateUploadUrlsRequest
Details of the request body to retrieve presigned URLs for document upload.
The ID of the dispatch to associate the document with. Required if listingId is null. Not allowed if listingId is provided.
Example:d159acc0-e89b-12d3-a456-426614174000
The ID of the listing to associate the document with. Required if dispatchId is null. Not allowed if disptachId is provided.
Example:42220470
Details of the upload URL request.
OK. Successful request.
Details of the upload URL response.
Details of the upload URL response.
Get the document for the provided dispatch document ID.
The ID of the dispatch document.
Example:d0c00000-e89b-12d3-a456-426614174000
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
OK. Successful request.
Details of a dispatch document.
The fully qualified URL of the dispatch document.
Example:https://document-api.centraldispatch.com/dispatch-documents/id/d0c00000-e89b-12d3-a456-426614174000
The ID of the dispatch document.
Example:d0c00000-e89b-12d3-a456-426614174000
If the document is linked to a dispatch, this is the associated dispatch ID.
Example:d159acc0-e89b-12d3-a456-426614174000
If the document is linked to a listing, this is the associated listing ID.
Example:42220470
The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:
10000.Example:10000
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
The type of record the document belongs to. Values: DISPATCH, LISTING, VEHICLE.
Example:DISPATCH
The ID of the owner’s account.
Example:ce000000-e89b-12d3-a456-426614174000
The actual file name of the document including the file extension.
Example:example.txt
The display name of the document.
Example:Example document
The URL that may be used to download the document. This will not be populated until the virus scan passes.
Example:https://dispatch-scan.amazonaws.com/7085e98e-b05a-4385-b181-853fbd09ac5b/07529f23-b716-4666-9049-b97631e57fe2?X-Amz-Expires=86400&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEL7%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCICVzxbaz7GORTbE1eiw%2BMQOyx3atvEcsO1fG%2FyejTlKbAiEA7J9xO3uUJZYAGbQD5EwAocX%2FXfysldJc0MjL%2FZtsuJQqggQIx%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARACGgwyNzcyODQxNDY5NTUiDM3cnPJIy7yKuZfdGCrWA4palrdInlKU6u51SUWOKhiJQKKDdYOPaHpQcd24ufZuDXw%2F%2F%2FpsPmtI8Tot3Dnr5MSoaX4aRYlR5jSipRi9OTx36JLBZjEsDRl4STkeKj%2BCHuEYvYwiFprmLbzGmjD3qgeHsIwjGl2CyGTeKrxl65CHqSLv%2FWTMBaqwZG%2FGkydazKz9Vd8dq6%2BIlhOZtxZKM%2Bp79Pw2Wx9mWqQkRmZTS05FU5sSBcFN77Q9GPWB1lxpIrZRnVRLrhik3CjsdoLYRCdyHonvPRH0Ur7hGnLb%2BDbpGZkF5NnDKtwLvF8SWOt%2Fn020iEvnSPW6OKAaYt9dvHeTtxVQbeEehZD%2FC8AeLDG2RaJpJedstvYTmG3Vf7iknYwy82Ls4o3g8tVWVSvjMM%2FA0Wo2ent%2BVQg9qXJSN57iKMyo13gFcnqw1syc1SuydJ5YnbM%2Fsfr39CBnx7A6Oqs0JYv8wSfjMtafEJvmNIR6iW9G9YXmDABYNolKcW05sSO1jxaoogZm0X1N%2By0VRwbc0Vjv8AmHGh09EPEyhND6cYDMB7mmLyPi05FsyqwwYlH%2FtpgsNFqPJYEjyrlhN%2FD5jnMy%2BrUjwgrIjQBhTPUTEehB%2Fpt%2B%2BH8Fh6Fqs1WSAnvEm4TJMPuB9bwGOqUBpVOtGdAVIb3YHJxQI3k3hQtkDnA4pc%2BiL9u43W8BSxrxDSkFuSps8m%2BMdtvLwVIaXZPAWfxvMSSCudqwqRmx%2FFYz5WE78kfp0B6UueN9brj8OZYjmExtwkMEC0Iizjdfzqlki1RELIthscG9BlXy9knuxkYXxsjAnddYB4RvC%2FbiEoyl6t2%2BEHhJde5h8TFv8ddsABQr3Jwt%2Bc4kU5RYPM10OEAO&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAUBD3MJ4FRIRV4X5Y/20250131/us-east-1/s3/aws4_request&X-Amz-Date=20250131T234732Z&X-Amz-SignedHeaders=host&X-Amz-Signature=9a96b4cfb57c70f1bb1d90a2854e9332c88a4c8b330d3f223d5c80b5bddd57a5
The type of user that uploaded the document. Values: CARRIER, SHIPPER.
Example:SHIPPER
The date and time the document was created, in UTC/ISO 8601 format.
Example:2024-10-31T00:00:00Z
The Central Dispatch user ID of the user who last updated the document.
Example:d71b5750-e89b-12d3-a456-426614174000
The status of the virus scan on the document.
Allowed values:SCAN_NOT_SUPPORTEDNOT_SCANNEDSUCCESSFAILED
Example:SUCCESS
Get all of the available documents for the provided dispatch ID.
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
OK. Successful request.
Details of a document.
Details of the dispatch documents.
Get all of the available documents for the provided listing ID.
The ID of the listing.
Example:42220470
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
OK. Successful request.
Details of a document.
Details of the dispatch documents.
Get the dispatch sheet PDF file for the provided dispatch ID.
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+pdf.
Example:application/vnd.coxauto.v1+pdf
OK. Successful request.
PDF File.