GraphQL Cart tax improvements for cart

[paales]

As a visitor I want to see prices in my cart with the proper tax formatting so that I can accurately view my prices.

AC

• Discount should include price_incl_tax and price_excl_tax and amount should probably be deprecated?
• SelectedShippingMethod should include price_incl_tax and price_excl_tax and amount should probably be deprecated?

• CartItemPrices should include price_incl_tax
• SelectedShippingMethod should provide including and excluding tax prices
• StoreConfig should communicate how to render the cart

Suggested Schema

SelectedShippingMethod should include price_incl_tax and price_excl_tax and amount should probably be deprecated?

magento2/app/code/Magento/QuoteGraphQl/etc/schema.graphqls

Lines 356 to 359 in 8de016a

	type Discount @doc(description:"Defines an individual discount. A discount can be applied to the cart as a whole or to an item.") {
	amount: Money! @doc(description:"The amount of the discount.")
	label: String! @doc(description:"A description of the discount.")
	}

Should be:

type Discount @doc(description:"Defines an individual discount. A discount can be applied to the cart as a whole or to an item.") {
    amount: Money! @doc(description:"The amount of the discount.") @deprecated(reason: "use price_incl_tax and price_excl_tax")
    price_incl_tax: Money! @doc(description:"The amount of the discount including tax.")
    price_excl_tax: Money! @doc(description:"The amount of the discount excluding tax.")
    label: String! @doc(description:"A description of the discount.")
}

magento2/app/code/Magento/QuoteGraphQl/etc/schema.graphqls

Line 366 in 8de016a

total_item_discount: Money @doc(description: "The total of all discounts applied to the item.")

Should be:

type CartItemPrices @doc(description: "Contains details about the price of the item, including taxes and discounts.") {
    #other stuff
    total_item_discount: Money @doc(description: "The total of all discounts applied to the item.") @deprecated(reason: "use total_item_discount_incl_tax or total_item_discount_excl_tax")
    total_item_discount_incl_tax: Money @doc(description: "The total of all discounts applied to the item.")
    total_item_discount_excl_tax: Money @doc(description: "The total of all discounts applied to the item.")
}

CartItemPrices should include price_incl_tax

magento2/app/code/Magento/QuoteGraphQl/etc/schema.graphqls

Line 362 in 8de016a

price: Money! @doc(description: "The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.")

type CartItemPrices @doc(description: "Contains details about the price of the item, including taxes and discounts.") {
    price: Money! @doc(description: "The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.") @deprecated(reason: "use price_excl_tax or price_incl_tax instead")
    price_excluding_tax: Money! @doc(description: "The price of the item before any discounts were applied.")
    price_including_tax: Money! @doc(description: "The price of the item before any discounts were applied.")
    # other stuff
}

SelectedShippingMethod should provide including and excluding tax prices

magento2/app/code/Magento/QuoteGraphQl/etc/schema.graphqls

Lines 263 to 270 in 8de016a

	type SelectedShippingMethod @doc(description: "Contains details about the selected shipping method and carrier.") {
	carrier_code: String! @doc(description: "A string that identifies a commercial carrier or an offline shipping method.")
	method_code: String! @doc(description: "A shipping method code associated with a carrier.")
	carrier_title: String! @doc(description: "The label for the carrier code.")
	method_title: String! @doc(description: "The label for the method code.")
	amount: Money! @doc(description: "The cost of shipping using this shipping method.")
	base_amount: Money @deprecated(reason: "The field should not be used on the storefront.")
	}

Should be:

type SelectedShippingMethod @doc(description: "Contains details about the selected shipping method and carrier.") {
    carrier_code: String! @doc(description: "A string that identifies a commercial carrier or an offline shipping method.")
    method_code: String! @doc(description: "A shipping method code associated with a carrier.")
    carrier_title: String! @doc(description: "The label for the carrier code.")
    method_title: String! @doc(description: "The label for the method code.")
    amount: Money! @doc(description: "The cost of shipping using this shipping method.") @deprecated(reason "use price_incl_tax or price_excl_tax")
    price_incl_tax: Money!
    price_excl_tax: Money!
    base_amount: Money @deprecated(reason: "The field should not be used on the storefront.")
}

StoreConfig should communicate how to render the cart

enum CartTaxDisplayOptions {
    INCL
    EXCL
    BOTH
}

type StoreConfig {
    cart_display_prices: CartTaxDisplayOptions!
    cart_display_shipping_prices: CartTaxDisplayOptions!
    cart_display_subtotal: CartTaxDisplayOptions!
    cart_display_grandtotal: CartTaxDisplayOptions! #This will 
    cart_display_tax_summary: Boolean!
    cart_display_tax_when_zero: Boolean!
}

This will incorporate these settings:

(there are many more missing store config values, i can write them down, improve on them, etc. but one step at a time 😄 )

Related

• Add price including tax to CartItemPrices in GraphQL API #29057
• Product Prices And Cart Prices With Tax Setting From Configurations Are Not Showing In Graphqls #31313
• [GraphQl] Selected shipping method does not contain value including tax. #31206

[m2-assistant]

Hi @paales. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

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

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

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

For more details, please, review the Magento Contributor Assistant documentation.

Please, add a comment to assign the issue: @magento I am working on this

---

• 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, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

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

[m2-assistant]

Hi @engcom-Hotel. 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).

  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.

[m2-assistant]

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: 👇

• 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 @paales ,
As per official Magento dev docs, this is an expected behavior
"price_excl_tax" and ""price_incl_tax"" are available for available_shipping_methods but not for Discount.
"SelectedShippingMethod" has amount only but not price_incl_tax and price_excl_tax
Hence implementing these features can be considered as a feature request but not as a bug. Hence labeling this as feature request.