PUT api/dealcost/{id}
Request Information
Deprecated . Removed after 31 May 2026
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
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
{
"headerIdentifier": "LPF0aGnQQEWcOT5ceQ06Mw==",
"headerIdentifierGuid": "6874f12c-d069-4540-9c39-3e5c790d3a33",
"identifier": "Dl1SgSC4SUGmF2NFWLzLFg==",
"identifierGuid": "81525d0e-b820-4149-a617-634558bccb16",
"supplierIdentifier": "mDXGzWF60UuIgae6ST0g7w==",
"supplierGuid": "cdc63598-7a61-4bd1-8881-a7ba493d20ef",
"pluG_UID": "2zzAZnFA8km60oe5ikzg+g==",
"pluGuid": "66c03cdb-4071-49f2-bad2-87b98a4ce0fa",
"campaignName": "d5ec8999-b76d-4433-b32e-5a330e8aa9b1",
"description": "sample string 4",
"cost": 5,
"costDecimals": 6,
"start": "2026-06-03T18:33:35.5480643",
"end": "2026-06-03T18:33:35.5480643",
"type": 9,
"promoType": 10,
"bonusItemPLUG_UID": "1yZHDtIYlEuj8N3xilSk5g==",
"bonusItemPluGuid": "0e4726d7-18d2-4b94-a3f0-ddf18a54a4e6",
"bonusPurchaseUnits": 11,
"bonusReceiveUnits": 12,
"updated": "2026-06-03T18:33:35.5480643",
"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": "2026-06-03T18:33:35.5480643",
"campaignEndDate": "2026-06-03T18:33:35.5480643",
"masterPLUG_UID": "awNM1bf76kGJpIOFl8NQsw==",
"masterID": "d54c036b-fbb7-41ea-89a4-838597c350b3",
"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": "eyRDrOg4h0ae8+t9C6YBdw==",
"bonusMasterID": "ac43247b-38e8-4687-9ef3-eb7d0ba60177",
"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
<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>1yZHDtIYlEuj8N3xilSk5g==</BonusItemPLUG_UID>
<BonusItemPluGuid>0e4726d7-18d2-4b94-a3f0-ddf18a54a4e6</BonusItemPluGuid>
<BonusMasterID>ac43247b-38e8-4687-9ef3-eb7d0ba60177</BonusMasterID>
<BonusMasterPLUG_UID>eyRDrOg4h0ae8+t9C6YBdw==</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>2026-06-03T18:33:35.5480643+00:00</CampaignEndDate>
<CampaignMetcashPromotionID>sample string 19</CampaignMetcashPromotionID>
<CampaignName>d5ec8999-b76d-4433-b32e-5a330e8aa9b1</CampaignName>
<CampaignStartDate>2026-06-03T18:33:35.5480643+00:00</CampaignStartDate>
<CartonQuantity>28</CartonQuantity>
<Cost>5</Cost>
<CostDecimals>6</CostDecimals>
<Description>sample string 4</Description>
<End>2026-06-03T18:33:35.5480643+00:00</End>
<FromHost>15</FromHost>
<FuelItem>true</FuelItem>
<HeaderIdentifier>LPF0aGnQQEWcOT5ceQ06Mw==</HeaderIdentifier>
<HeaderIdentifierGuid>6874f12c-d069-4540-9c39-3e5c790d3a33</HeaderIdentifierGuid>
<Identifier>Dl1SgSC4SUGmF2NFWLzLFg==</Identifier>
<IdentifierGuid>81525d0e-b820-4149-a617-634558bccb16</IdentifierGuid>
<MasterID>d54c036b-fbb7-41ea-89a4-838597c350b3</MasterID>
<MasterPLUG_UID>awNM1bf76kGJpIOFl8NQsw==</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>2zzAZnFA8km60oe5ikzg+g==</PLUG_UID>
<PluGuid>66c03cdb-4071-49f2-bad2-87b98a4ce0fa</PluGuid>
<ProductAPN>sample string 23</ProductAPN>
<ProductName>sample string 22</ProductName>
<PromoType>10</PromoType>
<SalesMode>29</SalesMode>
<Start>2026-06-03T18:33:35.5480643+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>cdc63598-7a61-4bd1-8881-a7ba493d20ef</SupplierGuid>
<SupplierIdentifier>mDXGzWF60UuIgae6ST0g7w==</SupplierIdentifier>
<SupplierName>sample string 17</SupplierName>
<Type>9</Type>
<Updated>2026-06-03T18:33:35.5480643+00:00</Updated>
</DealCost>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
None.