Apply Incentives (Coupons and Loyalty Points) with SAP Omnichannel Promotion Pricing

Advanced

10 min.

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

Learn how to use SAP Omnichannel Promotion Pricing for calculating the effective sales price by applying a coupon to the transaction and adding loyalty points.

You will learn

How to use the SAP Omnichannel Promotion Pricing trial on SAP BTP.
How to upload a promotional rule with the help of the SAP API Business Hub. The promotional rule includes an example about applying a coupon to a transaction and how to add loyalty points.
How to apply a promotional rule and execute the calculation request.

Ulrike MuenchFebruary 16, 2022

Created by

July 28, 2021

Contributors

Prerequisites

You have completed the tutorials 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
Business goal: In your Heidelberg store (business unit ID: FC01) you want to promote coffee machines to free up stock. For this, you have created the following promotion: Buy a coffee machine and show the coupon TIME FOR COFFEE to get 5 Euro off and 100 loyalty points.
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.
A customer put one coffee machine in the shopping cart.
You call the Calculation service with the shopping cart information (store, products, date, time).
The Calculation service calculates the effective sales price by applying the promotional rules.
Which kind of promotional rule will be covered in this tutorial?
Mix-and-match promotional rule
Transactional promotional rule
A promotion with incentives
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 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_-PROMOTION02>
  <IDOC BEGIN="1">
<EDI_DC40 SEGMENT="1">
  <IDOCTYP>/ROP/PROMOTION02</IDOCTYP>
</EDI_DC40>
<_-ROP_-E1_PROMOTION SEGMENT="1">
  <CHANGED_ON>20210506072209</CHANGED_ON>
  <CHANGE_INDICATOR>I</CHANGE_INDICATOR>
  <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE>
  <EXPIRY_DATE>20210507235959</EXPIRY_DATE>
  <EXTERN_PROMO_ID>000000000000000000000000000000000161</EXTERN_PROMO_ID>
  <LOGSYS>ABCCLNT999</LOGSYS>
  <MIN_PPS_RELEASE>0</MIN_PPS_RELEASE>
  <OFFER_ID>42010AEF0FAA1EEBBABE7EEA0C2D0823</OFFER_ID>
  <ORIGIN>01</ORIGIN>
  <PROMOTION_ID>771</PROMOTION_ID>
  <PROMOTION_TYPE>Z001</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>772</ELIGIBILITY_ID>
    <ONLY_BASKET_MODE>X</ONLY_BASKET_MODE>
    <PRICE_RULE_ID>772</PRICE_RULE_ID>
    <PROMO_RULE_ID>772</PROMO_RULE_ID>
    <RESOLUTION>1</RESOLUTION>
    <SALE_RETURN_TCD>00</SALE_RETURN_TCD>
    <SEQUENCE>772</SEQUENCE>
    <_-ROP_-E1_ELIGIBILITY SEGMENT="1">
      <COMBINATION_CODE>&amp;&amp;</COMBINATION_CODE>
      <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE>
      <ELIGIBILITY_ID>772</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>772</PARENT_ELIGIB_ID>
      <PROMO_RULE_ID>772</PROMO_RULE_ID>
      <ROOT_ELIGIB_ID>772</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">
      <CONSUMPTION_TCD>00</CONSUMPTION_TCD>
      <COUPON_NUMBER>TIME FOR COFFEE</COUPON_NUMBER>
      <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE>
      <ELIGIBILITY_ID>773</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>772</PARENT_ELIGIB_ID>
      <PROMO_RULE_ID>772</PROMO_RULE_ID>
      <ROOT_ELIGIB_ID>772</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>COUP</TYPE_CODE>
    </_-ROP_-E1_ELIGIBILITY>
    <_-ROP_-E1_ELIGIBILITY SEGMENT="1">
      <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE>
      <ELIGIBILITY_ID>774</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>772</PARENT_ELIGIB_ID>
      <PROMO_RULE_ID>772</PROMO_RULE_ID>
      <ROOT_ELIGIB_ID>772</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>5.00000</PRICE_MODIF_AMT>
      <PRICE_MODIF_CODE>RT</PRICE_MODIF_CODE>
      <PRICE_MODIF_PERC>0.000</PRICE_MODIF_PERC>
      <PRICE_RULE_ID>772</PRICE_RULE_ID>
      <ROUNDING_METHOD>00</ROUNDING_METHOD>
      <ROUND_DECIMALS>2</ROUND_DECIMALS>
      <ROUND_DESTINATION>1</ROUND_DESTINATION>
      <RULE_CTRL_CODE>PO</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>RB</TYPE_CODE>
    </_-ROP_-E1_PRICE_RULE>
  </_-ROP_-E1_PROMOTION_RULE>
  <_-ROP_-E1_PROMOTION_RULE SEGMENT="1">
    <ELIGIBILITY_ID>775</ELIGIBILITY_ID>
    <ONLY_BASKET_MODE>X</ONLY_BASKET_MODE>
    <PRICE_RULE_ID>775</PRICE_RULE_ID>
    <PROMO_RULE_ID>775</PROMO_RULE_ID>
    <RESOLUTION>0</RESOLUTION>
    <SALE_RETURN_TCD>00</SALE_RETURN_TCD>
    <SEQUENCE>775</SEQUENCE>
    <_-ROP_-E1_ELIGIBILITY SEGMENT="1">
      <COMBINATION_CODE>&amp;&amp;</COMBINATION_CODE>
      <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE>
      <ELIGIBILITY_ID>775</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>775</PARENT_ELIGIB_ID>
      <PROMO_RULE_ID>775</PROMO_RULE_ID>
      <ROOT_ELIGIB_ID>775</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">
      <CONSUMPTION_TCD>00</CONSUMPTION_TCD>
      <COUPON_NUMBER>TIME FOR COFFEE</COUPON_NUMBER>
      <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE>
      <ELIGIBILITY_ID>776</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>775</PARENT_ELIGIB_ID>
      <PROMO_RULE_ID>775</PROMO_RULE_ID>
      <ROOT_ELIGIB_ID>775</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>COUP</TYPE_CODE>
    </_-ROP_-E1_ELIGIBILITY>
    <_-ROP_-E1_ELIGIBILITY SEGMENT="1">
      <EFFECTIVE_DATE>20210501000000</EFFECTIVE_DATE>
      <ELIGIBILITY_ID>777</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>775</PARENT_ELIGIB_ID>
      <PROMO_RULE_ID>775</PROMO_RULE_ID>
      <ROOT_ELIGIB_ID>775</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>100.00000</PRICE_MODIF_AMT>
      <PRICE_MODIF_CODE>RT</PRICE_MODIF_CODE>
      <PRICE_MODIF_PERC>0.000</PRICE_MODIF_PERC>
      <PRICE_RULE_ID>775</PRICE_RULE_ID>
      <REWARD_AS_POINTS>X</REWARD_AS_POINTS>
      <ROUNDING_METHOD>00</ROUNDING_METHOD>
      <ROUND_DECIMALS>0</ROUND_DECIMALS>
      <ROUND_DESTINATION>1</ROUND_DESTINATION>
      <RULE_CTRL_CODE>PO</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>RB</TYPE_CODE>
    </_-ROP_-E1_PRICE_RULE>
  </_-ROP_-E1_PROMOTION_RULE>
  <_-ROP_-E1_PROMOTION_TEXT SEGMENT="1">
    <DESCRIPTION>Buy a coffee machine and show coupon TIME FOR COFFEE to get 5 Euro off and 100 points</DESCRIPTION>
    <NAME>Coffee machine promotion</NAME>
    <SPRAS_ISO>EN</SPRAS_ISO>
  </_-ROP_-E1_PROMOTION_TEXT>
</_-ROP_-E1_PROMOTION>
  </IDOC>
</_-ROP_-PROMOTION02>

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

With this, you uploaded the promotional rule “Buy a coffee machine and show coupon TIME FOR COFFEE to get 5 Euro off and 100 points” (promotion ID: 771) for the Heidelberg store (business unit ID: FC01) and the validity period May 1st, 2021 to May 7th, 2021.

In this tutorial, you only upload the promotional rule. You have already uploaded the regular sales price of 500 Euro for the product coffee machine (material number: COFFEE_MACHINE, unit of measure: PCE) 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.

Copy and paste the code line that indicates the coupon number:

Step 4
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 5

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

Scenario: A customer has one coffee machine (material number: COFFEE_MACHINE) in the shopping cart with a regular sales price of 500 Euro. The customer wants to purchase the coffee machine on May 5th, 2021 in the Heidelberg store (business unit ID: FC01). The customer also presents the coupon TIME FOR COFFEE to the sales person at the checkout counter.

Desired Result: The customer should get a 5 Euro discount on the coffee machine and 100 points.

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="2" InternalMinorVersion="1">
	<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>
            <FrequentShopperPointsEligibilityFlag>true</FrequentShopperPointsEligibilityFlag>
            <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>
		<Coupon>
			<PrimaryLabel>TIME FOR COFFEE</PrimaryLabel>
			<Quantity>1</Quantity>
		</Coupon>
      </LineItem>
    </ShoppingBasket>  
   </PriceCalculateBody>
</PriceCalculate>

Make sure you get the HTTP response 200.

How many loyalty points do you get as a result?

1
100
1000

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

Apply Incentives (Coupons and Loyalty Points) 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 coupon number:

How many loyalty points do you get as a result?

Developer Products

Trials & Downloads

Site Information

Find us on