POST SalesReport/GetSaleItems

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.SalesReport.SalesReport.ReportViewModel

Name	Type	Additional information
DateFilterBy	IConnect.Domain.Reports.SalesReport.SalesReport.DateFilterBy	None.
SortByList	Collection of IConnect.Core.JsonSimpleViewModel	None.
EnteredBy	integer	None.
SalesPerson	integer	None.
OrderTypeCode	string	None.
ExcludeGiftCards	boolean	None.
SelectedCustomer	integer	None.
SelectedPaymentMethods	Collection of integer	None.
SortBy	IConnect.Domain.Reports.SalesReport.SalesReport.SortBy	None.
DefaultSortBy	IConnect.Domain.Reports.SalesReport.SalesReport.SortBy	None.
SelectedStartTime	date	None.
SelectedEndTime	date	None.
DollarPerTicket	decimal number	None.
ProductPerTicket	decimal number	None.
SelectedDollarPerTicketFilter	integer	None.
SelectedProductPerTicketFilter	integer	None.
ExcludeSKUs	string	None.
PageIndex	integer	None.
PageSize	integer	None.
ReportFormat	IConnect.Domain.Reports.ExportFormat	None.
PageResult	boolean	None.
DeliveryBy	IConnect.Domain.Companies.DeliveryProvider	None.
DeliveryByList	Collection of IConnect.Core.JsonSimpleViewModel	None.
ShippingOption	IConnect.Domain.POS.ShippingOptions	None.
GroupBy	IConnect.Domain.Reports.SalesReport.SalesReport.GroupBy	None.
DeviceId	string	None.
ZipCode	string	None.
ShippingOptionsList	Collection of IConnect.Core.JsonSimpleViewModel	None.
SelectedCompanies	Collection of integer	None.
OrderSource	IConnect.Domain.Orders.DisplayOrderSource	None.
Start	date	None.
End	date	None.
StartDateObjectString	string	None.
EndDateObjectString	string	None.
SkipTimeZoneConvertion	boolean	None.
ForceImmediateExport	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "DateFilterBy": 0,
  "SortByList": [
    {
      "id": {},
      "name": "sample string 2"
    },
    {
      "id": {},
      "name": "sample string 2"
    }
  ],
  "EnteredBy": 1,
  "SalesPerson": 1,
  "OrderTypeCode": "sample string 1",
  "ExcludeGiftCards": true,
  "SelectedCustomer": 3,
  "SelectedPaymentMethods": [
    1,
    2
  ],
  "SortBy": 0,
  "DefaultSortBy": 0,
  "SelectedStartTime": "2025-04-03T22:30:47.5276602-04:00",
  "SelectedEndTime": "2025-04-03T22:30:47.5276602-04:00",
  "DollarPerTicket": 1.0,
  "ProductPerTicket": 1.0,
  "SelectedDollarPerTicketFilter": 4,
  "SelectedProductPerTicketFilter": 5,
  "ExcludeSKUs": "sample string 6",
  "PageIndex": 7,
  "PageSize": 8,
  "ReportFormat": 1,
  "PageResult": true,
  "DeliveryBy": 1,
  "DeliveryByList": [
    {
      "id": {},
      "name": "sample string 2"
    },
    {
      "id": {},
      "name": "sample string 2"
    }
  ],
  "ShippingOption": 0,
  "GroupBy": 0,
  "DeviceId": "sample string 10",
  "ZipCode": "sample string 11",
  "ShippingOptionsList": [
    {
      "id": {},
      "name": "sample string 2"
    },
    {
      "id": {},
      "name": "sample string 2"
    }
  ],
  "SelectedCompanies": [
    1,
    2
  ],
  "OrderSource": 1,
  "Start": "2025-04-03T22:30:47.5276602-04:00",
  "End": "2025-04-03T22:30:47.5276602-04:00",
  "StartDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":30,\"seconds\":47,\"miliseconds\":527}",
  "EndDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":30,\"seconds\":47,\"miliseconds\":527}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IConnect.Core.PagedListOfIConnect.Domain.Reports.SalesReport.SalesReport.SalesReportItem

Name	Type	Additional information
Data	Collection of IConnect.Domain.Reports.SalesReport.SalesReport.SalesReportItem	None.
Footer	IConnect.Domain.Reports.SalesReport.SalesReport.SalesReportItem	None.
PageFooter	IConnect.Domain.Reports.SalesReport.SalesReport.SalesReportItem	None.
PageNumber	integer	None.
PageSize	integer	None.
TotalRows	integer	None.
TotalPages	integer	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<PagedListOfSalesReportItem5uzyVbJL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core">
  <PageNumber>1</PageNumber>
  <PageSize>2</PageSize>
  <TotalPages>4</TotalPages>
  <TotalRows>3</TotalRows>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.SalesReport">
    <d2p1:SalesReportItem>
      <d2p1:Cashier>sample string 10</d2p1:Cashier>
      <d2p1:CashierId>7</d2p1:CashierId>
      <d2p1:CustomReceiptNumber>sample string 2</d2p1:CustomReceiptNumber>
      <d2p1:Customer>sample string 5</d2p1:Customer>
      <d2p1:CustomerId>8</d2p1:CustomerId>
      <d2p1:Date>2025-04-03T22:30:47.5276602-04:00</d2p1:Date>
      <d2p1:DeliveryEmployeeId>1</d2p1:DeliveryEmployeeId>
      <d2p1:DeliveryEmployeeName>sample string 26</d2p1:DeliveryEmployeeName>
      <d2p1:DeliveryProvider>BuiltIn</d2p1:DeliveryProvider>
      <d2p1:IsFirstPayment>true</d2p1:IsFirstPayment>
      <d2p1:IsRestarant>true</d2p1:IsRestarant>
      <d2p1:IsSplitted>sample string 22</d2p1:IsSplitted>
      <d2p1:Location>sample string 11</d2p1:Location>
      <d2p1:OrderSource>POS</d2p1:OrderSource>
      <d2p1:OrderTypeId>1</d2p1:OrderTypeId>
      <d2p1:OrderTypeName>sample string 25</d2p1:OrderTypeName>
      <d2p1:PaymentAmount>12</d2p1:PaymentAmount>
      <d2p1:PaymentDate>2025-04-03T22:30:47.5276602-04:00</d2p1:PaymentDate>
      <d2p1:PaymentId>9</d2p1:PaymentId>
      <d2p1:PaymentMethod>sample string 4</d2p1:PaymentMethod>
      <d2p1:PaymentMethodId>3</d2p1:PaymentMethodId>
      <d2p1:RemainingBalance>21</d2p1:RemainingBalance>
      <d2p1:RewardPointsAmount>13</d2p1:RewardPointsAmount>
      <d2p1:SalesPersonIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:SalesPersonIds>
      <d2p1:SalesPersons xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:SalesPersons>
      <d2p1:ShippingOption>InStore</d2p1:ShippingOption>
      <d2p1:ShippingStatusId>24</d2p1:ShippingStatusId>
      <d2p1:TicketDiscount>15</d2p1:TicketDiscount>
      <d2p1:TicketId>1</d2p1:TicketId>
      <d2p1:TicketSubtotal>18</d2p1:TicketSubtotal>
      <d2p1:TicketTax>16</d2p1:TicketTax>
      <d2p1:TicketTips>17</d2p1:TicketTips>
      <d2p1:TicketTotal>19</d2p1:TicketTotal>
      <d2p1:TotalPaid>20</d2p1:TotalPaid>
      <d2p1:ZipPostal>sample string 6</d2p1:ZipPostal>
    </d2p1:SalesReportItem>
    <d2p1:SalesReportItem>
      <d2p1:Cashier>sample string 10</d2p1:Cashier>
      <d2p1:CashierId>7</d2p1:CashierId>
      <d2p1:CustomReceiptNumber>sample string 2</d2p1:CustomReceiptNumber>
      <d2p1:Customer>sample string 5</d2p1:Customer>
      <d2p1:CustomerId>8</d2p1:CustomerId>
      <d2p1:Date>2025-04-03T22:30:47.5276602-04:00</d2p1:Date>
      <d2p1:DeliveryEmployeeId>1</d2p1:DeliveryEmployeeId>
      <d2p1:DeliveryEmployeeName>sample string 26</d2p1:DeliveryEmployeeName>
      <d2p1:DeliveryProvider>BuiltIn</d2p1:DeliveryProvider>
      <d2p1:IsFirstPayment>true</d2p1:IsFirstPayment>
      <d2p1:IsRestarant>true</d2p1:IsRestarant>
      <d2p1:IsSplitted>sample string 22</d2p1:IsSplitted>
      <d2p1:Location>sample string 11</d2p1:Location>
      <d2p1:OrderSource>POS</d2p1:OrderSource>
      <d2p1:OrderTypeId>1</d2p1:OrderTypeId>
      <d2p1:OrderTypeName>sample string 25</d2p1:OrderTypeName>
      <d2p1:PaymentAmount>12</d2p1:PaymentAmount>
      <d2p1:PaymentDate>2025-04-03T22:30:47.5276602-04:00</d2p1:PaymentDate>
      <d2p1:PaymentId>9</d2p1:PaymentId>
      <d2p1:PaymentMethod>sample string 4</d2p1:PaymentMethod>
      <d2p1:PaymentMethodId>3</d2p1:PaymentMethodId>
      <d2p1:RemainingBalance>21</d2p1:RemainingBalance>
      <d2p1:RewardPointsAmount>13</d2p1:RewardPointsAmount>
      <d2p1:SalesPersonIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:SalesPersonIds>
      <d2p1:SalesPersons xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:SalesPersons>
      <d2p1:ShippingOption>InStore</d2p1:ShippingOption>
      <d2p1:ShippingStatusId>24</d2p1:ShippingStatusId>
      <d2p1:TicketDiscount>15</d2p1:TicketDiscount>
      <d2p1:TicketId>1</d2p1:TicketId>
      <d2p1:TicketSubtotal>18</d2p1:TicketSubtotal>
      <d2p1:TicketTax>16</d2p1:TicketTax>
      <d2p1:TicketTips>17</d2p1:TicketTips>
      <d2p1:TicketTotal>19</d2p1:TicketTotal>
      <d2p1:TotalPaid>20</d2p1:TotalPaid>
      <d2p1:ZipPostal>sample string 6</d2p1:ZipPostal>
    </d2p1:SalesReportItem>
  </Data>
  <Footer xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.SalesReport">
    <d2p1:Cashier>sample string 10</d2p1:Cashier>
    <d2p1:CashierId>7</d2p1:CashierId>
    <d2p1:CustomReceiptNumber>sample string 2</d2p1:CustomReceiptNumber>
    <d2p1:Customer>sample string 5</d2p1:Customer>
    <d2p1:CustomerId>8</d2p1:CustomerId>
    <d2p1:Date>2025-04-03T22:30:47.5276602-04:00</d2p1:Date>
    <d2p1:DeliveryEmployeeId>1</d2p1:DeliveryEmployeeId>
    <d2p1:DeliveryEmployeeName>sample string 26</d2p1:DeliveryEmployeeName>
    <d2p1:DeliveryProvider>BuiltIn</d2p1:DeliveryProvider>
    <d2p1:IsFirstPayment>true</d2p1:IsFirstPayment>
    <d2p1:IsRestarant>true</d2p1:IsRestarant>
    <d2p1:IsSplitted>sample string 22</d2p1:IsSplitted>
    <d2p1:Location>sample string 11</d2p1:Location>
    <d2p1:OrderSource>POS</d2p1:OrderSource>
    <d2p1:OrderTypeId>1</d2p1:OrderTypeId>
    <d2p1:OrderTypeName>sample string 25</d2p1:OrderTypeName>
    <d2p1:PaymentAmount>12</d2p1:PaymentAmount>
    <d2p1:PaymentDate>2025-04-03T22:30:47.5276602-04:00</d2p1:PaymentDate>
    <d2p1:PaymentId>9</d2p1:PaymentId>
    <d2p1:PaymentMethod>sample string 4</d2p1:PaymentMethod>
    <d2p1:PaymentMethodId>3</d2p1:PaymentMethodId>
    <d2p1:RemainingBalance>21</d2p1:RemainingBalance>
    <d2p1:RewardPointsAmount>13</d2p1:RewardPointsAmount>
    <d2p1:SalesPersonIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:SalesPersonIds>
    <d2p1:SalesPersons xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:SalesPersons>
    <d2p1:ShippingOption>InStore</d2p1:ShippingOption>
    <d2p1:ShippingStatusId>24</d2p1:ShippingStatusId>
    <d2p1:TicketDiscount>15</d2p1:TicketDiscount>
    <d2p1:TicketId>1</d2p1:TicketId>
    <d2p1:TicketSubtotal>18</d2p1:TicketSubtotal>
    <d2p1:TicketTax>16</d2p1:TicketTax>
    <d2p1:TicketTips>17</d2p1:TicketTips>
    <d2p1:TicketTotal>19</d2p1:TicketTotal>
    <d2p1:TotalPaid>20</d2p1:TotalPaid>
    <d2p1:ZipPostal>sample string 6</d2p1:ZipPostal>
  </Footer>
  <PageFooter xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.SalesReport">
    <d2p1:Cashier>sample string 10</d2p1:Cashier>
    <d2p1:CashierId>7</d2p1:CashierId>
    <d2p1:CustomReceiptNumber>sample string 2</d2p1:CustomReceiptNumber>
    <d2p1:Customer>sample string 5</d2p1:Customer>
    <d2p1:CustomerId>8</d2p1:CustomerId>
    <d2p1:Date>2025-04-03T22:30:47.5276602-04:00</d2p1:Date>
    <d2p1:DeliveryEmployeeId>1</d2p1:DeliveryEmployeeId>
    <d2p1:DeliveryEmployeeName>sample string 26</d2p1:DeliveryEmployeeName>
    <d2p1:DeliveryProvider>BuiltIn</d2p1:DeliveryProvider>
    <d2p1:IsFirstPayment>true</d2p1:IsFirstPayment>
    <d2p1:IsRestarant>true</d2p1:IsRestarant>
    <d2p1:IsSplitted>sample string 22</d2p1:IsSplitted>
    <d2p1:Location>sample string 11</d2p1:Location>
    <d2p1:OrderSource>POS</d2p1:OrderSource>
    <d2p1:OrderTypeId>1</d2p1:OrderTypeId>
    <d2p1:OrderTypeName>sample string 25</d2p1:OrderTypeName>
    <d2p1:PaymentAmount>12</d2p1:PaymentAmount>
    <d2p1:PaymentDate>2025-04-03T22:30:47.5276602-04:00</d2p1:PaymentDate>
    <d2p1:PaymentId>9</d2p1:PaymentId>
    <d2p1:PaymentMethod>sample string 4</d2p1:PaymentMethod>
    <d2p1:PaymentMethodId>3</d2p1:PaymentMethodId>
    <d2p1:RemainingBalance>21</d2p1:RemainingBalance>
    <d2p1:RewardPointsAmount>13</d2p1:RewardPointsAmount>
    <d2p1:SalesPersonIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:SalesPersonIds>
    <d2p1:SalesPersons xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:SalesPersons>
    <d2p1:ShippingOption>InStore</d2p1:ShippingOption>
    <d2p1:ShippingStatusId>24</d2p1:ShippingStatusId>
    <d2p1:TicketDiscount>15</d2p1:TicketDiscount>
    <d2p1:TicketId>1</d2p1:TicketId>
    <d2p1:TicketSubtotal>18</d2p1:TicketSubtotal>
    <d2p1:TicketTax>16</d2p1:TicketTax>
    <d2p1:TicketTips>17</d2p1:TicketTips>
    <d2p1:TicketTotal>19</d2p1:TicketTotal>
    <d2p1:TotalPaid>20</d2p1:TotalPaid>
    <d2p1:ZipPostal>sample string 6</d2p1:ZipPostal>
  </PageFooter>
</PagedListOfSalesReportItem5uzyVbJL>

URI parameters

Headers | Add header

Body

Status

Headers

Body

POST SalesReport/GetSaleItems

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json

text/json

application/xml, text/xml