---
title: "Returns a list of unused coupons that the customer have redeemed in the past using a body-based customer identifier."
method: POST
path: "/v1/pvt/Customer/availablecoupons"
tags: ["Customer"]
---

# Returns a list of unused coupons that the customer have redeemed in the past using a body-based customer identifier.

`POST /v1/pvt/Customer/availablecoupons`

## Request body

- CustomerAvailableCouponsByCustomerRequest — Request used by the body-based available coupons endpoint.
  - `PageNumber` integer — Pagenation number
  - `PageSize` integer — Amount of items per page, Max size is 50 items per page.
  - `CustomerId` string — Legacy customer identifier used by the merchant platform. This field remains required. When `Checkout.CustomerOriginalIdSource` is configured as `document` or `email`, BonifiQ ignores this value for lookup and uses the configured `Customer` field instead.
  - `Customer` ExternalApiCustomerIdentifierRequest — Optional customer identifiers used when the tenant configuration changes which value is used as the customer's OriginalId.
    - `Document` string, nullable — Customer document. Required when `Checkout.CustomerOriginalIdSource` is set to `document`. The value is normalized to digits only before the customer lookup.
    - `Email` string, nullable — Customer e-mail. Required when `Checkout.CustomerOriginalIdSource` is set to `email`.

## Response `200`

- BaseExternalApiListResponseOfCreateCouponResponse — Base List response model methods
  - `Items` object[], nullable — Collection with the found entities on the bonifiq DB.
    - `CouponCode` string — Coupon Code
    - `CreatedDate` string, date-time — Create Date
    - `IsUsed` boolean, nullable — if true the coupon was already bein use or inactivated.
    - `CouponValue` number — Discount value for the coupon
    - `CustomerId` integer — the customer that the coupon is being given.
    - `ValidDateStart` string, date-time, nullable — Date the coupon is start to being enable for rewards
    - `ValidDateEnd` string, date-time, nullable — Date the coupon will not be able for rewards anymore.
    - `CouponType` 0 | 1 | 2 | 3 | 4 — 0 = FixedValue 1 = Percent 2 = FreeShipping 3 = DiscountShipping 4 = Others
  - `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/fafbe5673edc/schema)