| GET | /customer/{boosterCustomerId}/kpi | Get customer KPI details |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class GetCustomerKpi
{
/**
* Booster Customer ID
*/
@ApiMember(Description="Booster Customer ID", IsRequired=true)
var boosterCustomerId:Int? = null
/**
* Transaction Date From e.g. '2022-01-01'
*/
@ApiMember(Description="Transaction Date From e.g. '2022-01-01'")
var transactionDateFrom:Date? = null
/**
* Transaction Date To e.g. '2023-11-01'
*/
@ApiMember(Description="Transaction Date To e.g. '2023-11-01'")
var transactionDateTo:Date? = null
}
open class GetCustomerKpiResponse
{
/**
* Booster Customer ID
*/
@ApiMember(Description="Booster Customer ID", IsRequired=true)
var boosterCustomerId:Int? = null
/**
* Total Transaction
*/
@ApiMember(Description="Total Transaction", IsRequired=true)
var totalTransaction:Int? = null
/**
* Total Sales
*/
@ApiMember(Description="Total Sales", IsRequired=true)
var totalSales:Int? = null
/**
* Total Return
*/
@ApiMember(Description="Total Return", IsRequired=true)
var totalReturn:Int? = null
/**
* Total Items
*/
@ApiMember(Description="Total Items", IsRequired=true)
var totalItems:Int? = null
/**
* Average Basket Amount
*/
@ApiMember(Description="Average Basket Amount", IsRequired=true)
var averageBasketAmount:BigDecimal? = null
/**
* Total Spending Amount
*/
@ApiMember(Description="Total Spending Amount", IsRequired=true)
var totalSpendingAmount:Double? = null
/**
* Currency code e.g. 'EUR', 'CHF'
*/
@ApiMember(Description="Currency code e.g. 'EUR', 'CHF'", IsRequired=true)
var currencyCode:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}