POST api/deals

Add or update a deal cost header

Request Information

URI Parameters

None.

Body Parameters

Deal cost header to save

Name	Description	Type	Additional information
HeaderIdentifier		Collection of byte	None.
HeaderIdentifierGuid		globally unique identifier	None.
SupplierIdentifier		Collection of byte	None.
SupplierGuid		globally unique identifier	None.
Description		string	None.
Start		date	Data type: Date
End		date	Data type: Date
Type		DealCostType	None.
PromoType		PromoType	None.
FromHost	FromHost identifying the source, see	integer	None.
Created		date	None.
CreatedByUser		string	None.
Updated	Local updated time	date	None.
UpdatedByUser		string	None.
Deleted		boolean	None.
SupplierName	Supplier name	string	Relation. This field may not always be loaded or used for updates.
StoreNames	Concatenated list of the stores that the deal cost header is in	string	Relation. This field may not always be loaded or used for updates.
StoreIDs	StoreIDs for the deal cost to be updated to	Collection of integer	Relation. This field may not always be loaded or used for updates.
MasterPLUG_UID		Collection of byte	Relation. This field may not always be loaded or used for updates.
MasterPluGuid	Product for the deal cost header	globally unique identifier	Relation. This field may not always be loaded or used for updates.
DealCosts	Deal costs to update	Collection of DealCost	Relation. This field may not always be loaded or used for updates.

Request Formats

application/json, text/json

Sample:

{
  "headerIdentifier": "m0w7ckff+EGr2GgDu2JvaQ==",
  "headerIdentifierGuid": "723b4c9b-df47-41f8-abd8-6803bb626f69",
  "supplierIdentifier": "yWDpcJsBq0uGZvs/PKIYzQ==",
  "supplierGuid": "70e960c9-019b-4bab-8666-fb3f3ca218cd",
  "description": "sample string 2",
  "start": "2025-10-05T00:03:58.727875",
  "end": "2025-10-05T00:03:58.727875",
  "type": 5,
  "promoType": 6,
  "fromHost": 7,
  "created": "2025-10-05T00:03:58.727875",
  "createdByUser": "sample string 9",
  "updated": "2025-10-05T00:03:58.727875",
  "updatedByUser": "sample string 11",
  "deleted": true,
  "supplierName": "sample string 13",
  "storeNames": "sample string 14",
  "storeIDs": [
    1,
    2
  ],
  "masterPLUG_UID": "nJb6Abd1gEO2iqfqM2AOGQ==",
  "masterPluGuid": "01fa969c-75b7-4380-b68a-a7ea33600e19",
  "dealCosts": [
    {
      "$id": "2",
      "headerIdentifier": "WLEYG1YgfkypMF0q6cKnKg==",
      "headerIdentifierGuid": "1b18b158-2056-4c7e-a930-5d2ae9c2a72a",
      "identifier": "UjTUIs0T5EasPv1ll3DMdQ==",
      "identifierGuid": "22d43452-13cd-46e4-ac3e-fd659770cc75",
      "supplierIdentifier": "/MERRBat8EulAg8gWOSt0Q==",
      "supplierGuid": "4411c1fc-ad16-4bf0-a502-0f2058e4add1",
      "pluG_UID": "JcbIRhQxyUu7er+1pV2ucA==",
      "pluGuid": "46c8c625-3114-4bc9-bb7a-bfb5a55dae70",
      "campaignName": "542ea28a-2ea7-4e08-bdf9-979d8acb5528",
      "description": "sample string 4",
      "cost": 5,
      "costDecimals": 6,
      "start": "2025-10-05T00:03:58.727875",
      "end": "2025-10-05T00:03:58.727875",
      "type": 9,
      "promoType": 10,
      "bonusItemPLUG_UID": "wrJsgTD5uE2ZxdiDqPVktw==",
      "bonusItemPluGuid": "816cb2c2-f930-4db8-99c5-d883a8f564b7",
      "bonusPurchaseUnits": 11,
      "bonusReceiveUnits": 12,
      "updated": "2025-10-05T00:03:58.727875",
      "metcashPromotionID": "sample string 14",
      "fromHost": 15,
      "storeNames": "sample string 16",
      "storeIDs": [
        1,
        2
      ],
      "supplierName": "sample string 17",
      "campaignDescription": "sample string 18",
      "newPrice": 1,
      "campaignMetcashPromotionID": "sample string 19",
      "campaignActive": true,
      "campaignStartDate": "2025-10-05T00:03:58.727875",
      "campaignEndDate": "2025-10-05T00:03:58.727875",
      "masterPLUG_UID": "r1BzW1JWVUWSdoSoNbuPkg==",
      "masterID": "5b7350af-5652-4555-9276-84a835bb8f92",
      "productName": "sample string 22",
      "productAPN": "sample string 23",
      "orderCode": "sample string 24",
      "normalSell": 25,
      "normalCost": 26,
      "normalCostDecimals": 27,
      "cartonQuantity": 28,
      "salesMode": 29,
      "orderPacked": 30,
      "fuelItem": true,
      "active": true,
      "bonusMasterPLUG_UID": "trdBfWSMnUOAKtqbeuybQw==",
      "bonusMasterID": "7d41b7b6-8c64-439d-802a-da9b7aec9b43",
      "bonusProductName": "sample string 34",
      "bonusProductAPN": "sample string 35",
      "bonusOrderCode": "sample string 36",
      "bonusNormalSell": 37,
      "bonusNormalCost": 38,
      "bonusNormalCostDecimals": 39,
      "bonusCartonQuantity": 40,
      "bonusSalesMode": 41,
      "bonusOrderPacked": 42,
      "bonusFuelItem": true,
      "bonusActive": true
    },
    {
      "$ref": "2"
    }
  ]
}

application/xml, text/xml

Sample:

<DealCostHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager">
  <Created>2025-10-05T00:03:58.727875+00:00</Created>
  <CreatedByUser>sample string 9</CreatedByUser>
  <DealCosts>
    <DealCost>
      <Active>true</Active>
      <BonusActive>true</BonusActive>
      <BonusCartonQuantity>40</BonusCartonQuantity>
      <BonusFuelItem>true</BonusFuelItem>
      <BonusItemPLUG_UID>wrJsgTD5uE2ZxdiDqPVktw==</BonusItemPLUG_UID>
      <BonusItemPluGuid>816cb2c2-f930-4db8-99c5-d883a8f564b7</BonusItemPluGuid>
      <BonusMasterID>7d41b7b6-8c64-439d-802a-da9b7aec9b43</BonusMasterID>
      <BonusMasterPLUG_UID>trdBfWSMnUOAKtqbeuybQw==</BonusMasterPLUG_UID>
      <BonusNormalCost>38</BonusNormalCost>
      <BonusNormalCostDecimals>39</BonusNormalCostDecimals>
      <BonusNormalSell>37</BonusNormalSell>
      <BonusOrderCode>sample string 36</BonusOrderCode>
      <BonusOrderPacked>42</BonusOrderPacked>
      <BonusProductAPN>sample string 35</BonusProductAPN>
      <BonusProductName>sample string 34</BonusProductName>
      <BonusPurchaseUnits>11</BonusPurchaseUnits>
      <BonusReceiveUnits>12</BonusReceiveUnits>
      <BonusSalesMode>41</BonusSalesMode>
      <CampaignActive>true</CampaignActive>
      <CampaignDescription>sample string 18</CampaignDescription>
      <CampaignEndDate>2025-10-05T00:03:58.727875+00:00</CampaignEndDate>
      <CampaignMetcashPromotionID>sample string 19</CampaignMetcashPromotionID>
      <CampaignName>542ea28a-2ea7-4e08-bdf9-979d8acb5528</CampaignName>
      <CampaignStartDate>2025-10-05T00:03:58.727875+00:00</CampaignStartDate>
      <CartonQuantity>28</CartonQuantity>
      <Cost>5</Cost>
      <CostDecimals>6</CostDecimals>
      <Description>sample string 4</Description>
      <End>2025-10-05T00:03:58.727875+00:00</End>
      <FromHost>15</FromHost>
      <FuelItem>true</FuelItem>
      <HeaderIdentifier>WLEYG1YgfkypMF0q6cKnKg==</HeaderIdentifier>
      <HeaderIdentifierGuid>1b18b158-2056-4c7e-a930-5d2ae9c2a72a</HeaderIdentifierGuid>
      <Identifier>UjTUIs0T5EasPv1ll3DMdQ==</Identifier>
      <IdentifierGuid>22d43452-13cd-46e4-ac3e-fd659770cc75</IdentifierGuid>
      <MasterID>5b7350af-5652-4555-9276-84a835bb8f92</MasterID>
      <MasterPLUG_UID>r1BzW1JWVUWSdoSoNbuPkg==</MasterPLUG_UID>
      <MetcashPromotionID>sample string 14</MetcashPromotionID>
      <NewPrice>1</NewPrice>
      <NormalCost>26</NormalCost>
      <NormalCostDecimals>27</NormalCostDecimals>
      <NormalSell>25</NormalSell>
      <OrderCode>sample string 24</OrderCode>
      <OrderPacked>30</OrderPacked>
      <PLUG_UID>JcbIRhQxyUu7er+1pV2ucA==</PLUG_UID>
      <PluGuid>46c8c625-3114-4bc9-bb7a-bfb5a55dae70</PluGuid>
      <ProductAPN>sample string 23</ProductAPN>
      <ProductName>sample string 22</ProductName>
      <PromoType>10</PromoType>
      <SalesMode>29</SalesMode>
      <Start>2025-10-05T00:03:58.727875+00:00</Start>
      <StoreIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </StoreIDs>
      <StoreNames>sample string 16</StoreNames>
      <SupplierGuid>4411c1fc-ad16-4bf0-a502-0f2058e4add1</SupplierGuid>
      <SupplierIdentifier>/MERRBat8EulAg8gWOSt0Q==</SupplierIdentifier>
      <SupplierName>sample string 17</SupplierName>
      <Type>9</Type>
      <Updated>2025-10-05T00:03:58.727875+00:00</Updated>
    </DealCost>
    <DealCost>
      <Active>true</Active>
      <BonusActive>true</BonusActive>
      <BonusCartonQuantity>40</BonusCartonQuantity>
      <BonusFuelItem>true</BonusFuelItem>
      <BonusItemPLUG_UID>wrJsgTD5uE2ZxdiDqPVktw==</BonusItemPLUG_UID>
      <BonusItemPluGuid>816cb2c2-f930-4db8-99c5-d883a8f564b7</BonusItemPluGuid>
      <BonusMasterID>7d41b7b6-8c64-439d-802a-da9b7aec9b43</BonusMasterID>
      <BonusMasterPLUG_UID>trdBfWSMnUOAKtqbeuybQw==</BonusMasterPLUG_UID>
      <BonusNormalCost>38</BonusNormalCost>
      <BonusNormalCostDecimals>39</BonusNormalCostDecimals>
      <BonusNormalSell>37</BonusNormalSell>
      <BonusOrderCode>sample string 36</BonusOrderCode>
      <BonusOrderPacked>42</BonusOrderPacked>
      <BonusProductAPN>sample string 35</BonusProductAPN>
      <BonusProductName>sample string 34</BonusProductName>
      <BonusPurchaseUnits>11</BonusPurchaseUnits>
      <BonusReceiveUnits>12</BonusReceiveUnits>
      <BonusSalesMode>41</BonusSalesMode>
      <CampaignActive>true</CampaignActive>
      <CampaignDescription>sample string 18</CampaignDescription>
      <CampaignEndDate>2025-10-05T00:03:58.727875+00:00</CampaignEndDate>
      <CampaignMetcashPromotionID>sample string 19</CampaignMetcashPromotionID>
      <CampaignName>542ea28a-2ea7-4e08-bdf9-979d8acb5528</CampaignName>
      <CampaignStartDate>2025-10-05T00:03:58.727875+00:00</CampaignStartDate>
      <CartonQuantity>28</CartonQuantity>
      <Cost>5</Cost>
      <CostDecimals>6</CostDecimals>
      <Description>sample string 4</Description>
      <End>2025-10-05T00:03:58.727875+00:00</End>
      <FromHost>15</FromHost>
      <FuelItem>true</FuelItem>
      <HeaderIdentifier>WLEYG1YgfkypMF0q6cKnKg==</HeaderIdentifier>
      <HeaderIdentifierGuid>1b18b158-2056-4c7e-a930-5d2ae9c2a72a</HeaderIdentifierGuid>
      <Identifier>UjTUIs0T5EasPv1ll3DMdQ==</Identifier>
      <IdentifierGuid>22d43452-13cd-46e4-ac3e-fd659770cc75</IdentifierGuid>
      <MasterID>5b7350af-5652-4555-9276-84a835bb8f92</MasterID>
      <MasterPLUG_UID>r1BzW1JWVUWSdoSoNbuPkg==</MasterPLUG_UID>
      <MetcashPromotionID>sample string 14</MetcashPromotionID>
      <NewPrice>1</NewPrice>
      <NormalCost>26</NormalCost>
      <NormalCostDecimals>27</NormalCostDecimals>
      <NormalSell>25</NormalSell>
      <OrderCode>sample string 24</OrderCode>
      <OrderPacked>30</OrderPacked>
      <PLUG_UID>JcbIRhQxyUu7er+1pV2ucA==</PLUG_UID>
      <PluGuid>46c8c625-3114-4bc9-bb7a-bfb5a55dae70</PluGuid>
      <ProductAPN>sample string 23</ProductAPN>
      <ProductName>sample string 22</ProductName>
      <PromoType>10</PromoType>
      <SalesMode>29</SalesMode>
      <Start>2025-10-05T00:03:58.727875+00:00</Start>
      <StoreIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </StoreIDs>
      <StoreNames>sample string 16</StoreNames>
      <SupplierGuid>4411c1fc-ad16-4bf0-a502-0f2058e4add1</SupplierGuid>
      <SupplierIdentifier>/MERRBat8EulAg8gWOSt0Q==</SupplierIdentifier>
      <SupplierName>sample string 17</SupplierName>
      <Type>9</Type>
      <Updated>2025-10-05T00:03:58.727875+00:00</Updated>
    </DealCost>
  </DealCosts>
  <Deleted>true</Deleted>
  <Description>sample string 2</Description>
  <End>2025-10-05T00:03:58.727875+00:00</End>
  <FromHost>7</FromHost>
  <HeaderIdentifier>m0w7ckff+EGr2GgDu2JvaQ==</HeaderIdentifier>
  <HeaderIdentifierGuid>723b4c9b-df47-41f8-abd8-6803bb626f69</HeaderIdentifierGuid>
  <MasterPLUG_UID>nJb6Abd1gEO2iqfqM2AOGQ==</MasterPLUG_UID>
  <MasterPluGuid>01fa969c-75b7-4380-b68a-a7ea33600e19</MasterPluGuid>
  <PromoType>6</PromoType>
  <Start>2025-10-05T00:03:58.727875+00:00</Start>
  <StoreIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </StoreIDs>
  <StoreNames>sample string 14</StoreNames>
  <SupplierGuid>70e960c9-019b-4bab-8666-fb3f3ca218cd</SupplierGuid>
  <SupplierIdentifier>yWDpcJsBq0uGZvs/PKIYzQ==</SupplierIdentifier>
  <SupplierName>sample string 13</SupplierName>
  <Type>5</Type>
  <Updated>2025-10-05T00:03:58.727875+00:00</Updated>
  <UpdatedByUser>sample string 11</UpdatedByUser>
</DealCostHeader>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Deal cost header identifier

globally unique identifier

Response Formats

application/json, text/json

Sample:

"faf2e56f-b9b5-4fcb-80f0-3eb84d21b1d4"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">faf2e56f-b9b5-4fcb-80f0-3eb84d21b1d4</guid>

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample:

PK}E[�\3�5xl/workbook.xml �(�����0D{$���`E��*
-��l����m>�J$:���ٷ#��s����"�T��ƢTh �G;�Z�Q�sm�%�N�
��2�O,`I;���.�X��&*�d�e@[Z�w����C�g9k��$l	�ߔ�a�Ŭ��%�!%�skJz�$z�\b�����7Y��{�	����PK}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
}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="R40120cc09243476f" /></Relationships>PK}E[���>%�xl/worksheets/sheet1.xml �(��Q�N�0���w����Lm'�i���кK�&����瓤!q�Ė��{v��MlF������:e.5L��+��T٫����q[��~<p�Z�Z�
�hB�'����p�{���I��<ϲ�[�RN�����.7Z]����Je��:أ{f���i�7UB�+\ܯ��1>��1y�j������e�b�-Ϩ.҇
�ROK�K7�*�
���.���bS��|_����n�k'�I���%_i��Ix�T�fS9��(��� �¼s�U|�������_�-�=y�I���/PK}E[d���Pxl/_rels/workbook.xml.rels �(���AN�0E�b͞�qҒ��ݰa[z��=��&vd�@�Ƃ#q,*A*�`ӕ5짧�lvo��^ȇ���L#��l��)vw춛=�Ӎ`�9��ĆL���A�0dn&�:���T��Ϩ���B��_2����Ct]7(zt�4�������`�"���b?Q��G�%*�'��^(*��^TB���o��y���u�2�ꪒuQ�Tɛ����O�^:-�Z�nWy�D]��vu����/PK}E[Ѓ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��%�}���Ǉ\in�,���9oy}��y.�$��6��ųǊ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK}E[s�����xl/sharedStrings.xml �(�5�An� E��fO���&�J=As0C�d׃���!�,���z�\��*~q�Th��A �%$�Op���#���[��� ��0WѦ�,�nJ�`v|*RKbٳ�
���mGxA�yU���]"s9�6-���ρ�/n�dM���ϗ(��?�!�^�:j��~B��.FUkԳ��+�PK-}E[�\3�5xl/workbook.xmlPK-}E[����	��[Content_Types].xmlPK-
}E[�+''U_rels/.relsPK-}E[���>%��xl/worksheets/sheet1.xmlPK-}E[d���P8xl/_rels/workbook.xml.relsPK-}E[Ѓc'2E
xl/styles.xmlPK-}E[s������xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample:

PK}E[Qn�Է5xl/workbook.xml �(�����0��&�C���N\�z�^�"
�'�||�	$޼���~;|��Zۓ���]�`eZ��:0Ӯ�^�0I�b�m���ʷXE�0����N9�+�:�� �aEi���B���`�EN�Vw6	[C�7��~�(b����"J�֔�L�/�4ܯ2��m�^�&I���a�m��/PK}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
}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="R4126093a823b4a28" /></Relationships>PK}E[���>%�xl/worksheets/sheet1.xml �(��Q�N�0���w����Lm'�i���кK�&����瓤!q�Ė��{v��MlF������:e.5L��+��T٫����q[��~<p�Z�Z�
�hB�'����p�{���I��<ϲ�[�RN�����.7Z]����Je��:أ{f���i�7UB�+\ܯ��1>��1y�j������e�b�-Ϩ.҇
�ROK�K7�*�
���.���bS��|_����n�k'�I���%_i��Ix�T�fS9��(��� �¼s�U|�������_�-�=y�I���/PK}E[ �E�Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞�u��TM�aö��=N�&vd�@��G�
XE�Tb�������4�y�Xo�ǁ�b��w
,
���wm�d*�n�;T���H�
t)M+J��pT���ܱ>�*�4�tR��Z��1IÜ�Lr8O��������iD���7��CL@*���)Ez
�"S�<�v�沒F�J,�)K �nj1���^��L�&�,��fw��T@�O!_z�4/�Ը�e���>%����ћ��|PK}E[Ѓ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��%�}���Ǉ\in�,���9oy}��y.�$��6��ųǊ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK}E[s�����xl/sharedStrings.xml �(�5�An� E��fO���&�J=As0C�d׃���!�,���z�\��*~q�Th��A �%$�Op���#���[��� ��0WѦ�,�nJ�`v|*RKbٳ�
���mGxA�yU���]"s9�6-���ρ�/n�dM���ϗ(��?�!�^�:j��~B��.FUkԳ��+�PK-}E[Qn�Է5xl/workbook.xmlPK-}E[����	�[Content_Types].xmlPK-
}E[���@''V_rels/.relsPK-}E[���>%��xl/worksheets/sheet1.xmlPK-}E[ �E�P9xl/_rels/workbook.xml.relsPK-}E[Ѓc'2E
�xl/styles.xmlPK-}E[s������xl/sharedStrings.xmlPK��