GET api/product/{id}/history/sales?storeID={storeID}
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-06-14T07:37:13.2749642", "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-06-14T07:37:13.2749642+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-06-14T07:37:13.2749642+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 �<�Z �� 5 xl/workbook.xml � (� ����0��J}�(Ф!����k��.�&��(IE�!�n�|���㦧1��Y��5T�`+�|/P���:�F��(�q�=v�+ԁe���A텴�n�X�:��Ġ� �@jڞO��k����'���j���o�N��")�AaC;@IrnCC���J�� Ǣ�2�<�v������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 �<�Z0o�' ' _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="Rb1dd3e1b3ff04fdb" /></Relationships>PK �<�Z!�Ā� 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 �<�Z�/��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�N#'��ݰa[z��=��&vd�@�Ƃ#q�"A*�`��h~OO��|�Xoߦ��P��w-�B #��\��)uw l7����D��Y^q�����yԖ&�����N�Ä)���3�#��K!K\3��<����M�^�&r�0��-Q���Sj��%�"S�=�v�*���T�M%�7S��<R����2�i�A-�8T%���Xd�Sȗ^:-�5S�Z%W��+]�5~��/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 �<�ZW=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- �<�Z �� 5 xl/workbook.xmlPK- �<�Z���� � � [Content_Types].xmlPK- �<�Z0o�' ' U _rels/.relsPK- �<�Z!�Ā� � xl/worksheets/sheet1.xmlPK- �<�Z�/��� P � xl/_rels/workbook.xml.relsPK- �<�ZЃc'2 E � xl/styles.xmlPK- �<�ZW=D0� � l xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK �<�Z� �Ķ 5 xl/workbook.xml � (� ����0D�&�C��E R8q����[i�-ik��-H�yۙ�};b������G�箠]cΘo:��OvDw�: !J�bVJ�`e��Fؙ�9 (k|�FOW�?,?:��w�A+J�2�<s����/2[��$l �ߔX`�Ţ��� %�so�P�r��M^�I[g��2����a�m��/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��8' ' _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="Ra1d3c24bdf0243d3" /></Relationships>PK �<�Z!�Ā� 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 �<�Z���{� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8 ���ݰa[z��=��&vd�@�Ƃ#q�"A*�`��h~OO��|����扽��5dI ���r4C����m7{�0� ��ų�b|:��s/4�����e!�n��#��4��[3����C�J���8�d�`�j��k� �n���O��KȒH�$;�7��d_�i�� �������w��Q2�D+K�R]`_�TF�#�\���i]^���&�e���(�����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 �<�ZW=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- �<�Z� �Ķ 5 xl/workbook.xmlPK- �<�Z���� � � [Content_Types].xmlPK- �<�Z��8' ' U _rels/.relsPK- �<�Z!�Ā� � xl/worksheets/sheet1.xmlPK- �<�Z���{� P � xl/_rels/workbook.xml.relsPK- �<�ZЃc'2 E � xl/styles.xmlPK- �<�ZW=D0� � l xl/sharedStrings.xmlPK � �