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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Documentation edits made through Mintlify web editor
mintlify[bot]07d2fba1d612
diff --git a/docs/docs.json b/docs/docs.jsonindex a3b617be1b..0f0e5c38a5 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -927,6 +927,13 @@"user/orders/searching-orders"]},+ {+ "group": "Returns",+ "pages": [+ "user/settings/returns-configuration",+ "user/returns/returns-processing"+ ]+ },{"group": "Customers","pages": [diff --git a/docs/images/user/returns/returns-processing/1.order_page.png b/docs/images/user/returns/returns-processing/1.order_page.pngnew file mode 100644index 0000000000..2d047b762cBinary files /dev/null and b/docs/images/user/returns/returns-processing/1.order_page.png differdiff --git a/docs/images/user/returns/returns-processing/10.new_reimbursement.png b/docs/images/user/returns/returns-processing/10.new_reimbursement.pngnew file mode 100644index 0000000000..50be1f5bfbBinary files /dev/null and b/docs/images/user/returns/returns-processing/10.new_reimbursement.png differdiff --git a/docs/images/user/returns/returns-processing/11.reimbursement_form.png b/docs/images/user/returns/returns-processing/11.reimbursement_form.pngnew file mode 100644index 0000000000..b1500ec7b4Binary files /dev/null and b/docs/images/user/returns/returns-processing/11.reimbursement_form.png differdiff --git a/docs/images/user/returns/returns-processing/12.customer_reimbursed.png b/docs/images/user/returns/returns-processing/12.customer_reimbursed.pngnew file mode 100644index 0000000000..9e0466e836Binary files /dev/null and b/docs/images/user/returns/returns-processing/12.customer_reimbursed.png differdiff --git a/docs/images/user/returns/returns-processing/13.updated_cr_form.png b/docs/images/user/returns/returns-processing/13.updated_cr_form.pngnew file mode 100644index 0000000000..5956ee093cBinary files /dev/null and b/docs/images/user/returns/returns-processing/13.updated_cr_form.png differdiff --git a/docs/images/user/returns/returns-processing/2.new_return_auth.png b/docs/images/user/returns/returns-processing/2.new_return_auth.pngnew file mode 100644index 0000000000..d2a3f79e00Binary files /dev/null and b/docs/images/user/returns/returns-processing/2.new_return_auth.png differdiff --git a/docs/images/user/returns/returns-processing/3.ra_form.png b/docs/images/user/returns/returns-processing/3.ra_form.pngnew file mode 100644index 0000000000..da1e92f5e8Binary files /dev/null and b/docs/images/user/returns/returns-processing/3.ra_form.png differdiff --git a/docs/images/user/returns/returns-processing/4.ra_section.png b/docs/images/user/returns/returns-processing/4.ra_section.pngnew file mode 100644index 0000000000..3604a9d1f2Binary files /dev/null and b/docs/images/user/returns/returns-processing/4.ra_section.png differdiff --git a/docs/images/user/returns/returns-processing/5.ra_tab.png b/docs/images/user/returns/returns-processing/5.ra_tab.pngnew file mode 100644index 0000000000..6284efa02dBinary files /dev/null and b/docs/images/user/returns/returns-processing/5.ra_tab.png differdiff --git a/docs/images/user/returns/returns-processing/6.new_customer_return.png b/docs/images/user/returns/returns-processing/6.new_customer_return.pngnew file mode 100644index 0000000000..02ef06c49eBinary files /dev/null and b/docs/images/user/returns/returns-processing/6.new_customer_return.png differdiff --git a/docs/images/user/returns/returns-processing/7.cr_form.png b/docs/images/user/returns/returns-processing/7.cr_form.pngnew file mode 100644index 0000000000..2a666218adBinary files /dev/null and b/docs/images/user/returns/returns-processing/7.cr_form.png differdiff --git a/docs/images/user/returns/returns-processing/8.cr_section.png b/docs/images/user/returns/returns-processing/8.cr_section.pngnew file mode 100644index 0000000000..0c2ebbddeaBinary files /dev/null and b/docs/images/user/returns/returns-processing/8.cr_section.png differdiff --git a/docs/images/user/returns/returns-processing/9.returns_tab.png b/docs/images/user/returns/returns-processing/9.returns_tab.pngnew file mode 100644index 0000000000..bffc013404Binary files /dev/null and b/docs/images/user/returns/returns-processing/9.returns_tab.png differdiff --git a/docs/user/products/creating-products.mdx b/docs/user/products/creating-products.mdxindex 99dee32226..75b134bdf6 100644--- a/docs/user/products/creating-products.mdx+++ b/docs/user/products/creating-products.mdx@@ -61,9 +61,9 @@ To edit an image’s alt text, replace it, or delete it entirely, click on the iThis section controls when and how your product appears on the storefront:- **Status:**- - **_Active:_**_ visible and purchasable_- - **_Draft:_**_ hidden from customers_- - **_Archived:_**_ stored in the admin, no longer available_+ - **Active:** visible and purchasable+ - **Draft:** hidden from customers+ - **Archived:** stored in the admin, no longer available- **Make Active At:** Schedule a future go-live date- **Available On:** Set a public release date (commonly used for preorders)- **Discontinue On:** Choose a date to automatically unpublish the productdiff --git a/docs/user/returns/returns-processing.mdx b/docs/user/returns/returns-processing.mdxnew file mode 100644index 0000000000..9b3b00d993--- /dev/null+++ b/docs/user/returns/returns-processing.mdx@@ -0,0 +1,136 @@+---+title: "Returns Processing"+description: "Learn how to process returns in Spree Commerce."+---++Spree supports native returns processing, giving you full control over how refunds, exchanges, and restocking are handled directly from the admin dashboard. The workflow is designed to be flexible, with clear steps for managing each stage of the return process.++This guide walks you through the full lifecycle of a return: from authorization, to customer return, to final reimbursement.++## 1) Create a Return Authorization (RA)++Returns are initiated from the order, not from the Returns tab, so navigate to the Orders tab and open the relevant order.++++<Note>+ Alternatively, find the customer in the Customers tab and access their order from there.+</Note>++Click the three-dot menu in the top-right corner and select **New Return Authorization**.++++This will open the Return Authorization form.++++Here you’ll see a table of line items from the order. For each item, configure the following:++- **Include in RA**: check the box to include this item in the return+- **Product**: name and variant (read-only)+- **Status**: shipment status (e.g., "shipped", read-only)+- **Charged**: amount originally charged to the customer+- **Return Quantity**: set how many units should be returned (0 if not returning)+- **Pre-tax Refund Amount**: amount to be refunded per item+- **Reimbursement Type**: choose from: Exchange, Store Credit, Credit, Original Payment+- **Exchange for**: if Exchange is selected, choose the replacement variant from the dropdown++Below the table, you’ll see a dynamic refund summary showing the Total Pre-Tax Refund amount (e.g., $35.00).++At the bottom of the form complete the additional fields:++- **Location**: stock location the item should be returned to (required)+- **Reason**: select an RMA reason (required)+- **Memo**: optional internal note++Click **Create** to finalize the Return Authorization.++You’ll be redirected back to the order overview, where a Return Authorizations section will now appear under the Shipments section. You can edit the RA at any time.++++The RA will also now be listed in the **Returns → Return Authorizations** tab.++++## 2) Create a Customer Return++With an RA in place, you're ready to log the return of the physical item.++From the same order overview page, click the three-dot menu again and select **New Customer Return**.++++This will open the Customer Return form.++++The form lists each item from the order. For each item, configure:++- **Include in return**: check if the item has been returned+- **Product**: name and variant (read-only)+- **SKU**: stock keeping unit (read-only)+- **Pre-tax Amount**: non-zero if part of the RA, 0 if not included (read-only)+- **Exchange for**: variant selected for exchange (if applicable) (read-only)+- **Resellable**: check if the item can be restocked; unchecked items won’t be returned to inventory++Below the table, select:++- **Location**: confirm the stock location the items are being returned to++Click **Create** to finalize the Customer Return.++You’ll then be returned to the order overview page again, and a new Customer Returns section will appear above the Return Authorizations section.++++The return will also now be visible in the Returns tab and can be edited from either location.++++## 3) Reimburse the Customer++Once a customer return has been logged, you can process the refund or exchange.++In the Customer Returns section, click the three-dot menu and select **Create Reimbursement**.++++This will create the reimbursement immediately and redirect you to the reimbursement form.++++Here you can review the items to be reimbursed, and override the reimbursement type or the exchange variant if necessary (e.g., reimburse with store credits instead of the original payment).++Click **Reimburse** to finalize the return process:++- If it’s a refund, the customer will be reimbursed via the selected method.+- If it’s an exchange, a new shipment will be created on the order and can be fulfilled like any other shipment.++++### Alternative Method++If you’d like to review the Customer Return before reimbursing the customer, you can instead select **Edit** from the three-dot menu, or just click on the Customer Return itself.++This will redirect you to a Customer Return summary that includes a Reimbursements section.++++This form displays:++- Customer name+- Order number+- Reimbursement status+- Pre-tax total+- Line item details:+ - Product+ - Amount+ - Reimbursement Type+ - Exchange For+ - Acceptance Errors++At the bottom of the page you’ll find the **Reimbursements** section.++Simply click **Create Reimbursement** and follow the steps outlined previously.\ No newline at end of filediff --git a/docs/user/settings/return_configuration.mdx b/docs/user/settings/return-configuration.mdxsimilarity index 99%rename from docs/user/settings/return_configuration.mdxrename to docs/user/settings/return-configuration.mdxindex 1abb1aae8e..5511ea05fb 100644--- a/docs/user/settings/return_configuration.mdx+++ b/docs/user/settings/return-configuration.mdx@@ -122,4 +122,5 @@ To delete a reimbursement type, simply open the Edit form as shown above and cliNow that you’ve defined all of your RMA reasons, refund reasons, and reimbursement types, you’ll be ready to process returns in the event that a customer requests them.-To learn how to process returns, please refer to Returns → Processing Returns.\ No newline at end of file+To learn how to process returns, please refer to Returns → Processing Returns.+