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

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)
  - `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

---

[API](https://skmtc.net/bonifiq/apis/bonifiq-private-apis.md) · [All operations](https://skmtc.net/bonifiq/apis/bonifiq-private-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bonifiq/bonifiq-private-apis/revisions/070a57eeffdc/schema)