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]29a805953402
diff --git a/docs/docs.json b/docs/docs.jsonindex d605493058..bc0f093727 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -1747,7 +1747,14 @@"group": "Customers","pages": ["user/customers/create-customer",- "user/customers/customer-profile"+ "user/customers/customer-profile",+ "user/customers/edit-customer",+ "user/customers/issue-gift-card",+ "user/customers/assign-store-credits",+ "user/customers/searching-customers",+ "user/customers/exporting-customers",+ "user/customers/importing-customers",+ "user/customers/customer-import-file"]},{diff --git a/docs/user/customers/assign-store-credits.mdx b/docs/user/customers/assign-store-credits.mdxnew file mode 100644index 0000000000..80d8b1d5fb--- /dev/null+++ b/docs/user/customers/assign-store-credits.mdx@@ -0,0 +1,5 @@+---+title: 'New file'+description: 'Description of your new file.'+---+diff --git a/docs/user/customers/customer-import-file.mdx b/docs/user/customers/customer-import-file.mdxnew file mode 100644index 0000000000..80d8b1d5fb--- /dev/null+++ b/docs/user/customers/customer-import-file.mdx@@ -0,0 +1,5 @@+---+title: 'New file'+description: 'Description of your new file.'+---+diff --git a/docs/user/customers/edit-customer.mdx b/docs/user/customers/edit-customer.mdxnew file mode 100644index 0000000000..f84957485c--- /dev/null+++ b/docs/user/customers/edit-customer.mdx@@ -0,0 +1,44 @@+---+title: "Edit a Customer"+description: "In this Spree user doc, you'll learn how to edit existing customers' data."+---++Occasionally, you may need to edit a customer’s profile to update contact details, addresses, or preferences for accurate order fulfillment and communication. This is especially common if your sales process frequently includes off-site or manual order entries.++To edit a customer’s profile, navigate to the Customers tab of the admin dashboard.++<img alt="Edit a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747651949/docs/Customers/Edit%20a%20Customer/5.3.1.1_Edit_a_Customer_-_Navigate_To_Tab_lgyf5q.png" />++Find and click on the customer you’d like to edit and you’ll be redirected to their Customer Profile page.++<img alt="Edit a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1747651950/docs/Customers/Edit%20a%20Customer/5.3.1.2_Edit_a_Customer_-_Customer_Profile_ojckzh.png" />++The following information can be edited:++## Contact Details++<img alt="Edit a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747651949/docs/Customers/Edit%20a%20Customer/5.3.1.3_Edit_a_Customer_-_Contact_Details_pqhrpw.png" />++Here you can update the following:++- Email Address+- Phone Number+- First & Last Name+- Email marketing opt-in/opt-out+- Add/remove tags++## Shipping Address++<img alt="Edit a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747651949/docs/Customers/Edit%20a%20Customer/5.3.1.3_Edit_a_Customer_-_Contact_Details_pqhrpw.png" />++Here you can edit the default shipping address of the customer.++Note: Updating the shipping address in the customer profile will not change the shipping address on any outstanding orders. If you’d like to update the shipping address for the order, you must do it from the Orders tab.++## Billing Address++<img alt="Edit a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747651948/docs/Customers/Edit%20a%20Customer/5.3.1.5_Edit_a_Customer_-_Billing_Address_rmkcgw.png" />++Here you can edit the default billing address of the customer.++Note: Updating the billing address in the customer profile will not change the billing address on any outstanding orders. If you’d like to update the billing address for the order, you must do it from the Orders tab.\ No newline at end of filediff --git a/docs/user/customers/exporting-customers.mdx b/docs/user/customers/exporting-customers.mdxnew file mode 100644index 0000000000..80d8b1d5fb--- /dev/null+++ b/docs/user/customers/exporting-customers.mdx@@ -0,0 +1,5 @@+---+title: 'New file'+description: 'Description of your new file.'+---+diff --git a/docs/user/customers/importing-customers.mdx b/docs/user/customers/importing-customers.mdxnew file mode 100644index 0000000000..80d8b1d5fb--- /dev/null+++ b/docs/user/customers/importing-customers.mdx@@ -0,0 +1,5 @@+---+title: 'New file'+description: 'Description of your new file.'+---+diff --git a/docs/user/customers/issue-gift-card.mdx b/docs/user/customers/issue-gift-card.mdxnew file mode 100644index 0000000000..fd4ef4cd18--- /dev/null+++ b/docs/user/customers/issue-gift-card.mdx@@ -0,0 +1,42 @@+---+title: "Issue a Gift Card"+description: "In this Spree user doc, you'll learn how to issue a gift to an existing customer."+---+Gift cards are prepaid balances that can be purchased or issued and redeemed like cash on future purchases, often with no expiration date.++In Spree, you can create and issue gift cards directly to specific customers or generate them in bulk for distribution at a later time.++This guide covers issuing a gift card to a specific customer.++To issue a gift card to a customer, navigate to the Customers tab of the admin dashboard.++<img alt="Issue a Gift Card" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747652499/docs/Customers/Issue%20a%20Gift%20Card/5.3.2.1_Issue_a_Gift_Card_-_Navigate_To_Tab_ts8s7a.png" />++Find and click on the customer who is supposed to receive the gift card to open their customer profile page.++<img alt="Issue a Gift Card" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747652498/docs/Customers/Issue%20a%20Gift%20Card/5.3.2.2_Issue_a_Gift_Card_-_Customer_Profile_hgnkd0.png" />++Click on ‘More Actions’ in the top right corner and select ‘Issue a Gift Card’ from the dropdown.++<img alt="Issue a Gift Card" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747652352/docs/Customers/Issue%20a%20Gift%20Card/5.3.2.3_Issue_a_Gift_Card_-_Dropdown_Menu_fgzvdy.png" />++You’ll be redirected to the gift card creation page where you can define the details and conditions of the gift cards.++<img alt="Issue a Gift Card" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747652497/docs/Customers/Issue%20a%20Gift%20Card/5.3.2.4_Issue_a_Gift_Card_-_Gift_Card_Creation_swstod.png" />++The customer field will automatically be filled and uneditable, but you can enter values for the following fields:++- Code - you can leave this blank and Spree will automatically generate a code+- Amount - the amount to be placed on the gift card (required)+- Minimum Order Amount - a minimum order value to use the gift card, can be set to 0 (required)+- Expires At - the gift card’s expiration date, leave it blank for a non-expiring card++Click ‘Create’ once you’re finished and the gift card will be added to the customer’s account.++<img alt="Issue a Gift Card" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747652351/docs/Customers/Issue%20a%20Gift%20Card/5.3.2.5_Issue_a_Gift_Card_-_Gift_Card_Issued_pswuil.png" />++To learn more about creating gift cards in bulk, please refer to the Promotions section of our user documentation.++## Edit or Delete Gift Cards++If you’d like to edit or delete a gift card, click on ‘Edit’ next to the gift card (found under the ‘Gift Cards’ subsection of the customer profile page) and take the appropriate action.\ No newline at end of filediff --git a/docs/user/customers/searching-customers.mdx b/docs/user/customers/searching-customers.mdxnew file mode 100644index 0000000000..80d8b1d5fb--- /dev/null+++ b/docs/user/customers/searching-customers.mdx@@ -0,0 +1,5 @@+---+title: 'New file'+description: 'Description of your new file.'+---+