GET api/store/{storeID}/product/{id}/history/sales/total

Get sales history total for a product

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

Total sales history record

SalesHistory
NameDescriptionTypeAdditional 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

Sample:
{
  "storeID": 1,
  "storeName": "sample string 1",
  "periodBeginning": "2025-06-14T07:38:16.958656",
  "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
}

application/xml, text/xml

Sample:
<SalesHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Sales">
  <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:38:16.958656+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>

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample:
PK�<�Z�s��5xl/workbook.xml �(�����0��&�C���#R8q���{mi�?ik��H�yۙ��v�d��4f@5j_��!؊�{P̟�=�:��t/b�Nrh
+Ё��sA�,H�}/��+�����=@P�RLj�ѥ�C�䣜���b"���o�F�~�LA�[Fѹ�'�J��=M���"���ȋ�w��d��|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
�<�Zd��@''_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="Rba4edae13d094a2c" /></Relationships>PK�<�Z�����
xl/worksheets/sheet1.xml �(����r�0�_���@vBH訝����֋�k�Fa*��}����׷v��r���dm}�,�e:��A�%ҹ\��jho��n_�;�}����4�ȆvT����H�ܑ�*m)�$,�m�r�r��Xη�H#仙X��Z*��Mn���V��D�(�����0N��`����[�X�+��a�rG����.o\[�'�'����~1�Qɺ-xR.��Y���b&wS��B5����\�姕����V~�߻xQDC;p�C>V�|�2�{�j���+>��sE/�9g�g?������E>9��W������������?�9�{�cD��U~�s]^�xO_P���>@u P�d�0�3��L�c�N��x�0��j��-\\m!�r�Ap�B�. �
X�b����;S���
�	���:c��u�邾�:_p
�ꔧ�	#����)��8,�� �;++eUu�.�rT�铫��5B�kרּ�6:q�&�N��щ�6��ĤMP��k�NL�Ӊ�6�u�M:���1��O�����h�Kb���1�ց�}�@���:�So]�c��)}�2u���GqӴ����C�����8�qG5��n�̤m�ƑޝG���c�q�=��>4Uj��M�7է��L���rS}i����j=C����`�My���~��6[�^�D6��Y9������PK�<�Z��y��Pxl/_rels/workbook.xml.rels �(���Kn�0@�b;���M7l)p�q�ؑmJ9[=R�P�Jm����h~OO��|����Ɓ����
��V:�ۮ�s�O5춛"��`�)��bC&�iMi�G27�M��(bJ}G'!O�CZ0VQ?g�=������%>;y��?����)��(|����R���g�
d�8���\�e�+^-J �aj!^�^��\F�J�UΑ-yݶ�1£z�>]z�4/����e��`�s�������PK�<�ZЃc'2E
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�s��5xl/workbook.xmlPK-�<�Z����	�[Content_Types].xmlPK-
�<�Zd��@''W_rels/.relsPK-�<�Z�����
�xl/worksheets/sheet1.xmlPK-�<�Z��y��P�xl/_rels/workbook.xml.relsPK-�<�ZЃc'2E
xl/styles.xmlPK-�<�Z;
���	xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample:
PK�<�Z0���5xl/workbook.xml �(�����0D�J��(�@TB��ҵCw��&�$(IE?�R�n�����ٺ��v =_�����1�%j�;����:
!J�b�����F�5I
�p����RM�n�X~r�KĠ�
�AڜO�TK���ٯ2{��$l��T�Ž�Uk�BJV�.j�R�J��<�DǹH��z�X����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="R045a8e3305974a72" /></Relationships>PK�<�Z�����
xl/worksheets/sheet1.xml �(����r�0�_���@vBH訝����֋�k�Fa*��}����׷v��r���dm}�,�e:��A�%ҹ\��jho��n_�;�}����4�ȆvT����H�ܑ�*m)�$,�m�r�r��Xη�H#仙X��Z*��Mn���V��D�(�����0N��`����[�X�+��a�rG����.o\[�'�'����~1�Qɺ-xR.��Y���b&wS��B5����\�姕����V~�߻xQDC;p�C>V�|�2�{�j���+>��sE/�9g�g?������E>9��W������������?�9�{�cD��U~�s]^�xO_P���>@u P�d�0�3��L�c�N��x�0��j��-\\m!�r�Ap�B�. �
X�b����;S���
�	���:c��u�邾�:_p
�ꔧ�	#����)��8,�� �;++eUu�.�rT�铫��5B�kרּ�6:q�&�N��щ�6��ĤMP��k�NL�Ӊ�6�u�M:���1��O�����h�Kb���1�ց�}�@���:�So]�c��)}�2u���GqӴ����C�����8�qG5��n�̤m�ƑޝG���c�q�=��>4Uj��M�7է��L���rS}i����j=C����`�My���~��6[�^�D6��Y9������PK�<�ZPÌ��Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞8.�����tö��=��&vd����G�
XE�Tb�������4����ڼ�9c��w-���Nyݻ��S2
l֫2�h�)���b6��Ҩ,�2~B�;ƇQ����NRe�tQ���9n�d��?DoL�p��iD���W��"& {:L-��"�Vd*�g��NɊs}PJ3��J�wS��2`����g2K��q�h���2V�/)�Kϝ�噚Y�G�hRsfʫ����PK�<�ZЃc'2E
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-�<�Z0���5xl/workbook.xmlPK-�<�Z����	��[Content_Types].xmlPK-
�<�Z��''U_rels/.relsPK-�<�Z�����
�xl/worksheets/sheet1.xmlPK-�<�ZPÌ��P�xl/_rels/workbook.xml.relsPK-�<�ZЃc'2E
xl/styles.xmlPK-�<�Z;
���	xl/sharedStrings.xmlPK��