Search
K
Dispatch Document API

Dispatch Document API

1.0.0OAS 3.0

Central Dispatch’s Documents API allows customers to manage, upload, and retrieve dispatch-related documents for automotive logistics workflows. It supports operations for both dispatches and listings, including document upload (with presigned URLs), retrieval by dispatch or listing ID, batch operations, and PDF generation for dispatch sheets, invoices, and electronic bills of lading (EBOL).
🔑 Scope: dispatchdocument_api

API Base URL
  • Server 1:https://document-api.centraldispatch.com

    Production server

Security
Bearer (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Additional Information
Contact (datasyndicationsupport@centraldispatch.com)

Dispatch Document

Create Upload URLs

Get a temporary URL (or URLs) to upload a document.

📝 Important Notes

  • The URL is temporary and will expire after a short period.
  • Use the URL with a standard HTTP PUT request to upload the document.
  • Requires either dispatchId or listingId, both must not be provided in the same request.

</> Example using the returned URL

curl {uploadUrl} --upload-file {filename}
post
https://document-api.centraldispatch.com/dispatch-documents/upload-urls

Headers

Content-Typestringrequired

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

Body

application/json

CreateUploadUrlsRequest

CreateUploadUrlsRequest

Details of the request body to retrieve presigned URLs for document upload.

dispatchIdstring | null(uuid)

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

listingIdstring | null

The ID of the listing to associate the document with. Required if dispatchId is null. Not allowed if disptachId is provided.

Example:42220470

documentsarray[object]

Details of the upload URL request.

Show Child Parameters

Response

application/json

OK. Successful request.

UploadUrlCollection

Details of the upload URL response.

documentsarray[object]

Details of the upload URL response.

Show Child Parameters
post/dispatch-documents/upload-urls

Body

{ "dispatchId": "d159acc0-e89b-12d3-a456-426614174000", "listingId": "42220470", "documents": [ { "displayName": "Example document", "parentId": "dad00000-e89b-12d3-a456-426614174000", "fileName": "example.txt" } ] }
 
application/json