clients/profitPoints

get

https://{domain}/api/admin/v8/clients/profitPoints

Method that enables extracting information about the amount of loyalty points collected by customers in a loyalty program.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

clientsIds

array of integers

Customer numbers.

clientsIds

clientTextSearch

string

Text search through customer data.

clientIsActive

string

enum

Active

Allowed:

clientHasTradeCredit

string

enum

Trade credit:

positive or negative,
only positive,
only negative,
only zero.

Allowed:

clientLastPurchaseDate

object

Date of last purchase.

pointsModificationDate

object

Profit points modification date range.

returnElements

array of strings

Elements to be returned by the endpoint. By default all elements are returned.
Available elements:

clientId
clientProfitPoints
clientProfitPointsHistories

returnElements

resultsPage

integer

Page with results number. Numeration starts from 0

resultsLimit

integer

Number of results on page. Value from 1 to 100

Responses

401

Authorization error

403

Access denied

404

Not found

422

Invalid data format

429

Too many requests

500

Internal server error

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

207Multi-Status