POST api/SaleReport/GetSaleSummaryReportNew
Request Information
URI Parameters
None.
Body Parameters
SummaryReportRequestName | Description | Type | Additional information |
---|---|---|---|
ReportType | integer |
None. |
|
FromDate | date |
None. |
|
ToDate | date |
None. |
|
CustomerId | integer |
None. |
|
CustomerEmail | string |
None. |
|
Telephone | string |
None. |
|
BillingAddress | string |
None. |
|
ShippingAddress | string |
None. |
|
PaymentMethodId | integer |
None. |
|
ShippingMethodId | integer |
None. |
|
ProductId | integer |
None. |
|
SKU | string |
None. |
|
Model | string |
None. |
|
ManufacturerCode | string |
None. |
|
IsGetAll | boolean |
None. |
|
PageNo | integer |
None. |
|
PageSize | integer |
None. |
|
OrderType | integer |
None. |
|
ManufacturerId | integer |
None. |
|
RequestedUserID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "ReportType": 1, "FromDate": "2025-01-22T20:57:02.3436997-06:00", "ToDate": "2025-01-22T20:57:02.3436997-06:00", "CustomerId": 4, "CustomerEmail": "sample string 5", "Telephone": "sample string 6", "BillingAddress": "sample string 7", "ShippingAddress": "sample string 8", "PaymentMethodId": 9, "ShippingMethodId": 10, "ProductId": 11, "SKU": "sample string 12", "Model": "sample string 13", "ManufacturerCode": "sample string 14", "IsGetAll": true, "PageNo": 16, "PageSize": 17, "OrderType": 18, "ManufacturerId": 19, "RequestedUserID": 1 }
application/xml, text/xml
Sample:
<SummaryReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Request"> <RequestedUserID>1</RequestedUserID> <BillingAddress>sample string 7</BillingAddress> <CustomerEmail>sample string 5</CustomerEmail> <CustomerId>4</CustomerId> <FromDate>2025-01-22T20:57:02.3436997-06:00</FromDate> <IsGetAll>true</IsGetAll> <ManufacturerCode>sample string 14</ManufacturerCode> <ManufacturerId>19</ManufacturerId> <Model>sample string 13</Model> <OrderType>18</OrderType> <PageNo>16</PageNo> <PageSize>17</PageSize> <PaymentMethodId>9</PaymentMethodId> <ProductId>11</ProductId> <ReportType>1</ReportType> <SKU>sample string 12</SKU> <ShippingAddress>sample string 8</ShippingAddress> <ShippingMethodId>10</ShippingMethodId> <Telephone>sample string 6</Telephone> <ToDate>2025-01-22T20:57:02.3436997-06:00</ToDate> </SummaryReportRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SummaryReportResponseName | Description | Type | Additional information |
---|---|---|---|
SummaryData | Collection of SummaryReportModel |
None. |
|
ResponseCode | integer |
None. |
|
ResponseText | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "SummaryData": [ { "Year": "sample string 1", "DayOfWeek": "sample string 2", "Hour": "sample string 3", "Month": "sample string 4", "Address": "sample string 5", "ShippingMethod": "sample string 6", "SaleIds": "sample string 7", "StatTableIds": "sample string 8", "Orders": "sample string 9", "Customers": "sample string 10", "Products": "sample string 11", "Discounts": "sample string 12", "TotalValue": "sample string 13", "AvgOrders": "sample string 14", "ProductRefunds": "sample string 15", "TotalProfit": "sample string 16", "TotalExpenses": "sample string 17" }, { "Year": "sample string 1", "DayOfWeek": "sample string 2", "Hour": "sample string 3", "Month": "sample string 4", "Address": "sample string 5", "ShippingMethod": "sample string 6", "SaleIds": "sample string 7", "StatTableIds": "sample string 8", "Orders": "sample string 9", "Customers": "sample string 10", "Products": "sample string 11", "Discounts": "sample string 12", "TotalValue": "sample string 13", "AvgOrders": "sample string 14", "ProductRefunds": "sample string 15", "TotalProfit": "sample string 16", "TotalExpenses": "sample string 17" } ], "ResponseCode": 1, "ResponseText": "sample string 2" }
application/xml, text/xml
Sample:
<SummaryReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Response"> <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">1</ResponseCode> <ResponseText xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">sample string 2</ResponseText> <SummaryData> <SummaryReportModel> <Address>sample string 5</Address> <AvgOrders>sample string 14</AvgOrders> <Customers>sample string 10</Customers> <DayOfWeek>sample string 2</DayOfWeek> <Discounts>sample string 12</Discounts> <Hour>sample string 3</Hour> <Month>sample string 4</Month> <Orders>sample string 9</Orders> <ProductRefunds>sample string 15</ProductRefunds> <Products>sample string 11</Products> <SaleIds>sample string 7</SaleIds> <ShippingMethod>sample string 6</ShippingMethod> <StatTableIds>sample string 8</StatTableIds> <TotalExpenses>sample string 17</TotalExpenses> <TotalProfit>sample string 16</TotalProfit> <TotalValue>sample string 13</TotalValue> <Year>sample string 1</Year> </SummaryReportModel> <SummaryReportModel> <Address>sample string 5</Address> <AvgOrders>sample string 14</AvgOrders> <Customers>sample string 10</Customers> <DayOfWeek>sample string 2</DayOfWeek> <Discounts>sample string 12</Discounts> <Hour>sample string 3</Hour> <Month>sample string 4</Month> <Orders>sample string 9</Orders> <ProductRefunds>sample string 15</ProductRefunds> <Products>sample string 11</Products> <SaleIds>sample string 7</SaleIds> <ShippingMethod>sample string 6</ShippingMethod> <StatTableIds>sample string 8</StatTableIds> <TotalExpenses>sample string 17</TotalExpenses> <TotalProfit>sample string 16</TotalProfit> <TotalValue>sample string 13</TotalValue> <Year>sample string 1</Year> </SummaryReportModel> </SummaryData> </SummaryReportResponse>