---
title: "Get eBOL PDF"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-dispatch-document-api-1-0-0/versions/37a28be1-2b73-47a5-9171-d6fcf5977ad4/operations/getBillOfLadingPdf"
---

> 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 PDF

`GET` `/dispatch-documents/id/dispatch/{dispatchId}/bill-of-lading`

Operation ID: `getBillOfLadingPdf`

Get the Electronic Bill of Lading (eBOL) PDF file for the provided dispatch ID.

## Path parameters

- `dispatchId` (string, uuid, required) - The ID of the dispatch.

## Header parameters

- `Accept` (string, required) - The MIME type of the expected content `application/pdf`.

## Responses

- `200` - OK. Successful request.
- `401` - Unauthorized. Authentication failed or missing.
- `403` - Forbidden. The attempted action is not permitted.
- `404` - Not Found. **Scenarios:** - Dispatch not found. - Dispatch not delivered (required for this operation). - eBOL not available for dispatch.
- `409` - Conflict. Update not allowed based on the current resource state. **Scenarios:** - Dispatch Not Signed. - Dispatch Canceled. - Dispatch in invalid state for this operation.
- `415` - Unsupported Media Type **Scenarios:** - Missing Accept header. - Accept header is not `application/pdf`.
- `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/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.

            **Scenarios:**

             - Dispatch not found.
             - Dispatch not delivered (required for this operation).
             - 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.

            **Scenarios:**

             - Dispatch Not Signed.
             - Dispatch Canceled.
             - Dispatch in invalid state for this operation.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Errors"
        "415":
          description: |-
            Unsupported Media Type

            **Scenarios:**

             - Missing Accept header.
             - 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: []
security:
  - Bearer: []
components:
  schemas:
    PdfFile:
      type: object
      description: PDF File.
    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.
    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
```