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-08-02T23:23:49.3005757", "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-08-02T23:23:49.3005757+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-08-02T23:23:49.3005757+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 ��[M Q�� 5 xl/workbook.xml � (� ����0��&�C���48q���{m�@����[J ��mgv��if�ǧ�#��ɄڷX��jB��Y8Y&��5�I��à8��5�H J+�abQY�r��X�y`"H�����2�;j�fs�2[��Dd ��T�a�EV�0 -�Yde�&Z|���* �T��R�^˪�xgﰆl��/PK ��[���� � [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 ��[S��R' ' _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="R0639de3aa8ff46f0" /></Relationships>PK ��[�Ep�� � xl/worksheets/sheet1.xml � (� ���r�0�_���@vBt�N[k��E�5Gce*��}��&�E�Z;��o�0��I��7O�Xl�68ȶ�f.��sh����� �"��V�疴o��th��|{��|œ(sĖo��i��g���2�����]���|�r�lo3�X�7��mʣE�B�>�J�xc��XV?to�|9���bFl� �G��Y��:��?!�?�C^�a����ւ/��:����ǟ�\���Xgŧ�ć��V���x���v耇|,��]�����o���.s���ay����yR��9O��2��c}��{=��e����e�?�� x(��@W��y�sݠ�=sa�{� U@���"�aJf�AG�Qg��8!�F[���B�h 8;*Tt�W��������Q���a�1��o����_p@Nʓ��9�� ��)�q�G�A*�VZȲ���J^f�Q%O�L�y�#4p���q�t��i:��7Du�6��4Tu�5��6Lu�7��xh:B���21m�O-m��-m�/-m��-m�o-m��-m���y���D>Ӈ�PUYPۊ�z\:��y�2�&�-մm�543iƱ��wݖi}�hk�+w��u���c]�u���2]}�������PW_��!]~Sd��wEƺ<S�����'b��t�D~�SK5'C3�f��S�eJ�8#NĈ1�D�8#NĈ1�D�83NČ�[{N��O'B�<-������PK ��[��ά� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞��`��i7lؖ^���q�Ďl��Xp$��U$p%l����I3�����<��at���`@�J�F;�p�����f��I�4̸�Vl��ĸ�( ��,B������EL��"�QH+�8�9��d^�?D��(���ӌ6�����A�@��{�)z e��@�T���FɊ� �$z3���_��<��u'Z��ND#y}S#<���ӥs������Bqફ��//j��/6_PK ��[Ѓ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 ��[; � � 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- ��[M Q�� 5 xl/workbook.xmlPK- ��[���� � � [Content_Types].xmlPK- ��[S��R' ' U _rels/.relsPK- ��[�Ep�� � � xl/worksheets/sheet1.xmlPK- ��[��ά� P xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E G xl/styles.xmlPK- ��[; � � � xl/sharedStrings.xmlPK � !
application/vnd.ms-excel
PK ��[�� Z� 5 xl/workbook.xml � (� ����0��&�C��H�()��x��}[i�?ik���'�x�3;�����^Xۓ�L(|I�]�X�j'��L��z q���l�*���o�&�4Ir�q��� �r���X�y�&t�Q+J�2�:�s���1,r2���I�b�)����EKZCJ�ޔ�L�/�4<R�\�-2�rq�;{�q����PK ��[���� � [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 ��[&���' ' _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="R23852ef4ca6e45ae" /></Relationships>PK ��[�Ep�� � xl/worksheets/sheet1.xml � (� ���r�0�_���@vBt�N[k��E�5Gce*��}��&�E�Z;��o�0��I��7O�Xl�68ȶ�f.��sh����� �"��V�疴o��th��|{��|œ(sĖo��i��g���2�����]���|�r�lo3�X�7��mʣE�B�>�J�xc��XV?to�|9���bFl� �G��Y��:��?!�?�C^�a����ւ/��:����ǟ�\���Xgŧ�ć��V���x���v耇|,��]�����o���.s���ay����yR��9O��2��c}��{=��e����e�?�� x(��@W��y�sݠ�=sa�{� U@���"�aJf�AG�Qg��8!�F[���B�h 8;*Tt�W��������Q���a�1��o����_p@Nʓ��9�� ��)�q�G�A*�VZȲ���J^f�Q%O�L�y�#4p���q�t��i:��7Du�6��4Tu�5��6Lu�7��xh:B���21m�O-m��-m�/-m��-m�o-m��-m���y���D>Ӈ�PUYPۊ�z\:��y�2�&�-մm�543iƱ��wݖi}�hk�+w��u���c]�u���2]}�������PW_��!]~Sd��wEƺ<S�����'b��t�D~�SK5'C3�f��S�eJ�8#NĈ1�D�8#NĈ1�D�83NČ�[{N��O'B�<-������PK ��[~� U� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞���$�n7lؖ^�q&q�Ķl��Xp$��U$H%l����I3�����2��a�F@�1 h��'3 8�ᮁ�v��Y�4��I+&�1�J�ҸȐY�&u�S�G�:�i��~̀k&9���h�aR�h�iA� �W�A#F �G�~J�^B�%*��^������-:UU�k�Л��x�1�z}�+�X֊!ky^�MyS-=��ѧK����Z[�X�Nf�jK~Q�W��PK ��[Ѓ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 ��[; � � 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- ��[���� � � [Content_Types].xmlPK- ��[&���' ' U _rels/.relsPK- ��[�Ep�� � � xl/worksheets/sheet1.xmlPK- ��[~� U� P xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E H xl/styles.xmlPK- ��[; � � � xl/sharedStrings.xmlPK � "