POST api/dealheader/create
Create deal costs based on the batch details
Request Information
URI Parameters
None.
Body Parameters
Promo Costing batch details
PromoCostingHeaderName | Description | Type | Additional information |
---|---|---|---|
SupplierIdentifier | Collection of byte |
None. |
|
SupplierGuid | globally unique identifier |
None. |
|
Description | string |
None. |
|
HostIdentifier |
Host identifier for a promotion sell to be created with this |
Collection of byte |
None. |
HostIdentifierGuid | globally unique identifier |
None. |
|
SellStart |
Promotion sell start to be created with campaign |
date |
Data type: Date |
SellEnd |
Promotion sell end to be created with campaign |
date |
Data type: Date |
CostStart | date |
Data type: Date |
|
CostEnd | date |
Data type: Date |
|
Type | DealCostType |
None. |
|
PromoType | PromoType |
None. |
|
FromHost |
FromHost identifying the source, see |
integer |
None. |
StoreIDs |
StoreIDs for the deal cost to be updated to |
Collection of integer |
Required |
Details |
Deal costs to create |
Collection of PromoCostingDetail |
Required |
Request Formats
application/json, text/json
Sample:
{ "supplierIdentifier": "n3pmqGkKt0CUG1GJNwrksQ==", "supplierGuid": "a8667a9f-0a69-40b7-941b-5189370ae4b1", "description": "sample string 2", "hostIdentifier": "ixFZCFJUekmoXRNqM3DG8g==", "hostIdentifierGuid": "0859118b-5452-497a-a85d-136a3370c6f2", "sellStart": "2025-06-14T06:17:01.0375619", "sellEnd": "2025-06-14T06:17:01.0375619", "costStart": "2025-06-14T06:17:01.0375619", "costEnd": "2025-06-14T06:17:01.0375619", "type": 5, "promoType": 6, "fromHost": 7, "storeIDs": [ 1, 2 ], "details": [ { "$id": "2", "pluG_UID": "6CY8t5UpmUqxRR8If1d6tg==", "pluGuid": "b73c26e8-2995-4a99-b145-1f087f577ab6", "sell": 1, "cost": 2, "costDecimals": 3, "bonusItemPLUG_UID": "A65VUDiAWEu6hUMP98WeKQ==", "bonusItemPluGuid": "5055ae03-8038-4b58-ba85-430ff7c59e29", "bonusPurchaseUnits": 5, "bonusReceiveUnits": 6, "metcashPromotionID": "sample string 7" }, { "$ref": "2" } ] }
application/xml, text/xml
Sample:
<PromoCostingHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.PromoBatch"> <CostEnd>2025-06-14T06:17:01.0375619+00:00</CostEnd> <CostStart>2025-06-14T06:17:01.0375619+00:00</CostStart> <Description>sample string 2</Description> <Details> <PromoCostingDetail> <BonusItemPLUG_UID>A65VUDiAWEu6hUMP98WeKQ==</BonusItemPLUG_UID> <BonusItemPluGuid>5055ae03-8038-4b58-ba85-430ff7c59e29</BonusItemPluGuid> <BonusPurchaseUnits>5</BonusPurchaseUnits> <BonusReceiveUnits>6</BonusReceiveUnits> <Cost>2</Cost> <CostDecimals>3</CostDecimals> <MetcashPromotionID>sample string 7</MetcashPromotionID> <PLUG_UID>6CY8t5UpmUqxRR8If1d6tg==</PLUG_UID> <PluGuid>b73c26e8-2995-4a99-b145-1f087f577ab6</PluGuid> <Sell>1</Sell> </PromoCostingDetail> <PromoCostingDetail> <BonusItemPLUG_UID>A65VUDiAWEu6hUMP98WeKQ==</BonusItemPLUG_UID> <BonusItemPluGuid>5055ae03-8038-4b58-ba85-430ff7c59e29</BonusItemPluGuid> <BonusPurchaseUnits>5</BonusPurchaseUnits> <BonusReceiveUnits>6</BonusReceiveUnits> <Cost>2</Cost> <CostDecimals>3</CostDecimals> <MetcashPromotionID>sample string 7</MetcashPromotionID> <PLUG_UID>6CY8t5UpmUqxRR8If1d6tg==</PLUG_UID> <PluGuid>b73c26e8-2995-4a99-b145-1f087f577ab6</PluGuid> <Sell>1</Sell> </PromoCostingDetail> </Details> <FromHost>7</FromHost> <HostIdentifier>ixFZCFJUekmoXRNqM3DG8g==</HostIdentifier> <HostIdentifierGuid>0859118b-5452-497a-a85d-136a3370c6f2</HostIdentifierGuid> <PromoType>6</PromoType> <SellEnd>2025-06-14T06:17:01.0375619+00:00</SellEnd> <SellStart>2025-06-14T06:17:01.0375619+00:00</SellStart> <StoreIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </StoreIDs> <SupplierGuid>a8667a9f-0a69-40b7-941b-5189370ae4b1</SupplierGuid> <SupplierIdentifier>n3pmqGkKt0CUG1GJNwrksQ==</SupplierIdentifier> <Type>5</Type> </PromoCostingHeader>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Details of deal cost creation
PromoCostingResultName | Description | Type | Additional information |
---|---|---|---|
Statuses | Collection of PromoCostingStatus |
None. |
Response Formats
application/json, text/json
Sample:
{ "statuses": [ { "$id": "2", "pluGuid": "916986fe-a153-412e-9882-50fc6dfbd42a", "dealCostHeaderIdentifierGuid": "360ba0ea-9dd6-4871-86ab-5ab7b8bc9cad", "campaignName": "sample string 1", "success": 2 }, { "$ref": "2" } ] }
application/xml, text/xml
Sample:
<PromoCostingResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.PromoBatch"> <Statuses> <PromoCostingStatus> <CampaignName>sample string 1</CampaignName> <DealCostHeaderIdentifierGuid>360ba0ea-9dd6-4871-86ab-5ab7b8bc9cad</DealCostHeaderIdentifierGuid> <PluGuid>916986fe-a153-412e-9882-50fc6dfbd42a</PluGuid> <Success>2</Success> </PromoCostingStatus> <PromoCostingStatus> <CampaignName>sample string 1</CampaignName> <DealCostHeaderIdentifierGuid>360ba0ea-9dd6-4871-86ab-5ab7b8bc9cad</DealCostHeaderIdentifierGuid> <PluGuid>916986fe-a153-412e-9882-50fc6dfbd42a</PluGuid> <Success>2</Success> </PromoCostingStatus> </Statuses> </PromoCostingResult>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK 2�Z ܷ 5 xl/workbook.xml � (� ����0��&�C��h� )��x���V�O�5��B $���~;|�~xZ;�� ���}�d����u`杴^�0K�bVJ�Bc۷�%Ir�aAY��rHW�?,tD�=@���BZ���C��Q��Vw1 [C�7�#l����������ܺ��){��E�ɢ��5-2Iw��l�]PK 2�Z���� � [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�Zy,>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="Rd5029d9846eb467b" /></Relationships>PK 2�Z����0 " xl/worksheets/sheet1.xml � (� �Q�n�0~�(�5@��V@U���۴�v����$Fq(}�� u�z�!�-?�S�o�gWp�і<]%����Ѷ+��ۗ �Wń�B �� ��s%W�;!�V`$�p j-:#}H]'�mu G�G,I^��^�`EJ���h��@6��/RFj˫��A}�9hK~Hw��3Q��a���͓|#^��)y�� |���5�ʱ�8�Awʇ%�ScO�fFϫ���[|'�xU��z�'�|���6_�k��<����.L�<J/����\,�9:��b������*)�u��wN��ɞ8��x�Ta��N�\�����PK 2�ZY8��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8I�ԩ�vÆm�gGM��v���G� XEWb�������4����ݿ�yA�GkZ(�i��-��z��m8�'�O��-�� �^j����&v�u�1u]�<�i��5u)n��xY�?D��(����&���֝�F@�� Z�)yz E�@���1^W���5�W ���� ���w��4e#�B5Xʆu��������S����I��V���!��j��/v_PK 2�ZЃc'2 E 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 2�Z���i� xl/sharedStrings.xml � (� E�AK�0��J�ݤ��E��u/�$�!�@2S3Sq��FV�����v�������i�4F��~z���֊���!8}�jߵ̢�+�ӳ�rc-��gC`��Q�^�-�奀y���iv6��ZZQ��j�b|_����V��2pk�k�O���Y ��R� �;� ��]dy�<����OP�@#$6ǡ7��2���"{b�S/������oPK- 2�Z ܷ 5 xl/workbook.xmlPK- 2�Z���� � [Content_Types].xmlPK- 2�Zy,>8' ' V _rels/.relsPK- 2�Z����0 " � xl/worksheets/sheet1.xmlPK- 2�ZY8��� P D xl/_rels/workbook.xml.relsPK- 2�ZЃc'2 E � xl/styles.xmlPK- 2�Z���i� xl/sharedStrings.xmlPK � '
application/vnd.ms-excel
Sample:
PK 2�Z��b�� 5 xl/workbook.xml � (� ����0D�&�C�`Q#)��x��}�EhK��|�o�vfgߎ���t�z�2�C���q��HO��X�~���M�ȊJS�i�OQ�rK=zi�k��`���r�%�]K�U��J �~ǘ��=$�.��X��&�K���D�mA1��r(�#������l&��\�Ө�`rN�� {� ��.�PK 2�Z���� � [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�Z-�_(' ' _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="R37bb637d3b234ba8" /></Relationships>PK 2�Z����0 " xl/worksheets/sheet1.xml � (� �Q�n�0~�(�5@��V@U���۴�v����$Fq(}�� u�z�!�-?�S�o�gWp�і<]%����Ѷ+��ۗ �Wń�B �� ��s%W�;!�V`$�p j-:#}H]'�mu G�G,I^��^�`EJ���h��@6��/RFj˫��A}�9hK~Hw��3Q��a���͓|#^��)y�� |���5�ʱ�8�Awʇ%�ScO�fFϫ���[|'�xU��z�'�|���6_�k��<����.L�<J/����\,�9:��b������*)�u��wN��ɞ8��x�Ta��N�\�����PK 2�Z�~�3� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;�� D`�M��{�D$vd������W�E��H]t�j4��'�|�lvo�@^0�xŀ����m���v����D��)���b]JӚҨ;U���.w��J9 -��>�錱 %n��p��?Dom�����.���>�b���Th15�S��x��@�L{Y���JΥ�+ �nj1]��^�y!å�sΘQV�� �*ө��9�|�ҩ,ju�Z,�fG&dm�W5z��/PK 2�ZЃc'2 E 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 2�Z���i� xl/sharedStrings.xml � (� E�AK�0��J�ݤ��E��u/�$�!�@2S3Sq��FV�����v�������i�4F��~z���֊���!8}�jߵ̢�+�ӳ�rc-��gC`��Q�^�-�奀y���iv6��ZZQ��j�b|_����V��2pk�k�O���Y ��R� �;� ��]dy�<����OP�@#$6ǡ7��2���"{b�S/������oPK- 2�Z��b�� 5 xl/workbook.xmlPK- 2�Z���� � � [Content_Types].xmlPK- 2�Z-�_(' ' U _rels/.relsPK- 2�Z����0 " � xl/worksheets/sheet1.xmlPK- 2�Z�~�3� P C xl/_rels/workbook.xml.relsPK- 2�ZЃc'2 E � xl/styles.xmlPK- 2�Z���i� xl/sharedStrings.xmlPK � &