PUT api/deal/{id}

Add or update a deal cost header

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Deal cost header identifier

 globally unique identifier

Required

Body Parameters

Deal cost header to save

DealCostHeader
NameDescriptionTypeAdditional 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": "0tAm+nHez0W2r9hi3fHztA==",
  "headerIdentifierGuid": "fa26d0d2-de71-45cf-b6af-d862ddf1f3b4",
  "supplierIdentifier": "uXnvn7R2OEaG6931nH08MA==",
  "supplierGuid": "9fef79b9-76b4-4638-86eb-ddf59c7d3c30",
  "description": "sample string 2",
  "start": "2025-06-14T07:13:53.7725974",
  "end": "2025-06-14T07:13:53.7725974",
  "type": 5,
  "promoType": 6,
  "fromHost": 7,
  "created": "2025-06-14T07:13:53.7725974",
  "createdByUser": "sample string 9",
  "updated": "2025-06-14T07:13:53.7725974",
  "updatedByUser": "sample string 11",
  "deleted": true,
  "supplierName": "sample string 13",
  "storeNames": "sample string 14",
  "storeIDs": [
    1,
    2
  ],
  "masterPLUG_UID": "ZiCoWtdIsEiX09hN++E83g==",
  "masterPluGuid": "5aa82066-48d7-48b0-97d3-d84dfbe13cde",
  "dealCosts": [
    {
      "$id": "2",
      "headerIdentifier": "mfRRE6IXq0mTe2rz5xVsjg==",
      "headerIdentifierGuid": "1351f499-17a2-49ab-937b-6af3e7156c8e",
      "identifier": "6CbzWRsI3U+jh/EK3vz1AQ==",
      "identifierGuid": "59f326e8-081b-4fdd-a387-f10adefcf501",
      "supplierIdentifier": "dK89+Bd1q0yemu40ye+8Ew==",
      "supplierGuid": "f83daf74-7517-4cab-9e9a-ee34c9efbc13",
      "pluG_UID": "6RwGU0D/ukakjEgEzk8jgQ==",
      "pluGuid": "53061ce9-ff40-46ba-a48c-4804ce4f2381",
      "campaignName": "0c1acb6e-28ed-4adc-adf3-18c5eb71ac8c",
      "description": "sample string 4",
      "cost": 5,
      "costDecimals": 6,
      "start": "2025-06-14T07:13:53.7725974",
      "end": "2025-06-14T07:13:53.7725974",
      "type": 9,
      "promoType": 10,
      "bonusItemPLUG_UID": "8ptkiTvEwkKsys0n9tOqvw==",
      "bonusItemPluGuid": "89649bf2-c43b-42c2-acca-cd27f6d3aabf",
      "bonusPurchaseUnits": 11,
      "bonusReceiveUnits": 12,
      "updated": "2025-06-14T07:13:53.7725974",
      "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-06-14T07:13:53.7725974",
      "campaignEndDate": "2025-06-14T07:13:53.7725974",
      "masterPLUG_UID": "S1yJT2slr0yky7J4MJnO1g==",
      "masterID": "4f895c4b-256b-4caf-a4cb-b2783099ced6",
      "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": "xLY4ooWEJ0CW3gDiPHiE7A==",
      "bonusMasterID": "a238b6c4-8485-4027-96de-00e23c7884ec",
      "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-06-14T07:13:53.7725974+00:00</Created>
  <CreatedByUser>sample string 9</CreatedByUser>
  <DealCosts>
    <DealCost>
      <Active>true</Active>
      <BonusActive>true</BonusActive>
      <BonusCartonQuantity>40</BonusCartonQuantity>
      <BonusFuelItem>true</BonusFuelItem>
      <BonusItemPLUG_UID>8ptkiTvEwkKsys0n9tOqvw==</BonusItemPLUG_UID>
      <BonusItemPluGuid>89649bf2-c43b-42c2-acca-cd27f6d3aabf</BonusItemPluGuid>
      <BonusMasterID>a238b6c4-8485-4027-96de-00e23c7884ec</BonusMasterID>
      <BonusMasterPLUG_UID>xLY4ooWEJ0CW3gDiPHiE7A==</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-06-14T07:13:53.7725974+00:00</CampaignEndDate>
      <CampaignMetcashPromotionID>sample string 19</CampaignMetcashPromotionID>
      <CampaignName>0c1acb6e-28ed-4adc-adf3-18c5eb71ac8c</CampaignName>
      <CampaignStartDate>2025-06-14T07:13:53.7725974+00:00</CampaignStartDate>
      <CartonQuantity>28</CartonQuantity>
      <Cost>5</Cost>
      <CostDecimals>6</CostDecimals>
      <Description>sample string 4</Description>
      <End>2025-06-14T07:13:53.7725974+00:00</End>
      <FromHost>15</FromHost>
      <FuelItem>true</FuelItem>
      <HeaderIdentifier>mfRRE6IXq0mTe2rz5xVsjg==</HeaderIdentifier>
      <HeaderIdentifierGuid>1351f499-17a2-49ab-937b-6af3e7156c8e</HeaderIdentifierGuid>
      <Identifier>6CbzWRsI3U+jh/EK3vz1AQ==</Identifier>
      <IdentifierGuid>59f326e8-081b-4fdd-a387-f10adefcf501</IdentifierGuid>
      <MasterID>4f895c4b-256b-4caf-a4cb-b2783099ced6</MasterID>
      <MasterPLUG_UID>S1yJT2slr0yky7J4MJnO1g==</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>6RwGU0D/ukakjEgEzk8jgQ==</PLUG_UID>
      <PluGuid>53061ce9-ff40-46ba-a48c-4804ce4f2381</PluGuid>
      <ProductAPN>sample string 23</ProductAPN>
      <ProductName>sample string 22</ProductName>
      <PromoType>10</PromoType>
      <SalesMode>29</SalesMode>
      <Start>2025-06-14T07:13:53.7725974+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>f83daf74-7517-4cab-9e9a-ee34c9efbc13</SupplierGuid>
      <SupplierIdentifier>dK89+Bd1q0yemu40ye+8Ew==</SupplierIdentifier>
      <SupplierName>sample string 17</SupplierName>
      <Type>9</Type>
      <Updated>2025-06-14T07:13:53.7725974+00:00</Updated>
    </DealCost>
    <DealCost>
      <Active>true</Active>
      <BonusActive>true</BonusActive>
      <BonusCartonQuantity>40</BonusCartonQuantity>
      <BonusFuelItem>true</BonusFuelItem>
      <BonusItemPLUG_UID>8ptkiTvEwkKsys0n9tOqvw==</BonusItemPLUG_UID>
      <BonusItemPluGuid>89649bf2-c43b-42c2-acca-cd27f6d3aabf</BonusItemPluGuid>
      <BonusMasterID>a238b6c4-8485-4027-96de-00e23c7884ec</BonusMasterID>
      <BonusMasterPLUG_UID>xLY4ooWEJ0CW3gDiPHiE7A==</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-06-14T07:13:53.7725974+00:00</CampaignEndDate>
      <CampaignMetcashPromotionID>sample string 19</CampaignMetcashPromotionID>
      <CampaignName>0c1acb6e-28ed-4adc-adf3-18c5eb71ac8c</CampaignName>
      <CampaignStartDate>2025-06-14T07:13:53.7725974+00:00</CampaignStartDate>
      <CartonQuantity>28</CartonQuantity>
      <Cost>5</Cost>
      <CostDecimals>6</CostDecimals>
      <Description>sample string 4</Description>
      <End>2025-06-14T07:13:53.7725974+00:00</End>
      <FromHost>15</FromHost>
      <FuelItem>true</FuelItem>
      <HeaderIdentifier>mfRRE6IXq0mTe2rz5xVsjg==</HeaderIdentifier>
      <HeaderIdentifierGuid>1351f499-17a2-49ab-937b-6af3e7156c8e</HeaderIdentifierGuid>
      <Identifier>6CbzWRsI3U+jh/EK3vz1AQ==</Identifier>
      <IdentifierGuid>59f326e8-081b-4fdd-a387-f10adefcf501</IdentifierGuid>
      <MasterID>4f895c4b-256b-4caf-a4cb-b2783099ced6</MasterID>
      <MasterPLUG_UID>S1yJT2slr0yky7J4MJnO1g==</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>6RwGU0D/ukakjEgEzk8jgQ==</PLUG_UID>
      <PluGuid>53061ce9-ff40-46ba-a48c-4804ce4f2381</PluGuid>
      <ProductAPN>sample string 23</ProductAPN>
      <ProductName>sample string 22</ProductName>
      <PromoType>10</PromoType>
      <SalesMode>29</SalesMode>
      <Start>2025-06-14T07:13:53.7725974+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>f83daf74-7517-4cab-9e9a-ee34c9efbc13</SupplierGuid>
      <SupplierIdentifier>dK89+Bd1q0yemu40ye+8Ew==</SupplierIdentifier>
      <SupplierName>sample string 17</SupplierName>
      <Type>9</Type>
      <Updated>2025-06-14T07:13:53.7725974+00:00</Updated>
    </DealCost>
  </DealCosts>
  <Deleted>true</Deleted>
  <Description>sample string 2</Description>
  <End>2025-06-14T07:13:53.7725974+00:00</End>
  <FromHost>7</FromHost>
  <HeaderIdentifier>0tAm+nHez0W2r9hi3fHztA==</HeaderIdentifier>
  <HeaderIdentifierGuid>fa26d0d2-de71-45cf-b6af-d862ddf1f3b4</HeaderIdentifierGuid>
  <MasterPLUG_UID>ZiCoWtdIsEiX09hN++E83g==</MasterPLUG_UID>
  <MasterPluGuid>5aa82066-48d7-48b0-97d3-d84dfbe13cde</MasterPluGuid>
  <PromoType>6</PromoType>
  <Start>2025-06-14T07:13:53.7725974+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>9fef79b9-76b4-4638-86eb-ddf59c7d3c30</SupplierGuid>
  <SupplierIdentifier>uXnvn7R2OEaG6931nH08MA==</SupplierIdentifier>
  <SupplierName>sample string 13</SupplierName>
  <Type>5</Type>
  <Updated>2025-06-14T07:13:53.7725974+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: 
"55951433-7efe-426c-83f0-aee6c76ad967"

application/xml, text/xml

Sample: 
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">55951433-7efe-426c-83f0-aee6c76ad967</guid>

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample: 
PK�9�Z+N�5xl/workbook.xml �(���;�0D�H���Ā�A�PѤM���u��َ��c�@J�ngv���ٸ�3fD5i_�!؊���?:�q��(݋!d���
t E�]���i���x������~jZQ�I���!�4{J�}����.&"k���h��I!�Ըe�a��;�q���d��(r�/噗1��w%���PK�9�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
�9�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="R0d3236498c5e49ff" /></Relationships>PK�9�Z��4f%�xl/worksheets/sheet1.xml �(��Q�N�0��(w�v��Lm'�i���кK�&���瓤!q�Ė��{v���l�5ښ盌3�-v�^j>QW�cS-�^p���h<�[F�
�`C�Gg$��]��n��d���fY!���Wz�|e���.Y0�Je����:أ{栯�SΙh��|װ�_1�c|"^c���<KX�|Nʯ�u��i�7\�A_�
=���nft�gF�һ�T�w�MQl�}Q�ey_r�N��|��եXi��I�l*�s��c���i�a޹�*1��p���گ–��	\R����PK�9�Z�����Pxl/_rels/workbook.xml.rels �(���Kn�0@�b;��*6�R.���8"�-�8[=R�P�Jm����h~OO��|�Xo/�H�0���ʂA+�l��)����G��D4��$��؂I�?S��I��y���]�D�i��(z�c+��g�����N�A���ӄ6��g�� & zL-��"����T /��=S��j�p� �aj1]G��^��Lf�\0�u��L�+cD@��B���i^��U(�n�oxͱlnj��/6_PK�9�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�9�ZЙ����xl/sharedStrings.xml �(�5�An�0E�b��1	�$�q�z����%<&�P������������'/�7N�8PH����<�>�K�1,�p�_dPw�E�)���z3��9�H5�ʖ�Tܞ��
��3��Ŝ�ƚ��e'�ZP;�׎o������v�s��'�瓍��N��6�6�W�;#ޙ�����PK-�9�Z+N�5xl/workbook.xmlPK-�9�Z����	�[Content_Types].xmlPK-
�9�Z���"''V_rels/.relsPK-�9�Z��4f%��xl/worksheets/sheet1.xmlPK-�9�Z�����P9xl/_rels/workbook.xml.relsPK-�9�ZЃc'2E
~xl/styles.xmlPK-�9�Z�����xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample: 
PK�9�Z�E��5xl/workbook.xml �(�����0D�&�C���B������ڒ�?��ě���ٷSL��O�{򑃲�))wn��
G	��GT~�i#�yi^Lw�h���[�r,
���	�,��+��
Bk9��Ê� ��B���C�d鍭�l���o�X`�Ţ��%��%�skKRbr�;��$;�x��4�3��;�`���PK�9�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
�9�ZrO��''_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="R94b9073b5133495e" /></Relationships>PK�9�Z��4f%�xl/worksheets/sheet1.xml �(��Q�N�0��(w�v��Lm'�i���кK�&���瓤!q�Ė��{v���l�5ښ盌3�-v�^j>QW�cS-�^p���h<�[F�
�`C�Gg$��]��n��d���fY!���Wz�|e���.Y0�Je����:أ{栯�SΙh��|װ�_1�c|"^c���<KX�|Nʯ�u��i�7\�A_�
=���nft�gF�һ�T�w�MQl�}Q�ey_r�N��|��եXi��I�l*�s��c���i�a޹�*1��p���گ–��	\R����PK�9�Z����Pxl/_rels/workbook.xml.rels �(���Kn�0@�b;q��
�n)p�I�ؖmh9[=R�P�J�����b4?=�����ٽ�����-Y�0r�C��?5��n8�7��'��-��R/��gƢ��޸��X��Z.N|@��|I]ʀ{&9^-��h�~�7�<���q'��#w�~Z��R�E*�g��媬�aE]U+�>L͇����Nd���d]YD�Z���(�P�:uJ۩Z�5��`�U
Û����PK�9�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�9�ZЙ����xl/sharedStrings.xml �(�5�An�0E�b��1	�$�q�z����%<&�P������������'/�7N�8PH����<�>�K�1,�p�_dPw�E�)���z3��9�H5�ʖ�Tܞ��
��3��Ŝ�ƚ��e'�ZP;�׎o������v�s��'�瓍��N��6�6�W�;#ޙ�����PK-�9�Z�E��5xl/workbook.xmlPK-�9�Z����	�[Content_Types].xmlPK-
�9�ZrO��''V_rels/.relsPK-�9�Z��4f%��xl/worksheets/sheet1.xmlPK-�9�Z����P9xl/_rels/workbook.xml.relsPK-�9�ZЃc'2E
xl/styles.xmlPK-�9�Z�����xl/sharedStrings.xmlPK��