Richemont.Booster2.PublicApi

GetCustomerKpi

The following routes are available for this service:
GET	/customer/{boosterCustomerId}/kpi	Get customer KPI details

namespace Richemont.Booster2.PublicApi.CRM.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type GetCustomerKpiResponse() = 
        ///<summary>
        ///Booster Customer ID
        ///</summary>
        [<ApiMember(Description="Booster Customer ID", IsRequired=true)>]
        member val boosterCustomerId:Int32 = new Int32() with get,set

        ///<summary>
        ///Total Transaction
        ///</summary>
        [<ApiMember(Description="Total Transaction", IsRequired=true)>]
        member val totalTransaction:Int32 = new Int32() with get,set

        ///<summary>
        ///Total Sales
        ///</summary>
        [<ApiMember(Description="Total Sales", IsRequired=true)>]
        member val totalSales:Int32 = new Int32() with get,set

        ///<summary>
        ///Total Return
        ///</summary>
        [<ApiMember(Description="Total Return", IsRequired=true)>]
        member val totalReturn:Int32 = new Int32() with get,set

        ///<summary>
        ///Total Items
        ///</summary>
        [<ApiMember(Description="Total Items", IsRequired=true)>]
        member val totalItems:Int32 = new Int32() with get,set

        ///<summary>
        ///Average Basket Amount
        ///</summary>
        [<ApiMember(Description="Average Basket Amount", IsRequired=true)>]
        member val averageBasketAmount:Decimal = new Decimal() with get,set

        ///<summary>
        ///Total Spending Amount
        ///</summary>
        [<ApiMember(Description="Total Spending Amount", IsRequired=true)>]
        member val totalSpendingAmount:Double = new Double() with get,set

        ///<summary>
        ///Currency code e.g. 'EUR', 'CHF'
        ///</summary>
        [<ApiMember(Description="Currency code e.g. 'EUR', 'CHF'", IsRequired=true)>]
        member val currencyCode:String = null with get,set

    [<AllowNullLiteral>]
    type GetCustomerKpi() = 
        ///<summary>
        ///Booster Customer ID
        ///</summary>
        [<ApiMember(Description="Booster Customer ID", IsRequired=true)>]
        member val boosterCustomerId:Int32 = new Int32() with get,set

        ///<summary>
        ///Transaction Date From e.g. '2022-01-01'
        ///</summary>
        [<ApiMember(Description="Transaction Date From e.g. '2022-01-01'")>]
        member val transactionDateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///Transaction Date To e.g. '2023-11-01'
        ///</summary>
        [<ApiMember(Description="Transaction Date To e.g. '2023-11-01'")>]
        member val transactionDateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# GetCustomerKpi DTOs

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
}