| GET | /customer/{boosterCustomerId}/kpi | Get customer KPI details |
|---|
export class GetCustomerKpiResponse
{
/** @description Booster Customer ID */
// @ApiMember(Description="Booster Customer ID", IsRequired=true)
public boosterCustomerId: number;
/** @description Total Transaction */
// @ApiMember(Description="Total Transaction", IsRequired=true)
public totalTransaction: number;
/** @description Total Sales */
// @ApiMember(Description="Total Sales", IsRequired=true)
public totalSales: number;
/** @description Total Return */
// @ApiMember(Description="Total Return", IsRequired=true)
public totalReturn: number;
/** @description Total Items */
// @ApiMember(Description="Total Items", IsRequired=true)
public totalItems: number;
/** @description Average Basket Amount */
// @ApiMember(Description="Average Basket Amount", IsRequired=true)
public averageBasketAmount: number;
/** @description Total Spending Amount */
// @ApiMember(Description="Total Spending Amount", IsRequired=true)
public totalSpendingAmount: number;
/** @description Currency code e.g. 'EUR', 'CHF' */
// @ApiMember(Description="Currency code e.g. 'EUR', 'CHF'", IsRequired=true)
public currencyCode: string;
public constructor(init?: Partial<GetCustomerKpiResponse>) { (Object as any).assign(this, init); }
}
export class GetCustomerKpi
{
/** @description Booster Customer ID */
// @ApiMember(Description="Booster Customer ID", IsRequired=true)
public boosterCustomerId: number;
/** @description Transaction Date From e.g. '2022-01-01' */
// @ApiMember(Description="Transaction Date From e.g. '2022-01-01'")
public transactionDateFrom?: string;
/** @description Transaction Date To e.g. '2023-11-01' */
// @ApiMember(Description="Transaction Date To e.g. '2023-11-01'")
public transactionDateTo?: string;
public constructor(init?: Partial<GetCustomerKpi>) { (Object as any).assign(this, init); }
}
TypeScript GetCustomerKpi DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"boosterCustomerId":0,"totalTransaction":0,"totalSales":0,"totalReturn":0,"totalItems":0,"averageBasketAmount":0,"totalSpendingAmount":0,"currencyCode":"String"}