Skip to main content
POST
Returns a list of unused coupons that the customer have redeemed in the past using a body-based customer identifier.

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Body

application/json

Customer identifier data and pagination filter. CustomerId remains required. When Checkout.CustomerOriginalIdSource is configured as document or email, lookup uses Customer.Document or Customer.Email respectively.

Request used by the body-based available coupons endpoint.

PageNumber
integer<int32>

Pagenation number

PageSize
integer<int32>

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
object | null

Customer identifiers used when Checkout.CustomerOriginalIdSource is configured as document or email.

Response

200 - application/json

Base List response model methods

Items
object[] | null

Collection with the found entities on the bonifiq DB.

TotalItemCount
integer<int32>

Total of rewards Configurations founds.

PageSize
integer<int32>

Pagination size

PageNumber
integer<int32>

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