---
title: "Dispatch Document API"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-dispatch-document-api-1-0-0/versions/37a28be1-2b73-47a5-9171-d6fcf5977ad4"
---

# Dispatch Document API

OpenAPI specification document.

````json
{"openapi":"3.0.1","info":{"title":"Dispatch Document API","description":"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).\n 🔑 Scope: dispatchdocument_api","contact":{"email":"datasyndicationsupport@centraldispatch.com"},"version":"1.0.0"},"servers":[{"url":"https://document-api.centraldispatch.com","description":"Production server"}],"paths":{"/dispatch-documents/upload-urls":{"post":{"tags":["Dispatch Document"],"summary":"Create Upload URLs","description":"\nGet a temporary URL (or URLs) to upload a document.\n\n#### 📝 Important Notes\n- The URL is temporary and will expire after a short period.\n- Use the URL with a standard HTTP PUT request to upload the document.\n- Requires either dispatchId or listingId, both must not be provided in the same request.\n\n#### </> Example using the returned URL\n```bash\ncurl {uploadUrl} --upload-file {filename}\n```","operationId":"postUploadUrls","parameters":[{"name":"Content-Type","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"requestBody":{"description":"`CreateUploadUrlsRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUploadUrlsRequest"},"examples":{"sample single":{"value":{"dispatchId":"d159acc0-e89b-12d3-a456-426614174000","listingId":"42220470","documents":[{"displayName":"Example document","parentId":"dad00000-e89b-12d3-a456-426614174000","fileName":"example.txt"}]}},"sample multiple":{"value":{"dispatchId":"d159acc0-e89b-12d3-a456-426614174000","documents":[{"fileName":"Document.pdf"},{"displayName":"Example document","parentId":"dad00000-e89b-12d3-a456-426614174000","fileName":"example.txt"}]}}}}},"required":true},"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadUrlCollection"}}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Invalid `dispatchId` format.\n - Invalid request body structure.\n - Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - `dispatchId` not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.\n\n**Scenarios:**\n\n - Both `dispatchId` and `listingId` provided (mutually exclusive).\n - Neither `dispatchId` nor `listingId` provided (at least one required).\n - `fileName`not supplied.\n - `documents` array not supplied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/dispatch-documents/id/{dispatchDocumentId}":{"get":{"tags":["Dispatch Document"],"summary":"Get Document","description":"Get the document for the provided dispatch document ID.","operationId":"getDispatchDocumentById","parameters":[{"name":"dispatchDocumentId","in":"path","description":"The ID of the dispatch document.","required":true,"schema":{"type":"string","format":"uuid"},"example":"d0c00000-e89b-12d3-a456-426614174000"},{"name":"Accept","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - `dispatchDocumentId` not found.\n - Dispatch has been canceled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/dispatch-documents/id/dispatch/{dispatchId}":{"get":{"tags":["Dispatch Document"],"summary":"Get Documents by Dispatch ID","description":"Get all of the available documents for the provided dispatch ID.","operationId":"getDispatchDocumentsByDispatchId","parameters":[{"name":"dispatchId","in":"path","description":"The ID of the dispatch.","required":true,"schema":{"type":"string","format":"uuid"},"example":"d159acc0-e89b-12d3-a456-426614174000"},{"name":"Accept","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentData"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - `dispatchId` not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"409":{"description":"Conflict. Update not allowed based on the current resource state.\n\n**Scenarios:**\n\n - Dispatch has been canceled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/dispatch-documents/id/listing/{listingId}":{"get":{"tags":["Dispatch Document"],"summary":"Get Documents by Listing ID","description":"Get all of the available documents for the provided listing ID.","operationId":"getDispatchDocumentsByListingId","parameters":[{"name":"listingId","in":"path","description":"The ID of the listing.","required":true,"schema":{"type":"string"},"example":"42220470"},{"name":"Accept","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentData"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/dispatch-documents/id/dispatch/{dispatchId}/dispatch-sheet":{"get":{"tags":["Dispatch Document"],"summary":"Get Dispatch Sheet PDF","description":"Get the dispatch sheet PDF file for the provided dispatch ID.","operationId":"getDispatchSheetPdf","parameters":[{"name":"dispatchId","in":"path","description":"The ID of the dispatch.","required":true,"schema":{"type":"string","format":"uuid"},"example":"d159acc0-e89b-12d3-a456-426614174000"},{"name":"Accept","in":"header","description":"The MIME type of the expected content `application/pdf`.","required":true,"schema":{"type":"string"},"example":"application/pdf"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"Content-Type":{"description":"application/pdf","schema":{"type":"string"},"example":"True"},"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/PdfFile"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Dispatch not found.\n - Dispatch not delivered (required for this operation).\n - eBOL not available for dispatch.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"409":{"description":"Conflict. Update not allowed based on the current resource state.\n\n**Scenarios:**\n\n - Dispatch Not Signed.\n - Dispatch Canceled.\n - Dispatch in invalid state for this operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/dispatch-documents/id/dispatch/{dispatchId}/bill-of-lading":{"get":{"tags":["Dispatch Document"],"summary":"Get eBOL PDF","description":"Get the Electronic Bill of Lading (eBOL) PDF file for the provided dispatch ID.","operationId":"getBillOfLadingPdf","parameters":[{"name":"dispatchId","in":"path","description":"The ID of the dispatch.","required":true,"schema":{"type":"string","format":"uuid"},"example":"d159acc0-e89b-12d3-a456-426614174000"},{"name":"Accept","in":"header","description":"The MIME type of the expected content `application/pdf`.","required":true,"schema":{"type":"string"},"example":"application/pdf"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"Content-Type":{"description":"application/pdf","schema":{"type":"string"},"example":"True"},"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/PdfFile"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Dispatch not found.\n - Dispatch not delivered (required for this operation).\n - eBOL not available for dispatch.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"409":{"description":"Conflict. Update not allowed based on the current resource state.\n\n**Scenarios:**\n\n - Dispatch Not Signed.\n - Dispatch Canceled.\n - Dispatch in invalid state for this operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"415":{"description":"Unsupported Media Type\n\n**Scenarios:**\n\n - Missing Accept header.\n - Accept header is not `application/pdf`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/dispatch-documents/id/dispatch/{dispatchId}/invoice":{"get":{"tags":["Dispatch Document"],"summary":"Get Invoice PDF","description":"Get the Invoice PDF file for the provided dispatch ID.","operationId":"getInvoicePdf","parameters":[{"name":"dispatchId","in":"path","description":"The ID of the dispatch.","required":true,"schema":{"type":"string","format":"uuid"},"example":"d159acc0-e89b-12d3-a456-426614174000"},{"name":"Accept","in":"header","description":"The MIME type of the expected content `application/pdf`.","required":true,"schema":{"type":"string"},"example":"application/pdf"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"Content-Type":{"description":"application/pdf","schema":{"type":"string"},"example":"True"},"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/PdfFile"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Dispatch not found.\n - Dispatch not delivered (required for this operation).\n - eBOL not available for dispatch.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"409":{"description":"Conflict. Update not allowed based on the current resource state.\n\n**Scenarios:**\n\n - Dispatch Not Signed.\n - Dispatch Canceled.\n - Dispatch in invalid state for this operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"415":{"description":"Unsupported Media Type\n\n**Scenarios:**\n\n - Missing Accept header.\n - Accept header is not `application/pdf`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/dispatch-documents/ebol/batch":{"post":{"tags":["Dispatch Document"],"summary":"Get eBOL URLs","description":"Get URLs for the provided dispatches to access each Electronic Bill of Lading (eBOL) PDF file.","operationId":"postEbolUrls","parameters":[{"name":"Content-Type","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"requestBody":{"description":"An array of dispatch IDs or fully qualified dispatch URLs.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"examples":{"sample with IDs":{"value":["d159acc0-e89b-12d3-a456-426614174000","157a16f0-503d-4256-ba60-a4876e8eb9bb"]},"sample with URLs":{"value":["https://document-api.centraldispatch.com/dispatch-documents/id/d159acc0-e89b-12d3-a456-426614174000","https://document-api.centraldispatch.com/dispatch-documents/id/2539f4b4-d3d6-45db-8df3-7ba768caba9b"]}}}},"required":true},"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ebolUrlResponseCollection"}}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Invalid UUID passed.\n - Invalid `dispatchId` format.\n - Invalid request body structure.\n - Duplicate `disptachId` passed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - One or more of the dispatches could not be found. Note: If any single dispatch is not found, the entire batch request will fail.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.\n\n**Scenarios:**\n\n - One or more of the dispatches were found but do not have an available eBOL (either not delivered or canceled).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}}},"components":{"schemas":{"CreateUploadUrlsRequest":{"type":"object","properties":{"dispatchId":{"type":"string","description":"The ID of the dispatch to associate the document with. Required if `listingId` is null. Not allowed if `listingId` is provided.","format":"uuid","nullable":true,"example":"d159acc0-e89b-12d3-a456-426614174000"},"listingId":{"type":"string","description":"The ID of the listing to associate the document with. Required if `dispatchId` is null. Not allowed if `disptachId` is provided.","nullable":true,"example":"42220470"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/UploadUrlRequest"},"description":"Details of the documents to be uploaded."}},"description":"Details of the request body to retrieve presigned URLs for document upload."},"DocumentCollection":{"type":"object","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentResponse"},"description":"A collection of documents."}},"description":"Details of the dispatch documents."},"DocumentData":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DocumentCollection"}},"description":"Details of a document."},"DocumentResponse":{"type":"object","properties":{"href":{"type":"string","description":"The fully qualified URL of the dispatch document.","example":"https://document-api.centraldispatch.com/dispatch-documents/id/d0c00000-e89b-12d3-a456-426614174000"},"dispatchDocumentId":{"type":"string","description":"The ID of the dispatch document.","format":"uuid","example":"d0c00000-e89b-12d3-a456-426614174000"},"dispatchId":{"type":"string","description":"If the document is linked to a dispatch, this is the associated dispatch ID.","format":"uuid","nullable":true,"example":"d159acc0-e89b-12d3-a456-426614174000"},"listingId":{"type":"string","description":"If the document is linked to a listing, this is the associated listing ID.","nullable":true,"example":"42220470"},"marketplaceId":{"type":"integer","description":"The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:\r\n\r\n- **Public**: The public Marketplace ID is `10000`.\r\n- **Test**: Test Marketplace IDs will be provided to you by Central Dispatch.\r\n- **Private**: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.","format":"int32","nullable":true,"example":10000},"parentId":{"type":"string","description":"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.","format":"uuid","nullable":true,"example":"dad00000-e89b-12d3-a456-426614174000"},"parentType":{"type":"string","description":"The type of record the document belongs to. Values: `DISPATCH`, `EXPENSE`, `LISTING`, `STOP`, `VEHICLE`.","example":"DISPATCH"},"ownerAccountId":{"type":"string","description":"The ID of the owner's account.","format":"uuid","example":"ce000000-e89b-12d3-a456-426614174000"},"fileName":{"type":"string","description":"The actual file name of the document including the file extension.","example":"example.txt"},"displayName":{"type":"string","description":"The display name of the document.","example":"Example document"},"documentDownloadUrl":{"type":"string","description":"The URL that may be used to download the document. This will not be populated until the virus scan passes.","nullable":true,"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"},"profileType":{"type":"string","description":"The type of user that uploaded the document. Values: `CARRIER`, `SHIPPER`.","example":"SHIPPER"},"createdDateTime":{"type":"string","description":"The date and time the document was created, in UTC/ISO 8601 format.","example":"2024-10-31T00:00:00Z"},"updateByUserId":{"type":"string","description":"The Central Dispatch user ID of the user who last updated the document.","format":"uuid","example":"d71b5750-e89b-12d3-a456-426614174000"},"scanStatus":{"$ref":"#/components/schemas/ScanStatus"}},"description":"Details of a dispatch document."},"ebolUrlResponse":{"type":"object","properties":{"href":{"type":"string","description":"The fully qualified URL of the dispatch.","example":"https://fulfillment-api.manheim.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000"},"dispatchId":{"type":"string","description":"The ID of the dispatch.","example":"d159acc0-e89b-12d3-a456-426614174000"},"marketplaceId":{"minimum":3000,"type":"integer","description":"The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:\r\n\r\n- **Public**: The public Marketplace ID is `10000`.\r\n- **Test**: Test Marketplace IDs will be provided to you by Central Dispatch.\r\n- **Private**: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.","format":"int32","example":10000},"ebolUrl":{"type":"string","description":"The download URL of the eBOL PDF.","example":"https://ebol-app.manheim.com/ebol/pdf/id/d159acc0-e89b-12d3-a456-426614174000"},"vehicles":{"type":"array","items":{"$ref":"#/components/schemas/VehicleResponse"},"description":"A collection of vehicles associated with the eBOL."},"pickupInspectionCompletedBy":{"type":"string","description":"The Central Dispatch user ID of the user who completed the pick up inspection.","format":"uuid","nullable":true,"example":"d71b5750-e89b-12d3-a456-426614174000"},"dropoffInspectionCompletedBy":{"type":"string","description":"The Central Dispatch user ID of the user who completed the delivery inspection.","format":"uuid","nullable":true,"example":"3ca6e1c2-98fb-4b4e-bfd8-ffaec58fb347"}},"description":"Details of the Electronic Bill of Lading (eBOL)."},"ebolUrlResponseCollection":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ebolUrlResponse"},"description":"A collection of records."},"count":{"minimum":1,"type":"integer","description":"The total count of resources in the collection.","format":"int32","example":1}},"description":"Details of the Electronic Bill of Lading (eBOL) URL response."},"EmptyResponse":{"type":"object","description":"No response."},"Error":{"type":"object","properties":{"code":{"type":"string","description":"The code used for the issue.","nullable":true,"example":"resource.issue_type"},"message":{"type":"string","description":"A detailed message.","nullable":true,"example":"The issue happened because something is wrong."},"property":{"type":"string","description":"The property to which the issue is associated.","nullable":true,"example":"person"},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional properties related to the issue.","nullable":true,"example":{"firstName":"D0nn@","lastName":"Sm!th"}}},"description":"Details of an error or issue."},"Errors":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"A collection of errors.","nullable":true}},"description":"An error occurred, and the request could not be completed."},"PdfFile":{"type":"object","description":"PDF File."},"ScanStatus":{"enum":["SCAN_NOT_SUPPORTED","NOT_SCANNED","SUCCESS","FAILED"],"description":"The status of the virus scan on the document. This list is not exhaustive and additional values may be added at any time.","example":"SUCCESS"},"UploadUrlCollection":{"type":"object","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/UploadUrlsResponse"},"description":"A collection of presigned URLs."}},"description":"Details of the upload URL response."},"UploadUrlRequest":{"type":"object","properties":{"fileName":{"type":"string","description":"The actual file name of the document including the file extension.","example":"example.txt"},"parentId":{"type":"string","description":"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.","format":"uuid","nullable":true,"example":"dad00000-e89b-12d3-a456-426614174000"},"displayName":{"type":"string","description":"The display name of the document. If not provided, `fileName` will be used.","nullable":true,"example":"Example document"}},"description":"Details of the upload URL request."},"UploadUrlsResponse":{"type":"object","properties":{"fileName":{"type":"string","description":"The actual file name of the document including the file extension.","example":"example.txt"},"uploadUrl":{"type":"string","description":"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"},"expiresUtc":{"type":"string","description":"The expiration date and time of the URL, in UTC/ISO 8601 format.","example":"2025-11-05T20:45:37.284Z"}},"description":"Details of the upload URL response."},"VehicleResponse":{"type":"object","properties":{"vehicleId":{"type":"string","description":"The ID of the vehicle.","format":"uuid","example":"b331c130-e89b-12d3-a456-426614174000"},"pickupInspectionDone":{"type":"boolean","description":"Indicates whether the pick up inspection is complete.","example":true},"deliveryInspectionDone":{"type":"boolean","description":"Indicates whether the delivery inspection is complete.","example":true}},"description":"Details of the vehicle information related to a dispatch."}},"securitySchemes":{"Bearer":{"type":"http","scheme":"Bearer"}}},"tags":[{"name":"Dispatch Document"}]}
````