---
title: "POST /sales-overview-report"
method: POST
path: "/sales-overview-report"
tags: ["Reports"]
---

# POST /sales-overview-report

`POST /sales-overview-report`

## Request

- Base URL: `https://api.khaasfood.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.khaasfood.com/sales-overview-report`
- Auth: OAuth 2
  - Authorization code: `https://api.khaasfood.com/connect/authorize`
  - Token URL: `https://api.khaasfood.com/connect/token`

## Request body

- KhaasFoodReportsDtosSalesOverviewReportInputDto
  - `fromDate` string, date-time, nullable
  - `toDate` string, date-time, nullable
  - `groupAs` integer
  - `viewAs` integer
  - `searchState` integer
  - `channels` integer[], nullable
  - `outlets` string[], nullable
  - `selectedRows` string[], nullable

## Response `200`

Success

- KhaasFoodReportsDtosSalesOverviewReportResultDto[]
  - `name` string, nullable
  - `results` KhaasFoodReportsDtosSalesOverviewReportResultSummary[], nullable
    - `name` string, nullable
    - `totalProductAmount` number, double
    - `totalOrders` integer
    - `newCustomers` integer
    - `newCustomerOrders` integer
    - `newCustomersTotalProductAmount` number, double
    - `onlineCustomers` integer
    - `offlineCustomers` integer
    - `onlineCustomerOrders` integer
    - `onlineCustomersTotalProductAmount` integer
    - `offlineCustomerOrders` integer
    - `offlineCustomersTotalProductAmount` integer
    - `newOnlineCustomers` integer
    - `newOfflineCustomers` integer
    - `newOnlineCustomerOrders` integer
    - `newOnlineCustomersTotalProductAmount` integer
    - `newOfflineCustomerOrders` integer
    - `newOfflineCustomersTotalProductAmount` integer
    - `averageBasketSize` number, double
    - `returningCustomers` integer
    - `returningCustomersAmount` number, double
    - `uniqueCustomers` integer
    - `averageSpentPerCustomer` number, double
    - `totalProductQuantity` integer
    - `averagePricePerItem` number, double
    - `productDiscount` number, double
    - `orderDiscount` number, double
    - `redeemedAmount` number, double
    - `deliveryCharge` number, double
  - `summary` KhaasFoodReportsDtosSalesOverviewReportResultSummary
    - `name` string, nullable
    - `totalProductAmount` number, double
    - `totalOrders` integer
    - `newCustomers` integer
    - `newCustomerOrders` integer
    - `newCustomersTotalProductAmount` number, double
    - `onlineCustomers` integer
    - `offlineCustomers` integer
    - `onlineCustomerOrders` integer
    - `onlineCustomersTotalProductAmount` integer
    - `offlineCustomerOrders` integer
    - `offlineCustomersTotalProductAmount` integer
    - `newOnlineCustomers` integer
    - `newOfflineCustomers` integer
    - `newOnlineCustomerOrders` integer
    - `newOnlineCustomersTotalProductAmount` integer
    - `newOfflineCustomerOrders` integer
    - `newOfflineCustomersTotalProductAmount` integer
    - `averageBasketSize` number, double
    - `returningCustomers` integer
    - `returningCustomersAmount` number, double
    - `uniqueCustomers` integer
    - `averageSpentPerCustomer` number, double
    - `totalProductQuantity` integer
    - `averagePricePerItem` number, double
    - `productDiscount` number, double
    - `orderDiscount` number, double
    - `redeemedAmount` number, double
    - `deliveryCharge` number, double
  - `customerSummary` KhaasFoodReportsDtosSalesOverviewReportResultTotalCustomerSummary
    - `newCustomers` integer
    - `onlineCustomers` integer
    - `offlineCustomers` integer
    - `newOnlineCustomers` integer
    - `newOfflineCustomers` integer
    - `uniqueCustomers` integer

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Server Error
- `501`: Server Error

---

[API](https://skmtc.dev/khaasfood/apis/khaasfood-api.md) - [All operations](https://skmtc.dev/khaasfood/apis/khaasfood-api/llms.txt) - [OpenAPI document](https://skmtc.dev/khaasfood/apis/khaasfood-api/revisions/149b6034bea9?raw)
