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
"use strict";
export class GetCustomerKpiResponse {
    /** @param {{boosterCustomerId?:number,totalTransaction?:number,totalSales?:number,totalReturn?:number,totalItems?:number,averageBasketAmount?:number,totalSpendingAmount?:number,currencyCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Booster Customer ID */
    boosterCustomerId;
    /**
     * @type {number}
     * @description Total Transaction */
    totalTransaction;
    /**
     * @type {number}
     * @description Total Sales */
    totalSales;
    /**
     * @type {number}
     * @description Total Return */
    totalReturn;
    /**
     * @type {number}
     * @description Total Items */
    totalItems;
    /**
     * @type {number}
     * @description Average Basket Amount */
    averageBasketAmount;
    /**
     * @type {number}
     * @description Total Spending Amount */
    totalSpendingAmount;
    /**
     * @type {string}
     * @description Currency code e.g. 'EUR', 'CHF' */
    currencyCode;
}
export class GetCustomerKpi {
    /** @param {{boosterCustomerId?:number,transactionDateFrom?:string,transactionDateTo?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Booster Customer ID */
    boosterCustomerId;
    /**
     * @type {?string}
     * @description Transaction Date From e.g. '2022-01-01' */
    transactionDateFrom;
    /**
     * @type {?string}
     * @description Transaction Date To e.g. '2023-11-01' */
    transactionDateTo;
}

JavaScript 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>