---
title: "Returns a list of generated coupons filtered by creation date."
method: GET
path: "/v1/pvt/Reports/ListGeneratedCouponList"
tags: ["Reports"]
---

# Returns a list of generated coupons filtered by creation date.

`GET /v1/pvt/Reports/ListGeneratedCouponList`

## Request

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

This endpoint returns coupons that were generated through point redemption, excluding cashback coupons.
Each coupon includes information about its current status, type, value, and associated customer.

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Paginated list of generated coupons report data

- BaseExternalApiListResponseOfReportGeneratedCouponResponse: Base List response model methods
  - `Items` object[], nullable: Collection with the found entities on the bonifiq DB.
    - `CouponCode` string: Coupon code
    - `CustomerId` integer: Customer ID who owns the coupon
    - `CustomerName` string: Customer name
    - `CustomerEmail` string: Customer email
    - `CustomerDocument` string: Customer document (CPF/CNPJ)
    - `CreatedDate` string, date-time: Date when the coupon was created/generated
    - `CouponType` 0 | 1 | 2 | 3 | 4: 0 = FixedValue 1 = Percent 2 = FreeShipping 3 = DiscountShipping 4 = Others
    - `CouponValue` number: Coupon value (depends on CouponType)
    - `Status` 0 | 1 | 2 | 3: 0 = Available 1 = Used 2 = Cancelled 3 = Expired
    - `IsUsed` boolean, nullable: Indicates if the coupon has been used in an order
    - `OrderId` string, nullable: Order ID where the coupon was used (if applicable)
    - `OrderOrigin` 0 | 1 | 2 | 3 | 4: 0 = Integration 1 = API 2 = Import 3 = PDV 4 = OfflineIntegration
    - `BranchName` string, nullable: Branch name where the coupon was generated or used
    - `TenantSalesmanName` string, nullable: Salesman name associated with the coupon
    - `ValidDateStart` string, date-time, nullable: Start date of coupon validity period
    - `ValidDateEnd` string, date-time, nullable: End date of coupon validity period
    - `CanceledDate` string, date-time, nullable: Date when the coupon was cancelled (if applicable)
    - `Refunded` boolean, nullable: Indicates if the coupon was refunded
    - `IsAssigned` boolean: Indicates if the coupon is assigned to a customer
  - `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)