Order Amendment feature overview
Edit on GitHubThe Order Amendment feature enables customers to make changes to previously placed orders before they enter processing. Customers can adjust items, quantities, delivery details, and payment options.
Only registered customers can make changes to placed orders because guest users don’t have access to order history.
A customer can change an order once it reaches a state that allows amendments. By default, customers can initiate an amendment when an order is in the grace period started
state.
You can customize which states allow amendments in the state machine. For instructions, on customizing state machines, see Configure OMS.
Order amendment flow
A customer can change their order as follows:
- Customer clicks the Edit Order button
- This adds the order’s items to cart and opens the cart page
- Customers can add, remove, or modify items in the cart
- Checkout proceeds via the standard flow.
- Upon confirmation, the original order is updated with the amendments.
Cart strategies
Order amendment uses the cart functionality as an interface. When a customer initiates an amendment, the order is carried over to cart for making changes. There’re two default strategies to handle this process:
- Replace: All current cart items are replaced with the items from the order the customer wants to amend
- New: A new cart is created with the items from the amended order
On the project level, you can add other strategies to process order amendment.
The following details are carried over from the order to cart:
- B2B/B2B Marketplace: Order reference
- Cart notes
- Item notes
- Comments
- Custom order reference
You can customize what details are carried over on the project level.
Products
When a customer initiates an order amendment, the following happens to products:
- Abstract and concrete products are added to cart
- Out-of-stock, disabled, and removed products are excluded from the cart
- Configurable products are reset, and the customer needs to configure them again
Pricing
Prices at the time of initiating an amendment may differ from the prices used to place the order. To handle such cases, you can use one of the following default strategies:
- Current catalog prices: catalog prices at the time of initiating order amendment are applied to all items.
- Original order prices: catalog prices at the time of placing the original order are applied to all items.
- Best price: If a product’s price dropped since the order had been placed, the new lower price is used; otherwise, the original prices is used.
During the order amendment process, the prices for cart items are displayed according to the strategy only on Cart and Product Details pages. On all other pages, such as Product Catalog or Search Results pages, the current prices ar displayed.
Orders created through request for quote can’t be amended.
Gift cards and vouchers
When a customer initiates order amendment, gift cards and vouchers are unapplied from the order. The balance of all unapplied gift cards and vouchers is restored once order amendment is complete. They can be used for new orders but not for the order they were unapplied from.
For better user experience, we recommend implementing a way to inform customers about gift cards and vouchers being unapplied.
Grace period
A grace period lets you restrict order amendments to a certain time period after an order reaches an amendable state. For example, you can allow customers to change orders for two hours. This can be useful for shops that process orders quickly but want to give their customers enough time to change orders if needed, preventing order cancellations during processing.
For instructions on configuring the grace period, see Install the Order Amendment feature.
Related Developer documents
Thank you!
For submitting the form