Customer

Returns the customer's paginated points and tier history

This endpoint includes tier changes. If 'IsTierHistory' is true, disregard the use of 'PointType' and use 'TierUpdate' instead.

On success, returns HTTP 200 with hasError: false, items and pagination metadata. An existing customer with no history returns an empty items array. If the customer is not found, returns HTTP 400 (Bad Request) with hasError: true and errorMessages: ["Customer not found"], rather than HTTP 404 or a successful empty list. This list response does not expose errorCode or customerId as an error field; callers should check the HTTP status and hasError, and read errorMessages for details. Pagination metadata in an error response does not represent a successful query.

post/v1/pvt/Customer/{id}/history

Request

  • Base URL
    https://api.bonifiq.com.br
  • Auth
    HTTP basic

Path parameters

idstring required

Id from the client`s store, usually email address

Query parameters

PageNumberinteger

Pagenation number

PageSizeinteger

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

Response

Customer found; returns the requested history page, which may be empty.

TotalItemCountinteger

Total of rewards Configurations founds.

PageSizeinteger

Pagination size

PageNumberinteger

Actual Page Number

HasNextPageboolean

true if there is another page to be load.

HasErrorboolean

If true the request had an error.

ErrorMessagesstring[]

List with the error messages

Changes

No recorded changes to this operation across all 38 revisions of this API.