Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

[Skip CI] Added 'Order adjustments' user doc (#13495)

jaburghes27d68df07cd8
diff --git a/docs/docs.json b/docs/docs.json
index d25b97a7ef..3fa845f936 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -1013,6 +1013,7 @@
"user/orders/processing-orders",
"user/orders/creating-orders",
"user/orders/editing-orders",
+ "user/orders/order-adjustments",
"user/orders/exporting-orders",
"user/orders/cancelling-orders",
"user/orders/refunding-orders",
diff --git a/docs/images/user/orders/order-adjustments/1-orders-tab.png b/docs/images/user/orders/order-adjustments/1-orders-tab.png
new file mode 100644
index 0000000000..68b7fa29eb
Binary files /dev/null and b/docs/images/user/orders/order-adjustments/1-orders-tab.png differ
diff --git a/docs/images/user/orders/order-adjustments/2-order-page.png b/docs/images/user/orders/order-adjustments/2-order-page.png
new file mode 100644
index 0000000000..c907fdb68f
Binary files /dev/null and b/docs/images/user/orders/order-adjustments/2-order-page.png differ
diff --git a/docs/images/user/orders/order-adjustments/3-new-adjustment.png b/docs/images/user/orders/order-adjustments/3-new-adjustment.png
new file mode 100644
index 0000000000..37d6fea136
Binary files /dev/null and b/docs/images/user/orders/order-adjustments/3-new-adjustment.png differ
diff --git a/docs/images/user/orders/order-adjustments/4-refund.png b/docs/images/user/orders/order-adjustments/4-refund.png
new file mode 100644
index 0000000000..03fb67085a
Binary files /dev/null and b/docs/images/user/orders/order-adjustments/4-refund.png differ
diff --git a/docs/images/user/orders/order-adjustments/5-refund-form.png b/docs/images/user/orders/order-adjustments/5-refund-form.png
new file mode 100644
index 0000000000..d1876c3343
Binary files /dev/null and b/docs/images/user/orders/order-adjustments/5-refund-form.png differ
diff --git a/docs/images/user/orders/order-adjustments/6-new-payment.png b/docs/images/user/orders/order-adjustments/6-new-payment.png
new file mode 100644
index 0000000000..1a2155594c
Binary files /dev/null and b/docs/images/user/orders/order-adjustments/6-new-payment.png differ
diff --git a/docs/images/user/orders/order-adjustments/7-payment-form.png b/docs/images/user/orders/order-adjustments/7-payment-form.png
new file mode 100644
index 0000000000..5fd25be53e
Binary files /dev/null and b/docs/images/user/orders/order-adjustments/7-payment-form.png differ
diff --git a/docs/images/user/orders/order-adjustments/8-close-adjustment.png b/docs/images/user/orders/order-adjustments/8-close-adjustment.png
new file mode 100644
index 0000000000..3c08b2496d
Binary files /dev/null and b/docs/images/user/orders/order-adjustments/8-close-adjustment.png differ
diff --git a/docs/user/orders/order-adjustments.mdx b/docs/user/orders/order-adjustments.mdx
new file mode 100644
index 0000000000..e0c7cd0e6c
--- /dev/null
+++ b/docs/user/orders/order-adjustments.mdx
@@ -0,0 +1,75 @@
+---
+title: "Order Adjustments"
+description: "Learn how to create and settle order adjustments in Spree Commerce."
+---
+
+# Order Adjustments
+
+Order adjustments let you manually add a charge or credit to an existing order - ideal for handling things like special fees, discounts, or post-purchase updates.
+
+## How to Create an Adjustment
+
+To create an order adjustment, navigate to the **Orders** tab in the admin dashboard.
+
+![The Order management tab in Spree Commerce](/docs/images/user/orders/order-adjustments/1-orders-tab.png)
+
+Find the order you'd like to adjust and click on it to open the order page.
+
+![A customer order page in Spree commerce](/docs/images/user/orders/order-adjustments/2-order-page.png)
+
+Scroll to the **Adjustments** section and click **New Adjustment** to open the adjustment creation form.
+
+![Adding an adjustment to an order in Spree Commerce](/docs/images/user/orders/order-adjustments/3-new-adjustment.png)
+
+Fill out the form:
+
+- **Label** - A name for the adjustment (e.g., "Custom Discount", "Packaging Fee")
+- **Amount** - Use a **positive value** for a charge or a **negative value** for a credit.
+
+Finally, click **Create** to add the new adjustment.
+
+## Handling the Payment or Refund
+
+Once the adjustment has been created, it will need to be settled manually. Depending on whether it’s a charge or credit, follow one of the steps below:
+
+### Credit (Negative Amount)
+
+To manually refund the adjustment amount, click the **three-dot menu** next to the payment and select **Refund**.
+
+![Refunding a payment in Spree Commerce](/docs/images/user/orders/order-adjustments/4-refund.png)
+
+This will open a refund form where you can enter the amount to be refunded.
+
+![The Spree Commerce refund form](/docs/images/user/orders/order-adjustments/5-refund-form.png)
+
+After entering the amount and selecting a refund reason, click **Create** to process the refund.
+
+<Note>Refund behavior depends on the payment method used - some refunds can be processed automatically, while others may require manual handling.</Note>
+
+### Charge (Positive Amount)
+
+There are two methods to charge a customer in the event of a positive adjustment.
+
+### Automatated Payment
+
+To charge a customer, click **New Payment** in the Payments section.
+
+![Adding a new payment to an order in Spree Commerce](/docs/images/user/orders/order-adjustments/6-new-payment.png)
+
+This will open the payment form where you can select the amount to charge the customer and the payment method to be charged.
+
+![The Spree Commerce payment form](/docs/images/user/orders/order-adjustments/7-payment-form.png)
+
+Click **Create** after entering the details. The customer’s payment method will then be automatically charged for the outstanding balance.
+
+### Send Payment Link
+
+Alternatively, you can send the customer a payment link by email. The customer will receive a link that redirects them to a checkout where they can choose to pay for the outstanding balance using any of the payment methods available on your store.
+
+## Close the Adjustment
+
+Once the adjustment has been handled, click the **three-dot menu** next to the adjustment, and select **Close** to mark the adjustment as finalized.
+
+![Closing an order adjustment in Spree Commerce](/docs/images/user/orders/order-adjustments/8-close-adjustment.png)
+
+<Note>Closing an adjustment helps track which ones have been settled, especially when managing refunds or manual charges.</Note>