GET api/product/{guid}/campaigns/deals?PluGuid={PluGuid}&ShowPriceChanges={ShowPriceChanges}&IncludePast={IncludePast}&ShowDealCosts={ShowDealCosts}

Get product campaign information for presentation as deals

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

Product identifier

globally unique identifier

Required

PluGuid

globally unique identifier

None.

ShowPriceChanges

boolean

None.

IncludePast

boolean

None.

ShowDealCosts

boolean

None.

Body Parameters

None.

Response Information

Resource Description

List of product campaign details

Collection of ProductCampaignDetails
NameDescriptionTypeAdditional information
CampaignName

Campaign Identifier

string

None.

CampaignDescription

Campaign Description

string

None.

CampaignType

CampaignType

None.

ComboPriceGroupG_UID

Collection of byte

None.

ComboPriceGroupIdentifier

Combo Price Group Identifier of combo pricing campaign's price group

globally unique identifier

None.

PromoType

The Campaign promo type enum

PromoType

None.

FromHost

Campaign from host flag

boolean

None.

StoreNames

Names of stores Campaign is at

Collection of string

None.

PLUG_UID

Collection of byte

None.

PluGuid

Product Identifier

globally unique identifier

None.

CartonQuantity

Product Carton Quantity value

integer

None.

FuelItem

Product Fuel Item flag

boolean

None.

DealCostHeaderIdentifier

Collection of byte

None.

DealCostHeaderGuid

Deal Cost Header Identifier if campaign plu is associated

globally unique identifier

None.

DealCostIdentifier

Collection of byte

None.

DealCostGuid

Deal Cost Identifier if campaign plu is associated

globally unique identifier

None.

CostStartDate

Cost start date, if present

date

None.

CostEndDate

Cost end date, if present

date

None.

NewCost

New Unit Cost as cents

integer

None.

NewCostDecimals

New Cost decimals

integer

None.

NewPrice

New Unit Sell Price as cents

integer

None.

SellStartDate

Campaign start date

date

None.

SellEndDate

Campaign end date

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "campaignName": "sample string 1",
    "campaignDescription": "sample string 2",
    "campaignType": 1,
    "comboPriceGroupG_UID": "Zv9eaxymWEyH6K5cdZykJw==",
    "comboPriceGroupIdentifier": "6b5eff66-a61c-4c58-87e8-ae5c759ca427",
    "promoType": 1,
    "fromHost": true,
    "storeNames": [
      "sample string 1",
      "sample string 2"
    ],
    "pluG_UID": "pBN25LePf0mpgbkG8zLU7w==",
    "pluGuid": "e47613a4-8fb7-497f-a981-b906f332d4ef",
    "cartonQuantity": 5,
    "fuelItem": true,
    "dealCostHeaderIdentifier": "fI+S7HJfCkWgB4Y+F4yFJA==",
    "dealCostHeaderGuid": "ec928f7c-5f72-450a-a007-863e178c8524",
    "dealCostIdentifier": "bPJCCUTyO0Gnncd8eKr6ag==",
    "dealCostGuid": "0942f26c-f244-413b-a79d-c77c78aafa6a",
    "costStartDate": "2025-06-14T07:47:41.964097",
    "costEndDate": "2025-06-14T07:47:41.964097",
    "newCost": 7,
    "newCostDecimals": 8,
    "newPrice": 9,
    "sellStartDate": "2025-06-14T07:47:41.964097",
    "sellEndDate": "2025-06-14T07:47:41.964097"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfProductCampaignDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Campaigns">
  <ProductCampaignDetails>
    <CampaignDescription>sample string 2</CampaignDescription>
    <CampaignName>sample string 1</CampaignName>
    <CampaignType>1</CampaignType>
    <CartonQuantity>5</CartonQuantity>
    <ComboPriceGroupG_UID>Zv9eaxymWEyH6K5cdZykJw==</ComboPriceGroupG_UID>
    <ComboPriceGroupIdentifier>6b5eff66-a61c-4c58-87e8-ae5c759ca427</ComboPriceGroupIdentifier>
    <CostEndDate>2025-06-14T07:47:41.964097+00:00</CostEndDate>
    <CostStartDate>2025-06-14T07:47:41.964097+00:00</CostStartDate>
    <DealCostGuid>0942f26c-f244-413b-a79d-c77c78aafa6a</DealCostGuid>
    <DealCostHeaderGuid>ec928f7c-5f72-450a-a007-863e178c8524</DealCostHeaderGuid>
    <DealCostHeaderIdentifier>fI+S7HJfCkWgB4Y+F4yFJA==</DealCostHeaderIdentifier>
    <DealCostIdentifier>bPJCCUTyO0Gnncd8eKr6ag==</DealCostIdentifier>
    <FromHost>true</FromHost>
    <FuelItem>true</FuelItem>
    <NewCost>7</NewCost>
    <NewCostDecimals>8</NewCostDecimals>
    <NewPrice>9</NewPrice>
    <PLUG_UID>pBN25LePf0mpgbkG8zLU7w==</PLUG_UID>
    <PluGuid>e47613a4-8fb7-497f-a981-b906f332d4ef</PluGuid>
    <PromoType>1</PromoType>
    <SellEndDate>2025-06-14T07:47:41.964097+00:00</SellEndDate>
    <SellStartDate>2025-06-14T07:47:41.964097+00:00</SellStartDate>
    <StoreNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </StoreNames>
  </ProductCampaignDetails>
  <ProductCampaignDetails>
    <CampaignDescription>sample string 2</CampaignDescription>
    <CampaignName>sample string 1</CampaignName>
    <CampaignType>1</CampaignType>
    <CartonQuantity>5</CartonQuantity>
    <ComboPriceGroupG_UID>Zv9eaxymWEyH6K5cdZykJw==</ComboPriceGroupG_UID>
    <ComboPriceGroupIdentifier>6b5eff66-a61c-4c58-87e8-ae5c759ca427</ComboPriceGroupIdentifier>
    <CostEndDate>2025-06-14T07:47:41.964097+00:00</CostEndDate>
    <CostStartDate>2025-06-14T07:47:41.964097+00:00</CostStartDate>
    <DealCostGuid>0942f26c-f244-413b-a79d-c77c78aafa6a</DealCostGuid>
    <DealCostHeaderGuid>ec928f7c-5f72-450a-a007-863e178c8524</DealCostHeaderGuid>
    <DealCostHeaderIdentifier>fI+S7HJfCkWgB4Y+F4yFJA==</DealCostHeaderIdentifier>
    <DealCostIdentifier>bPJCCUTyO0Gnncd8eKr6ag==</DealCostIdentifier>
    <FromHost>true</FromHost>
    <FuelItem>true</FuelItem>
    <NewCost>7</NewCost>
    <NewCostDecimals>8</NewCostDecimals>
    <NewPrice>9</NewPrice>
    <PLUG_UID>pBN25LePf0mpgbkG8zLU7w==</PLUG_UID>
    <PluGuid>e47613a4-8fb7-497f-a981-b906f332d4ef</PluGuid>
    <PromoType>1</PromoType>
    <SellEndDate>2025-06-14T07:47:41.964097+00:00</SellEndDate>
    <SellStartDate>2025-06-14T07:47:41.964097+00:00</SellStartDate>
    <StoreNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </StoreNames>
  </ProductCampaignDetails>
</ArrayOfProductCampaignDetails>

text/csv

Sample:

Sample not available.

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample:
PK�=�Z^�߶5xl/workbook.xml �(�����0��&�C�pA��x�བ�4П�5��$޼���~;�d��4f 5j_���!����'cQǝ0N��{�Brl
+��I��Ñi���t�����!�|�Ը���6�!���!q��Vw6	�!�MUl�X�LaM[%�s�j�R�J�{�a��i&�/&tg�
���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��U,''_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="R956f81ff0a6d423c" /></Relationships>PK�=�Z步���xl/worksheets/sheet1.xml �(���]s�@��
�}a�~oF�M��&M�6^S��T%$��wEXvXڛD��={x�y�q���v��Y�����x�H���y��w�?����w������.?˦��(^��0_��m��K���Vi��
�6{��*Y����u�#��,�D�>*_'/��6�V���Ѳla�9��F�ΟM���~�������gs�{�lR�OI��[��Ý�J�߇7�˩�J6��������W��xH�Wq�.�I��,�M^�����:��F���dY�\@�@B2�1����5/���\W9�q��'=Fp 
cԡ'��4�Ӏp)� h������|`ƁS��MֳJ�Nz"�^II�D��Jϛ�!`�(�A�֋J/=
�	A���q����$
��ec
ǫJ���I�8�R�@OaX���1PP�(f��
�
� J��F�8F�B��*3�#�ʱCP/!��qE�6B=I�P�!ж
T"��Q�P/"4��H���+̱k�*B���J݂��X��D{8C1�@`pl#���>��aT��.sT�7Tk�X(D�&�7��� V#+���Ղ�w�M�4�c������\o$&�V!<~��ς�f�,�{YyY�?���_��D?r�(z��I�v�V��>]�S��]�O�.�O�.q�'X����K\�	�%����7}Bu�/�S�Z��[b�zgA_�Y��{b8�݂�>X��Gb��Â���l���1ܝ[���P��܄�E��-�����D��"7f�ق��8��"7�teA�9]���� fP�}��>o�M��b,�7w�{K����[�LbL�W/���X�
w��}����5�𧱇�G����&$�b����"7CbA̐�pi��!� fH�}�X3$d $�>o�M���^H�U�-U̐��!>����������=|><�$l}[��2�.Ҵ���K��w��_PK�=�Z��;��Pxl/_rels/workbook.xml.rels �(���An� E�����lZ�d�M�i.@�`�؀���ٺ�z��Tj��n�B���h�|�Xo��	�@L�w�������O��	�ݬw0�\n$;����$�9�B��0�T��t���ʥ�	J�dEiK⒁��h��7f����i���W��d��*�%���uU�=��:�֍�Xe|r3����_��z!c���>c�uS�"��9�M/���B�s��5p��N.j��_l�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 �(��T]o�0�+��Ķ�!I�%k�(Z$y*����D�,y��-�~J�m�����GR���g#��h��j&�8P1]u����-)��:P5H�p�ц��bf��T�yxr��E���;�-*�pmp��#��ڞ]#�4����€�N�y8MàS�[�˿�/!3�XBӂ8�hp��,��o�ZfD�|�Bv�v(��A?�pmt׮��7�wb65*'�@�|4��cUn=q����[�
^���T��Q/��[w��h�VOxg�<(ߡ�8l��
A.��;�4��z7V�O��9F�{|�|+p#�Ǩ����+�B&���z�e��e��W]\�+.�^��0A�:$>[���dz���}�8��yQ(F2����X��Ѽb����ٙn��w�����D�d�
�&�º���k�����f�H����(�*�	TeBU\��4�3�
�ҒSFrNS��1�cJ�b�	-Y��Y_WY�ӂ�fɒ��j�(e��P�?M�@�_PK-�=�Z^�߶5xl/workbook.xmlPK-�=�Z����	��[Content_Types].xmlPK-
�=�Z��U,''U_rels/.relsPK-�=�Z步����xl/worksheets/sheet1.xmlPK-�=�Z��;��P�xl/_rels/workbook.xml.relsPK-�=�ZЃc'2E
&	xl/styles.xmlPK-�=�Z������
xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample:
PK�=�Z�{���5xl/workbook.xml �(�����0��&�C��h���x��}[��@����%�x�3;��T��pn 3�X���)���({4OΣ�w�i��ŜRZb��۠M�R7p���������X��.��Ɍ+ʀ��9��fO�S�r6���I�b��*������5m!%ٹw5=SJ=!��*���XН��*��n�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="Raf0a86a234b44163" /></Relationships>PK�=�Z步���xl/worksheets/sheet1.xml �(���]s�@��
�}a�~oF�M��&M�6^S��T%$��wEXvXڛD��={x�y�q���v��Y�����x�H���y��w�?����w������.?˦��(^��0_��m��K���Vi��
�6{��*Y����u�#��,�D�>*_'/��6�V���Ѳla�9��F�ΟM���~�������gs�{�lR�OI��[��Ý�J�߇7�˩�J6��������W��xH�Wq�.�I��,�M^�����:��F���dY�\@�@B2�1����5/���\W9�q��'=Fp 
cԡ'��4�Ӏp)� h������|`ƁS��MֳJ�Nz"�^II�D��Jϛ�!`�(�A�֋J/=
�	A���q����$
��ec
ǫJ���I�8�R�@OaX���1PP�(f��
�
� J��F�8F�B��*3�#�ʱCP/!��qE�6B=I�P�!ж
T"��Q�P/"4��H���+̱k�*B���J݂��X��D{8C1�@`pl#���>��aT��.sT�7Tk�X(D�&�7��� V#+���Ղ�w�M�4�c������\o$&�V!<~��ς�f�,�{YyY�?���_��D?r�(z��I�v�V��>]�S��]�O�.�O�.q�'X����K\�	�%����7}Bu�/�S�Z��[b�zgA_�Y��{b8�݂�>X��Gb��Â���l���1ܝ[���P��܄�E��-�����D��"7f�ق��8��"7�teA�9]���� fP�}��>o�M��b,�7w�{K����[�LbL�W/���X�
w��}����5�𧱇�G����&$�b����"7CbA̐�pi��!� fH�}�X3$d $�>o�M���^H�U�-U̐��!>����������=|><�$l}[��2�.Ҵ���K��w��_PK�=�ZJ��j�Pxl/_rels/workbook.xml.rels �(����N!�_�pw�-][Sڋ��/�l���g��#�
5J^z"�|�&����f�2O�	b��5#p���>es�»�f���F�cH�<qI`�s�#$i�L��J��8�\�8� �Q@ZJ;k�d��9��ޘQýק\�L�}<&�1:�8@�'J��`M�b���W��QF�9�2>��Z��	ү�W]��5��B��a���������˦k�:��:�^�����+�j��_l?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 �(��T]o�0�+��Ķ�!I�%k�(Z$y*����D�,y��-�~J�m�����GR���g#��h��j&�8P1]u����-)��:P5H�p�ц��bf��T�yxr��E���;�-*�pmp��#��ڞ]#�4����€�N�y8MàS�[�˿�/!3�XBӂ8�hp��,��o�ZfD�|�Bv�v(��A?�pmt׮��7�wb65*'�@�|4��cUn=q����[�
^���T��Q/��[w��h�VOxg�<(ߡ�8l��
A.��;�4��z7V�O��9F�{|�|+p#�Ǩ����+�B&���z�e��e��W]\�+.�^��0A�:$>[���dz���}�8��yQ(F2����X��Ѽb����ٙn��w�����D�d�
�&�º���k�����f�H����(�*�	TeBU\��4�3�
�ҒSFrNS��1�cJ�b�	-Y��Y_WY�ӂ�fɒ��j�(e��P�?M�@�_PK-�=�Z�{���5xl/workbook.xmlPK-�=�Z����	��[Content_Types].xmlPK-
�=�Z��;''T_rels/.relsPK-�=�Z步����xl/worksheets/sheet1.xmlPK-�=�ZJ��j�P�xl/_rels/workbook.xml.relsPK-�=�ZЃc'2E
#	xl/styles.xmlPK-�=�Z������
xl/sharedStrings.xmlPK��