Stage - Dispatch Document API
Get Documents by Dispatch ID
Get all of the available documents for the provided dispatch ID.
get
https://document-api.centraldispatch.com/dispatch-documents/id/dispatch/{dispatchId}
Path Parameters
dispatchIdstring(uuid)required
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
Headers
Acceptstringrequired
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
Response
application/json
Response
application/json
OK. Successful request.
DocumentData
Details of a document.
dataobject
Details of the dispatch documents.
Show Child Parameters
get/dispatch-documents/id/dispatch/{dispatchId}
Authentication
Path Parameters
Headers
application/json
Get Documents by Listing ID
Get all of the available documents for the provided listing ID.
get
https://document-api.centraldispatch.com/dispatch-documents/id/listing/{listingId}
Path Parameters
listingIdstringrequired
The ID of the listing.
Example:42220470
Headers
Acceptstringrequired
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
Response
application/json
Response
application/json
OK. Successful request.
DocumentData
Details of a document.
dataobject
Details of the dispatch documents.
Show Child Parameters
get/dispatch-documents/id/listing/{listingId}
Authentication
Path Parameters
Headers
application/json
Get Dispatch Sheet PDF
Get the dispatch sheet PDF file for the provided dispatch ID.
get
https://document-api.centraldispatch.com/dispatch-documents/id/dispatch/{dispatchId}/dispatch-sheet
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}/dispatch-sheet
Authentication
Path Parameters
Headers
application/pdf
Get eBOL PDF
Get the Electronic Bill of Lading (eBOL) PDF file for the provided dispatch ID.
get
https://document-api.centraldispatch.com/dispatch-documents/id/dispatch/{dispatchId}/bill-of-lading
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}/bill-of-lading
Authentication
Path Parameters
Headers
application/pdf
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