--- title: "Get Document" url: "https://stage-api-docs.centraldispatch.com/apis/stage-dispatch-document-api-1-0-0/versions/37a28be1-2b73-47a5-9171-d6fcf5977ad4/operations/getDispatchDocumentById" --- > Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-dispatch-document-api-1-0-0/versions/37a28be1-2b73-47a5-9171-d6fcf5977ad4.md # Get Document `GET` `/dispatch-documents/id/{dispatchDocumentId}` Operation ID: `getDispatchDocumentById` Get the document for the provided dispatch document ID. ## Path parameters - `dispatchDocumentId` (string, uuid, required) - The ID of the dispatch document. ## Header parameters - `Accept` (string, required) - 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`. ## Responses - `200` - OK. Successful request. - `401` - Unauthorized. Authentication failed or missing. - `403` - Forbidden. The attempted action is not permitted. - `404` - Not Found. **Scenarios:** - `dispatchDocumentId` not found. - Dispatch has been canceled. - `429` - Too Many Requests. Rate limit exceeded. - `500` - Error. - `503` - Service Unavailable. Temporary service interruption. ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Dispatch Document API version: 1.0.0 servers: - url: https://document-api.centraldispatch.com description: Production server paths: /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. **Scenarios:** - `dispatchDocumentId` not found. - 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: [] security: - Bearer: [] components: schemas: 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 \r - **Public**: The public Marketplace ID is `10000`.\r - **Test**: Test Marketplace IDs will be provided to you by Central Dispatch.\r - **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. EmptyResponse: type: object description: No response. 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. 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 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. securitySchemes: Bearer: type: http scheme: Bearer ```