GET api/store/{storeID}/product/{id}/history/sales
Get sales history for a product
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. |
SummaryPeriod |
Period to summarise |
SalesHistorySummaryPeriod |
None. |
StartDate |
Start of period to get history for |
date |
Required |
EndDate |
End of period to get history for |
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
PageListOfSalesHistoryName | Description | Type | Additional information |
---|---|---|---|
Type | string |
None. |
|
List | Collection of SalesHistory |
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. |
Response Formats
application/json, text/json
Sample:
{ "type": "SalesHistory", "list": [ { "$id": "2", "storeID": 1, "storeName": "sample string 1", "periodBeginning": "2025-10-05T00:02:34.7695422", "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": "2" } ], "skip": 1, "take": 1, "totalCount": 1 }
application/xml, text/xml
Sample:
<PageListOfSalesHistory2z4GtjVb xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.Common"> <Skip>1</Skip> <Take>1</Take> <TotalCount>1</TotalCount> <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Sales"> <d2p1:SalesHistory> <d2p1:AvgUnitCostEx>8.1</d2p1:AvgUnitCostEx> <d2p1:AvgUnitCostInc>7.1</d2p1:AvgUnitCostInc> <d2p1:AvgUnitSellEx>6.1</d2p1:AvgUnitSellEx> <d2p1:AvgUnitSellInc>5.1</d2p1:AvgUnitSellInc> <d2p1:CostEx>12.1</d2p1:CostEx> <d2p1:CostInc>11.1</d2p1:CostInc> <d2p1:Dumped>4.1</d2p1:Dumped> <d2p1:GrossProfit>13.1</d2p1:GrossProfit> <d2p1:Hour>1</d2p1:Hour> <d2p1:PLUG_UID i:nil="true" /> <d2p1:Period>Hourly</d2p1:Period> <d2p1:PeriodBeginning>2025-10-05T00:02:34.7695422+00:00</d2p1:PeriodBeginning> <d2p1:PluGuid i:nil="true" /> <d2p1:Quantity>3.1</d2p1:Quantity> <d2p1:SalesEx>10.1</d2p1:SalesEx> <d2p1:SalesInc>9.1</d2p1:SalesInc> <d2p1:StoreID>1</d2p1:StoreID> <d2p1:StoreName>sample string 1</d2p1:StoreName> </d2p1:SalesHistory> <d2p1:SalesHistory> <d2p1:AvgUnitCostEx>8.1</d2p1:AvgUnitCostEx> <d2p1:AvgUnitCostInc>7.1</d2p1:AvgUnitCostInc> <d2p1:AvgUnitSellEx>6.1</d2p1:AvgUnitSellEx> <d2p1:AvgUnitSellInc>5.1</d2p1:AvgUnitSellInc> <d2p1:CostEx>12.1</d2p1:CostEx> <d2p1:CostInc>11.1</d2p1:CostInc> <d2p1:Dumped>4.1</d2p1:Dumped> <d2p1:GrossProfit>13.1</d2p1:GrossProfit> <d2p1:Hour>1</d2p1:Hour> <d2p1:PLUG_UID i:nil="true" /> <d2p1:Period>Hourly</d2p1:Period> <d2p1:PeriodBeginning>2025-10-05T00:02:34.7695422+00:00</d2p1:PeriodBeginning> <d2p1:PluGuid i:nil="true" /> <d2p1:Quantity>3.1</d2p1:Quantity> <d2p1:SalesEx>10.1</d2p1:SalesEx> <d2p1:SalesInc>9.1</d2p1:SalesInc> <d2p1:StoreID>1</d2p1:StoreID> <d2p1:StoreName>sample string 1</d2p1:StoreName> </d2p1:SalesHistory> </List> </PageListOfSalesHistory2z4GtjVb>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK Q E[�]�ȷ 5 xl/workbook.xml � (� ����0��&�C��H� )��x��}-[i�?ik���'�x�3;������imO>z0���bt%cAt�!��C3���$��Y)��Ɗ�FY�$W�q��� �r���X�y�6t�Q+J�2�>�s���1,r2���I�b�)����E+�@J��V�L�/�4��"�g�%O�L��������PK Q E[���� � [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 Q E[�m1�' ' _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="R4f2b7a3218524ccc" /></Relationships>PK Q E[!�Ā� xl/worksheets/sheet1.xml � (� ��Mo�0�������BT�M��[���� V1�l'��1�6%��k�w�Ό�߽���6B�$�����E(��6?6���_M˹��V����E�T-����{�k��̺�> �4��;U�$�-�'H�Yw�i�����wj����d7��L��k��M��vO!@e�ῂ�S�N^�z�bϢ��/Ԡ� ;u�I ��8�� )��Ju���� ����Q��E4 4"����Y Au2V��9�^e��YO}�� �8K�8 o��Y.�, Nh|[ͺ�?u�?�% ]�'a���U=���g�c���V�>��ѽ�ߌ�q+>�8G�Q;?��$~� zI��DxI��D���^���t���x_���ĕ�v7r���)�4��=%���\��,ϻ�PK Q E[��TI� P xl/_rels/workbook.xml.rels � (� ��Mn� F��f_�#�5U�l��6�Ɗ ��9[=R�P�H�#u�MVh�����>>W��i$��|�b@��`�wp�����z��Q�r#�aN�<����Hi�'��0�/�r)cOg��G*kh\2�Iv��C���>N��`��!9�d�b����(����B�l:� ɴjkq�2Ski�Л��|1�z]ꅌ��E����\�TƩ��%Dz��2^��=g���Hl�2�����oPK Q E[Ѓ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 Q E[W=D0� � xl/sharedStrings.xml � (� e��N�0D��;� ��!*p '� !a%�Ī�� "|=n5ǙռYM��^|@"�ȍ*� �b�p0����bo}D0r�b[�D,r�ȑy�՚��%'�|��,g�MS�����ˢ���:���3���R���g�u.pU�U�LPj�J}�?ޣ#>��n:�Z{Xe��֟ZV�2:�eu[�!�:z�H�Br�:>�y�}�Ƣ �&��I�Z���?�����7PK- Q E[�]�ȷ 5 xl/workbook.xmlPK- Q E[���� � [Content_Types].xmlPK- Q E[�m1�' ' V _rels/.relsPK- Q E[!�Ā� � xl/worksheets/sheet1.xmlPK- Q E[��TI� P � xl/_rels/workbook.xml.relsPK- Q E[Ѓc'2 E � xl/styles.xmlPK- Q E[W=D0� � n xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK Q E[�s��� 5 xl/workbook.xml � (� ����0��&�C�`�D��x��}��6Ж�5��$���~;�`l�0�e�i����}ƹ�)t;ӓ��X�>H��idM��ߊ���(J���4� �;�i��\o �Ny��(�RC��0����7�`,uG��9�S�[/&�4**�B��&��, f3�[��)�4=$���V� ����PK Q E[���� � [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 Q E[����' ' _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="R7aa09debf6ae4fee" /></Relationships>PK Q E[!�Ā� xl/worksheets/sheet1.xml � (� ��Mo�0�������BT�M��[���� V1�l'��1�6%��k�w�Ό�߽���6B�$�����E(��6?6���_M˹��V����E�T-����{�k��̺�> �4��;U�$�-�'H�Yw�i�����wj����d7��L��k��M��vO!@e�ῂ�S�N^�z�bϢ��/Ԡ� ;u�I ��8�� )��Ju���� ����Q��E4 4"����Y Au2V��9�^e��YO}�� �8K�8 o��Y.�, Nh|[ͺ�?u�?�% ]�'a���U=���g�c���V�>��ѽ�ߌ�q+>�8G�Q;?��$~� zI��DxI��D���^���t���x_���ĕ�v7r���)�4��=%���\��,ϻ�PK Q E[��&V� P xl/_rels/workbook.xml.rels � (� ��An� E����� &8��M7٦� ��X�i��u�#� E��:R�d��<������ٽM#z�g[\%F`�S��[|N����vs�Q�|#��G����b��_��I��y���]�D�e��$z ��d$�����W�!:� �N�'��0��p� at����(��Q���^�����+�|ɚ��'S��:B����g2�r!V�c��8�u�P#����N�x����c�n�-i}S#w�b�PK Q E[Ѓ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 Q E[W=D0� � xl/sharedStrings.xml � (� e��N�0D��;� ��!*p '� !a%�Ī�� "|=n5ǙռYM��^|@"�ȍ*� �b�p0����bo}D0r�b[�D,r�ȑy�՚��%'�|��,g�MS�����ˢ���:���3���R���g�u.pU�U�LPj�J}�?ޣ#>��n:�Z{Xe��֟ZV�2:�eu[�!�:z�H�Br�:>�y�}�Ƣ �&��I�Z���?�����7PK- Q E[�s��� 5 xl/workbook.xmlPK- Q E[���� � [Content_Types].xmlPK- Q E[����' ' V _rels/.relsPK- Q E[!�Ā� � xl/worksheets/sheet1.xmlPK- Q E[��&V� P � xl/_rels/workbook.xml.relsPK- Q E[Ѓc'2 E � xl/styles.xmlPK- Q E[W=D0� � p xl/sharedStrings.xmlPK � �