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

> Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-dispatch-document-api-1-0-0/versions/37a28be1-2b73-47a5-9171-d6fcf5977ad4.md

# ebolUrlResponseCollection

Details of the Electronic Bill of Lading (eBOL) URL response.

## 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
components:
  schemas:
    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).
    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.
    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.
```