---
title: "Returns a list of sales (orders that used an BonifiQ reward) filtered by date."
method: GET
path: "/v1/pvt/Reports/ListSalesReport"
tags: ["Reports"]
---

# Returns a list of sales (orders that used an BonifiQ reward) filtered by date.

`GET /v1/pvt/Reports/ListSalesReport`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pvt/Reports/ListSalesReport`
- 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 sales report data

- BaseExternalApiListResponseOfReportSalesResponse: Base List response model methods
  - `Items` object[], nullable: Collection with the found entities on the bonifiq DB.
    - `Id` integer: Unique identifier of the order on BonifiQ
    - `OrderPlacementDate` string, date-time: Date when the order was placed in commerce
    - `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
    - `OriginalId` string: Original order ID from the commerce platform
    - `OrderTotal` number: Total value of the order
    - `Coupon` string, nullable: Coupon code used in the order
    - `State` 0 | 1 | 2 | 3 | 4: 0 = Initial 1 = Pending 2 = Completed 3 = Cancelled 4 = Ignored
    - `CustomerId` integer: Customer Id
    - `CustomerName` string: Customer name
    - `CustomerEmail` string: Customer email
    - `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.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)