PUT api/deal/{id}/cost/{guid}

Add or update a deal cost for a deal cost header

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Deal cost header identifier	globally unique identifier	Required
guid	Product identifier	globally unique identifier	Required

Body Parameters

Deal cost to save

DealCost

Name	Description	Type	Additional 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": "eRPlMSmIEUqVh0sUa3PzOQ==",
  "headerIdentifierGuid": "31e51379-8829-4a11-9587-4b146b73f339",
  "identifier": "jnH1xwtqTkiEyYIJM7AE1w==",
  "identifierGuid": "c7f5718e-6a0b-484e-84c9-820933b004d7",
  "supplierIdentifier": "MqiZ61UqLk22foyYfQr4oQ==",
  "supplierGuid": "eb99a832-2a55-4d2e-b67e-8c987d0af8a1",
  "pluG_UID": "8NfNSPoHEU6sjVHl8DiM8Q==",
  "pluGuid": "48cdd7f0-07fa-4e11-ac8d-51e5f0388cf1",
  "campaignName": "99e0ab82-79ef-4aaa-9456-4b5aba4baede",
  "description": "sample string 4",
  "cost": 5,
  "costDecimals": 6,
  "start": "2025-08-02T23:22:52.9374039",
  "end": "2025-08-02T23:22:52.9374039",
  "type": 9,
  "promoType": 10,
  "bonusItemPLUG_UID": "ezGSXJChAkGcio8qAypfew==",
  "bonusItemPluGuid": "5c92317b-a190-4102-9c8a-8f2a032a5f7b",
  "bonusPurchaseUnits": 11,
  "bonusReceiveUnits": 12,
  "updated": "2025-08-02T23:22:52.9374039",
  "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-08-02T23:22:52.9374039",
  "campaignEndDate": "2025-08-02T23:22:52.9374039",
  "masterPLUG_UID": "hFN+P+aCb0ivj9qruJP0Fg==",
  "masterID": "3f7e5384-82e6-486f-af8f-daabb893f416",
  "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": "dPi3HoxqrUa4um3w4rLNPQ==",
  "bonusMasterID": "1eb7f874-6a8c-46ad-b8ba-6df0e2b2cd3d",
  "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>ezGSXJChAkGcio8qAypfew==</BonusItemPLUG_UID>
  <BonusItemPluGuid>5c92317b-a190-4102-9c8a-8f2a032a5f7b</BonusItemPluGuid>
  <BonusMasterID>1eb7f874-6a8c-46ad-b8ba-6df0e2b2cd3d</BonusMasterID>
  <BonusMasterPLUG_UID>dPi3HoxqrUa4um3w4rLNPQ==</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-08-02T23:22:52.9374039+00:00</CampaignEndDate>
  <CampaignMetcashPromotionID>sample string 19</CampaignMetcashPromotionID>
  <CampaignName>99e0ab82-79ef-4aaa-9456-4b5aba4baede</CampaignName>
  <CampaignStartDate>2025-08-02T23:22:52.9374039+00:00</CampaignStartDate>
  <CartonQuantity>28</CartonQuantity>
  <Cost>5</Cost>
  <CostDecimals>6</CostDecimals>
  <Description>sample string 4</Description>
  <End>2025-08-02T23:22:52.9374039+00:00</End>
  <FromHost>15</FromHost>
  <FuelItem>true</FuelItem>
  <HeaderIdentifier>eRPlMSmIEUqVh0sUa3PzOQ==</HeaderIdentifier>
  <HeaderIdentifierGuid>31e51379-8829-4a11-9587-4b146b73f339</HeaderIdentifierGuid>
  <Identifier>jnH1xwtqTkiEyYIJM7AE1w==</Identifier>
  <IdentifierGuid>c7f5718e-6a0b-484e-84c9-820933b004d7</IdentifierGuid>
  <MasterID>3f7e5384-82e6-486f-af8f-daabb893f416</MasterID>
  <MasterPLUG_UID>hFN+P+aCb0ivj9qruJP0Fg==</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>8NfNSPoHEU6sjVHl8DiM8Q==</PLUG_UID>
  <PluGuid>48cdd7f0-07fa-4e11-ac8d-51e5f0388cf1</PluGuid>
  <ProductAPN>sample string 23</ProductAPN>
  <ProductName>sample string 22</ProductName>
  <PromoType>10</PromoType>
  <SalesMode>29</SalesMode>
  <Start>2025-08-02T23:22:52.9374039+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>eb99a832-2a55-4d2e-b67e-8c987d0af8a1</SupplierGuid>
  <SupplierIdentifier>MqiZ61UqLk22foyYfQr4oQ==</SupplierIdentifier>
  <SupplierName>sample string 17</SupplierName>
  <Type>9</Type>
  <Updated>2025-08-02T23:22:52.9374039+00:00</Updated>
</DealCost>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.