| GET | /customer/{boosterCustomerId}/kpi | Get customer KPI details |
|---|
import Foundation
import ServiceStack
public class GetCustomerKpi : Codable
{
/**
* Booster Customer ID
*/
// @ApiMember(Description="Booster Customer ID", IsRequired=true)
public var boosterCustomerId:Int
/**
* Transaction Date From e.g. '2022-01-01'
*/
// @ApiMember(Description="Transaction Date From e.g. '2022-01-01'")
public var transactionDateFrom:Date?
/**
* Transaction Date To e.g. '2023-11-01'
*/
// @ApiMember(Description="Transaction Date To e.g. '2023-11-01'")
public var transactionDateTo:Date?
required public init(){}
}
public class GetCustomerKpiResponse : Codable
{
/**
* Booster Customer ID
*/
// @ApiMember(Description="Booster Customer ID", IsRequired=true)
public var boosterCustomerId:Int
/**
* Total Transaction
*/
// @ApiMember(Description="Total Transaction", IsRequired=true)
public var totalTransaction:Int
/**
* Total Sales
*/
// @ApiMember(Description="Total Sales", IsRequired=true)
public var totalSales:Int
/**
* Total Return
*/
// @ApiMember(Description="Total Return", IsRequired=true)
public var totalReturn:Int
/**
* Total Items
*/
// @ApiMember(Description="Total Items", IsRequired=true)
public var totalItems:Int
/**
* Average Basket Amount
*/
// @ApiMember(Description="Average Basket Amount", IsRequired=true)
public var averageBasketAmount:Double
/**
* Total Spending Amount
*/
// @ApiMember(Description="Total Spending Amount", IsRequired=true)
public var totalSpendingAmount:Double
/**
* Currency code e.g. 'EUR', 'CHF'
*/
// @ApiMember(Description="Currency code e.g. 'EUR', 'CHF'", IsRequired=true)
public var currencyCode:String
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetCustomerKpiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.CRM.ServiceModel"> <averageBasketAmount>0</averageBasketAmount> <boosterCustomerId>0</boosterCustomerId> <currencyCode>String</currencyCode> <totalItems>0</totalItems> <totalReturn>0</totalReturn> <totalSales>0</totalSales> <totalSpendingAmount>0</totalSpendingAmount> <totalTransaction>0</totalTransaction> </GetCustomerKpiResponse>