Questions:

...

Expand

title	1 - TASK: Create a new promo code flow for loyalty

Create a feature flag;
The first step to use the loyalty promo code at checkout will be to change the validation promo code flow.
- On the promo code component field, we will need to add a feature flag:
  - When this flag is enabled: The promo code flow will be LOYALTY OFFER
  - When this flag is disabled: The promo code flow will be CBA OFFER (current flow)
We will create a new hook to contain all the rules of this flow
- We can use the same hook used to offer page flow.
  - intl-whitelabel-app/workspaces/frontend/src/state/loyalty/hooks/use-redeem-promo-codes.ts

Code Block

language	typescript

const onSubmitLoyaltyPromoCode = useCallback(async () => {
    setPromoCodeValidationLoading(true);

    // const loyaltyId = 'ec5cec01-b41b-509b-9111-310ab5a18154';

    let event = createRbiApplyPromoCodeEvent(promoCodeInput, 'Successful');
    const personalizedOffer = await redeemMutation(user?.loyaltyId || '', promoCodeInput)
      .catch((e: PromoCodeError) => {
        const reason = buildErrorMessageFromPromoCodeError(e);
        setPromoCodeErrorMessageId(
          (reason as TPromoCodeErrorMessageIds) || PromoCodeErrorMessageIds.default
        );

        logger.error(`Error validating promo code ${e}`);
        event = createRbiApplyPromoCodeEvent(promoCodeInput, 'Failed', e.message);
      })
      .finally(() => {
        setPromoCodeValidationLoading(false);
      });

    trackEvent(event);

    if (personalizedOffer) {
      await handleRedemption(personalizedOffer);

      // clear promo code input & error message
      setPromoCodeErrorMessageId(null);
      setPromoCodeInput('');

      toast.success(formatMessage({ id: 'offerAddedToCart' }));
    }
  }, [
    formatMessage,
    handleRedemption,
    promoCodeInput,
    redeemMutation,
    trackEvent,
    user?.loyaltyId,
  ]);
  
  
   useEffect(() => {
    if (appliedOfferPromoCode?.loyaltyEngineId) {
      const standardOffersLimit =
        earningCalculationData?.EarningCalculation?.offerRedemptionLimits?.standardOffersLimit || 1;

      dispatch(actions.loyalty.setSelectedOffer(appliedOfferPromoCode));
      dispatch(actions.loyalty.setAppliedOffers([appliedOfferPromoCode]));

      if (isDiscountLoyaltyOffer(appliedOfferPromoCode)) {
        // If limit of offers reached remove the first one
        if (appliedOffers?.length >= standardOffersLimit) {
          removeFromCart({ cartId: appliedOffers[0].cartId });
        }

        //Discount offers should not show menu item details
        dispatch(
          actions.loyalty.applyOffer({
            id: appliedOfferPromoCode.loyaltyEngineId,
            type: OfferType.GLOBAL,
            isStackable: appliedOfferPromoCode.isStackable,
            isSurprise: isSurpriseOffer(appliedOfferPromoCode),
            cmsId: appliedOfferPromoCode._id,
            cartId: 'discount-offer',
          })
        );
      }

      dispatch(actions.loyalty.setCmsOffers([appliedOfferPromoCode]));
      return;
    }

    dispatch(actions.loyalty.setSelectedOffer(null));
    dispatch(actions.loyalty.setAppliedOffers([]));
    dispatch(actions.loyalty.setCmsOffers([]));

    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [appliedOfferPromoCode]);

Attention points:

We need to apply (dispatch) the personalised offer on some contexts:
1. actions.loyalty.setSelectedOffer(personalizedOffer)
2. actions.loyalty.setAppliedOffers
3. actions.loyalty.applyOffer
4. actions.loyalty.setCmsOffers

OBS.: It’s possible we need to apply the offer in another context too.

When we click on remove in offer info (after applying the offer), we need to remove the offer in all contexts.
When the customers reload the page, the offer must continue applied.
Verify the need for other validations

With this update, the frontend is prepared to apply the promo code to loyalty.

...

Currently, we already sent the sanityId offer to the backend (intl-partners-service);
Then, we need to send the discount information to Winrest;
- With the sanityId that we have, we will find the discount values by getOffers(sanityId: string)
  - path: intl-partners-service/src/modules/orders/cart-total.service.ts
We will add a new attribute orderDiscounts on the webhook IWebhookPriceOrder payload;

Note
We will send it to Winrest always in percentage (requested to Winrest, 'cause will be easier for them);

The orderDiscounts object would be in each cart object;
If the discount is amount type, we will transform it to percentage type;
- E.g: If the total cart is 10 euros and amount discount is 5 euros;
  - We will calculate the discount:
    Code Block
    discount = (100 * 5) / 100; discount = 50%;

Acceptance criteria

We can’t impact the other markets;
If there is an offer applied on the “input cart“, we need to send the discount to Winrest;
The discount sento to Winrest should be Percentage

Tasks:

...

title	1 - TASK: Create a method to calculate the percentage offer;

...

Create a feature flag;

Create a method to calculate the percentage offer.

...

Acceptance criteria

We can’t impact the other markets;
If there is an offer applied on the “input cart“, we need to send the discount to Winrest;
The discount sent to Winrest should be a percentage;

Tasks:

{ "callbackUrl": "https://euw3-dev-plk-partners-api.rbictg.com/api/v1/orders/84b5f1df-28df-4e6f-a871-a2783602436f/price/callback", "cart": { "menuSelections": [

- to Winrest via IWebhookPriceOrder adding the orderDiscounts;
  Image Added
Payload will be:

Expand

title	1 - TASK: Send to orderDiscount to Winrest

Create a feature flag;
Update mapOrderDiscounts method to return the offer discount also.
- path: intl-partners-service/src/modules/orders/orders.service.ts
  Image AddedImage Added
- To discover the discount values we will need to use the method getOffers
  - path: intl-partners-service/src/modules/orders/
  orders
  - cart-total.service.ts
  We
  - This method is private, so we will update it to public;
- After that, we will send the discount values per cart item to Winrest, but the calculation of the discount percentage will be based on the cart total, which will be easier to calculate and in the end will have the same result if we calculate the discount per item.
- The method will receive two params:
  - appliedOffers: IAppliedOffer[] | null | undefined
    - Offer applied on the cart;
      Image Removed
  - total: number | undefined
    - total cart value;
- The method return will be:
  - Promise<IOrderDiscounts[] | undefined>
    - Where the IOrderDiscounts.type will be always a percentage;
- To discover the discount values we will need to use the method getOffers
  - path: intl-partners-service/src/modules/orders/cart-total.service.ts
  - This method is private, so we will update it to public;
- E.g: If the total cart is 10 euros and amount discount is 5 euros;
  - We will calculate the discount:
    Code Block
    discount = Math.round((5 * 100) / 10) discount = 50%;
- payload

Code Block

language	json

Code Block

language	json

{
  "callbackUrl": "https://euw3-dev-plk-partners-api.rbictg.com/api/v1/orders/84b5f1df-28df-4e6f-a871-a2783602436f/price/callback",
  "cart": {
    "menuSelections": [
      {
        "externalReferenceId": "800853",
        "id": "f9f5b02e-bee8-4dd1-a5fa-222b79516a98",
        "menuSelections": [
          {
            "externalReferenceId": "800852",
      {         "externalReferenceIdid": "800853item_67167",
          "id  "menuSelections": "f9f5b02e-bee8-4dd1-a5fa-222b79516a98"[],
        "menuSelections": [         "price": {
 {             "externalReferenceIdamount": "800852"679,
              "idcurrency": "item_67167EUR",
            "menuSelections": []},
            "pricequantity": {1
          }
   "amount": 679,    ],
          "currencyprice": "EUR"{
            },
 "amount": 1100,
          "quantitycurrency": 1,"EUR"
        },
   "orderDiscounts": [    "quantity": 1
      }
  {  ]
      },
       "typechannel": "percentageWHITELABEL_IN_STORE",
                "value": 50
              }
            ]
          },
          {
            "externalReferenceId": "940151",
            "id": "item_50929",
            "menuSelections": [],
            "price": {
              "amount": 0,
              "currency": "EUR"
            },
            "quantity": 1,
            "orderDiscounts": [
              {
                "type": "percentage",
                "value": 50
              }
            ]
          },
          {
            "externalReferenceId": "940180",
            "id": "item_66018",
            "menuSelections": [],
            "price": {
              "amount": 1500,
              "currency": "EUR"
            },
            "quantity": 1,
            "orderDiscounts": [
              {
                "type": "percentage",
                "value": 50
              }
            ]
          },
          {
            "externalReferenceId": "940325",
            "id": "45adf5bb-2f3d-4c40-a735-cf59d5a661ef",
            "menuSelections": [],
            "price": {
              "amount": 0,
              "currency": "EUR"
            },
            "quantity": 1,
            "orderDiscounts": [
              {
                "type": "percentage",
                "value": 50
              }
            ]
          }
        ],
        "price": {
          "amount": 1100,
          "currency": "EUR"
        },
        "quantity": 1,
        "orderDiscounts": [
          {
            "type": "percentage",
            "value": 50
          }
        ]
      }
    ]
  },
  "channel": "WHITELABEL_IN_STORE",
  "fees": [],
  "id": "84b5f1df-28df-4e6f-a871-a2783602436f",
  "instructions": [],
  "serviceMode": "TAKEOUT",
  "storeId": "1111"
}

If the discount offer is a type percentage we will return the percentage value;
The method example is on branch poc: https://github.com/rbilabs/intl-partners-service/tree/poc/IBFEC-934-send-discount-offers-to-winrest
- path: intl-partners-service/src/modules/orders/orders.service.ts
- method name: mapOffersDiscounts

Expand

title	2 - TASK: Update the calculated total card;

Currently, the total cart is calculated the all item values including the offers configs, so we need to remove the discount offers config this calc;
- path: intl-partners-service/src/modules/orders/cart-total.service.ts
- method: calculate(cart: ICart)
We will refactor this method abstracting the logic into two parts because we will need just the part of the method code to this flow. But we can’t change the calculate(cart: ICart) because it is used in other flows. Then, we will create a new method.
As the POC method public calculateTotalCart(cart: ICart)
- path: intl-partners-service/src/modules/orders/cart-total.service.ts
- POC: https://github.com/rbilabs/intl-partners-service/tree/poc/IBFEC-934-send-discount-offers-to-winrest

Expand

title	3 - TASK: Add the discount on the order;

We will use all methods created above (mapOffersDiscounts and calculateTotalCart):
- path: intl-partners-service/src/modules/orders/orders.service.ts

On method public async price(input: IPriceOrderRequest):

We will import the attribute appliedOffers on object input.cart;
We will protect the code with feature flag here;

We will calculate the total cart without possible discounts (calculateTotalCart) and use the method mapOffersDiscounts to create the object with percentage discount:

Code Block

language	typescript

let discountsOffer;
if (FEATURE_FLAG && appliedOffers?.length) {
  const totalCart = this.cartTotalService.calculateTotalCart(input.cart);
  discountsOffer = await this.mapOffersDiscounts(appliedOffers, totalCart);
}

We will add the variable orderDiscounts on attribute orderDiscounts from newOrder object;
Image Removed

const verifyDiscountTypes = (cartEntry: ICartEntry): boolean => { return ( cartEntry.type !== CartEntryType.offerDiscount && cartEntry.type !== CartEntryType.offerCombo && cartEntry.type !== CartEntryType.offerItem ); };

Expand

title	4 - TASK: Send the new discount object to Winrest

We will need to send the new discount attribute to Winrest by webhook:

Image Removed

Then, we will add the new attribute on mapper mapRbiCart;

So we will add the variable discountsOffer to mapRbiCart: mapRbiCart(pricingCart, discountsOffer);

In this method, we will add a new condition to send the discount values:

Image Removed

Code Block

language	typescript

if (FEATURE_FLAG && orderDiscounts?.length && verifyDiscountTypes(cartEntry)) {
  result.orderDiscounts = orderDiscounts;
}

Where, the verifyDiscountTypes method verify item type of the cart that there will be a discount because the types (CartEntryType.offerDiscount, CartEntryType.offerCombo, CartEntryType.offerItem) are already the offer of an item;

Code Block

language	json

"fees": [],
  "id": "84b5f1df-28df-4e6f-a871-a2783602436f",
  "instructions": [],
  "serviceMode": "TAKEOUT",
  "storeId": "1111",
  "orderDiscounts": [
    {
      "type": "percentage", // or amount
      "value": 50
    }
  ]
}

Screenshots

N/A

POC

FRONTEND (WHITELABEL)
- Branch POC: https://github.com/rbilabs/intl-whitelabel-app/tree/poc/IBFEC-934-loyalty-promo-code-at-checkout
BACKEND (INTL-PARTNERS-SERVICE)
- Branch POC: https://github.com/rbilabs/intl-partners-service/tree/poc/IBFEC-934-send-discount-offers-to-winrest

...

Versions Compared

Old Version 50

New Version 51

Key

Questions:

Attention points:

Acceptance criteria

Tasks:

Acceptance criteria

Tasks:

Screenshots

POC

Page Comparison

Versions Compared

Old Version 50

New Version 51

Key

Attention points:

Acceptance criteria

Tasks:

Acceptance criteria

Tasks:

Screenshots

POC