GET a/PosItemGroupSales/GetItemGroupSales?start={start}&end={end}
Get sales information for the report period, grouped by item group
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| start |
Start of report period |
date |
Required |
| end |
End of report period |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
Sales summary grouped by Item Group
Collection of PosItemsSalesSummaryDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemName |
Gets or set the Name of the Item |
string |
None. |
| ItemPosIdentifier |
Gets or sets the POS specific identifier of this item |
string |
None. |
| ItemGroupName |
Gets or sets the Item Group Name |
string |
None. |
| ItemGroupIdentifier |
Gets or sets the POS specific identifier of the item group |
string |
None. |
| ItemCategoryName |
Gets or sets the Item Category name |
string |
None. |
| ItemCategoryIdentifier |
Gets or sets the POS specific identifier of the item category |
string |
None. |
| Invoices |
Gets or sets the total dollar amount invoiced for this item |
decimal number |
None. |
| Quantity |
Gets or sets the quantity of this item that was sold |
decimal number |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"itemName": "sample string 1",
"itemPosIdentifier": "sample string 2",
"itemGroupName": "sample string 3",
"itemGroupIdentifier": "sample string 4",
"itemCategoryName": "sample string 5",
"itemCategoryIdentifier": "sample string 6",
"invoices": 7.0,
"quantity": 8.1
},
{
"itemName": "sample string 1",
"itemPosIdentifier": "sample string 2",
"itemGroupName": "sample string 3",
"itemGroupIdentifier": "sample string 4",
"itemCategoryName": "sample string 5",
"itemCategoryIdentifier": "sample string 6",
"invoices": 7.0,
"quantity": 8.1
}
]
application/xml, text/xml
Sample:
<ArrayOfPosItemsSalesSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loaded.WebApi.Models.POS.Items">
<PosItemsSalesSummaryDTO>
<Invoices>7</Invoices>
<ItemCategoryIdentifier>sample string 6</ItemCategoryIdentifier>
<ItemCategoryName>sample string 5</ItemCategoryName>
<ItemGroupIdentifier>sample string 4</ItemGroupIdentifier>
<ItemGroupName>sample string 3</ItemGroupName>
<ItemName>sample string 1</ItemName>
<ItemPosIdentifier>sample string 2</ItemPosIdentifier>
<Quantity>8.1</Quantity>
</PosItemsSalesSummaryDTO>
<PosItemsSalesSummaryDTO>
<Invoices>7</Invoices>
<ItemCategoryIdentifier>sample string 6</ItemCategoryIdentifier>
<ItemCategoryName>sample string 5</ItemCategoryName>
<ItemGroupIdentifier>sample string 4</ItemGroupIdentifier>
<ItemGroupName>sample string 3</ItemGroupName>
<ItemName>sample string 1</ItemName>
<ItemPosIdentifier>sample string 2</ItemPosIdentifier>
<Quantity>8.1</Quantity>
</PosItemsSalesSummaryDTO>
</ArrayOfPosItemsSalesSummaryDTO>