POST api/dealCosts

Save a deal cost

Request Information

Deprecated . Removed after 31 May 2026

URI Parameters

None.

Body Parameters

Deal cost to save

DealCost
NameDescriptionTypeAdditional information
HeaderIdentifier

Collection of byte

None.
HeaderIdentifierGuid

globally unique identifier

None.
Identifier

Collection of byte

None.
IdentifierGuid

globally unique identifier

None.
SupplierIdentifier

Collection of byte

None.
SupplierGuid

globally unique identifier

None.
PLUG_UID

Collection of byte

None.
PluGuid

A Store Product GUID

 globally unique identifier

None.
CampaignName

string

Deprecated. Please use CampaignPLU.DealCostIdentifier instead.

String length: inclusive between 0 and 64
Description

string

None.
Cost

integer

None.
CostDecimals

integer

None.
Start

date

Data type: Date
End

date

Data type: Date
Type

DealCostType

None.
PromoType

PromoType

None.
BonusItemPLUG_UID

Collection of byte

None.
BonusItemPluGuid

A Store Product GUID

 globally unique identifier

None.
BonusPurchaseUnits

integer

None.
BonusReceiveUnits

integer

None.
Updated

date

None.
MetcashPromotionID

string

None.
FromHost

FromHost identifying the source, see

 integer

None.
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

List of store ids of the stores that the deal cost header belongs to

 Collection of integer

Relation. This field may not always be loaded or used for updates.
SupplierName

Supplier name

 string

Relation. This field may not always be loaded or used for updates.
CampaignDescription

Campaign description of campaign using this deal cost

 string

Relation. This field may not always be loaded or used for updates.
NewPrice

New sell price of campaign using this deal cost

 integer

Relation. This field may not always be loaded or used for updates.
CampaignMetcashPromotionID

Metcash promotion id of campaign using this deal cost

 string

Relation. This field may not always be loaded or used for updates.
CampaignActive

Active status of campaign using this deal cost

 boolean

Relation. This field may not always be loaded or used for updates.
CampaignStartDate

Start date of campaign using this deal cost

 date

Relation. This field may not always be loaded or used for updates.
CampaignEndDate

End date of campaign using this deal cost

 date

Relation. This field may not always be loaded or used for updates.
MasterPLUG_UID

Master plu guid for the deal cost store product

 Collection of byte

Relation. This field may not always be loaded or used for updates.
MasterID

Master guid for the deal cost store product

 globally unique identifier

Relation. This field may not always be loaded or used for updates.
ProductName

Product description

 string

Relation. This field may not always be loaded or used for updates.
ProductAPN

Product barcode

 string

Relation. This field may not always be loaded or used for updates.
OrderCode

Order code of product for this supplier deal cost

 string

Relation. This field may not always be loaded or used for updates.
NormalSell

Normal product sell

 integer

Relation. This field may not always be loaded or used for updates.
NormalCost

Normal product cost

 integer

Relation. This field may not always be loaded or used for updates.
NormalCostDecimals

Normal product cost decimals

 integer

Relation. This field may not always be loaded or used for updates.
CartonQuantity

integer

Relation. This field may not always be loaded or used for updates.
SalesMode

integer

Relation. This field may not always be loaded or used for updates.
OrderPacked

integer

Relation. This field may not always be loaded or used for updates.
FuelItem

boolean

Relation. This field may not always be loaded or used for updates.
Active

boolean

Relation. This field may not always be loaded or used for updates.
BonusMasterPLUG_UID

Master plu guid for the deal cost store bonus product

 Collection of byte

Relation. This field may not always be loaded or used for updates.
BonusMasterID

Master guid for the deal cost store bonus product

 globally unique identifier

Relation. This field may not always be loaded or used for updates.
BonusProductName

Bonus product description

 string

Relation. This field may not always be loaded or used for updates.
BonusProductAPN

Bonus product barcode

 string

Relation. This field may not always be loaded or used for updates.
BonusOrderCode

Order code of bonus product for this supplier deal cost

 string

Relation. This field may not always be loaded or used for updates.
BonusNormalSell

Normal bonus product sell

 integer

Relation. This field may not always be loaded or used for updates.
BonusNormalCost

Normal bonus product cost

 integer

Relation. This field may not always be loaded or used for updates.
BonusNormalCostDecimals

Normal bonus product cost decimals

 integer

Relation. This field may not always be loaded or used for updates.
BonusCartonQuantity

integer

Relation. This field may not always be loaded or used for updates.
BonusSalesMode

integer

Relation. This field may not always be loaded or used for updates.
BonusOrderPacked

integer

Relation. This field may not always be loaded or used for updates.
BonusFuelItem

boolean

Relation. This field may not always be loaded or used for updates.
BonusActive

boolean

Relation. This field may not always be loaded or used for updates.

Request Formats

application/json, text/json

Sample: 
{
  "headerIdentifier": "bVaIMAv2kkOrXM+e/0nqHg==",
  "headerIdentifierGuid": "3088566d-f60b-4392-ab5c-cf9eff49ea1e",
  "identifier": "FappA4b/UECze6Kh1bRSag==",
  "identifierGuid": "0369aa15-ff86-4050-b37b-a2a1d5b4526a",
  "supplierIdentifier": "7RoMAI+QrEavvkycHLOulA==",
  "supplierGuid": "000c1aed-908f-46ac-afbe-4c9c1cb3ae94",
  "pluG_UID": "7OmlPNmDv0mKzSQ1zoLgQQ==",
  "pluGuid": "3ca5e9ec-83d9-49bf-8acd-2435ce82e041",
  "campaignName": "8eaefe46-1398-4e7c-bb3b-7a275c7e6df6",
  "description": "sample string 4",
  "cost": 5,
  "costDecimals": 6,
  "start": "2025-10-05T00:04:03.0877146",
  "end": "2025-10-05T00:04:03.0877146",
  "type": 9,
  "promoType": 10,
  "bonusItemPLUG_UID": "3xlvYKeNREGp/7uc9ftq9g==",
  "bonusItemPluGuid": "606f19df-8da7-4144-a9ff-bb9cf5fb6af6",
  "bonusPurchaseUnits": 11,
  "bonusReceiveUnits": 12,
  "updated": "2025-10-05T00:04:03.0877146",
  "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:04:03.0877146",
  "campaignEndDate": "2025-10-05T00:04:03.0877146",
  "masterPLUG_UID": "iqewdxcevEOluYj5KYzQDw==",
  "masterID": "77b0a78a-1e17-43bc-a5b9-88f9298cd00f",
  "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": "qCjQRJLZ70W5Y8g+D9gX7A==",
  "bonusMasterID": "44d028a8-d992-45ef-b963-c83e0fd817ec",
  "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
}

application/xml, text/xml

Sample: 
<DealCost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager">
  <Active>true</Active>
  <BonusActive>true</BonusActive>
  <BonusCartonQuantity>40</BonusCartonQuantity>
  <BonusFuelItem>true</BonusFuelItem>
  <BonusItemPLUG_UID>3xlvYKeNREGp/7uc9ftq9g==</BonusItemPLUG_UID>
  <BonusItemPluGuid>606f19df-8da7-4144-a9ff-bb9cf5fb6af6</BonusItemPluGuid>
  <BonusMasterID>44d028a8-d992-45ef-b963-c83e0fd817ec</BonusMasterID>
  <BonusMasterPLUG_UID>qCjQRJLZ70W5Y8g+D9gX7A==</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:04:03.0877146+00:00</CampaignEndDate>
  <CampaignMetcashPromotionID>sample string 19</CampaignMetcashPromotionID>
  <CampaignName>8eaefe46-1398-4e7c-bb3b-7a275c7e6df6</CampaignName>
  <CampaignStartDate>2025-10-05T00:04:03.0877146+00:00</CampaignStartDate>
  <CartonQuantity>28</CartonQuantity>
  <Cost>5</Cost>
  <CostDecimals>6</CostDecimals>
  <Description>sample string 4</Description>
  <End>2025-10-05T00:04:03.0877146+00:00</End>
  <FromHost>15</FromHost>
  <FuelItem>true</FuelItem>
  <HeaderIdentifier>bVaIMAv2kkOrXM+e/0nqHg==</HeaderIdentifier>
  <HeaderIdentifierGuid>3088566d-f60b-4392-ab5c-cf9eff49ea1e</HeaderIdentifierGuid>
  <Identifier>FappA4b/UECze6Kh1bRSag==</Identifier>
  <IdentifierGuid>0369aa15-ff86-4050-b37b-a2a1d5b4526a</IdentifierGuid>
  <MasterID>77b0a78a-1e17-43bc-a5b9-88f9298cd00f</MasterID>
  <MasterPLUG_UID>iqewdxcevEOluYj5KYzQDw==</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>7OmlPNmDv0mKzSQ1zoLgQQ==</PLUG_UID>
  <PluGuid>3ca5e9ec-83d9-49bf-8acd-2435ce82e041</PluGuid>
  <ProductAPN>sample string 23</ProductAPN>
  <ProductName>sample string 22</ProductName>
  <PromoType>10</PromoType>
  <SalesMode>29</SalesMode>
  <Start>2025-10-05T00:04:03.0877146+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 16</StoreNames>
  <SupplierGuid>000c1aed-908f-46ac-afbe-4c9c1cb3ae94</SupplierGuid>
  <SupplierIdentifier>7RoMAI+QrEavvkycHLOulA==</SupplierIdentifier>
  <SupplierName>sample string 17</SupplierName>
  <Type>9</Type>
  <Updated>2025-10-05T00:04:03.0877146+00:00</Updated>
</DealCost>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Deal Cost identifier

globally unique identifier

Response Formats

application/json, text/json

Sample: 
"df07075b-aa88-40ab-81e5-938572faf2ca"

application/xml, text/xml

Sample: 
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">df07075b-aa88-40ab-81e5-938572faf2ca</guid>

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample: 
PK�E[�zն5xl/workbook.xml �(�����0��&�C���(18q����Z��H����[J ��mgv�۩'�_k_�G*��!FW1Ā��:4i'����Of�T;+�Md�%�8BTքA�@�?��<BĨ��A��w��s���)d����l���o�ΰ�"+b@cC;�@Iv�}C���J��&�<sQ^��T�X��f���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[d�''_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="R7092809ae6bd45f1" /></Relationships>PK�E[f�%�xl/worksheets/sheet1.xml �(��Q�n� ��}��j�UI�IU�ݦ�3K��pdH��m����-?��l�����
���W�3p
����B�p৺���^����:��(�o4X�W8���ɪS�v�i��d�����
Q�k3z����ˏ���PYe���D��tZs&�2#�
��W����ה���+��/Y��X�����3�^���]�ip��f֤�qf�=��i���v���f�Xȍ��g��ڏ���M�<���pf�ˑ=Ei��Fq�ղ��O��_�u��1e�����PK�E[|>l��Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞�)iH��ݰ���=��&�e����G�
XE�Tb�������4����޾M#9c���ʂA+�l���C��z��Hy"��G�Wl�`R�+J�48�X8�6w��H9
=�BE�t�XMÜ�Lr�x��i=H|v�4�M���h��=&?�H��,2�Nq�K�����ZUV�wS��2b����g2�n�n���T�R��]e��^Rȗ�;��3�N��c�U����l�j��/6_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��%�}���LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK�E[A�KE��xl/sharedStrings.xml �(�5�An� E����״�dQ�'H0��1�\�8jn���������//��B�>�VHC�z�s�6^+��B���V��E�)q�g���Zf����"�d*[���,���3���6ν����NR�Z�~w���*H1H'׹��������#���ͷ]3����`_}[_�'PK-�E[�zն5xl/workbook.xmlPK-�E[����	��[Content_Types].xmlPK-
�E[d�''U_rels/.relsPK-�E[f�%��xl/worksheets/sheet1.xmlPK-�E[|>l��P8xl/_rels/workbook.xml.relsPK-�E[Ѓc'2E
~xl/styles.xmlPK-�E[A�KE���xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample: 
PK�E[G�ao�5xl/workbook.xml �(����� ��&���ZŤ�=��Ճ��]��@����'6��mgv�����#oۻX��ꔆ���h�~@7��$Óy�L��o^]b�,�,`�x�"]i���ڨ��W��h��"�f�c\�d|��&ak�����.EX,i
	(Y�[[�#%�0�p�B��R��"�3��n�
&��w�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[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="R99f48690923444b2" /></Relationships>PK�E[f�%�xl/worksheets/sheet1.xml �(��Q�n� ��}��j�UI�IU�ݦ�3K��pdH��m����-?��l�����
���W�3p
����B�p৺���^����:��(�o4X�W8���ɪS�v�i��d�����
Q�k3z����ˏ���PYe���D��tZs&�2#�
��W����ה���+��/Y��X�����3�^���]�ip��f֤�qf�=��i���v���f�Xȍ��g��ڏ���M�<���pf�ˑ=Ei��Fq�ղ��O��_�u��1e�����PK�E[��_��Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞�I�BM��m���8��ؑ�=�����ĂMW��==i���c�{�F�B>�֐gYt�`���<�a��h�1M�~�K+6���8?r��I���dS�8?�R��Y�Iw�!�K�2��2��Θi��<�������E`G�;�5����<KT`Om
��m�UV
J�(`�nj!^F
�^��B�F�V�z%K)P�U�מ���ӥ�N��B�BDj�"/0�jm�j��/�_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��%�}���LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK�E[A�KE��xl/sharedStrings.xml �(�5�An� E����״�dQ�'H0��1�\�8jn���������//��B�>�VHC�z�s�6^+��B���V��E�)q�g���Zf����"�d*[���,���3���6ν����NR�Z�~w���*H1H'׹��������#���ͷ]3����`_}[_�'PK-�E[G�ao�5xl/workbook.xmlPK-�E[����	�[Content_Types].xmlPK-
�E[8��''V_rels/.relsPK-�E[f�%��xl/worksheets/sheet1.xmlPK-�E[��_��P9xl/_rels/workbook.xml.relsPK-�E[Ѓc'2E
xl/styles.xmlPK-�E[A�KE���xl/sharedStrings.xmlPK��