GraphQL - Return shipping total including tax in shipping method resolver #35338

liamjtoohey · 2022-04-20T11:48:27Z

Description (*)

Return shipping total including tax for selected shipping method resolver. Vanilla Magento will always display the shipping price including tax within cart price summary, regardless of tax/calculation/shipping_includes_tax value. This logic is not mirrored in the graphql resolvers, however, as the base shipping amount is returned.

Vanilla Magento checkout with tax/calculation/shipping_includes_tax set to 1:

GraphQL cart query for shipping totals with tax/calculation/shipping_includes_tax set to 1:

query getCartDetails($cartId: String!) {
    cart(cart_id: $cartId) {
        shipping_addresses {
            selected_shipping_method {
                amount {
                    value
                    currency
                }
                carrier_code
                carrier_title
                method_code
                method_title
            }
        }
    }
}

{
  "data": {
    "cart": {
      "shipping_addresses": [
        {
          "selected_shipping_method": {
            "amount": {
              "value": 8.33,
              "currency": "GBP"
            },
            "carrier_code": "testshipping",
            "carrier_title": "Shipping",
            "method_code": "testshipping",
            "method_title": "Shipping"
          }
        }
      ]
    }
  }
}

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Setup latest version of M2.4
Set tax/calculation/shipping_includes_tax to 1 (or manually define shipping price to "Include Tax" via admin panel)
Configure standard tax class/rates of 20% for taxable goods
Create test product, assign to taxable goods tax class
Set "Flat Rate" shipping method "Enabled" field to "Yes" via admin panel
Set "Flat Rate" shipping method "Type" field to "Per Order" via admin panel
Set "Flat Rate" shipping method "Price" field to "10" via admin panel
Add test product to cart
Navigate to checkout, fill in shipping address data, select flat rate shipping method
Confirm order summary in checkout and cart lists shipping price as 10
Run example graphql query noted in ticket description on the same cart
Confirm that value returned is not the same as the value returned in checkout/cart summary

Questions or comments

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

Resolved issues:

resolves [Issue] Return shipping total including tax #36876: Return shipping total including tax

m2-assistant · 2022-04-20T11:48:30Z

Hi @liamjtoohey. Thank you for your contribution
Here are some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here

ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests 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 Pull Requests 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.

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

liamjtoohey · 2022-04-20T11:49:43Z

@magento run all tests

magento-automated-testing · 2022-04-20T11:49:49Z