[5.x]: Recalculation of completed orders removes out of stock/unavailable line items

[jmauzyk]

What happened?

Description

Noticed a behavior where running recalculation on a completed order can result in line items being removed if their purchasables' stock has reached 0 Available or been marked as not available for purchase.

Steps to reproduce

1. Complete an order containing a line item for purchasable X.
2. Either set purchasable X's Available inventory to 0 or toggle its Available for purchase field off.
3. On the order's edit page in the CP, click Edit, then click Recalculate order.

Expected behavior

Order recalculates adjustments but retains line items based on their availability when the order was placed.

Actual behavior

The entire order is recalculated, removing line items based on their purchasables' current stock and availability. Even if its purchasable has On Hand stock and a committed quantity for the line item, it will be removed if the
Available stock is 0.

Craft CMS version

Craft Pro 5.10.8.1

Craft Commerce version

5.6.6.1

PHP version

8.2.4

Operating system and version

Linux 4.15.0-65-generic

Database type and version

PostgreSQL 14.7

Image driver and version

Imagick 3.7.0 (ImageMagick 6.9.7-4)

Installed plugins and versions

No response

[linear-code]

COM-588

[nfourtythree]

Hi @jmauzyk

Thank you for your message.

The behaviour you are seeing is, currently, functioning as expected. With recalculation when you click to recalculate the order that sets the mode to Order::RECALCULATION_MODE_ALL.

Basically it is saying look at this order as if it were a cart. Therefore it will go and get all the current price information and adjustments and things like that.

This means you see the same behaviour as if you were interacting with a cart, and in your example, for a cart, you would expect an unavailable purchasable to be dropped.

That isn't to say there could potentially be improvements to be made with this functionality.

It would be great to get your thoughts on what you might like to see in terms of functionality. In the scenario you outlined for your project, what information are you trying to get updated and which bits are you attempting to leave unchanged?

Thanks!

[jmauzyk]

Hi @nfourtythree, thanks for your response.

What I'm trying to accomplish is recalculating adjustments on a completed order while leaving the line items unchanged.

Our specific use case is for situations in which we aren't able to fulfill a line item a customer has ordered. For example, occasionally we oversell an item because we have stock on hand in Commerce but are actually out due to a B2B order in our ERP system. When this happens, we want to mark the affected line item as cancelled while keeping it on the order. Keeping the item rather than removing it makes it easier to understand the order and its payment/refund amounts in the event that we need to audit it for some reason. When a line item is marked as cancelled, a custom adjuster would deduct the item's subtotal, and tax/shipping calculations would exclude any cancelled line items. On order payment, a queue job would be scheduled to refund the difference between the original payment amount and order total after line item cancellations.

However, to prevent further sales of an oversold item, we mark its variant as not available for purchase. As a result, when we mark a line item as cancelled and recalculate, it ends up being removed entirely. This has prevented us from implementing the solution I described.

More generally, treating a completed order as a cart during recalculation creates opportunity for undesirable side effects. Take a simpler example in which a customer has entered their postal code incorrectly and we need to recalculate so tax and shipping reflect the corrected address. In addition to removing line items in the way I described, the current recalculation strategy could also produce other side effects, such as replacing a line item's promotional price with its regular price if the promotion is no longer active. In this scenario, the desired effect is to only update tax and shipping, but recalculation has the potential to alter the order well beyond that.

The functionality I'd like to see is for completed orders to use Order::RECALCULATION_MODE_ADJUSTMENTS_ONLY rather than Order::RECALCULATION_MODE_ALL. If an item is genuinely no longer available, it seems safer to remove it manually rather than have it happen implicitly as a side effect of recalculation. That said, there may be use cases for full recalculation on completed orders that I'm not aware of, and I'm not sure how adjustments-only mode would work if there were also newly-added line items on the completed order. Curious whether this is something the team would consider, or if there's a recommended pattern for handling this today.