Customer Sales Order Item GraphQL Resolver does not honor tax configuration

[pmzandbergen]

Preconditions and environment

• Magento 2.x (including the current 2.4-develop branch)
• Tax configured, all display settings on "Including Tax" (See Stores > Configuration > Sales > Tax)

Steps to reproduce

1. Create a Customer
2. Create an Order as Customer, including a Product with Tax included
3. Run the following GraphQL query as this Customer:

query {
    customer {
        orders {
            items {
                number
                items {
                    quantity_ordered
                    product_sale_price {
                        value
                    }
                }
                total {
                    subtotal {
                        value
                    }
                    total_tax {
                        value
                    }
                    base_grand_total {
                        value
                    }
                }
            }
        }
    }
}

Current result:

{
    "data": {
        "customer": {
            "orders": {
                "items": [
                    {
                        "number": "SOME-ORDER-NUMBER",
                        "items": [
                            {
                                "quantity_ordered": 1,
                                "product_sale_price": {
                                    "value": 49.58
                                }
                            }
                        ],
                        "total": {
                            "subtotal": {
                                "value": 49.58
                            },
                            "total_tax": {
                                "value": 10.41
                            },
                            "base_grand_total": {
                                "value": 59.99
                            }
                        }
                    }
                ]
            }
        }
    }
}

The field product_sale_price should include tax, since all display settings (especially tax/sales_display/price) include tax.

Expected result

The price (product_sale_price) should include tax with tax/sales_display/price set.

Actual result

The price (product_sale_price) is excluding tax with tax/sales_display/price set.

Additional information

The cause can be found in the DataProvider:
https://github.com/magento/magento2/blob/2.4-develop/app/code/Magento/SalesGraphQl/Model/OrderItem/DataProvider.php#L142

It does not honor the configuration, it simply uses $orderItem->getPrice(). Depending on the setting it should be either using $orderItem->getPriceInclTax() or $orderItem->getPrice().

If required separate fields should be used, e.g.:

• product_sale_price (the display price as configured; existing)
• product_sale_price_excl_tax (the price excluding tax; new)
• product_sale_price_incl_tax (the price including tax; new)

However these additional fields should not be necessary in the current (known) use cases.

Note: If I have time I'll submit a PR.

Release note

No response

Triage and priority

• 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]

Hi @pmzandbergen. Thank you for your report.
To speed up processing of this issue, 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.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 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.

[m2-assistant]

Hi @engcom-Bravo. 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: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas 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.

[m2-assistant]

Hi @engcom-Lima. 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: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas 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-Lima]

@magento give me 2.4-develop instance

[magento-deployment-service]

Hi @engcom-Lima. Thank you for your request. I'm working on Magento instance for you.

[magento-deployment-service]

Hi @engcom-Lima, here is your Magento Instance: https://e0d2798a296a9d90a8906901b07a1b3f.instances.magento-community.engineering
Admin access: https://e0d2798a296a9d90a8906901b07a1b3f.instances.magento-community.engineering/admin_4508
Login: 1bb603b6
Password: 8990c1766436

[engcom-Lima]

✔️ Issue confirmed

Issue got reproduced in 2.4-develop branch.

Description: Customer sales order item in GraphQl is not displaying tax properly.

Pre-requisite:
Fresh magento 2.4-develop should be installed.

Steps to reproduce:
As given in comment.

Expected result: The price (product_sale_price) should include tax with tax/sales_display/price set.

Actual result: The price (product_sale_price) is excluding tax with tax/sales_display/price set.
Screenshots:

[github-jira-sync-bot]

✅ Jira issue https://jira.corp.adobe.com/browse/AC-8104 is successfully created for this GitHub issue.

[m2-assistant]

✅ Confirmed by @engcom-Lima. Thank you for verifying the issue.
Issue Available: @engcom-Lima, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

[pmzandbergen]

@magento I am working on this

[pmzandbergen]

PR #36966 is ready for review

[glo23503]

Internal team is working on it.

[pmzandbergen]

Internal team is working on it.

@glo23503 should I still add a unit test for the PR or is it already created by the internal team?

[glo23503]

Our internal team is working on the test coverage.
Thank you.