Richemont.Booster2.PublicApi

<back to all web services

GetCustomerKpi

Requires Authentication
The following routes are available for this service:
GET/customer/{boosterCustomerId}/kpiGet customer KPI details
GetCustomerKpi Parameters:
NameParameterData TypeRequiredDescription
boosterCustomerIdpathintYesBooster Customer ID
transactionDateFromqueryDateTime?NoTransaction Date From e.g. '2022-01-01'
transactionDateToqueryDateTime?NoTransaction Date To e.g. '2023-11-01'
GetCustomerKpiResponse Parameters:
NameParameterData TypeRequiredDescription
boosterCustomerIdformintYesBooster Customer ID
totalTransactionformintYesTotal Transaction
totalSalesformintYesTotal Sales
totalReturnformintYesTotal Return
totalItemsformintYesTotal Items
averageBasketAmountformdecimalYesAverage Basket Amount
totalSpendingAmountformdoubleYesTotal Spending Amount
currencyCodeformstringYesCurrency code e.g. 'EUR', 'CHF'

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /customer/{boosterCustomerId}/kpi HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	boosterCustomerId: 0,
	totalTransaction: 0,
	totalSales: 0,
	totalReturn: 0,
	totalItems: 0,
	averageBasketAmount: 0,
	totalSpendingAmount: 0,
	currencyCode: String
}