POST api/store/{storeID}/dealCosts
Save a deal cost at a single store
Request Information
Deprecated . Removed after 31 May 2026
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
storeID | string |
None. |
Body Parameters
Deal cost to save
DealCostName | 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": "eTUdkJDA7Eer+H9zriluJA==", "headerIdentifierGuid": "901d3579-c090-47ec-abf8-7f73ae296e24", "identifier": "okrllFxd0UaNIsAi+r+wAQ==", "identifierGuid": "94e54aa2-5d5c-46d1-8d22-c022fabfb001", "supplierIdentifier": "XHLLE2FWikGxElzje2/prw==", "supplierGuid": "13cb725c-5661-418a-b112-5ce37b6fe9af", "pluG_UID": "uk/wG8x4R0WXUBb0bn8TRw==", "pluGuid": "1bf04fba-78cc-4547-9750-16f46e7f1347", "campaignName": "2cbe5aa2-c789-470a-9233-9eeda27195d6", "description": "sample string 4", "cost": 5, "costDecimals": 6, "start": "2025-10-05T00:01:57.2627075", "end": "2025-10-05T00:01:57.2627075", "type": 9, "promoType": 10, "bonusItemPLUG_UID": "+Q7c5F8NYE2kSWKWQHGwBw==", "bonusItemPluGuid": "e4dc0ef9-0d5f-4d60-a449-62964071b007", "bonusPurchaseUnits": 11, "bonusReceiveUnits": 12, "updated": "2025-10-05T00:01:57.2627075", "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:01:57.2627075", "campaignEndDate": "2025-10-05T00:01:57.2627075", "masterPLUG_UID": "dc1VHOCv5kK2qsBI/rblzg==", "masterID": "1c55cd75-afe0-42e6-b6aa-c048feb6e5ce", "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": "tnAI8dJWXkG65pRfTeWHiw==", "bonusMasterID": "f10870b6-56d2-415e-bae6-945f4de5878b", "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>+Q7c5F8NYE2kSWKWQHGwBw==</BonusItemPLUG_UID> <BonusItemPluGuid>e4dc0ef9-0d5f-4d60-a449-62964071b007</BonusItemPluGuid> <BonusMasterID>f10870b6-56d2-415e-bae6-945f4de5878b</BonusMasterID> <BonusMasterPLUG_UID>tnAI8dJWXkG65pRfTeWHiw==</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:01:57.2627075+00:00</CampaignEndDate> <CampaignMetcashPromotionID>sample string 19</CampaignMetcashPromotionID> <CampaignName>2cbe5aa2-c789-470a-9233-9eeda27195d6</CampaignName> <CampaignStartDate>2025-10-05T00:01:57.2627075+00:00</CampaignStartDate> <CartonQuantity>28</CartonQuantity> <Cost>5</Cost> <CostDecimals>6</CostDecimals> <Description>sample string 4</Description> <End>2025-10-05T00:01:57.2627075+00:00</End> <FromHost>15</FromHost> <FuelItem>true</FuelItem> <HeaderIdentifier>eTUdkJDA7Eer+H9zriluJA==</HeaderIdentifier> <HeaderIdentifierGuid>901d3579-c090-47ec-abf8-7f73ae296e24</HeaderIdentifierGuid> <Identifier>okrllFxd0UaNIsAi+r+wAQ==</Identifier> <IdentifierGuid>94e54aa2-5d5c-46d1-8d22-c022fabfb001</IdentifierGuid> <MasterID>1c55cd75-afe0-42e6-b6aa-c048feb6e5ce</MasterID> <MasterPLUG_UID>dc1VHOCv5kK2qsBI/rblzg==</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>uk/wG8x4R0WXUBb0bn8TRw==</PLUG_UID> <PluGuid>1bf04fba-78cc-4547-9750-16f46e7f1347</PluGuid> <ProductAPN>sample string 23</ProductAPN> <ProductName>sample string 22</ProductName> <PromoType>10</PromoType> <SalesMode>29</SalesMode> <Start>2025-10-05T00:01:57.2627075+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>13cb725c-5661-418a-b112-5ce37b6fe9af</SupplierGuid> <SupplierIdentifier>XHLLE2FWikGxElzje2/prw==</SupplierIdentifier> <SupplierName>sample string 17</SupplierName> <Type>9</Type> <Updated>2025-10-05T00:01:57.2627075+00:00</Updated> </DealCost>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Deal Cost identifier
globally unique identifierResponse Formats
application/json, text/json
"e3bad9e4-9b3d-460a-9d60-88eb6efe081c"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">e3bad9e4-9b3d-460a-9d60-88eb6efe081c</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK <