⚠️ When working on this use the Clockify code: Citi Food Vouchers: #1A. #11922 Citi OFN Voucher - VINE Integration ⚠️

Description

- As a: a shopper
- On page: payment method step at checkout
- I want to be able to do:

A voucher issued through VINE should work the same as an OFN voucher for the shopper experience:

• they can add the code at payment step
• they can see the discount is applied during checkout process

For the hub: all reports handling vouchers are updated accordingly.

the system should first check the OFN vouchers database before the VINE one.

Acceptance Criteria & Tests

1. Check both guest shoppers and shoppers with an account and a VINE voucher
2. Check also guest shoppers and shopper with an account, but with an OFN voucher
3. Check what happens when the voucher has expired
4. For enterprise users, reports should be accurate

Estimations

For context this is the current voucher "life cycle" :
When a customer enter a voucher code :

• Check voucher exist in OFN
• Create order adjustment linked to voucher
• update adjustment with the correct amount and tax portion if necessary and update order totals and states
• after payment details are entered, update adjustment and order totals and states
• voucher adjustment will be closed when the order is finalised, ie: this is when the voucher is considered "redeemed"

VINE voucher "life cycle" :

• Check if voucher exist in VINE : https://vine-staging.openfoodnetwork.org.au/api-documentation#app-endpoints-POSTapi-v1-voucher-validation type: "voucher_code", value: "short_voucher_code"
• Create a VINE voucher in OFN, based on data retrieved from VINE API, obfuscate voucher code (ie, keep only last 3 digit visible), will need to store voucher_id and voucher_set_id.
• Create order adjustment linked to voucher
• Update adjustment with the correct amount and tax portion if necessary and update order totals and states
• After payment details are entered, update adjustment and order totals and states
• When order is finalised:
  • Redeem VINE voucher the amount stored in voucher adjustment ( don't forget tax ) : https://vine-staging.openfoodnetwork.org.au/api-documentation#app-endpoints-POSTapi-v1-voucher-redemptions , use voucher_id and voucher_set_id stored against the voucher
  • Close the voucher adjustment on success
  • Handle redeeming error, display feedback to the user, potentially redirect to payment step so they can try a different voucher ?

Assumption:

• functionality to sign request with a JWT token already exist

Tasks:

• Check if VINE voucher exists and create voucher in OFN, update voucher model to add voucher_id, voucher_set_id : 0.5 -1 days
• VINE voucher redeeming and handle potential errors : 1.5 days (high estimate, our checkout logic is complicated)

Total : 2 -2.5 days , add 20% to cover unforeseen issue
Estimation total: 2.4 - 3 days