GET api/store/{storeID}/product/{id}/sales/histories
Get a group of sales histories for multiple periods
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Product identifier |
globally unique identifier |
Required |
storeID |
Store to restrict sales information to |
integer |
Default value is 0 |
PLUG_UID | Collection of byte |
None. |
|
PluGuid |
Product to get sales history of |
globally unique identifier |
None. |
SummaryPeriods |
Period to summarise |
Collection of integer |
None. |
TodayLocal |
CurrentDate |
date |
Required |
IncludeExternalSales |
Whether external sales should be included |
boolean |
None. |
Stores |
List of stores to restrict sales records to |
Collection of integer |
None. |
Skip |
Number of records to skip over |
integer |
None. |
Take |
Number of records to take |
integer |
None. |
TotalCount | integer |
Relation. This field may not always be loaded or used for updates. |
Body Parameters
None.
Response Information
Resource Description
List of sales history records for periods
Collection of SalesHistoryName | Description | Type | Additional information |
---|---|---|---|
StoreID | integer |
Relation. This field may not always be loaded or used for updates. |
|
StoreName |
Store name |
string |
Relation. This field may not always be loaded or used for updates. |
PeriodBeginning |
First day of summary period |
date |
Relation. This field may not always be loaded or used for updates. |
Period |
First day of summary period |
SalesHistorySummaryPeriod |
Relation. This field may not always be loaded or used for updates. |
Hour |
Hour of the summary if by hour |
integer |
Relation. This field may not always be loaded or used for updates. |
PLUG_UID | Collection of byte |
Relation. This field may not always be loaded or used for updates. |
|
PluGuid |
Product guid |
globally unique identifier |
Relation. This field may not always be loaded or used for updates. |
Quantity |
Quantity of items sold |
decimal number |
Relation. This field may not always be loaded or used for updates. |
Dumped |
Quantity of items dumped |
decimal number |
Relation. This field may not always be loaded or used for updates. |
AvgUnitSellInc |
Average SellPrice for the period |
decimal number |
Relation. This field may not always be loaded or used for updates. |
AvgUnitSellEx |
Average SellPrice for the period |
decimal number |
Relation. This field may not always be loaded or used for updates. |
AvgUnitCostInc |
Average Cost for the period |
decimal number |
Relation. This field may not always be loaded or used for updates. |
AvgUnitCostEx |
Average Cost for the period |
decimal number |
Relation. This field may not always be loaded or used for updates. |
SalesInc |
Value of the Sale Price including tax of sales |
decimal number |
Relation. This field may not always be loaded or used for updates. |
SalesEx |
Value of the Sale Price excluding tax of sales |
decimal number |
Relation. This field may not always be loaded or used for updates. |
CostInc |
Value of the Cost including tax of sales |
decimal number |
Relation. This field may not always be loaded or used for updates. |
CostEx |
Value of the Cost excluding tax of sales |
decimal number |
Relation. This field may not always be loaded or used for updates. |
GrossProfit |
Gross Profit dollar value |
decimal number |
Relation. This field may not always be loaded or used for updates. |
Response Formats
application/json, text/json
[ { "$id": "1", "storeID": 1, "storeName": "sample string 1", "periodBeginning": "2025-06-14T07:40:11.1136608", "period": 0, "hour": 1, "quantity": 3.1, "dumped": 4.1, "avgUnitSellInc": 5.1, "avgUnitSellEx": 6.1, "avgUnitCostInc": 7.1, "avgUnitCostEx": 8.1, "salesInc": 9.1, "salesEx": 10.1, "costInc": 11.1, "costEx": 12.1, "grossProfit": 13.1 }, { "$ref": "1" } ]
application/xml, text/xml
<ArrayOfSalesHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Sales"> <SalesHistory> <AvgUnitCostEx>8.1</AvgUnitCostEx> <AvgUnitCostInc>7.1</AvgUnitCostInc> <AvgUnitSellEx>6.1</AvgUnitSellEx> <AvgUnitSellInc>5.1</AvgUnitSellInc> <CostEx>12.1</CostEx> <CostInc>11.1</CostInc> <Dumped>4.1</Dumped> <GrossProfit>13.1</GrossProfit> <Hour>1</Hour> <PLUG_UID i:nil="true" /> <Period>Hourly</Period> <PeriodBeginning>2025-06-14T07:40:11.1136608+00:00</PeriodBeginning> <PluGuid i:nil="true" /> <Quantity>3.1</Quantity> <SalesEx>10.1</SalesEx> <SalesInc>9.1</SalesInc> <StoreID>1</StoreID> <StoreName>sample string 1</StoreName> </SalesHistory> <SalesHistory> <AvgUnitCostEx>8.1</AvgUnitCostEx> <AvgUnitCostInc>7.1</AvgUnitCostInc> <AvgUnitSellEx>6.1</AvgUnitSellEx> <AvgUnitSellInc>5.1</AvgUnitSellInc> <CostEx>12.1</CostEx> <CostInc>11.1</CostInc> <Dumped>4.1</Dumped> <GrossProfit>13.1</GrossProfit> <Hour>1</Hour> <PLUG_UID i:nil="true" /> <Period>Hourly</Period> <PeriodBeginning>2025-06-14T07:40:11.1136608+00:00</PeriodBeginning> <PluGuid i:nil="true" /> <Quantity>3.1</Quantity> <SalesEx>10.1</SalesEx> <SalesInc>9.1</SalesInc> <StoreID>1</StoreID> <StoreName>sample string 1</StoreName> </SalesHistory> </ArrayOfSalesHistory>
text/csv
Sample not available.
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK =�Z�+�� 5 xl/workbook.xml � (� ���� D�&���6��=��Ճw�EH4���oK�&��ξ6��=�����.V��:��"$ �ǃ�M;��i��E�RF@��ۂK�DiI�<�6C��Vp5@�����8��w����������l"���o�e�v�r�B�[�8Fٹ�1 ����,/��B���gyUxco0F���PK =�Z���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d� �d�k��<�H���V���= ��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ �1Z�$�8z�R��3 tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b ��%#H'�2}���e�B)��~j/F�t��PK =�Z��9' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R79e3cec5bc9f40ff" /></Relationships>PK =�Z~���� � xl/worksheets/sheet1.xml � (� ��[s�@�� ����4�%��r3&���Ϭ������w@Pf����9����j(F������i%۱ 1 �]$�h�16���o^NF�$��֜熰o��tl��|wa��b��0��� m��q�����NV�h�o��>��ܦ��v�7a.����.3��~R+ۥ<\�-ěc�8���d��D��{#嫱ys4 {2*�"~��F�O�%�gq�����-�\�-5�|�7�<9�x��ŐX�Y$���4��i��w�}���zl8ĥ½�gy�=�u���U��r�X#'p}ߣ�<Vy<���g#.���Tyg`߬ʱ�9�ʹ�~�� |��� ��*� \ׯr��\P傁9 5�������AO�Qg� -���QA�Hp��� � �� 5]�� T��(ty��T�����AMEj����邡xA���r�6z(F�Y�>�#�s��d�&#-eQ����YyT��'g�ׄ��"[9���7m��mʎ��ÑӶ�Ɏ��Õ��Óm�/;ێ@v�2ԧ�2���2֗�2���2ط�2���2�y��<[[�w����U���k�.�l�M3.J-�@<���C!����mw�f��8U���2k����ƃ�oT���2U��T]U}j���>7U_U_�j����̈*�I2��$SU�Krs^Nx� 58a?N�s�:��8i����-��-3��Z�P�jqB-N�� �8�'��z�P���xN��O�I��|���R&�PK =�Z1{]�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞؉�4��vÆm�\{�DMl�v���G� XEWb�������4����ٽ�yAFk:(��j4}�Z�m7{�DLa] iń�ݚ� �E(�C�:��YĔ��:!O�GZ1�P�3�I��!Z�G��V�g4�0}���� |����R��P� �Iu�W�B2ͥn8�U��л��x�0�z}��j��f����o�*3��9�t��)/gjbY!c�<2�k�VW5z��/PK =�ZЃc'2 E xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&� AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK =�Z; � � xl/sharedStrings.xml � (� }�AO�0��J�;˶B�-� �$��F�(j�.R�ؙ�O�P�q������Yq�@�c)g����o v��ߟ�n� ��j�Jy��*�X�(R)����R���i��0��Ns*C���[���j>�^+� J���\��L���3��GH#LUp�e`�,W�:K�W�`6�o�3���x�>�2�K�����W�d-ޢF6|���z�����F�[�v��?��x.<����ѭ�@#�o=�_1�{<�&���!"�z�B�1[����[�tk�PK- =�Z�+�� 5 xl/workbook.xmlPK- =�Z���� � � [Content_Types].xmlPK- =�Z��9' ' U _rels/.relsPK- =�Z~���� � � xl/worksheets/sheet1.xmlPK- =�Z1{]�� P xl/_rels/workbook.xml.relsPK- =�ZЃc'2 E I xl/styles.xmlPK- =�Z; � � � xl/sharedStrings.xmlPK � #
application/vnd.ms-excel
PK =�Z��� 5 xl/workbook.xml � (� ����0��&�C��@�R8q���{)�m�?ik��-%�x�3;���Ÿ�`�}Ԭ}�Z,B� !�P�_�w�q��(ݓ�i�z�� t E�U��̂4�i=�h���u�F/ ��7�bR��|B����d4�����"�)�`�ERH3-�Y`%�6�8��52��j(�Wu �*���>`�쿻/PK =�Z���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d� �d�k��<�H���V���= ��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ �1Z�$�8z�R��3 tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b ��%#H'�2}���e�B)��~j/F�t��PK =�Z>�*' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R1a17ced44493444b" /></Relationships>PK =�Z~���� � xl/worksheets/sheet1.xml � (� ��[s�@�� ����4�%��r3&���Ϭ������w@Pf����9����j(F������i%۱ 1 �]$�h�16���o^NF�$��֜熰o��tl��|wa��b��0��� m��q�����NV�h�o��>��ܦ��v�7a.����.3��~R+ۥ<\�-ěc�8���d��D��{#嫱ys4 {2*�"~��F�O�%�gq�����-�\�-5�|�7�<9�x��ŐX�Y$���4��i��w�}���zl8ĥ½�gy�=�u���U��r�X#'p}ߣ�<Vy<���g#.���Tyg`߬ʱ�9�ʹ�~�� |��� ��*� \ׯr��\P傁9 5�������AO�Qg� -���QA�Hp��� � �� 5]�� T��(ty��T�����AMEj����邡xA���r�6z(F�Y�>�#�s��d�&#-eQ����YyT��'g�ׄ��"[9���7m��mʎ��ÑӶ�Ɏ��Õ��Óm�/;ێ@v�2ԧ�2���2֗�2���2ط�2���2�y��<[[�w����U���k�.�l�M3.J-�@<���C!����mw�f��8U���2k����ƃ�oT���2U��T]U}j���>7U_U_�j����̈*�I2��$SU�Krs^Nx� 58a?N�s�:��8i����-��-3��Z�P�jqB-N�� �8�'��z�P���xN��O�I��|���R&�PK =�Z�'� P xl/_rels/workbook.xml.rels � (� ��An� E����;$��M7٦� ƃm�&Ms�.z�^�(�Z"u�MVh��� �����4�W�ap��<�)�];خ�g4O�� ��s � 5��5cA�0���l��'�����>�X���)��3��:��ΘAó�� ,�f�O�@J��w�5���<�TJ�mM�l$�+Y��x�=L-�u����]'2��B�T�J���镇�}�t�Ɖon��b�,nj��_l� PK =�ZЃc'2 E xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&� AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK =�Z; � � xl/sharedStrings.xml � (� }�AO�0��J�;˶B�-� �$��F�(j�.R�ؙ�O�P�q������Yq�@�c)g����o v��ߟ�n� ��j�Jy��*�X�(R)����R���i��0��Ns*C���[���j>�^+� J���\��L���3��GH#LUp�e`�,W�:K�W�`6�o�3���x�>�2�K�����W�d-ޢF6|���z�����F�[�v��?��x.<����ѭ�@#�o=�_1�{<�&���!"�z�B�1[����[�tk�PK- =�Z��� 5 xl/workbook.xmlPK- =�Z���� � � [Content_Types].xmlPK- =�Z>�*' ' U _rels/.relsPK- =�Z~���� � � xl/worksheets/sheet1.xmlPK- =�Z�'� P xl/_rels/workbook.xml.relsPK- =�ZЃc'2 E K xl/styles.xmlPK- =�Z; � � � xl/sharedStrings.xmlPK � %