| GET | /customer/{boosterCustomerId}/kpi | Get customer KPI details |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| boosterCustomerId | path | int | Yes | Booster Customer ID |
| transactionDateFrom | query | DateTime? | No | Transaction Date From e.g. '2022-01-01' |
| transactionDateTo | query | DateTime? | No | Transaction Date To e.g. '2023-11-01' |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| boosterCustomerId | form | int | Yes | Booster Customer ID |
| totalTransaction | form | int | Yes | Total Transaction |
| totalSales | form | int | Yes | Total Sales |
| totalReturn | form | int | Yes | Total Return |
| totalItems | form | int | Yes | Total Items |
| averageBasketAmount | form | decimal | Yes | Average Basket Amount |
| totalSpendingAmount | form | double | Yes | Total Spending Amount |
| currencyCode | form | string | Yes | Currency code e.g. 'EUR', 'CHF' |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"boosterCustomerId":0,"totalTransaction":0,"totalSales":0,"totalReturn":0,"totalItems":0,"averageBasketAmount":0,"totalSpendingAmount":0,"currencyCode":"String"}