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-08-02T23:23:48.159569", "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-08-02T23:23:48.159569+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-08-02T23:23:48.159569+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 ��[2ժh� 5 xl/workbook.xml � (� ����0��&�C�����N\�z4Ж�5���$���~;|��Xۓ��/]E�ƒ1/:��vDw�: !J�dVJ%�����%ɉ9 (k|�FOW�?,?:��w�A+J�2����s����/2ߺ�I�b�)����E+�@ J��V4�ĕ*�c~� �\ʴHZI7������ 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="Rb189c90b25d4467c" /></Relationships>PK ��[!�Ā� 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 ��[��R� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�M�4AM�aö��=N�&vd�@�Ƃ#q�"A*�`��h~OO��|���ަ�����-�2��rz�]�h�j�m7{1���s`iņ��{�i��l��'�)��Q�#�Qq�d�5��3���=8u���?����c�"���b?��/a�%*�G�¾,ֹT�Ƭ����Z��¯�w���B�b-t��FbU�T�GO�)�t�Ӳ�PCY嘔�纑$ʋ����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 ��[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- ��[2ժh� 5 xl/workbook.xmlPK- ��[���� � [Content_Types].xmlPK- ��[]��{' ' V _rels/.relsPK- ��[!�Ā� � xl/worksheets/sheet1.xmlPK- ��[��R� P � xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E � xl/styles.xmlPK- ��[W=D0� � n xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK ��[�#�� 5 xl/workbook.xml � (� ��;�0D�H����"�PѤM�~1K��?��㇏@J�ngv���ɅW�܋|�hc*:��KƢ�@�8�v��.H�O��^+l�z���p�������n�X��.�Ɍʀ��>��K���)�r6���I�b�)��U+�@JV��U4�$�z��(z(�B\U���>`���/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 ��[�-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="R83294b7648cf42de" /></Relationships>PK ��[!�Ā� 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 ��[~�(�� P xl/_rels/workbook.xml.rels � (� ��An� E����@�R'��M7�&� ��X�i��e�#� E����n�B���h��|����^!�����bV:5ڡç�Z�ݬw0��oD3���;lR�+B�40�X96w��H��B� dA)'�d�[&:�=���%<;y���?��ͅc4 ����D�\Ve*F/��;�����U�����nj1�'��^�u!�9[��I)�lZw�1"�ڧ�7]:�q�F{Z�F�=Wu�2}U#7�b�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 ��[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- ��[�#�� 5 xl/workbook.xmlPK- ��[���� � � [Content_Types].xmlPK- ��[�-R' ' U _rels/.relsPK- ��[!�Ā� � xl/worksheets/sheet1.xmlPK- ��[~�(�� P � xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E � xl/styles.xmlPK- ��[W=D0� � n xl/sharedStrings.xmlPK � �