Creditmemo Gift Cards (Partial Refund)

[zepgram]

Preconditions and environment

• Magento EE 2.4.5

Steps to reproduce

1. Add 1 gift card product to the cart
2. Add 1 simple product or any other types
3. Place an order
4. Navigate to order detail in admin panel
5. Invoice the order
6. Navigate to invoce detail
7. Click Creditmemo
8. Create a Creditmemo for the the simple product

Expected result

1. The gift card account should be kept

Actual result

1. The gift card account is deleted

Additional information

Take a look here, the reason is very simple magento/vendor/magento/module-gift-card-account/Model/Plugin/CreditmemoRepository.php

 /**
 * Remove gift card account for refund
 *
 * @param CreditmemoRepositoryInterface $subject
 * @param CreditmemoInterface $entity
 *
 * @return CreditmemoInterface
 *
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function afterSave(CreditmemoRepositoryInterface $subject, CreditmemoInterface $entity): CreditmemoInterface
{
    $order = ($entity->getOrder()) ?: $this->getOrderById((int)$entity->getOrderId());
    $orderItems = $this->getOrderItems($order);
    if ($orderItems) {
        foreach ($entity->getItems() as $creditMemoItem) {
            $orderItem = $orderItems[$creditMemoItem->getOrderItemId()];
            if ($orderItem->getProductOptionByCode('giftcard_created_codes')) {
                $this->removeGiftCardAccount(
                    $orderItem->getProductOptionByCode('giftcard_created_codes'),
                    abs((int)$creditMemoItem->getQty())
                );
            }
        }
    }

    return $entity;
}

The error is here:

 foreach ($entity->getItems() as $creditMemoItem) {

Should be:

 foreach ($entity->getAllItems() as $creditMemoItem) {

This way, we exclude the gift card item who has been previously deleted from the object (because she's not targeted by our creditmemo)

Release note

No response

Triage and priority

• [X] Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• [ ] Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• [ ] Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• [ ] Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• [ ] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant[bot]]

Hi @zepgram. Thank you for your report. To speed up processing of this issue, make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, review the Magento Contributor Assistant documentation.

Add a comment to assign the issue: @magento I am working on this

To learn more about issue processing workflow, refer to the Code Contributions.

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

  :warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

:clock10: You can find the schedule on the Magento Community Calendar page.

:telephone_receiver: The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

:pencil2: Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

[m2-assistant[bot]]

Hi @engcom-November. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

• [ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• [ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• [ ] 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• [ ] 4. Verify that the issue is reproducible on 2.4-develop branch

  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• [ ] 5. Add label Issue: Confirmed once verification is complete.

• [ ] 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-November]

Hi @zepgram , Thank you for reporting and collaboration. Verified the issue on Magento 2.4-develop instance with enterprise edition modules enabled but the issue is not reproducible with below steps performed. Steps performed: Placed an order from front end with gift card product and simple product. Created invoice from admin and credit memo for only simple product. No issue. Credit memo / refund created for only simple product as expected. No gift card account is deleted. Kindly recheck the issue on Magento 2.4-develop instance with enterprise edition and provide missing steps if any if the issue is still reproducible. Thank you.

[zepgram]

You must also invoice the gift card product before creating the creditmemo for the simple product

[engcom-November]

Hi @zepgram , invoice has been created for gift-card product as well but credit memo created only for simple product.

[zepgram]

I don't know how you do, anytime I'm reporing something you cannot reproduce. Just look at the code, it's wrong anyway.

[engcom-November]

Hi @zepgram , I verified the code in Magento 2.4-develop instance and the code is the same which mentioned by you but still unable to reproduce the issue. I rechecked again with Gift card type Virtual and Combination but could not able to reproduce the issue. Please find the below screenshots of the steps performed: Steps performed:

1. Admin - Stores - Configuration - Sales - Gift cards - Created gift card
2. Created Gift card product of Virtual type with open amount selected.
3. Login to Front end and added simple product and gift card product to cart
4. Proceed to checkout and paid with Gift card balance
5. Admin - Sales - Orders - Created invoice for both products
6. Credit memo created only for simple product. No issue: If refund to store credit is selected - amount credited to store credit balance Gift card account is not deleted. Balance deducted as expected. Kindly let us know if you are using any third party extensions / modules and recheck on clean 2.4-develop enterprise edition instance, provide missing steps if any if the issue is still reproducible. Thank you.

[zepgram]

Then you must probably disable the store credit to reproduce

[engcom-November]

Hi @zepgram , Thank you for the response. Verified the issue again on latest Magento 2.4-develop instance with enterprise edition modules enabled with below steps but the issue is still not reproducible. Steps performed:

1. Disabled Store credit option from Admin (Stores - Settings - Configuration - Customers - Customer Configuration - Enable Store credit - No) and save
2. Reindex and clear cache
3. Created Gift card account from - Marketing - Promotions - Gift Card Accounts
4. Created Gift card product and simple product
5. Front end - Added both the products to cart
6. Placed order using Gift card balance
7. Admin - Order details page - Created invoice for both the products
8. Credit Memo - Update Quantity 0 for gift card product and create credit memo only for simple product. No issue: Credit memo created successfully and balance updated as expected in Gift card account. Gift card account is not deleted. Can you please check if the issue occurred due to any 3rd party extensions / modules enabled? Kindly recheck the issue on Magento 2.4-develop instance as it is having latest code base and provide missing steps if any if the issue is still reproducible. Thank you.

[engcom-November]

Hi @zepgram , We are closing this issue as there has been no latest update on the same. Kindly reopen / create new issue if you are still facing any issues. Thank you.

[zepgram]

Quality patch available here: https://experienceleague.adobe.com/docs/commerce-knowledge-base/kb/support-tools/patches/v1-1-32/acsd-51230-gift-card-account-is-deleted.html?lang=en

https://github.com/magento/quality-patches/blob/master/patches/commerce/ACSD-51230_2.4.3-p1.patch

Looks like this is reproducible :1st_place_medal: