Returns a timeline history of points usage from the customer

curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/Customer/{id}/history \
  --header 'Authorization: Basic <encoded-value>'

{
  "Items": [
    {
      "Date": "2023-11-07T05:31:56Z",
      "Points": 123,
      "Title": "<string>",
      "PointType": 0,
      "IsCanceled": true,
      "CouponCode": "<string>",
      "CouponRefunded": true,
      "CouponIsUsed": true,
      "CouponIsAvailable": true,
      "CashbackDescription": "<string>",
      "CashbackValue": 123,
      "IsTierHistory": true,
      "TierUpdate": 0,
      "TierName": "<string>",
      "Metadatas": [
        {
          "Name": "<string>",
          "Value": "<string>"
        }
      ]
    }
  ],
  "TotalItemCount": 123,
  "PageSize": 123,
  "PageNumber": 123,
  "HasNextPage": true,
  "HasError": true,
  "ErrorMessages": [
    "<string>"
  ]
}

POST

pvt

Customer

{id}

history

Returns a timeline history of points usage from the customer

curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/Customer/{id}/history \
  --header 'Authorization: Basic <encoded-value>'

{
  "Items": [
    {
      "Date": "2023-11-07T05:31:56Z",
      "Points": 123,
      "Title": "<string>",
      "PointType": 0,
      "IsCanceled": true,
      "CouponCode": "<string>",
      "CouponRefunded": true,
      "CouponIsUsed": true,
      "CouponIsAvailable": true,
      "CashbackDescription": "<string>",
      "CashbackValue": 123,
      "IsTierHistory": true,
      "TierUpdate": 0,
      "TierName": "<string>",
      "Metadatas": [
        {
          "Name": "<string>",
          "Value": "<string>"
        }
      ]
    }
  ],
  "TotalItemCount": 123,
  "PageSize": 123,
  "PageNumber": 123,
  "HasNextPage": true,
  "HasError": true,
  "ErrorMessages": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Use API Basic Auth Keys

Path Parameters

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.

Show child attributes

Items.Date

string<date-time>

Date when the point was given or taken

Items.Points

integer<int32>

Amount of points received or used. For points received (such as points for purchase) it will be positive. For points taken (such as points used in purchases) it will be negative

Items.Title

string

Quick description of the event

Items.PointType

enum<integer>

0 - Purchase points 1 - Account creation points 2 - Birthday points 3 - Admin-generated points. Can be either positive or negative 4 - Points used in a reward 5 - Review points 6 - Points refunded (for cancelled purchases) 7 - Points expired 8 - Points for referral

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

11,

12,

13,

14,

15,

16

Items.IsCanceled

boolean

If true this points was used and canceled afterwards

Items.CouponCode

string | null

If this reward contains a coupon this field represents it

Items.CouponRefunded

boolean

true if the coupon was refunded and cannot be used

Items.CouponIsUsed

boolean

True if the coupon was used in a purchase and cannot be used again

Items.CouponIsAvailable

boolean

If true the Coupon in the field CouponCode can be used in a purchase

Items.CashbackDescription

string | null

Items.CashbackValue

number<decimal>

If cashback is enabled this field will contain the value of the cashback otherwise it will be zero

Items.IsTierHistory

boolean

If true the fields is about tier change

Items.TierUpdate

enum<integer>

0 - Upgrade 1 - Downgrade

Available options:

0,

1

Items.TierName

string | null

Tier name that was applied

Items.Metadatas

object[]

List of metadata associated with this point. A metadata can came from when inserting an order or redeeming a reward

Show child attributes

Items.Metadatas.Name

string

Items.Metadatas.Value

string

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

Redeem points for a cashback value Set the birthday date of the given customer

⌘I

API Privada

API Pública

Endpoint Examples

Returns a timeline history of points usage from the customer

Authorizations

Path Parameters

Query Parameters

Response