Apply an Additional Bonus with SAP Omnichannel Promotion Pricing

Advanced

20 min.

SAP Business Technology Platform, Tutorial, Advanced, Cloud, SAP BTP, Cloud Foundry environment

Set up an additional bonus as a reward for your customers with SAP Omnichannel Promotion Pricing.

You will learn

How to use the SAP Omnichannel Promotion Pricing trial on SAP BTP
How to upload a promotional rule with an additional bonus with the help of the SAP API Business Hub
How to execute a calculation request that includes an additional bonus with SAP Omnichannel Promotion Pricing

Ulrike MuenchFebruary 16, 2022

Created by

July 28, 2021

Contributors

Prerequisites

You have completed the tutorial Apply a Simple Promotion with SAP Omnichannel Promotion Pricing and Apply a Mix-and-Match Promotion with SAP Omnichannel Promotion Pricing.
You have registered for a trial account on SAP BTP.
You should be familiar with the SAP BTP trial landscape and terminology (see Take a Tour of SAP BTP Trial).
You have a subaccount in the Cloud Foundry environment, with Microsoft Azure as provider and the Singapore region (AP21).
You have set up SAP Omnichannel Promotion Pricing as described in Set Up SAP Omnichannel Promotion Pricing.

This tutorial includes steps and screenshots based on the classic design of the SAP API Business Hub. To use the classic design, navigate to the upper right corner and disable the New SAP API Business Hub option.

Additional Information

Step 1
An additional bonus is a reward in the form of one or more free products that customers receive if certain predefined triggers are met. An additional bonus only gives a recommendation for the client application to add the free products to the transaction. They are not added automatically to the transaction.
Business goal: You want to promote the product coffee machine in your Heidelberg store (business unit ID: FC01). You have created the following promotion: Buy one coffee machine and one bag of deluxe coffee to get one cleaning kit for free.
Your promotion is valid from May 1st, 2021 until May 7th, 2021.
The regular sales price for the coffee machine (material number: COFFEE_MACHINE) is 500 Euro.
The regular sales price for one package of deluxe coffee (material number: DELUXE_COFFEE) is 10 Euro.
The regular sales price for one cleaning kit (material number: CLEANING_KIT) is 20 Euro.
A customer put one coffee machine and one package of deluxe coffee in the shopping cart.
You call the Calculation service with the shopping cart information (store, products, date, time).
The Calculation service includes the cleaning kit in the response, giving the recommendation for the client application to add it as a free product to the transaction.
Which kind of promotional rule will be covered in this tutorial?
Simple promotional rule
Promotional rule with an incentive
Mix-and-match promotional rule
Promotional rule with an additional bonus
Log in to complete tutorial
Step 2
In order to continue with the next steps, you need to have already set up your trial environments for the Data Upload service, Data Access service, and Calculation service in the SAP API Business Hub. If you need guidance, have a look at step 2 of the tutorial Apply a Simple Promotion with SAP Omnichannel Promotion Pricing.
Log in to complete tutorial

Step 3

You can now upload the promotional rule that includes the additional bonus with the Data Upload service.

Navigate to the Data Upload service of SAP Omnichannel Promotion Pricing on SAP API Business Hub. Log on with the same login information that you use for your SAP BTP account.

For API Environment, select the trial environment you have created for the Data Upload service.
On the left-hand side, choose Upload promotions using OAuth2.
Open the POST request /idocinbound.
Choose Try Out.
For the Request body, choose application/xml.

Copy the following raw data and paste it into the body:

XML

Copy

<?xml version="1.0" encoding="utf-8"?>
<_-ROP_-PROMOTION03>
<IDOC BEGIN="1">
    <EDI_DC40 SEGMENT="1">
        <IDOCTYP>/ROP/PROMOTION02</IDOCTYP>          
    </EDI_DC40>
    <_-ROP_-E1_PROMOTION SEGMENT="1">
        <CHANGED_ON>20210505145958</CHANGED_ON>
        <CHANGE_INDICATOR>I</CHANGE_INDICATOR>
        <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE>
        <EXPIRY_DATE>20210507235959</EXPIRY_DATE>
        <EXTERN_PROMO_ID>000000000000000000000000000000001001</EXTERN_PROMO_ID>
        <LOGSYS>ABCCLNT999</LOGSYS>
        <MIN_PPS_RELEASE>6000000</MIN_PPS_RELEASE>
        <OFFER_ID>42010AEE03C21EEB9AC2AE5E5D380D47</OFFER_ID>
        <ORIGIN>01</ORIGIN>
        <PROMOTION_ID>9103</PROMOTION_ID>
        <PROMOTION_TYPE>OPP</PROMOTION_TYPE>
        <STATUS_TCD>AC</STATUS_TCD>
        <_-ROP_-E1_PROMOTION_BU SEGMENT="1">
            <BU_ID>FC01</BU_ID>
            <BU_TYPE>1040</BU_TYPE>
        </_-ROP_-E1_PROMOTION_BU>
        <_-ROP_-E1_PROMOTION_RULE SEGMENT="1">
            <ELIGIBILITY_ID>9104</ELIGIBILITY_ID>
            <ONLY_BASKET_MODE>X</ONLY_BASKET_MODE>
            <PRICE_RULE_ID>9104</PRICE_RULE_ID>
            <PROMO_RULE_ID>9104</PROMO_RULE_ID>
            <RESOLUTION>1</RESOLUTION>
            <SALE_RETURN_TCD>00</SALE_RETURN_TCD>
            <SEQUENCE>9104</SEQUENCE>
            <RULE_NAME>PromoRule 9104</RULE_NAME>
            <_-ROP_-E1_ELIGIBILITY SEGMENT="1">
                <COMBINATION_CODE>&amp;&amp;</COMBINATION_CODE>
                <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE>
                <ELIGIBILITY_ID>9104</ELIGIBILITY_ID>
                <EXPIRY_DATE>20210507235959</EXPIRY_DATE>
                <INTERVAL_AMT>0.00000</INTERVAL_AMT>
                <INTERVAL_QTY>0.000</INTERVAL_QTY>
                <LIMIT_AMT>0.00000</LIMIT_AMT>
                <LIMIT_QTY>0.000</LIMIT_QTY>
                <MERCH_SET_ID>0</MERCH_SET_ID>
                <PARENT_ELIGIB_ID>9104</PARENT_ELIGIB_ID>
                <PROMO_RULE_ID>9104</PROMO_RULE_ID>
                <ROOT_ELIGIB_ID>9104</ROOT_ELIGIB_ID>
                <STATUS_TCD>AC</STATUS_TCD>
                <THRESHOLD_AMT>0.00000</THRESHOLD_AMT>
                <THRESHOLD_QTY>0.000</THRESHOLD_QTY>
                <TRANS_TOTAL_AMT>0.00000</TRANS_TOTAL_AMT>
                <TYPE_CODE>COMB</TYPE_CODE>
            </_-ROP_-E1_ELIGIBILITY>
            <_-ROP_-E1_ELIGIBILITY SEGMENT="1">
                <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE>
                <ELIGIBILITY_ID>9105</ELIGIBILITY_ID>
                <EXPIRY_DATE>20210507235959</EXPIRY_DATE>
                <INTERVAL_AMT>0.00000</INTERVAL_AMT>
                <INTERVAL_QTY>1.000</INTERVAL_QTY>
                <ITEM_ID>COFFEE_MACHINE</ITEM_ID>
                <LIMIT_AMT>0.00000</LIMIT_AMT>
                <LIMIT_QTY>9999999999.000</LIMIT_QTY>
                <MERCH_SET_ID>0</MERCH_SET_ID>
                <PARENT_ELIGIB_ID>9104</PARENT_ELIGIB_ID>
                <PROMO_RULE_ID>9104</PROMO_RULE_ID>
                <ROOT_ELIGIB_ID>9104</ROOT_ELIGIB_ID>
                <STATUS_TCD>AC</STATUS_TCD>
                <THRESHOLD_AMT>0.00000</THRESHOLD_AMT>
                <THRESHOLD_QTY>1.000</THRESHOLD_QTY>
                <THRESHOLD_TCD>QUTI</THRESHOLD_TCD>
                <TRANS_TOTAL_AMT>0.00000</TRANS_TOTAL_AMT>
                <TYPE_CODE>ITEM</TYPE_CODE>
                <UOM_ISO_CODE>PCE</UOM_ISO_CODE>
            </_-ROP_-E1_ELIGIBILITY>
            <_-ROP_-E1_ELIGIBILITY SEGMENT="1">
                <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE>
                <ELIGIBILITY_ID>9106</ELIGIBILITY_ID>
                <EXPIRY_DATE>20210507235959</EXPIRY_DATE>
                <INTERVAL_AMT>0.00000</INTERVAL_AMT>
                <INTERVAL_QTY>1.000</INTERVAL_QTY>
                <ITEM_ID>DELUXE_COFFEE</ITEM_ID>
                <LIMIT_AMT>0.00000</LIMIT_AMT>
                <LIMIT_QTY>9999999999.000</LIMIT_QTY>
                <MERCH_SET_ID>0</MERCH_SET_ID>
                <PARENT_ELIGIB_ID>9104</PARENT_ELIGIB_ID>
                <PROMO_RULE_ID>9104</PROMO_RULE_ID>
                <ROOT_ELIGIB_ID>9104</ROOT_ELIGIB_ID>
                <STATUS_TCD>AC</STATUS_TCD>
                <THRESHOLD_AMT>0.00000</THRESHOLD_AMT>
                <THRESHOLD_QTY>1.000</THRESHOLD_QTY>
                <THRESHOLD_TCD>QUTI</THRESHOLD_TCD>
                <TRANS_TOTAL_AMT>0.00000</TRANS_TOTAL_AMT>
                <TYPE_CODE>ITEM</TYPE_CODE>
                <UOM_ISO_CODE>PCE</UOM_ISO_CODE>
            </_-ROP_-E1_ELIGIBILITY>
            <_-ROP_-E1_PRICE_RULE SEGMENT="1">
                <CALCULATION_BASE>00</CALCULATION_BASE>
                <CALC_BASE_SEQUENCE>1-</CALC_BASE_SEQUENCE>
                <CONSIDER_PREVIOUS_RULES>X</CONSIDER_PREVIOUS_RULES>
                <COUPON_VALIDITY>0</COUPON_VALIDITY>
                <CURRENCY_ISO_CODE>EUR</CURRENCY_ISO_CODE>
                <DISC_METHOD_TCD>00</DISC_METHOD_TCD>
                <EX_PRICE_RULE_ID>0000000000000000000</EX_PRICE_RULE_ID>
                <ITEM_METHOD>00</ITEM_METHOD>
                <MAM_LIMIT_CNT>0.000</MAM_LIMIT_CNT>
                <NEW_PRICE_AMT>0.00000</NEW_PRICE_AMT>
                <NEW_SET_PRCE_AMT>0.00000</NEW_SET_PRCE_AMT>
                <PRICE_MODIF_AMT>0.00000</PRICE_MODIF_AMT>
                <PRICE_MODIF_PERC>0.000</PRICE_MODIF_PERC>
                <PRICE_RULE_ID>9104</PRICE_RULE_ID>
                <ROUNDING_METHOD>00</ROUNDING_METHOD>
                <ROUND_DECIMALS>2</ROUND_DECIMALS>
                <ROUND_DESTINATION>1</ROUND_DESTINATION>
                <RULE_CTRL_CODE>SP</RULE_CTRL_CODE>
                <STATUS_TCD>AC</STATUS_TCD>
                <SUBSEQ_NEW_PRICE_AMT>0.00000</SUBSEQ_NEW_PRICE_AMT>
                <SUBSEQ_PRICE_MODIF_AMT>0.00000</SUBSEQ_PRICE_MODIF_AMT>
                <SUBSEQ_PRICE_MODIF_PERC>0.000</SUBSEQ_PRICE_MODIF_PERC>
                <TYPE_CODE>AB</TYPE_CODE>
                <_-ROP_-E1_ADD_BONUS SEGMENT="1">
                    <ITEM_ID>CLEANING_KIT</ITEM_ID>
                    <ITEM_TCD>IT</ITEM_TCD>
                    <ADD_BONUS_ID>9108</ADD_BONUS_ID>
                    <MERCH_SET_ID>0</MERCH_SET_ID>
                    <QUANTITY>1.000</QUANTITY>
                    <UOM_ISO_CODE>PCE</UOM_ISO_CODE>
                </_-ROP_-E1_ADD_BONUS>
            </_-ROP_-E1_PRICE_RULE>
        </_-ROP_-E1_PROMOTION_RULE>
        <_-ROP_-E1_PROMOTION_TEXT SEGMENT="1">
            <DESCRIPTION>Buy one coffee machine and one bag deluxe coffee and get one cleaning kit for free</DESCRIPTION>
            <NAME>ADD_BONUS</NAME>
            <SPRAS_ISO>EN</SPRAS_ISO>
        </_-ROP_-E1_PROMOTION_TEXT>
    </_-ROP_-E1_PROMOTION>
</IDOC>
</_-ROP_-PROMOTION03>

Choose Execute.
Make sure you get the HTTP response 200.

With this, you uploaded the promotional rule “Buy one coffee machine and one bag of deluxe coffee to get one cleaning kit for free” (promotion ID: 9103) for the Heidelberg store (business unit ID: FC01) and the validity period May 1st, 2021 to May 7th, 2021.

Copy and paste the code line that indicates the additional bonus ID:

Step 4
In this tutorial, you only need to upload the regular sales price for the cleaning kit. You have already uploaded the regular sales price of 500 Euro for the product coffee machine (material number: COFFEE_MACHINE, unit of measure: PCE) and for the product DELUXE COFFEE with the validity period May 1st, 2021 to December 31st, 2021 in step 3 of the tutorial Apply a Mix-and-Match Promotion with SAP Omnichannel Promotion Pricing.
Navigate to the Data Upload service of SAP Omnichannel Promotion Pricing on SAP API Business Hub.

For API Environment, select the trial environment you have created for the Data Upload service.
On the left-hand side, choose Upload prices using OAuth2.
Open the POST request /idocinbound.
Choose Try Out.
For the Request body, choose application/xml.

Copy the following raw data and paste it into the body:

XML
Copy
<?xml version="1.0" encoding="UTF-8"?> <_-ROP_-BASE_PRICE01> <IDOC BEGIN="1"> <EDI_DC40 SEGMENT="1"> <IDOCTYP>/ROP/BASE_PRICE01</IDOCTYP> </EDI_DC40> <_-ROP_-E1_BASE_PRICE SEGMENT="1"> <LOGSYS>ABCCLNT999</LOGSYS> <BU_TYPE>1040</BU_TYPE> <PRICE_CLASSIFIC>PRICE_VAT</PRICE_CLASSIFIC> <_-ROP_-E1_BUSINESS_UNIT SEGMENT="1"> <BU_ID>FC01</BU_ID> </_-ROP_-E1_BUSINESS_UNIT> <_-ROP_-E1_ITEM SEGMENT="1"> <ITEM_ID>CLEANING_KIT</ITEM_ID> <_-ROP_-E1_ITEM_PRICE SEGMENT="1"> <PRICE_AMT>20.00000</PRICE_AMT> <COND_SPR_UNIT>1</COND_SPR_UNIT> <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE> <EXPIRY_DATE>20211231235959</EXPIRY_DATE> <UOM_ISO_CODE>PCE</UOM_ISO_CODE> <CURRENCY_ISO_CODE>EUR</CURRENCY_ISO_CODE> </_-ROP_-E1_ITEM_PRICE> </_-ROP_-E1_ITEM> </_-ROP_-E1_BASE_PRICE> </IDOC> </_-ROP_-BASE_PRICE01>
Choose Execute.
Make sure you get the HTTP response 200.

With this, you uploaded the regular sales price for the cleaning kit for the Heidelberg store (business unit ID: FC01) and the validity period May 1st, 2021 to December 31st, 2021.
For which store is the regular sales price valid?
FC01
FC10
1040
Log in to complete tutorial
Step 5
You can use the Data Access service for checking your uploaded data. If you need guidance, have a look at step 4 of the tutorial Apply a Simple Promotion with SAP Omnichannel Promotion Pricing.
Log in to complete tutorial

Step 6

You can now calculate the effective sales price based on the data you have uploaded in the previous steps.

Scenario: A customer has one coffee machine (material number: COFFEE_MACHINE) and one package of deluxe coffee (material number: DELUXE_COFFEE) in the shopping cart. The customer wants to purchase it on May 5th, 2021 in the Heidelberg store (business unit ID: FC01).

Desired Result: The Calculation service includes the cleaning kit as additional bonus in the response, giving the recommendation for the client application to add it as a free product to the transaction.

Let’s see if this is the case:

Navigate to the Calculation service on the SAP API Business Hub.
For API Environment, select your trial environment for the Calculation service.
Open the POST request /restapi/{tenantName} and choose Try Out.
In the field tenantName enter the identityzone from the service key you have created for the Calculation service in your SAP BTP account.
If you need more information about service keys, go to step 4 in the tutorial Set Up SAP Omnichannel Promotion Pricing.
For the Request body, choose application/xml.
Copy the following raw data and paste it into the body:

XML

Copy

<PriceCalculate xmlns="http://www.sap.com/IXRetail/namespace/" InternalMajorVersion="7" InternalMinorVersion="0">
	<ARTSHeader ActionCode="Calculate" MessageType="Request">
		<MessageID>123456789</MessageID>
		<DateTime>2021-05-05T18:13:51.0</DateTime>
		<BusinessUnit TypeCode="RetailStore">FC01</BusinessUnit>    
        <MasterDataSourceSystemID>ABCCLNT999</MasterDataSourceSystemID>
	</ARTSHeader>
   <PriceCalculateBody TransactionType="SaleTransaction" NetPriceFlag="false">
	  <TransactionID>3456789</TransactionID>
	  <DateTime>2021-05-05T18:13:51.0</DateTime>
    <ShoppingBasket>
      <LineItem>
         <SequenceNumber>0</SequenceNumber>
         <Sale ItemType="Stock" NonDiscountableFlag="false" FixedPriceFlag="false">
            <TaxIncludedInPriceFlag>false</TaxIncludedInPriceFlag>
            <NonPieceGoodFlag>false</NonPieceGoodFlag>
            <PriceTypeCode>00</PriceTypeCode>
            <NotConsideredByPriceEngineFlag>false</NotConsideredByPriceEngineFlag>
            <ItemID>COFFEE_MACHINE</ItemID>   
            <Quantity Units="1" UnitOfMeasureCode="PCE">1</Quantity>
           </Sale>
      </LineItem>
      <LineItem>
         <SequenceNumber>1</SequenceNumber>
         <Sale ItemType="Stock" NonDiscountableFlag="false" FixedPriceFlag="false">
            <TaxIncludedInPriceFlag>false</TaxIncludedInPriceFlag>
            <NonPieceGoodFlag>false</NonPieceGoodFlag>
            <PriceTypeCode>00</PriceTypeCode>
            <NotConsideredByPriceEngineFlag>false</NotConsideredByPriceEngineFlag>
            <ItemID>DELUXE_COFFEE</ItemID>   
            <Quantity Units="1" UnitOfMeasureCode="PCE">1</Quantity>
           </Sale>
      </LineItem>
    </ShoppingBasket>  
   </PriceCalculateBody>
</PriceCalculate>

Make sure you get the HTTP response 200.

Does SAP Omnichannel Promotion Pricing automatically add the additional bonus (in this example the cleaning kit) to the transaction?

Yes, the additional bonus is added automatically to the calculation of the effective sales price for the transaction.
No, it is checked if the customer fulfills the trigger for the additional bonus. If so, a recommendation is given to the client application to add the additional bonus to the transaction.

Get to know the business scenario
Create environments in SAP API Business Hub
Upload master data - promotional rule
Upload master data - regular sales price
Check uploaded master data
Calculate the effective sales price

Apply an Additional Bonus with SAP Omnichannel Promotion Pricing

Prerequisites

Additional Information

Which kind of promotional rule will be covered in this tutorial?

Copy and paste the code line that indicates the additional bonus ID:

For which store is the regular sales price valid?

Does SAP Omnichannel Promotion Pricing automatically add the additional bonus (in this example the cleaning kit) to the transaction?

Developer Products

Trials & Downloads

Site Information

Find us on