Richemont.Booster2.PublicApi

GetCustomerKpi

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Richemont.Booster2.PublicApi.CRM.ServiceModel;

namespace Richemont.Booster2.PublicApi.CRM.ServiceModel
{
    public partial class GetCustomerKpi
    {
        ///<summary>
        ///Booster Customer ID
        ///</summary>
        [ApiMember(Description="Booster Customer ID", IsRequired=true)]
        public virtual int boosterCustomerId { get; set; }

        ///<summary>
        ///Transaction Date From e.g. '2022-01-01'
        ///</summary>
        [ApiMember(Description="Transaction Date From e.g. '2022-01-01'")]
        public virtual DateTime? transactionDateFrom { get; set; }

        ///<summary>
        ///Transaction Date To e.g. '2023-11-01'
        ///</summary>
        [ApiMember(Description="Transaction Date To e.g. '2023-11-01'")]
        public virtual DateTime? transactionDateTo { get; set; }
    }

    public partial class GetCustomerKpiResponse
    {
        ///<summary>
        ///Booster Customer ID
        ///</summary>
        [ApiMember(Description="Booster Customer ID", IsRequired=true)]
        public virtual int boosterCustomerId { get; set; }

        ///<summary>
        ///Total Transaction
        ///</summary>
        [ApiMember(Description="Total Transaction", IsRequired=true)]
        public virtual int totalTransaction { get; set; }

        ///<summary>
        ///Total Sales
        ///</summary>
        [ApiMember(Description="Total Sales", IsRequired=true)]
        public virtual int totalSales { get; set; }

        ///<summary>
        ///Total Return
        ///</summary>
        [ApiMember(Description="Total Return", IsRequired=true)]
        public virtual int totalReturn { get; set; }

        ///<summary>
        ///Total Items
        ///</summary>
        [ApiMember(Description="Total Items", IsRequired=true)]
        public virtual int totalItems { get; set; }

        ///<summary>
        ///Average Basket Amount
        ///</summary>
        [ApiMember(Description="Average Basket Amount", IsRequired=true)]
        public virtual decimal averageBasketAmount { get; set; }

        ///<summary>
        ///Total Spending Amount
        ///</summary>
        [ApiMember(Description="Total Spending Amount", IsRequired=true)]
        public virtual double totalSpendingAmount { get; set; }

        ///<summary>
        ///Currency code e.g. 'EUR', 'CHF'
        ///</summary>
        [ApiMember(Description="Currency code e.g. 'EUR', 'CHF'", IsRequired=true)]
        public virtual string currencyCode { get; set; }
    }

}

C# 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>