Stage - Dispatch Document API
Get Invoice PDF
Get the Invoice PDF file for the provided dispatch ID.
get
https://document-api.centraldispatch.com/dispatch-documents/id/dispatch/{dispatchId}/invoice
Path Parameters
dispatchIdstring(uuid)required
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
Headers
Acceptstringrequired
The MIME type of the expected content application/pdf.
Example:application/pdf
Response
application/pdf
Response
application/pdf
OK. Successful request.
PdfFile
PdfFileobject
PDF File.
get/dispatch-documents/id/dispatch/{dispatchId}/invoice
Authentication
Path Parameters
Headers
application/pdf
Get eBOL URLs
Get URLs for the provided dispatches to access each Electronic Bill of Lading (eBOL) PDF file.
post
https://document-api.centraldispatch.com/dispatch-documents/ebol/batch
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
Body
application/json
An array of dispatch IDs or fully qualified dispatch URLs.
array[string]
Response
application/json
Response
application/json
OK. Successful request.
ebolUrlResponseCollection
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
post/dispatch-documents/ebol/batch
Authentication
Headers
Body
[
"d159acc0-e89b-12d3-a456-426614174000",
"157a16f0-503d-4256-ba60-a4876e8eb9bb"
]
application/json
CreateUploadUrlsRequest
objectDetails of the request body to retrieve presigned URLs for document upload.
dispatchIdstring(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
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
Example
DocumentCollection
objectDetails of the dispatch documents.
documentsarray[object]
Details of a dispatch document.
Show Child Parameters
Example
DocumentData
objectDetails of a document.
dataobject
Details of the dispatch documents.
Show Child Parameters
Example