Getting started

In this tutorial you place a test order as a customer, change it inside its edit window, and then look at the result in the administration. It takes about ten minutes.

Before you start

You need:

• the plugin installed and activated (Extensions > My extensions)
• scheduled tasks and a message queue worker running on your shop. The plugin releases orders from a background task, and the plugin's mails are sent through Flow Builder
• a customer account in your storefront that you can log in with
• a product with variants, for example a T-shirt in several sizes, with stock
• an offline payment method such as invoice or prepayment, so the test order is not charged

Step 1: Check the settings

1. In the administration, open Extensions > My extensions.
2. Find Order Editing — Self-Service for Customers, open its menu (…) and choose Configure.
3. Leave the default values as they are. Let customers edit their orders is on, and Window length (minutes) is 30.
4. Look at the top of the Edit window card. If a warning appears there, read it now:
   • A warning about an invoice issued as soon as an order is placed means every window would close before you can test it. Follow Fix a Flow that closes every window first.
   • A warning that every order will trigger certain Flows lists Flows that start when an order enters or leaves Open. Read Connect your ERP and the "On hold" status before you go live.
5. Click Save.

Step 2: Place a test order

1. Open your storefront and log in with the test customer.
2. Put the product with variants in the cart, for example size M, quantity 1.
3. Check out with the offline payment method.

The order confirmation page now shows a yellow banner, You can still change this order. It shows a countdown, the time the window closes, and the line Nothing ships while you can still change it.

The customer also gets a mail, You can still change order …, with a Change order link and the number of minutes they have.

Step 3: Change the order

1. In the banner, click Change order. The Change your order screen opens, with the countdown at the top.
2. Next to the product, click Change options. A dialog opens with the product's options. Options that are not available are greyed out, and the dialog shows the price difference and whether the chosen variant is in stock.
3. Choose another size, for example L, and click Apply selection. The dialog closes, and the screen now says Pending changes: 1 — nothing is applied until you confirm.
4. Use the + button next to the quantity to raise it to 2. The pending changes count goes up to 2.

Nothing has changed on the order yet. If you want to start over, click Discard changes: the order stays as it was, and the window stays open.

Step 4: Review and confirm

1. Click Review changes. The What changes screen lists:
   • under Your changes, the size change and the quantity change, each with its old and new value and the amount
   • under What follows from them, anything that moved on its own, for example a discount that depends on the order total
   • the new subtotal, the shipping, the VAT and the difference to the old total
   • a note on payment. For an unpaid order it says you only adjust what is owed.
2. Click Confirm changes.

You are back on Change your order, with the message Your order has been changed. The window is still open, so the customer could change something else until the countdown runs out.

If the window has closed in the meantime, the customer sees a Changes are closed page that says why, and nothing is applied.

Step 5: Check the order in the administration

1. In the administration, open Orders and open the test order.
2. Next to the order number in the header, a label reads Editable until with the closing time. The order status is On hold.
3. Open the Changes tab.
   • The Order editing card shows Window: Open with its closing time, Invoice: None issued and Confirmed changes: 1. One confirmation counts once, even when it changed two things.
   • The log below lists, newest first, one row for the size change and one for the quantity change, with the amount each moved the order by, the new Order total and Shopper as the source. Below them is the Window opened row, where the order went from Open to On hold.

Step 6: Watch the window close

Wait until the countdown has run out. Within a few minutes after that, the background task releases the order:

• the order status goes back to Open, and the order continues through your normal processing
• the header label reads Editing closed · Time ran out
• the Changes tab has a new Window closed row with the reason Time ran out
• in the storefront, the banner is gone and the order list no longer offers Change order

You have now followed one order through its whole edit window.

Next steps

• Choose what customers may change
• Connect your ERP and the "On hold" status
• Configuration reference