GET api/product/{id}/sales/histories?storeID={storeID}
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:41:16.8622394", "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:41:16.8622394+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:41:16.8622394+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�~�k� 5 xl/workbook.xml � (� ����0D�&�C���R8q����Ri�-ik��-H�yۙ�};b������G�箠]cΘ�j�';����: !J�b�m���ʷF�9 (k|�FOW�?,?:��w�A+J�2�<s����/2[��$l �ߔX`�Ţ��� %�so z���*��c�&ٍs��H��w�`���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="R495c2d83215749b2" /></Relationships>PK (=�Z� �� � xl/worksheets/sheet1.xml � (� ��[s�0�� ����l¥�v�Zk�=������矈�$0P^\k�lw� ���'^�<I#��`���XD�ϡ�˖|�r4؋�+]q�ҾI/���ʲ�m�����[���R$q������e4�c1��|�ٔ�N�:��R�*ڦ��oj�ۄ����x},��� ��~��H�rh^��M� r�G��i��8��B|n�C��^�f�䋿%Ƃ/��:����G��L�噹X���G�љF����h���f`�C\*��]�����g(��-r���q8���m�c��s�Y^@|�!0�b��N�wz�͊�s��{�X�w�O BW�+�^�u�"���E.�RA�;KС��yt8uF �r=`��l��/[�a>� �P�X�@e�RI�NG��/���A_Ġdܾɒ.��|�0 9)Gn��r���9�:�0G�D�$�e��Օ�L�J�>�<�Gd`���� �qSwP�1�;Pu�����Lu������긯;|��Pw��ab�P�,�T�,�X_,�\_,�`�,�d�,�hg ��lm މ>z�����i���7ո<t(�P^�F�=7T�,�-�L�q�m�]�eZ]-m�{����CUe��XU]]}����>WU_W_�j����̈.�)2��"S]�)ru^ Nx� [p�n���85T�qjifR��p�L�'l� [q�V��'l� [q�v��'l� �q�+�ɕ|#��D��'����2�PK (=�Z(�(�� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;��Χ�������8�H��6�����W�E��H]t�j4��'�|���o�H����l��A�\7ؾ�S� l7�=�"��`�9��bC&�yEiP' 7�M��$bJ}Og���G�d��>g�-�.3���>;u���?����c0��A�c?�@�aQ$*�]��^3,���C���л��x1�z}�L)�Ҫ�Y��,�]e��ؽD�.�;��L �))��#_�Z�����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�~�k� 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 G xl/styles.xmlPK- (=�Z; � � � xl/sharedStrings.xmlPK � !
application/vnd.ms-excel
PK (=�Z���w� 5 xl/workbook.xml � (� ����0��&�C���R8q���{-[i�?ik��-%�x�3;�����i�>z4��5�ct!A�y8X&����$��X)��֊�IA�xyTք^���?��<�.� Q�Jsep��!��fS�2k��Dd ��˰�"+d���<r��s�j|��W* ���������+{�1��n�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 (=�Zy�,�' ' _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="R7f204bb0a08341bd" /></Relationships>PK (=�Z� �� � xl/worksheets/sheet1.xml � (� ��[s�0�� ����l¥�v�Zk�=������矈�$0P^\k�lw� ���'^�<I#��`���XD�ϡ�˖|�r4؋�+]q�ҾI/���ʲ�m�����[���R$q������e4�c1��|�ٔ�N�:��R�*ڦ��oj�ۄ����x},��� ��~��H�rh^��M� r�G��i��8��B|n�C��^�f�䋿%Ƃ/��:����G��L�噹X���G�љF����h���f`�C\*��]�����g(��-r���q8���m�c��s�Y^@|�!0�b��N�wz�͊�s��{�X�w�O BW�+�^�u�"���E.�RA�;KС��yt8uF �r=`��l��/[�a>� �P�X�@e�RI�NG��/���A_Ġdܾɒ.��|�0 9)Gn��r���9�:�0G�D�$�e��Օ�L�J�>�<�Gd`���� �qSwP�1�;Pu�����Lu������긯;|��Pw��ab�P�,�T�,�X_,�\_,�`�,�d�,�hg ��lm މ>z�����i���7ո<t(�P^�F�=7T�,�-�L�q�m�]�eZ]-m�{����CUe��XU]]}����>WU_W_�j����̈.�)2��"S]�)ru^ Nx� [p�n���85T�qjifR��p�L�'l� [q�V��'l� [q�v��'l� �q�+�ɕ|#��D��'����2�PK (=�Z1Lw� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�N�&EM�a�m��=��&vd����G� XEWb�������4����M#9���-�A��l��)v l7�=�2��`�9��bC&���ҠN2nF�:��)�=��:�i�ؒ���Lr�����A�S� m�L_�?����1��S �x��@v���f]��B�X)�%B��e�����g2lQ���Z,�Q��]e����O�Ν�r�&&Q4r%U#xͮj��/6_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���w� 5 xl/workbook.xmlPK- (=�Z���� � � [Content_Types].xmlPK- (=�Zy�,�' ' U _rels/.relsPK- (=�Z� �� � � xl/worksheets/sheet1.xmlPK- (=�Z1Lw� P xl/_rels/workbook.xml.relsPK- (=�ZЃc'2 E H xl/styles.xmlPK- (=�Z; � � � xl/sharedStrings.xmlPK � "