---
title: "Returns a list of orders filtered by date."
method: GET
path: "/v1/pvt/Reports/ListOrdersReport"
tags: ["Reports"]
---

# Returns a list of orders filtered by date.

`GET /v1/pvt/Reports/ListOrdersReport`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pvt/Reports/ListOrdersReport`
- Auth: HTTP basic

The result can be filtered by date:
- OrderPlacementDate: date when the order was placed by the customer.
- DateCreated: date when the order was created in the BonifiQ system.
- UpdatedDate: date when the order was last updated in the BonifiQ system.

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `dateFilterType` 0 | 1 | 2: 0 = OrderPlacementDate 1 = DateCreated 2 = UpdatedDate
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Paginated list of orders report data

- BaseExternalApiListResponseOfReportOrderResponse: Base List response model methods
  - `Items` object[], nullable: Collection with the found entities on the bonifiq DB.
    - `Id` integer: Order Id
    - `OriginalId` string: Original order ID from the e-commerce platform
    - `OrderStatus` string: Order status description
    - `OrderPlacementDate` string, date-time: Date when the order was placed
    - `DateCreated` string, date-time: Date when the order was created in BonifiQ system
    - `UpdatedDate` string, date-time, nullable: Date when the order was last updated in BonifiQ system
    - `CustomerId` integer: Customer Id
    - `CustomerName` string: Customer name
    - `CustomerEmail` string: Customer email
    - `CustomerPhone` string: Customer phone
    - `State` 0 | 1 | 2 | 3 | 4: 0 = Initial 1 = Pending 2 = Completed 3 = Cancelled 4 = Ignored
    - `OrderTotal` number: Total value of the order
    - `Origin` 0 | 1 | 2 | 3 | 4: 0 = Integration 1 = API 2 = Import 3 = PDV 4 = OfflineIntegration
    - `Branch` string: Branch name
    - `OrderCompletedDate` string, date-time, nullable: Date when the order was completed
    - `Points` integer, nullable: Points earned from this order
    - `CustomerDocument` string: Customer document (CPF/CNPJ)
    - `Products` object[]: Products associated with the order in the report snapshot.
      - `OriginalId` string: Product ID from the client store.
      - `Quantity` integer, nullable: Quantity stored for this product in the order, when available.
      - `UnitPrice` number, nullable: Unit price stored for this product in the order, when available.
      - `ProductPrice` number: Product price stored for this product in the order.
  - `TotalItemCount` integer: Total of rewards Configurations founds.
  - `PageSize` integer: Pagination size
  - `PageNumber` integer: Actual Page Number
  - `HasNextPage` boolean: true if there is another page to be load.
  - `HasError` boolean: If true the request had an error.
  - `ErrorMessages` string[]: List with the error messages

## Changes

- **2026-09-01** `4ae776963df8`: 1 info
  - added the optional property `Items/items/oneOf[#/components/schemas/ReportOrderResponse]/Products` to the response with the `200` status

[Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/changes/v1/pvt/Reports/ListOrdersReport/get.md)

---

[API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)