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] Updated Customer and Storefront docs (#13481)

jaburghes7923ee879cc1
diff --git a/docs/docs.json b/docs/docs.json
index c6cc74fda3..d25b97a7ef 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -1075,18 +1075,18 @@
"user/storefront/delete-page"
]
},
- {
- "group": "Storefront Posts",
- "pages": [
- "user/storefront/create-post",
- "user/storefront/edit-post",
- "user/storefront/search-posts",
- "user/storefront/delete-post"
- ]
- },
"user/storefront/storefront-settings",
"user/storefront/create-new-store"
]
+ },
+ {
+ "group": "Posts",
+ "pages": [
+ "user/storefront/create-post",
+ "user/storefront/edit-post",
+ "user/storefront/search-posts",
+ "user/storefront/delete-post"
+ ]
},
{
"group": "Settings",
diff --git a/docs/images/user/customers/create-customer/1-customers-tab.png b/docs/images/user/customers/create-customer/1-customers-tab.png
new file mode 100644
index 0000000000..636ad4c48e
Binary files /dev/null and b/docs/images/user/customers/create-customer/1-customers-tab.png differ
diff --git a/docs/images/user/customers/create-customer/2-creation-form.png b/docs/images/user/customers/create-customer/2-creation-form.png
new file mode 100644
index 0000000000..5a5639e8ca
Binary files /dev/null and b/docs/images/user/customers/create-customer/2-creation-form.png differ
diff --git a/docs/images/user/customers/create-customer/3-customer-profile.png b/docs/images/user/customers/create-customer/3-customer-profile.png
new file mode 100644
index 0000000000..e1c0b9a9d6
Binary files /dev/null and b/docs/images/user/customers/create-customer/3-customer-profile.png differ
diff --git a/docs/images/user/customers/create-customer/4-shipping-address.png b/docs/images/user/customers/create-customer/4-shipping-address.png
new file mode 100644
index 0000000000..dd7209549e
Binary files /dev/null and b/docs/images/user/customers/create-customer/4-shipping-address.png differ
diff --git a/docs/images/user/customers/create-customer/5-address-preview.png b/docs/images/user/customers/create-customer/5-address-preview.png
new file mode 100644
index 0000000000..de1c27fe49
Binary files /dev/null and b/docs/images/user/customers/create-customer/5-address-preview.png differ
diff --git a/docs/user/customers/create-customer.mdx b/docs/user/customers/create-customer.mdx
index 20a32880d2..9803e13595 100644
--- a/docs/user/customers/create-customer.mdx
+++ b/docs/user/customers/create-customer.mdx
@@ -1,51 +1,63 @@
---
title: "Create a Customer"
-description: "In this user doc you'll learn how to create new customers in Spree as an admin."
+description: "Learn how to create new customers in Spree Commerce as an admin."
---
-Depending on your business model, you might want to create customers manually when processing phone or in-person orders or when migrating data from another platform. 
+Depending on your business model, you might need to manually create customer accounts—for example, when processing phone or in-person orders, handling wholesale clients, or migrating data from another platform.
-This ensures all customer details are accurately recorded in the system, allowing for better order tracking, personalized service, and marketing opportunities.
+This ensures customer details are accurately recorded in the system, enabling better order tracking, personalized service, and targeted marketing.
-To create a customer, navigate to the Customers tab of the admin dashboard.
+## Create a New Customer
-<img alt="Create a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747647964/docs/Customers/Create%20a%20Customer/5.1.1_Create_A_Customer_-_Navigate_To_Tab_jogabv.png" />
+To a create a new customer, navigate to **Customers** in the admin dashboard.
-Click on the ‘\+ Create Customer’ in the top right corner to open the customer creation form.
+![The Customers tab in the Spree Commerce dashboard](/docs/images/user/customers/create-customer/1-customers-tab.png)
-<img alt="Create a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747647965/docs/Customers/Create%20a%20Customer/5.1.2_Create_A_Customer_-_Customer_Creation_Form_yvvpqn.png" />
+Click **New Customer** in the top-right corner to open the creation form.
-Simply type in the customers details (only an email address is required) and click ‘Create’ and you’ll be redirected to the newly created customers admin page.
+![Creating a customer in the Spree Commerce dashboard](/docs/images/user/customers/create-customer/2-creation-form.png)
-Tip: Add customer tags like "VIP," "Frequent Buyer," or "Wholesale" to categorize customers based on purchasing behavior or status. Other tags such as "New Customer," "Flagged for Review," or "High-Value" can help streamline marketing efforts, customer service, and order management.
+Fill in the following customer fields:
-<img alt="Create a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747647964/docs/Customers/Create%20a%20Customer/5.1.3_Create_A_Customer_-_Customer_Created_rixjst.png" />
+- Email
+- First Name
+- Last Name
+- Phone Number (optional)
+- Tags (optional)
-Now that the customer has been created, you can add additional information such as the shipping and billing addresses.
+<Note>Tags help you categorize and segment customers based on purchasing behavior or account type, and can improve filtering, reporting, and personalization.</Note>
-## Add a Shipping Address
+Once you’ve filled in the required fields, click **Create**, and you’ll be redirected to the customer’s profile page.
-To add a shipping address, click ‘\+ Add’ in the Shipping Address section. This will reveal a form that will allow you to input the customer address.
+![Customer profile in the Spree Commerce dashboard](/docs/images/user/customers/create-customer/3-customer-profile.png)
-<img alt="Create a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747647964/docs/Customers/Create%20a%20Customer/5.1.4_Create_A_Customer_-_Shipping_Address_rjw28p.png" />
+From here, you can add additional customer details and manage everything related to the customer - including their orders, store credit, gift cards, and more.
-After entering the address, click create and the new shipping address will be saved.
+## Add Shipping Address
-<img alt="Create a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747647965/docs/Customers/Create%20a%20Customer/5.1.5_Create_A_Customer_-_Shipping_Address_Added_qpkgll.png" />
+![Adding a shipping address to a customer in Spree Commerce](/docs/images/user/customers/create-customer/4-shipping-address.png)
-## Add a Billing Address
+To add the customer’s shipping address, follow these steps:
-By default, the billing address will be set to ‘Same as shipping address’, but you can enter a different address by clicking on ‘Edit’ in the billing address section, and selecting ‘Add New Address’.
+1. Locate the **Shipping Address** section of the customer’s profile
+2. Click **Add** to open the address form
+3. Fill in the the customers shipping details and click **Create**
-<img alt="Create a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747647965/docs/Customers/Create%20a%20Customer/5.1.6_Create_A_Customer_-_Billing_Address_ao94w9.png" />
+Once created, you’ll be able to preview the customer’s shipping address.
-This will reveal a form in the same way as described above. Simply enter the correct billing address and click ‘Create’ to save it.
+![Customer address map preciew in Spree Commerce](/docs/images/user/customers/create-customer/5-address-preview.png)
-<img alt="Create a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747647966/docs/Customers/Create%20a%20Customer/5.1.7_Create_A_Customer_-_Change_Billing_Address_jeuubb.png" />
+<Note>If your store has the Google Maps API connected, a map will appear alongside the saved address, pinpointing the customer's location. This can help visually confirm the accuracy of the address.</Note>
+## Add Billing Address
-With this information added, the customer can now be added to manual orders at the click of a button.
+By default the billing address is set to **Same as Shipping Address**.
-Note: If the customer would like to access their user account, they’ll need to initiate a password reset on the storefront using the email address associated with their account.
+To use a different billing address:
-Congratulations, you’ve just created a customer account\!
\ No newline at end of file
+1. Click **Edit** under the **Billing Address** section.
+2. Select **Add New Address**, enter the billing address, and click **Create**.
+
+## Customer Login Access
+
+In order for the customer to access their account, they must initiate a password reset on the storefront using the email address tied to their profile.
diff --git a/docs/user/storefront/delete-page.mdx b/docs/user/storefront/delete-page.mdx
index 2c55748572..0ea0c1da98 100644
--- a/docs/user/storefront/delete-page.mdx
+++ b/docs/user/storefront/delete-page.mdx
@@ -3,8 +3,6 @@ title: "Delete a Landing Page"
description: "Learn how to delete custom pages in Spree Commerce."
---
-# Delete a Landing Page
-
If a landing page is no longer needed, you can delete it directly from the Pages list to keep your admin area organized.
## Delete a Page
diff --git a/docs/user/storefront/edit-page.mdx b/docs/user/storefront/edit-page.mdx
index 0192911074..f79dd94d6e 100644
--- a/docs/user/storefront/edit-page.mdx
+++ b/docs/user/storefront/edit-page.mdx
@@ -3,8 +3,6 @@ title: "Edit a Landing Page"
description: "Learn how to edit custom landing pages in Spree Commerce."
---
-# Edit a Landing Page
-
Learn how to edit custom landing pages in Spree Commerce.
You can easily update the content, layout, or product sections on your custom landing pages directly through the Theme Editor - no developer help required.