> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List device deliveries

> Returns the device's delivery per VPP event interval within the window, across every event it was in: committed power and energy, delivered energy, coverage and fulfillment. Delivery is measured from meter records; intervals no meter records cover are `UNREPORTED`. An interval in which the device was given no share is `NOT_COMMITTED`.



## OpenAPI

````yaml fleet-api/reference/flatpeak-api-spec-fleet.json GET /devices/{device_id}/deliveries
openapi: 3.0.3
info:
  description: >-
    The Flatpeak Fleet API. VPP operators use it to enroll, dispatch and settle
    OEM device fleets.


    ## Authentication

    Exchange your `account_id` and `secret_key` for a bearer token at `POST
    /auth/tokens` with basic auth. Send it as `Authorization: Bearer <token>` on
    every request.


    ## Base URL

    `https://fleet-api.flatpeak.com`


    ## Pagination

    Lists return `data`, `next_cursor` and `url`. Pass `next_cursor` as `cursor`
    until it is `null`. A cursor is opaque and bound to the endpoint and query
    parameters that issued it.


    ## Errors

    Every non-2xx response carries `object`, `type`, `code` and `message`.
    Branch on `code`.


    ## Money and energy

    Money is a decimal number paired with a `currency_code` (ISO 4217). Power is
    in kW and energy in kWh. Positive is import, negative is export.


    ## Live and test

    `live_mode` marks live or test data.
  version: 2027-01-01.busbar
  title: Flatpeak Fleet API
  termsOfService: https://flatpeak.com/legal
  contact:
    name: Technical Support
    email: support@flatpeak.com
    url: https://flatpeak.com/contact
  license:
    name: Apache 2.0
    url: https://flatpeak.com/legal
servers:
  - url: https://fleet-api.flatpeak.com
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: >-
      Exchange your account credentials for a bearer token to authenticate API
      requests.
  - name: Connect
    description: >-
      Create and retrieve Connect sessions for onboarding customers through your
      own app.
  - name: OEMs
    description: List and retrieve the OEMs whose devices your fleet can reach.
  - name: Devices
    description: >-
      Retrieve, list and update the devices connected to your account, and read
      their consent history and shared settings.
  - name: Locations
    description: >-
      Read the location a device sits behind: its timezone, currency, metering
      and your devices there.
  - name: Dispatch
    description: Submit plans to devices on managed tariffs and read the dispatch timeline.
  - name: Telemetry
    description: Read device state, device meter records and location meter records.
  - name: Tariffs
    description: Create, retrieve, delete, and list tariffs.
  - name: Events
    description: Retrieve and list account events.
  - name: VPP Programs
    description: >-
      Define and manage VPP programs: the commercial terms devices enroll under,
      and their live state.
  - name: Groups
    description: >-
      Named collections of devices for bulk dispatch and aggregated reads. OEMs
      see them read-only as [groups](/energy-api/reference/groups/list) on the
      Energy API.
  - name: Zones
    description: >-
      Network areas resolved to devices by Flatpeak, for locational eligibility
      and grouping without handling addresses.
  - name: Exports
    description: >-
      Package settlement evidence, consent records and enrollment registers as
      downloadable files.
  - name: Rewards
    description: >-
      The reward ledger: entries accrue from delivery, you approve them, pay the
      customers and mark them paid.
  - name: VPP Enrollments
    description: Track and act on device enrollments across your programs.
  - name: VPP Events
    description: >-
      Commit market activations: create an event for a group, then read its
      state and its devices' results.
externalDocs:
  description: Documentation
  url: https://docs.flatpeak.com
paths:
  /devices/{device_id}/deliveries:
    parameters:
      - schema:
          type: string
        name: device_id
        in: path
        required: true
        description: Flatpeak Device ID.
    get:
      tags:
        - VPP Events
      summary: List device deliveries
      description: >-
        Returns the device's delivery per VPP event interval within the window,
        across every event it was in: committed power and energy, delivered
        energy, coverage and fulfillment. Delivery is measured from meter
        records; intervals no meter records cover are `UNREPORTED`. An interval
        in which the device was given no share is `NOT_COMMITTED`.
      operationId: list-device-deliveries
      parameters:
        - schema:
            type: string
          name: vpp_event_id
          in: query
          required: false
          description: Only the commitment made under this VPP event.
        - schema:
            type: string
            format: date-time
          name: start_time
          in: query
          required: true
          description: Start time, in UTC.
        - schema:
            type: string
            format: date-time
          name: end_time
          in: query
          required: true
          description: End time, in UTC.
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/cursor'
      responses:
        '200':
          $ref: '#/components/responses/VppEventDeliveryList'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '503':
          $ref: '#/components/responses/503'
components:
  parameters:
    limit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 30
      description: >-
        Maximum number of objects to return per page. Between 1 and 100, default
        30. Values above 100 are clamped to 100.
    cursor:
      name: cursor
      in: query
      required: false
      schema:
        type: string
      description: >-
        Pagination cursor. Pass `next_cursor` from the previous response
        unchanged; omit for the first page. A cursor used with different
        parameters returns `400 cursor_invalid`.
  responses:
    '401':
      description: '401 Unauthorized: authentication credentials are missing or invalid.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '403':
      description: '403 Forbidden: you do not have permission to access this resource.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '404':
      description: '404 Not Found: the requested resource does not exist.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '429':
      description: '429 Too Many Requests: the rate limit has been exceeded.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '500':
      description: >-
        500 Internal Server Error: an unexpected error occurred. Safe to retry
        with backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '503':
      description: >-
        503 Service Unavailable: the service is temporarily down for
        maintenance. Retry after the indicated delay.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    VppEventDeliveryList:
      description: VPP event delivery list response.
      content:
        application/json:
          schema:
            type: object
            properties:
              object:
                type: string
                description: Object type, `list`.
                example: list
                enum:
                  - list
              url:
                type: string
                description: URL slug for the object.
                example: /devices/{device_id}/deliveries
              next_cursor:
                type: string
                nullable: true
                description: >-
                  Cursor for the next page. Pass it as `cursor`. `null` on the
                  last page. Page until it is `null`, even if `data` is short or
                  empty.
                example: djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx
              data:
                type: array
                items:
                  $ref: '#/components/schemas/VppEventDelivery'
            required:
              - object
              - url
              - next_cursor
              - data
          example:
            object: list
            url: /devices/dev_63a6087272941ef077a8fd3e/deliveries
            next_cursor: null
            data:
              - object: vpp_event_delivery
                device_id: dev_63a6087272941ef077a8fd3e
                vpp_event_id: vpe_7d2a4c6e9b1f3a5c8e0d2f4b
                program_id: vpr_5c8d1f2a7b3e4d6c9a0f1b2c
                start_time: '2026-08-04T20:00:00Z'
                end_time: '2026-08-04T21:00:00Z'
                committed_power_kw: -4.3
                committed_energy_kwh: -4.3
                delivered_energy_kwh: -4.3
                coverage: 1
                fulfillment: 1
                status: FULL
                time_reported: '2026-08-04T22:06:12Z'
                commitment_confidence: 0.91
              - object: vpp_event_delivery
                device_id: dev_63a6087272941ef077a8fd3e
                vpp_event_id: vpe_7d2a4c6e9b1f3a5c8e0d2f4b
                program_id: vpr_5c8d1f2a7b3e4d6c9a0f1b2c
                start_time: '2026-08-04T21:00:00Z'
                end_time: '2026-08-04T22:00:00Z'
                committed_power_kw: -4.3
                committed_energy_kwh: -4.3
                delivered_energy_kwh: -3.6
                coverage: 1
                fulfillment: 0.84
                status: PARTIAL
                time_reported: '2026-08-04T22:06:12Z'
                commitment_confidence: 0.91
  schemas:
    VppEventDelivery:
      type: object
      title: VppEventDelivery
      description: >-
        One VPP event window for one device, and the device's delivery against
        it, measured from meter records. A device that is in the event but was
        given no share for a window has a row with `status` `NOT_COMMITTED`.
      additionalProperties: false
      required:
        - object
        - device_id
        - vpp_event_id
        - program_id
        - start_time
        - end_time
        - committed_power_kw
        - committed_energy_kwh
        - delivered_energy_kwh
        - coverage
        - fulfillment
        - status
        - time_reported
        - commitment_confidence
      properties:
        object:
          type: string
          description: Object type, `vpp_event_delivery`.
          example: vpp_event_delivery
          enum:
            - vpp_event_delivery
        device_id:
          type: string
          description: Flatpeak Device ID this delivery row belongs to.
          example: dev_63a6087272941ef077a8fd3e
        vpp_event_id:
          type: string
          description: Flatpeak VPP event ID the commitment was made under.
          example: vpe_7d2a4c6e9b1f3a5c8e0d2f4b
        program_id:
          type: string
          description: Flatpeak Program ID the commitment was made under.
          example: vpr_5c8d1f2a7b3e4d6c9a0f1b2c
        start_time:
          type: string
          description: Time when the window starts, in UTC.
          format: date-time
          example: '2026-08-04T20:14:00Z'
        end_time:
          type: string
          description: Time when the window ends, in UTC.
          format: date-time
          example: '2026-08-04T22:00:00Z'
        committed_power_kw:
          type: number
          description: >-
            Committed power for the window, in kilowatts. Positive values
            indicate import, negative values indicate export.
          example: -4.3
        committed_energy_kwh:
          type: number
          description: >-
            Energy the commitment implies over the window, in kWh, signed like
            power.
          example: -7.6
        delivered_energy_kwh:
          type: number
          description: >-
            Energy delivered within the window, in kWh, signed like power: the
            metered energy of the intervals that the device's meter records
            cover in full, to three decimals. It rises as late records arrive,
            and rewards are priced from it. `null` when no meter records cover
            the window.
          nullable: true
          example: -7.6
        coverage:
          type: number
          nullable: true
          minimum: 0
          maximum: 1
          description: >-
            Share of the window covered by meter records, from 0 to 1. `null`
            until a record covers any of it. Intervals without full coverage are
            left out of `delivered_energy_kwh` until late records arrive.
          example: 1
        fulfillment:
          type: number
          description: >-
            Share of the committed energy delivered, from 0 to 1, energy
            weighted: 1 means the full window at the committed power. Measured
            from meter records. `null` when none cover the window.
          minimum: 0
          maximum: 1
          nullable: true
          example: 1
        status:
          type: string
          enum:
            - FULL
            - PARTIAL
            - ZERO
            - UNREPORTED
            - OPTED_OUT
            - NOT_COMMITTED
          description: >-
            | Value | Meaning |

            | :--- | :--- |

            | `FULL` | Fulfillment 1 |

            | `PARTIAL` | Fulfillment between 0 and 1 |

            | `ZERO` | Metered, nothing delivered |

            | `UNREPORTED` | No meter records cover the window |

            | `OPTED_OUT` | User skipped it |

            | `NOT_COMMITTED` | In the event, but given no share for the window
            |
          example: FULL
        time_reported:
          type: string
          description: >-
            Time the last meter record covering the window was received, in UTC.
            `null` when unreported.
          format: date-time
          nullable: true
          example: '2026-08-04T16:05:04Z'
        commitment_confidence:
          type: number
          minimum: 0
          maximum: 1
          nullable: true
          example: 0.92
          description: >-
            Likelihood that the device meets its commitment, from 0 to 1.
            Derived from the device's confirmations and delivery history. Set
            when the commitment is made.
    Error:
      type: object
      description: Standard error envelope returned by every non-2xx response.
      required:
        - object
        - type
        - code
        - message
      properties:
        object:
          type: string
          enum:
            - error
          default: error
          description: Object type.
        type:
          type: string
          description: High-level error category.
          example: invalid_request
        code:
          type: string
          description: Machine-readable error code, safe to branch on.
          example: access_denied
        message:
          type: string
          description: Human-readable description of the error.
          example: The requested resource could not be found.
        context:
          type: string
          description: Optional originating context, for example `api.price_get`.
          example: api.price_get
        live_mode:
          type: boolean
          description: Whether the error occurred against live or test data.
        time_created:
          type: string
          format: date-time
          description: Time the error was generated (RFC 3339).
          example: '2026-01-01T00:00:00Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate with the `bearer_token` obtained from the
        [authentication](/fleet-api/reference/authentication) endpoint.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.