[Order form] Use order item data for products in order creation/editing

[staskus]

Closes: #11455
Investigation: pdfdoF-4rm-p2

Description

This PR addresses an issue where iOS uses Product price, instead of the Order Item price in the Order Creation / Editing view.

It results in a couple of issues when Yes, I will enter prices inclusive of tax setting is enabled.

1. iOS Order Creation/Editing view is inconsistent with Android, and Web.
2. iOS Order Creation/Editing view is inconsistent with the iOS Order Details view.
3. Product prices displayed in the Products Section include taxes while product prices displayed in Order Summary exclude taxes, which results in different Product totals shown.
   3.1 When discounts are applied, discounted totals in the Product Section are calculated with included taxes, again resulting in different product prices displayed in Order Summary.
   3.2. Individually-priced bundle products are shown with full price, rather than an individual price within the bundle, which sums up to a different total that is shown in the Order Summary.

Solution

The simplest solution I found is to pass a single pre-tax pre-discount order item price to CollapsibleProductRowCardViewModel rather than Product.price. This mimics what Android implemented (https://github.com/woocommerce/woocommerce-android/blob/1e2829c413233e7a1a8602137ea8b2858b377386/WooCommerce/src/main/kotlin/com/woocommerce/android/model/Order.kt#L126) with introducing basePrice to Order Item. This is also could be considered a continuation of another fix #11012 which started using this single order item subtotal price to address order total calculation issues.

basePrice behaves as we would expect because it:

• Shows a consistent price independent of Yes, I will enter prices inclusive of tax
• Does not change when the quantity increases
• Does not contain a discount
• Works for simple products, variable products, individually priced product bundle products
• Correctly sums up to what we see in the Order Summary at the bottom of the Order view
• Reaches parity with Android, and web

Other existing Order Item properties do not satisfy these requirements:

• OrderItem subtotal - excludes discounts and depends on item quantity
• OrderItem total - includes discounts and depends on item quantity
• OrderItem price - includes discounts
• Product price - always static and doesn't take into account whether taxes are included or excluded from the product

Other not-addressed issues:

• [Order form] Show order item data (not product data) where possible in order form #11431 also started to implement loading states for Product and Order prices when the Order is syncing. There's also a related issue where the order total is momentarily wrong while Order is syncing (for example when quantity is changed) I'm leaving it for another task & PR: [Order form] Add shimmering effect to Order and Product values when Order is syncing #13340
• I found the issue on Android and iOS where two order items for $15 total to $30.01 while on the web it totals correctly to $30.00. There may be some issues in how taxes are calculated. I will check if such an issue is reported, if not, I'll report it. (Edit: Looks like this issue is known [Order Creation - Manual Taxes] Wrong subtotal when price includes taxes #11012 (comment) peaMlT-ec-p2)
• I found the issue on Android and iOS where Coupon Discount is applied differently compared to the web, resulting in completely different Order Totals. I will check if such an issue is reported, if not, I'll report it. (Edit: peaMlT-KO-p2)
• Order form > edit discount: when quantity is greater than 1, the price after discount doesn't show the total #11393 addressed in Display a total product price with quantity in Discount view to match what is displayed in Order view #13313

Simple Product

The product price is correctly displayed before tax which matches the "Products" line in the Order Summary

Before	After

Simple Product + Discount

The product price is correctly displayed before which matches the "Products" line in the Order Summary

Before	After

Variable Product + Discount

Before	After

Product Bundle + Child item custom price

• Before: Bundle products appear for $100, child items for $55 and $16 which totals to $171, however "Products" line shows $152.55
• After: Bundle product appears for $90.91, child items for $50 and $11.64, which correctly totals to $152.55 as in "Products" line

Before	After

Testing information

Checklist borrowed from pdfdoF-4rm-p2:

1. With the Prices entered with tax setting – Yes, I will enter prices inclusive of tax
   1.1 When adding an item to an order –
   - The item's total should be equal to the item's price, excluding taxes.
   - Taxes total should be calculated based on the item's price excluding taxes.
   1.2 When incrementing a quantity of the item –
   - The items' total should be updated accordingly, excluding taxes.
   - Taxes total should be calculated based on the sum of items' prices excluding taxes.
   1.3 When adding a discount to the item –
   - The item's total should be reduced according to the discount amount.
   - Taxes total for that item should be calculated based on the item's total excluding taxes reduced by the discount amount.

2. With the Prices entered with tax setting – No, I will enter prices exclusive of tax
   2.1 When adding an item to an order –
   - The item's total should be equal to the item's price, excluding taxes.
   - Taxes total should be calculated based on the item's price excluding taxes.
   2.2 When incrementing a quantity of the item –
   - The items' total should be updated accordingly, excluding taxes.
   - Taxes total should be calculated based on the sum of items' prices excluding taxes.
   2.3 When adding a discount to the item –
   - The item's total should be reduced according to the discount amount.
   - Taxes total for that item should be calculated based on the item's total excluding taxes reduced by the discount amount.

Testing steps (Borrowed from #11431)

• Enable Yes, I will enter prices inclusive of tax tax setting
• Go to the Orders tab
• Tap on + to create an order
• Add at least one product to the order -> Confirm the product appears in the order form with the expected product details, and with price excluding tax
• Expand any product card and confirm you can update the product as expected (change quantity, add discount, remove product)
• Tap "Create" to create the order -> Confirm the created order contains the products and quantities you added, and make a note of the prices shown in order details
• Tap "Edit" to edit the order -> Confirm the order loads with the expected products and quantities, and with prices matching what was shown in order details

---

• I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

[wpmobilebot]

📲 You can test the changes from this Pull Request in WooCommerce iOS by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce iOS
	Build Number	pr13305-d7f137c
	Version	19.5
	Bundle ID	com.automattic.alpha.woocommerce
	Commit	d7f137c
	App Center Build	WooCommerce - Prototype Builds #10027

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

[staskus]

@rachelmcr I would appreciate it if you could take a look at this 🙇 .

I opted to make as simple changes as possible to address the main issue - showing misleading prices in the product section when Yes, I will enter prices inclusive of tax setting is enabled.

In your previous PR #11431 you made further improvements around loading states and chose to pass additional properties to the collapsable card rather than using the existing price parameter. I will address loading states and other issues separately. However, as I tested it works fine passing single order item price to price parameter to make it all work. Let me know how you see it. Thanks again!

[iamgabrielma]

Thanks for taking care of this!

I found two things that behave oddly, but I think both precedes your changes and seem related to displaying the price without taking into account the store settings regarding inclusive/exclusive of taxes:

1. When testing custom amounts note how using Yes, I will enter prices inclusive of tax still allows us to add additional tax on top of a custom amount, since can be edited by toggling the button.

Custom amount	Toggle taxes

2. Having products inclusive/exclusive of taxes seems to be ignored if we "Set new tax rate". In this example prices should already have taxes baked in, but upon setting a new tax it adds it to the current price 🤔

I don't have full context of the custom amounts/set tax features, but as mentioned these exist before your PR, so we should log/address them separately

[iamgabrielma]

While not part of this PR, the same as above: How about netPrice or basePrice for the property? I'd say baseSubtotal feels off since both base and subtotal should mean the same price-wise ( a base price without any modifiers).

[staskus]

Thanks for the review, @iamgabrielma!

When testing custom amounts note how using Yes, I will enter prices inclusive of tax still allows us to add additional tax on top of a custom amount, since can be edited by toggling the button.

I think it's fine behavior, no? Regardless of this setting, we still allow users to select whether a tax will be applied to the Custom Amount or not. Even if Yes, I will enter prices inclusive of tax is enabled but we choose not to charge taxes, then the taxes are not charged for this Custom Amount.

Your expected behavior would be that if Yes, I will enter prices inclusive of tax enabled, then tax should be applied by default to Custom Amount?

Having products inclusive/exclusive of taxes seems to be ignored if we "Set new tax rate". In this example prices should already have taxes baked in, but upon setting a new tax it adds it to the current price 🤔

I see what you mean and that's a very good point. I agree that if the product already includes taxes, then the total shouldn't change, just the pricePreDiscount. I cannot get it to work in the same way on wp-admin as well. It may be a problematic area in the app.

I created an issue: #13342 and may file a CUW p1721127325826489-slack-C025A8VV728

Edit: This issue is also reported on the web (woocommerce/woocommerce#30702). Even if it's a bug, it's not an app issue.

[rachelmcr]

I haven't looked closely at the code to see what's causing it, but these changes aren't working well for me in testing. Here's an example:

• On my test store, my product prices include tax and tax is based on my store address.
• My store address is in a location with a 6% sales tax.
• I have a product that is $15.

When I add that product to an order on the web or in trunk, the order total is $15 ($14.15 for the product + $0.85 in tax). However, when I add that product to an order in this branch, it still shows the product with the price including tax, and it adds more tax on top of it for an order total of $15.90 ($15 for the product + $0.90 in tax).

Web	App (trunk)	App (this branch)

I'm out of time to review this further today, but I'll take another look tomorrow to see if I can sort out why it isn't working for me.

[rachelmcr]

Nevermind, you can ignore my last comment. I'm not sure what was happening with my testing on this branch earlier, but it's now all working as expected. Looks good!

The only issue I've seen is with the "Price after discount" amount when editing a product discount where the product quantity is > 1, but it looks like that is resolved with #13313.

In your previous PR #11431 you made further improvements around loading states and chose to pass additional properties to the collapsable card rather than using the existing price parameter. I will address loading states and other issues separately. However, as I tested it works fine passing single order item price to price parameter to make it all work. Let me know how you see it.

Your solution looks good to me! I can't remember why I approached it the way I did before, and this approach looks clean and easy to follow.

[staskus]

Thanks for the review @rachelmcr! Appreciate that 🙇

I'm not sure what was happening with my testing on this branch earlier, but it's now all working as expected. Looks good!

Good to hear! Not sure what happened there as well 🤔

The only issue I've seen is with the "Price after discount" amount when editing a product discount where the product quantity is > 1, but it looks like that is resolved with #13313.

Yes, it was resolved there. I haven't merged this branch with trunk after merging the other PR.