Skip to main content
POST
/
v1
/
pvt
/
Customer
/
{id}
/
availablecoupons
Returns a list of unused coupons that the customer have redeemed in the past
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/Customer/{id}/availablecoupons \
  --header 'Authorization: Basic <encoded-value>'
{
  "Items": [
    {
      "CouponCode": "<string>",
      "CreatedDate": "2023-11-07T05:31:56Z",
      "IsUsed": true,
      "CouponValue": 123,
      "CustomerId": 123,
      "ValidDateStart": "2023-11-07T05:31:56Z",
      "ValidDateEnd": "2023-11-07T05:31:56Z"
    }
  ],
  "TotalItemCount": 123,
  "PageSize": 123,
  "PageNumber": 123,
  "HasNextPage": true,
  "HasError": true,
  "ErrorMessages": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

​
id
string
required

Id from the client`s store, usually email address

Query Parameters

​
PageNumber
integer<int32>

Pagenation number

​
PageSize
integer<int32>

Amount of items per page, Max size is 50 items per page.

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