GET api/product/{guid}/bestcost?forDate={forDate}
Get the best deal cost for a product
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| guid |
Product identifier |
globally unique identifier |
Required |
| forDate |
Date to get deal cost for, defaults to today |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
Matching deal cost
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. |
Response Formats
application/json, text/json
{
"headerIdentifier": "Awji2ayFqUub+bwKCn7Syw==",
"headerIdentifierGuid": "d9e20803-85ac-4ba9-9bf9-bc0a0a7ed2cb",
"identifier": "GR/Kn7pFeEiHWldElatq3w==",
"identifierGuid": "9fca1f19-45ba-4878-875a-574495ab6adf",
"supplierIdentifier": "UF1hkpNSWUKtOBpQwJkAOQ==",
"supplierGuid": "92615d50-5293-4259-ad38-1a50c0990039",
"pluG_UID": "VXwySs4b7US+2EPP5PyO5w==",
"pluGuid": "4a327c55-1bce-44ed-bed8-43cfe4fc8ee7",
"campaignName": "729673d7-8e4e-4914-8147-483cc2a4d7a7",
"description": "sample string 4",
"cost": 5,
"costDecimals": 6,
"start": "2026-04-03T06:22:01.713224",
"end": "2026-04-03T06:22:01.713224",
"type": 9,
"promoType": 10,
"bonusItemPLUG_UID": "SxlDr2uouk+JyBbkZmwu4g==",
"bonusItemPluGuid": "af43194b-a86b-4fba-89c8-16e4666c2ee2",
"bonusPurchaseUnits": 11,
"bonusReceiveUnits": 12,
"updated": "2026-04-03T06:22:01.713224",
"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-04-03T06:22:01.713224",
"campaignEndDate": "2026-04-03T06:22:01.713224",
"masterPLUG_UID": "BrUmk6mcsE6M307JR4LG1w==",
"masterID": "9326b506-9ca9-4eb0-8cdf-4ec94782c6d7",
"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": "4tqrjoKOrkudpLrwbZ5LFg==",
"bonusMasterID": "8eabdae2-8e82-4bae-9da4-baf06d9e4b16",
"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>SxlDr2uouk+JyBbkZmwu4g==</BonusItemPLUG_UID>
<BonusItemPluGuid>af43194b-a86b-4fba-89c8-16e4666c2ee2</BonusItemPluGuid>
<BonusMasterID>8eabdae2-8e82-4bae-9da4-baf06d9e4b16</BonusMasterID>
<BonusMasterPLUG_UID>4tqrjoKOrkudpLrwbZ5LFg==</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-04-03T06:22:01.713224+00:00</CampaignEndDate>
<CampaignMetcashPromotionID>sample string 19</CampaignMetcashPromotionID>
<CampaignName>729673d7-8e4e-4914-8147-483cc2a4d7a7</CampaignName>
<CampaignStartDate>2026-04-03T06:22:01.713224+00:00</CampaignStartDate>
<CartonQuantity>28</CartonQuantity>
<Cost>5</Cost>
<CostDecimals>6</CostDecimals>
<Description>sample string 4</Description>
<End>2026-04-03T06:22:01.713224+00:00</End>
<FromHost>15</FromHost>
<FuelItem>true</FuelItem>
<HeaderIdentifier>Awji2ayFqUub+bwKCn7Syw==</HeaderIdentifier>
<HeaderIdentifierGuid>d9e20803-85ac-4ba9-9bf9-bc0a0a7ed2cb</HeaderIdentifierGuid>
<Identifier>GR/Kn7pFeEiHWldElatq3w==</Identifier>
<IdentifierGuid>9fca1f19-45ba-4878-875a-574495ab6adf</IdentifierGuid>
<MasterID>9326b506-9ca9-4eb0-8cdf-4ec94782c6d7</MasterID>
<MasterPLUG_UID>BrUmk6mcsE6M307JR4LG1w==</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>VXwySs4b7US+2EPP5PyO5w==</PLUG_UID>
<PluGuid>4a327c55-1bce-44ed-bed8-43cfe4fc8ee7</PluGuid>
<ProductAPN>sample string 23</ProductAPN>
<ProductName>sample string 22</ProductName>
<PromoType>10</PromoType>
<SalesMode>29</SalesMode>
<Start>2026-04-03T06:22:01.713224+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>92615d50-5293-4259-ad38-1a50c0990039</SupplierGuid>
<SupplierIdentifier>UF1hkpNSWUKtOBpQwJkAOQ==</SupplierIdentifier>
<SupplierName>sample string 17</SupplierName>
<Type>9</Type>
<Updated>2026-04-03T06:22:01.713224+00:00</Updated>
</DealCost>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK �2�\�ͥ� 5 xl/workbook.xml � (� ����0��&�C���(Q��x��})�4П�5��$���~;�d��3����]I�lΘ=*�'cQ�]g���{1�uR`m�[��'I���Ѿ��ӕ��[���1�qE)��V�!���)q��Vw6 [C�7U,��bQD����Ź�%M)q��Ã��r�B���Y����a�~W_PK �2�\���� � [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
�2�\t�o#' ' _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="Rd397721e2e724c19" /></Relationships>PK �2�\�
9 � � xl/worksheets/sheet1.xml � (� �ZkOK�+Q��d���*�JJi{�~?���R�R%���_'dȬ�� ���;s�ۋ8x�{v���,����a�L��\��ϦW���b�����|�cy�4�ï��������pyz��&���gs�k���l��_߇����is<?��5W�!㇋�r��G-/�?���l��Z�\4���f���f��U���l���-�����>?�~oxt�A�67��so}�����_����;�O6O��5���ջ���f��b�,�M���r��ޛM���{����ϛ���b�$(�d��������j>��]�Yn�aw� 1%C!:�s<n�q�|8���L�!�?��6�v��.�)�����m�����6ޗ�h�xr�������Ϗ��X��Ȧ�����?ǧm|*��Eg�E�oM�ٝ��2���1T`�$Xh�R���h�A��Y�J-�8![I�Uh�'�-T��fZ�o��D��bX2��5h}�lg�� �XɐUh��Kb��BmY��%�`l$o���=d%ڝ������[!Ud Y�PH�)�!��� ��Y�`�y�pW�<p50��wR�"d-B�E30k/�@{
��ʢ���`�6qa�d�Z�� ����akV�dM����&!�LZo1X�,̚�X8*ঀĽ)TjdIB!�8H�7�<���ݲ$є48o��B�z}�,I��5�%p��֫#fIbQú�'�� ��pפ���!�X�ܧ|�Y�����'