--- title: "Get eBOL URLs" url: "https://stage-api-docs.centraldispatch.com/apis/stage-dispatch-document-api-1-0-0/versions/37a28be1-2b73-47a5-9171-d6fcf5977ad4/operations/postEbolUrls" --- > 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 eBOL URLs `POST` `/dispatch-documents/ebol/batch` Operation ID: `postEbolUrls` Get URLs for the provided dispatches to access each Electronic Bill of Lading (eBOL) PDF file. ## Header parameters - `Content-Type` (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 Content-Type header should be set to `application/vnd.coxauto.v1+json`. ## Request body (required) Content types: `application/json` ## Responses - `200` - OK. Successful request. - `400` - Bad Request. Check the request payload. **Scenarios:** - Invalid UUID passed. - Invalid `dispatchId` format. - Invalid request body structure. - Duplicate `disptachId` passed. - `401` - Unauthorized. Authentication failed or missing. - `403` - Forbidden. The attempted action is not permitted. - `404` - Not Found. **Scenarios:** - One or more of the dispatches could not be found. Note: If any single dispatch is not found, the entire batch request will fail. - `422` - Unprocessable Entity. Errors found in the request. **Scenarios:** - One or more of the dispatches were found but do not have an available eBOL (either not delivered or 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/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. **Scenarios:** - Invalid UUID passed. - Invalid `dispatchId` format. - Invalid request body structure. - 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. **Scenarios:** - 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. **Scenarios:** - 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: [] security: - Bearer: [] components: schemas: 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. 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. 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 \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 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). 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. 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 ```