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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.CRM.ServiceModel

Namespace Global

    Namespace Richemont.Booster2.PublicApi.CRM.ServiceModel

        Public Partial Class GetCustomerKpi
            '''<Summary>
            '''Booster Customer ID
            '''</Summary>
            <ApiMember(Description:="Booster Customer ID", IsRequired:=true)>
            Public Overridable Property boosterCustomerId As Integer

            '''<Summary>
            '''Transaction Date From e.g. '2022-01-01'
            '''</Summary>
            <ApiMember(Description:="Transaction Date From e.g. '2022-01-01'")>
            Public Overridable Property transactionDateFrom As Nullable(Of Date)

            '''<Summary>
            '''Transaction Date To e.g. '2023-11-01'
            '''</Summary>
            <ApiMember(Description:="Transaction Date To e.g. '2023-11-01'")>
            Public Overridable Property transactionDateTo As Nullable(Of Date)
        End Class

        Public Partial Class GetCustomerKpiResponse
            '''<Summary>
            '''Booster Customer ID
            '''</Summary>
            <ApiMember(Description:="Booster Customer ID", IsRequired:=true)>
            Public Overridable Property boosterCustomerId As Integer

            '''<Summary>
            '''Total Transaction
            '''</Summary>
            <ApiMember(Description:="Total Transaction", IsRequired:=true)>
            Public Overridable Property totalTransaction As Integer

            '''<Summary>
            '''Total Sales
            '''</Summary>
            <ApiMember(Description:="Total Sales", IsRequired:=true)>
            Public Overridable Property totalSales As Integer

            '''<Summary>
            '''Total Return
            '''</Summary>
            <ApiMember(Description:="Total Return", IsRequired:=true)>
            Public Overridable Property totalReturn As Integer

            '''<Summary>
            '''Total Items
            '''</Summary>
            <ApiMember(Description:="Total Items", IsRequired:=true)>
            Public Overridable Property totalItems As Integer

            '''<Summary>
            '''Average Basket Amount
            '''</Summary>
            <ApiMember(Description:="Average Basket Amount", IsRequired:=true)>
            Public Overridable Property averageBasketAmount As Decimal

            '''<Summary>
            '''Total Spending Amount
            '''</Summary>
            <ApiMember(Description:="Total Spending Amount", IsRequired:=true)>
            Public Overridable Property totalSpendingAmount As Double

            '''<Summary>
            '''Currency code e.g. 'EUR', 'CHF'
            '''</Summary>
            <ApiMember(Description:="Currency code e.g. 'EUR', 'CHF'", IsRequired:=true)>
            Public Overridable Property currencyCode As String
        End Class
    End Namespace
End Namespace

VB.NET GetCustomerKpi DTOs

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

HTTP + 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>