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]f83985fbb77a
diff --git a/docs/docs.json b/docs/docs.jsonindex ca9e51d306..1e8719935a 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -874,8 +874,6 @@"pages": ["user/manage-products/search-products","user/manage-products/bulk-product-operations",- "user/manage-products/import-products",- "user/manage-products/product-import-file-template","user/manage-products/export-products","user/manage-products/stock-levels","user/manage-products/stock-transfers",@@ -955,13 +953,17 @@"group": "Settings","pages": ["user/settings/store-details",+ "user/settings/users","user/settings/emails","user/settings/policies","user/settings/checkout",+ "user/settings/domains","user/settings/locations",+ "user/settings/payments","user/settings/zones","user/settings/shipping-methods",- "user/settings/tax"+ "user/settings/tax",+ "user/settings/returns"]}]diff --git a/docs/images/4.1.1InviteAVendor-NavigateToTab.png b/docs/images/4.1.1InviteAVendor-NavigateToTab.pngdeleted file mode 100644index dc1d629fe1..0000000000Binary files a/docs/images/4.1.1InviteAVendor-NavigateToTab.png and /dev/null differdiff --git a/docs/images/4.1.2InviteAVendor-InvitePopup.png b/docs/images/4.1.2InviteAVendor-InvitePopup.pngdeleted file mode 100644index 0a986a9580..0000000000Binary files a/docs/images/4.1.2InviteAVendor-InvitePopup.png and /dev/null differdiff --git a/docs/images/4.1.3InviteAVendor-InvitationSent.png b/docs/images/4.1.3InviteAVendor-InvitationSent.pngdeleted file mode 100644index ac8d05d92b..0000000000Binary files a/docs/images/4.1.3InviteAVendor-InvitationSent.png and /dev/null differdiff --git a/docs/images/4.1.4InviteAVendor-VendorProfile.png b/docs/images/4.1.4InviteAVendor-VendorProfile.pngdeleted file mode 100644index 9cc8679497..0000000000Binary files a/docs/images/4.1.4InviteAVendor-VendorProfile.png and /dev/null differdiff --git a/docs/images/4.1.5InviteAVendor-CopyInvitationLink.png b/docs/images/4.1.5InviteAVendor-CopyInvitationLink.pngdeleted file mode 100644index 0bed511e87..0000000000Binary files a/docs/images/4.1.5InviteAVendor-CopyInvitationLink.png and /dev/null differdiff --git a/docs/images/4.1.6InviteAVendor-CancelInvitation.png b/docs/images/4.1.6InviteAVendor-CancelInvitation.pngdeleted file mode 100644index f4c62f944f..0000000000Binary files a/docs/images/4.1.6InviteAVendor-CancelInvitation.png and /dev/null differdiff --git a/docs/images/user/settings/domains/custom_domains.png b/docs/images/user/settings/domains/custom_domains.pngnew file mode 100644index 0000000000..f405373090Binary files /dev/null and b/docs/images/user/settings/domains/custom_domains.png differdiff --git a/docs/images/user/settings/payments/1.payments.png b/docs/images/user/settings/payments/1.payments.pngnew file mode 100644index 0000000000..eab57b3d0dBinary files /dev/null and b/docs/images/user/settings/payments/1.payments.png differdiff --git a/docs/images/user/settings/payments/2.payments_overview.png b/docs/images/user/settings/payments/2.payments_overview.pngnew file mode 100644index 0000000000..b610c93c2eBinary files /dev/null and b/docs/images/user/settings/payments/2.payments_overview.png differdiff --git a/docs/images/user/settings/payments/3.payments_display.png b/docs/images/user/settings/payments/3.payments_display.pngnew file mode 100644index 0000000000..0500f02740Binary files /dev/null and b/docs/images/user/settings/payments/3.payments_display.png differdiff --git a/docs/images/user/settings/payments/4.enabled_payment_methods.png b/docs/images/user/settings/payments/4.enabled_payment_methods.pngnew file mode 100644index 0000000000..445ef1093eBinary files /dev/null and b/docs/images/user/settings/payments/4.enabled_payment_methods.png differdiff --git a/docs/images/user/settings/payments/5.available_payment_methods.png b/docs/images/user/settings/payments/5.available_payment_methods.pngnew file mode 100644index 0000000000..825365e1baBinary files /dev/null and b/docs/images/user/settings/payments/5.available_payment_methods.png differdiff --git a/docs/images/user/settings/payments/6.add_payment_method.png b/docs/images/user/settings/payments/6.add_payment_method.pngnew file mode 100644index 0000000000..d2896dfb0cBinary files /dev/null and b/docs/images/user/settings/payments/6.add_payment_method.png differdiff --git a/docs/images/user/settings/payments/7.payment_provider_settings.png b/docs/images/user/settings/payments/7.payment_provider_settings.pngnew file mode 100644index 0000000000..4fa73ad274Binary files /dev/null and b/docs/images/user/settings/payments/7.payment_provider_settings.png differdiff --git a/docs/images/user/settings/payments/8.display_settings.png b/docs/images/user/settings/payments/8.display_settings.pngnew file mode 100644index 0000000000..35b32b098cBinary files /dev/null and b/docs/images/user/settings/payments/8.display_settings.png differdiff --git a/docs/images/user/settings/payments/9.edit_payment_method.png b/docs/images/user/settings/payments/9.edit_payment_method.pngnew file mode 100644index 0000000000..6ff222ab52Binary files /dev/null and b/docs/images/user/settings/payments/9.edit_payment_method.png differdiff --git a/docs/images/user/settings/returns-configuration/1.returns.png b/docs/images/user/settings/returns-configuration/1.returns.pngnew file mode 100644index 0000000000..1a91ceb9b6Binary files /dev/null and b/docs/images/user/settings/returns-configuration/1.returns.png differdiff --git a/docs/images/user/settings/returns-configuration/10.edit_reimbursement.png b/docs/images/user/settings/returns-configuration/10.edit_reimbursement.pngnew file mode 100644index 0000000000..d9a9378dcfBinary files /dev/null and b/docs/images/user/settings/returns-configuration/10.edit_reimbursement.png differdiff --git a/docs/images/user/settings/returns-configuration/2.return_authorizations.png b/docs/images/user/settings/returns-configuration/2.return_authorizations.pngnew file mode 100644index 0000000000..152071db18Binary files /dev/null and b/docs/images/user/settings/returns-configuration/2.return_authorizations.png differdiff --git a/docs/images/user/settings/returns-configuration/3.new_rma.png b/docs/images/user/settings/returns-configuration/3.new_rma.pngnew file mode 100644index 0000000000..95a5ef7bcfBinary files /dev/null and b/docs/images/user/settings/returns-configuration/3.new_rma.png differdiff --git a/docs/images/user/settings/returns-configuration/4.edit_rma.png b/docs/images/user/settings/returns-configuration/4.edit_rma.pngnew file mode 100644index 0000000000..28bc45c2a2Binary files /dev/null and b/docs/images/user/settings/returns-configuration/4.edit_rma.png differdiff --git a/docs/images/user/settings/returns-configuration/5.refund_reasons.png b/docs/images/user/settings/returns-configuration/5.refund_reasons.pngnew file mode 100644index 0000000000..0921124a0bBinary files /dev/null and b/docs/images/user/settings/returns-configuration/5.refund_reasons.png differdiff --git a/docs/images/user/settings/returns-configuration/6.new_refund_reason.png b/docs/images/user/settings/returns-configuration/6.new_refund_reason.pngnew file mode 100644index 0000000000..0d5055e241Binary files /dev/null and b/docs/images/user/settings/returns-configuration/6.new_refund_reason.png differdiff --git a/docs/images/user/settings/returns-configuration/7.edit_refund_reason.png b/docs/images/user/settings/returns-configuration/7.edit_refund_reason.pngnew file mode 100644index 0000000000..75f5c7e8fdBinary files /dev/null and b/docs/images/user/settings/returns-configuration/7.edit_refund_reason.png differdiff --git a/docs/images/user/settings/returns-configuration/8.reimbursement_types.png b/docs/images/user/settings/returns-configuration/8.reimbursement_types.pngnew file mode 100644index 0000000000..23dc2e0df8Binary files /dev/null and b/docs/images/user/settings/returns-configuration/8.reimbursement_types.png differdiff --git a/docs/images/user/settings/returns-configuration/9.new_reimbursement.png b/docs/images/user/settings/returns-configuration/9.new_reimbursement.pngnew file mode 100644index 0000000000..59d6085c38Binary files /dev/null and b/docs/images/user/settings/returns-configuration/9.new_reimbursement.png differdiff --git a/docs/images/user/settings/users/1.users.png b/docs/images/user/settings/users/1.users.pngnew file mode 100644index 0000000000..e9d140979cBinary files /dev/null and b/docs/images/user/settings/users/1.users.png differdiff --git a/docs/images/user/settings/users/2.users_tab.png b/docs/images/user/settings/users/2.users_tab.pngnew file mode 100644index 0000000000..27ef0eb7d3Binary files /dev/null and b/docs/images/user/settings/users/2.users_tab.png differdiff --git a/docs/images/user/settings/users/3.invite_user.png b/docs/images/user/settings/users/3.invite_user.pngnew file mode 100644index 0000000000..3c09adb11bBinary files /dev/null and b/docs/images/user/settings/users/3.invite_user.png differdiff --git a/docs/images/user/settings/users/4.user_signup.png b/docs/images/user/settings/users/4.user_signup.pngnew file mode 100644index 0000000000..0c41bd69acBinary files /dev/null and b/docs/images/user/settings/users/4.user_signup.png differdiff --git a/docs/images/user/settings/users/5.invitations.png b/docs/images/user/settings/users/5.invitations.pngnew file mode 100644index 0000000000..44c893f922Binary files /dev/null and b/docs/images/user/settings/users/5.invitations.png differdiff --git a/docs/images/user/settings/users/6.roles.png b/docs/images/user/settings/users/6.roles.pngnew file mode 100644index 0000000000..8c78ee8a70Binary files /dev/null and b/docs/images/user/settings/users/6.roles.png differdiff --git a/docs/images/user/settings/users/7.edit_user.png b/docs/images/user/settings/users/7.edit_user.pngnew file mode 100644index 0000000000..d09ece6193Binary files /dev/null and b/docs/images/user/settings/users/7.edit_user.png differdiff --git a/docs/images/user/settings/users/8.edit_form.png b/docs/images/user/settings/users/8.edit_form.pngnew file mode 100644index 0000000000..52f93dc955Binary files /dev/null and b/docs/images/user/settings/users/8.edit_form.png differdiff --git a/docs/images/user/vendors/invite_vendor/1.invite_vendor.png b/docs/images/user/vendors/invite_vendor/1.invite_vendor.pngnew file mode 100644index 0000000000..86c1f74998Binary files /dev/null and b/docs/images/user/vendors/invite_vendor/1.invite_vendor.png differdiff --git a/docs/images/user/vendors/invite_vendor/2.click_invite.png b/docs/images/user/vendors/invite_vendor/2.click_invite.pngnew file mode 100644index 0000000000..44eb2296bdBinary files /dev/null and b/docs/images/user/vendors/invite_vendor/2.click_invite.png differdiff --git a/docs/images/user/vendors/invite_vendor/3.invite_sent.png b/docs/images/user/vendors/invite_vendor/3.invite_sent.pngnew file mode 100644index 0000000000..7c96a989c7Binary files /dev/null and b/docs/images/user/vendors/invite_vendor/3.invite_sent.png differdiff --git a/docs/images/user/vendors/invite_vendor/4.vendor_profile.png b/docs/images/user/vendors/invite_vendor/4.vendor_profile.pngnew file mode 100644index 0000000000..806980c336Binary files /dev/null and b/docs/images/user/vendors/invite_vendor/4.vendor_profile.png differdiff --git a/docs/images/user/vendors/invite_vendor/5.invitation_link.png b/docs/images/user/vendors/invite_vendor/5.invitation_link.pngnew file mode 100644index 0000000000..e7325ca64eBinary files /dev/null and b/docs/images/user/vendors/invite_vendor/5.invitation_link.png differdiff --git a/docs/user/settings/domains.mdx b/docs/user/settings/domains.mdxnew file mode 100644index 0000000000..333aebbf3e--- /dev/null+++ b/docs/user/settings/domains.mdx@@ -0,0 +1,27 @@+---+title: "Domains"+description: "Learn how to connect custom domains to your Spree store."+---++Connecting a custom domain ensures your store is accessible via a branded, customer-friendly URL, rather than a technical or temporary address. It builds trust with users, strengthens brand identity, and improves discoverability through SEO.++### Add a Custom Domain++Adding custom domains in Spree is made simple with a convenient semi-automated process.++To add a custom domain, navigate to the Domains tab of the Settings menu.++<img src="/docs/images/user/settings/domains/custom_domains.png" />++Then follow these steps:++1. Click ‘Setup Domain’ and a window will appear+2. Enter the URL and click ‘Proceed’+3. Continue through the domain verification process (powered by Entri)+4. Complete verification with your domain provider++Once verified, the domain is automatically connected and enabled for use with your storefront.++The system handles most of the DNS configuration behind the scenes. However, if your domain is managed through a provider that isn’t supported for automated setup, you may be required to complete some manual DNS changes (instructions will be provided as needed).++<Note>Changes to DNS records may take some time to propagate, depending on your domain provider.</Note>\ No newline at end of filediff --git a/docs/user/settings/emails.mdx b/docs/user/settings/emails.mdxindex f5f0fef1e8..1c14323c5b 100644--- a/docs/user/settings/emails.mdx+++ b/docs/user/settings/emails.mdx@@ -1,17 +1,17 @@---title: "Emails"-description: "Learn to configure how your store communicates with customers via email."+description: "Configure how your store communicates with customers via email."---Email communication is a key part of building trust with your customers. From order confirmations to support inquiries, making sure your emails are professional and come from the right addresses helps reinforce your brand and ensures important messages reach the right people.To configure email settings, navigate to the Emails tab of the Settings menu.-<img src="/docs/images/user/settings/emails/1.Emails.png" />+## Logo for Emails-<img src="/docs/images/user/settings/emails/2.Logo.png" />+Here you can upload a logo that will appear in all automated email notifications (e.g. order confirmations, shipment tracking). Simply select the file you wish to upload.@@ -19,7 +19,7 @@ Note: We recommend using a transparent PNG or JPEG for best results.## Email Addresses-<img src="/docs/images/user/settings/emails/3.Addresses.png" />+Here you can set the email addresses that will be used for various purposes by your business:diff --git a/docs/user/settings/payments.mdx b/docs/user/settings/payments.mdxnew file mode 100644index 0000000000..cd818015e6--- /dev/null+++ b/docs/user/settings/payments.mdx@@ -0,0 +1,119 @@+---+title: "Payments"+description: "Learn how to view, add, edit, and remove payment methods in Spree."+---++Payments are a vital part of any e-commerce store. Spree offers a flexible and modular system for managing payment methods, supporting both out-of-the-box and third-party options.++<Warning>+ Not all payment methods are available by default - most require the installation of additional gems by a developer before they can be used in the admin interface.+</Warning>++To manage payments, navigate to the Payments tab of the Settings menu.++++## Payment Methods Overview++++Here you can see a list of enabled payment methods, and a list of available payment methods:++### Enabled Payment Methods++++Enabled methods are those that are configured and can be used by customers on checkout.++You can easily modify the display settings of enabled payment methods by changing the visibility and active status.++++### Available Payment Methods++++Available payment methods are those that have been installed, but have not been configured yet.++### Default Payment Methods++By default, the following payment methods are available in Spree:++- **Store Credits**: allow customers to pay using store credits issued by the admin, enabled by default+- **Offsite Payment**: labelled as "Check", not enabled by default++### Third-Party Payment Methods++Additional payment gateways (e.g., Stripe) can be made available by having your developers install the relevant gems. For example, Stripe gateway is free to use, but requires adding the [<u>spree_stripe</u>](https://github.com/spree/spree_stripe) gem to your store's codebase before it becomes available in the admin interface.++For more information about our native Stripe integration, see Integrations → Stripe Gateway.++Once a payment method has been installed, it appears in the Available Payment Methods list. From there, it can be added, configured, or removed as needed.++## Add a Payment Method++To add a payment method, click Add on the corresponding row in the Available Payment Methods list. This will direct you to the payment method creation form for that method.++++Depending on the payment method you’re adding, the sections displayed in the form may differ. The following example covers Stripe which has 2 distinct sections:++### Payment Provider Settings++++Simply enter the required credentials into their respective fields.++<Note>+ This section only applies to third-party payment methods.+</Note>++<Warning>+ Different payment providers may require different credentials to be entered.+</Warning>++### Display Settings++++Display settings can be configured for all payment methods whether default or third-party.++There are four fields to configure:++- **Name**: The name displayed on the storefront+- **Display**: Where the method is available for use+ - On both the admin panel & storefront+ - Only on storefront+ - Only on admin panel+- **Auto Capture**: Determines whether payment is captured automatically at the time of authorization. Use the app default or override it per method.+- **Status**: Toggle whether the payment method is available for use in orders. Inactive methods are hidden but not deleted.++### Create++Once you’ve entered all the required fields, click Create to add the payment method.++The method will now be listed in your store’s enabled payment methods and will be available to users on checkout (provided it is active and visible).++## Edit a Payment Method++To edit a payment method, click on the corresponding row in the enabled payment methods list. This will direct you to the edit form for that method.++++Feel free to update any of the display settings for the payment method, but be very cautious when editing payment provider settings.++<Warning>+ Swapping payment provider accounts on an active store can disrupt payment processing and lead to failed transactions or reporting inconsistencies. Ensure all pending payments are settled and test the new account thoroughly in a staging environment before applying changes in production.+</Warning>++## Delete a Payment Method++To remove a payment method, simply open the edit form as shown above and click Delete.++<Warning>+ Once a payment method is associated with an order, it cannot be deleted.+</Warning>++<Note>+ Deleting a payment method moves it from the enabled payment methods list back into the available payments list. It does not uninstall the associated gem. A developer would need to remove it from the codebase if complete deactivation is desired.+</Note>\ No newline at end of filediff --git a/docs/user/settings/return_configuration.mdx b/docs/user/settings/return_configuration.mdxnew file mode 100644index 0000000000..f5c2fca430--- /dev/null+++ b/docs/user/settings/return_configuration.mdx@@ -0,0 +1,125 @@+---+title: "Returns Configuration"+description: "Learn how to define return authorization reasons, refund reasons, and reimbursement types."+---++Returns management is a crucial part of ecommerce operations. It builds customer trust, streamlines support workflows, and helps maintain clarity around inventory and financial adjustments.++Not all eCommerce platforms offer built-in tools for managing returns, but fortunately Spree does - no extra plugins or custom development needed.++To get started with Returns, navigate to the Returns tab of the Settings menu.++++Here you’ll notice three subtabs for managing Return Authorization Reasons, Refund Reasons, and Reimbursement Types. Let’s look at each in detail:++## Return Authorization Reasons++++Return Merchandise Authorizations (RMAs) specify the reasons a customer provides when requesting to return an item. These reasons help categorize returns for internal reporting and customer service workflows.++RMAs only have two fields:++- **Name**: The visible reason for the return (e.g., Wrong size, No longer needed).+- **Status**: Toggle whether the reason is available for use in the returns flow. Inactive reasons are hidden but not deleted.++### Add New Return Authorization++To add a new return authorization reason, click ‘New RMA Reason’ in the top right corner and you’ll be redirected to the RMA reason creation form.++++Simply enter the name, set the status, and click Create to save the new RMA reason.++### Edit Return Authorization++To edit an RMA reason, simply click on the RMA’s row in the overview.++++The Edit form looks more or less identical to the Create form, but with pre-filled data, and Update buttons rather than Create buttons.++Simply update fields as needed and then click Update to save changes.++### Delete Return Authorization++To delete an RMA reason, simply open the Edit form as shown above and click Delete.++## Refund Reasons++++Refund Reasons are used internally to explain why a refund was issued. These help with tracking, reporting, and communication across teams.++Refund reasons also have two fields:++- **Name**: A label for the reason (e.g., Return processing, Order cancelled).+- **Status**: Toggle whether the reason is available for use in the returns flow. Inactive reasons are hidden but not deleted.++### Add New Refund Reason++To add a new refund reason, click ‘New Refund Reason’ in the top right corner and you’ll be redirected to the refund reason creation form.++++Simply enter the name, set the status, and click Create to save the new refund reason.++### Edit Refund Reason++To edit a refund reason, simply click on its row in the overview.++++The Edit form looks more or less identical to the Create form, but with pre-filled data, and Update buttons rather than Create buttons.++Simply update fields as needed and then click Update to save changes.++### Delete Refund Reason++To delete a refund reason, simply open the Edit form as shown above and click Delete.++## Reimbursement Types++++Reimbursement Types define how refunds are paid back to the customer. These options help determine whether a refund goes back to the original payment method, a store credit, or is handled through an exchange.++Reimbursement types have four fields:++- **Name**: The label for this type (e.g., Store credit, Exchange).+- **Type**: The method of reimbursement:+ - Credit+ - Original payment (e.g., debit card)+ - Exchange+ - Store credit+- **Status**: Toggle whether the reason is available for use in the returns flow. Inactive reasons are hidden but not deleted.+- **Mutable**: If set to Yes, the reimbursement type can be changed after it's assigned, otherwise it's locked it in.++### Add New Reimbursement Type++To add a reimbursement type, click ‘New Reimbursement Type’’ in the top right corner and you’ll be redirected to the reimbursement type creation form.++++Simply enter the name, set the status, and click Create to save the new reimbursement type.++### Edit Reimbursement Type++To edit a reimbursement type, simply click on its row in the overview.++++The Edit form looks more or less identical to the Create form, but with pre-filled data, and Update buttons rather than Create buttons.++Simply update fields as needed and then click Update to save changes.++### Delete Reimbursement Type++To delete a reimbursement type, simply open the Edit form as shown above and click Delete.++## Processing Returns++Now 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 filediff --git a/docs/user/settings/tax.mdx b/docs/user/settings/tax.mdxindex f5fa3865b1..629cdd374c 100644--- a/docs/user/settings/tax.mdx+++ b/docs/user/settings/tax.mdx@@ -9,21 +9,21 @@ Spree gives you a clear and customizable way to set up and manage taxes for anyTo manage Tax configurations, navigate to the Tax tab of the Settings menu.-<img src="/docs/images/user/settings/tax/1.tax.png" />+You’ll notice two separate subtabs here for managing Tax Rates and Tax Categories.-<img src="/docs/images/user/settings/tax/2.tax_subtabs.png" />+Let’s take a look at each in more detail:## Tax Rates-<img src="/docs/images/user/settings/tax/3.tax_rates.png" />+The Tax Rates overview displays all existing tax rates with key information such as:-- **Name**: A label for internal/admin use+- **Name**: A label for storefront and internal display- **Tax Category**: Which group of products this rate applies to- **Zone**: Where the tax applies (configured separately in the Zones section)- **Amount**: The tax percentage (e.g., 20%)@@ -35,13 +35,15 @@ From here, you can:- Add new tax rates- Edit existing tax rates-<Note>Tax rates in Spree rely on the Zones feature to determine where each rate applies. Zones define geographic regions (like countries or states), allowing you to target specific tax rules based on a customer's shipping address.</Note>+<Note>+ Tax rates in Spree rely on the Zones feature to determine where each rate applies. Zones define geographic regions (like countries or states), allowing you to target specific tax rules based on a customer's shipping address.+</Note>### Add a New Tax RateTo add a new tax rate click New Tax Rate in the top right corner, and you’ll be directed to a tax rate creation form.-<img src="/docs/images/user/settings/tax/4.add_new_rate.png" />+Simply fill in the form with the relevant information:@@ -60,13 +62,15 @@ This tax rate can now be applied to products with the matching category and shipTo edit a tax rate, simply click on the tax rate’s row in the Tax Rates overview.-<img src="/docs/images/user/settings/tax/5.edit_tax_rate.png" />+The edit form looks more or less identical to the New Tax Rate form, but with pre-filled data, and Update buttons rather than Create buttons.Simply update fields as needed and then click Update to save changes.-<Note>Changing a tax rate will affect all future orders using that rate, but not past orders.</Note>+<Note>+ Changing a tax rate will affect all future orders using that rate, but not past orders.+</Note>### Delete a Tax Rate@@ -74,7 +78,7 @@ To delete a Tax Rate, simply navigate to the edit form for the Tax Rate you wish## Tax Categories-<img src="/docs/images/user/settings/tax/6.tax_categories.png" />+Tax categories are used to organize products based on how they’re taxed.@@ -96,7 +100,7 @@ From here, you can:To add a new tax category click New Tax Category in the top right corner, and you’ll be directed to a tax category creation form.-<img src="/docs/images/user/settings/tax/7.new_tax_category.png" />+Simply fill in the form with the relevant information:@@ -113,13 +117,15 @@ This category will now be available for assignment to products and tax rates.To edit a tax category, simply click on the tax category’s row in the Tax Categories overview.-<img src="/docs/images/user/settings/tax/8.edit_tax_category.png" />+The edit form looks more or less identical to the New Tax Category form, but with pre-filled data, and Update buttons rather than Create buttons.Simply update fields as needed and then click Update to save changes.-<Note>You can switch the default tax category if needed, but only one can be default at a time.</Note>+<Note>+ You can switch the default tax category if needed, but only one can be default at a time.+</Note>### Delete a Tax Categorydiff --git a/docs/user/settings/users.mdx b/docs/user/settings/users.mdxnew file mode 100644index 0000000000..4c4e0d9d79--- /dev/null+++ b/docs/user/settings/users.mdx@@ -0,0 +1,81 @@+---+title: "Users"+description: "Learn how to invite and manage admin users."+---++Effectively managing user access to your store’s backend is essential for operational security and team collaboration. The Users settings section allows you to view active users, track invitations, and (eventually) create roles to define permissions.++To manage admin users, navigate to the Users tab of the admin dashboard.++++This page is split into three subsections for Users, Invitations, and Roles. Let’s take a look at each in detail:++## Users++++This section displays a list of all active users with access to the dashboard. From here, you can invite new users, view existing user details, and remove access if needed.++### Invite a User++To invite a new user, click ‘Send Invitation’ in the top right corner.++++Then follow these steps:++1. Enter the users email address+2. Set their user role+3. Set an invitation expiry date+4. Click ‘Send Invitation’++The user will then receive an email invitation to the specified email address.++When they click on the invitation link, they’ll be redirected to an account creation page.++++Once they complete the form and click ‘Create a new account’ they’ll be redirected to the admin dashboard.++### Edit a User++To edit a user, click on their corresponding row to open their admin profile.++++Click Edit in the details section to reveal the edit form.++++Change the fields as needed and click Update to save.++### Delete a User++It’s not possible to outright delete a user, but you can block their access by removing their role in the edit form shown above.++## Invitations++++This section shows a record of all invitations that have been sent, whether accepted, pending, or expired. This helps you monitor who’s been invited, by whom, and what role they’ve been assigned.++Each invitation includes:++- **Email**: The email address the invitation was sent to+- **Inviter**: The user who sent the invitation+- **Role**: The assigned role upon acceptance+- **Created at**: Date the invitation was created+- **Status**: Accepted, Pending, or Expired++<Note>+ Pending invitations can be Resent or Deleted by clicking on the three dots on the right hand side of the corresponding row and selecting the desired action.+</Note>++## Roles++++Role-based access control is not yet fully implemented in the admin UI. While you can create new role names, they do not affect permission levels.++However, you can currently create roles and apply permissions to them via code. Please refer to our developer docs for more info: [<u>Customization → Permissions</u>](https://spreecommerce.org/docs/developer/customization/permissions).\ No newline at end of filediff --git a/docs/user/user-quickstart-guide.mdx b/docs/user/user-quickstart-guide.mdxindex 562706edef..83fd74c4bf 100644--- a/docs/user/user-quickstart-guide.mdx+++ b/docs/user/user-quickstart-guide.mdx@@ -1,11 +1,15 @@----title: "User quickstart"+title: "User Quickstart"description: "Start selling with Spree Commerce open-source eCommerce solution"---When first logging in to your instance of Spree Commerce [open-source eCommerce platform](https://spreecommerce.org/), you’ll be greeted with the Getting Started tab which, by default, outlines 4 onboarding tasks you’ll need to complete.-<img alt="Getting started with Spree Commerce - an Open Source e-commerce platform" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.1_Getting_Started_pwvjhm" />+<img+ alt="Getting started with Spree Commerce - an Open Source e-commerce platform"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.1_Getting_Started_pwvjhm"+/>Once you’ve completed these tasks, this tab will disappear.@@ -17,21 +21,33 @@ It shouldn’t come as a surprise that in order to sell anything, you need to acTo setup payment methods, click on the blue button which will redirect you to the Payment Methods section of Settings.-<img alt="Payment Methods" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.2_Getting_Started_-_Payment_Methods_danmea.png" />+<img+ alt="Payment Methods"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.2_Getting_Started_-_Payment_Methods_danmea.png"+/>At the top, there’s a list of added payment methods, each of which you can toggle on/off, change its visibility on the storefront or admin panel, and edit. The Store Credits payment methods is always added by default, but alone it does not enable to accept payments from customers.Below that, you’ll see a list of available payment methods that you can add to your store.-Find the method you’d like to use and click ‘+ Add’. This will redirect you to the set up page for that particular payment method.+Find the method you’d like to use and click ‘\+ Add’. This will redirect you to the set up page for that particular payment method.Important: to use any of these available payment methods, you are required to first set up an account with the associated payment service provider.-<img alt="Create Payment Method" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.3_Getting_Started_-_Create_Payment_Method_i0xp8m.png" />+<img+ alt="Create Payment Method"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.3_Getting_Started_-_Create_Payment_Method_i0xp8m.png"+/>Simply follow the steps outlined for that payment method, click Create, and the payment method will be added to your store.-<img alt="Payment Method Added" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.4_Getting_Started_-_Payment_Method_Added_eojwfj.png" />+<img+ alt="Payment Method Added"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.4_Getting_Started_-_Payment_Method_Added_eojwfj.png"+/>To learn more about Payment Methods, please refer to a separate support article.@@ -39,25 +55,33 @@ To learn more about Payment Methods, please refer to a separate support article.Next on the list is adding products.-<img alt="Add Products" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.5_Getting_Started_-_Add_Products_cxbdq5.png" />+<img+ alt="Add Products"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.5_Getting_Started_-_Add_Products_cxbdq5.png"+/>There are three ways to add products to your store:1. Adding products manually-2. Importing products with CSV-3. Inviting vendors (3rd party products)Please refer to the respective articles for more information on each method of adding products.-<Note>Inviting 3rd party vendors to your marketplace is only available in the Spree Enterprise Edition.</Note>+<Note>+ Inviting 3rd party vendors to your marketplace is only available in the Spree Enterprise Edition.+</Note>## Set customer support emailThe next task is a simple one, but it plays a very important role.-<img alt="Add Customer Support Email" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.6_Getting_Started_-_Add_Customer_Support_Email_ahnei4.png" />+<img+ alt="Add Customer Support Email"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.6_Getting_Started_-_Add_Customer_Support_Email_ahnei4.png"+/>You need to add a customer support email to display on your storefront. This email serves as a contact point for your customers to reach out to you if they have any queries or require support.@@ -67,7 +91,11 @@ Simply type in the email address you’d like to use and click save.The last task to complete in the Getting Started is setting up taxes collection.-<img alt="Setup Taxes Collection" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.7_Getting_Started_-_Setup_Taxes_Collection_nwt1zn.png" />+<img+ alt="Setup Taxes Collection"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.7_Getting_Started_-_Setup_Taxes_Collection_nwt1zn.png"+/>Follow the link in the description and you’ll be redirected to the Tax section of Settings.@@ -79,11 +107,19 @@ To allow customers to actually place orders, there must be shipping methods avaiYou can add shipping methods by navigating to the Shipping section in Settings.-<img alt="Shipping Methods" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.8_Getting_Started_-_Shipping_Methods_ailaai.png" />+<img+ alt="Shipping Methods"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.8_Getting_Started_-_Shipping_Methods_ailaai.png"+/>To add a new shipping method, click the blue button in the top right corner. This will open to shipping method editor.-<img alt="Add A Shipping Method" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.9_Getting_Started_-_Add_A_Shipping_Method_wf4ajh.png" />+<img+ alt="Add A Shipping Method"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.9_Getting_Started_-_Add_A_Shipping_Method_wf4ajh.png"+/>Here you can configure the settings of the shipping method, such as the shipping zones, calculator and costs, and estimated delivery time.@@ -103,37 +139,65 @@ The Storefront tab of the admin dashboard, found under Channels & Apps, containsThis is where you can modify the layout and look and feel of your storefront.-<img alt="Theme" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.10_Getting_Started_-_Theme_nmwoh4.png" />+<img+ alt="Theme"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.10_Getting_Started_-_Theme_nmwoh4.png"+/>#### View StoreTo view the live storefront, click on the View Store button on the top right corner. If you haven’t modified the theme at all, you’ll see what is essentially a blank slate with a few default page sections, and perhaps some products if you’ve made them Active.-<img alt="View_Store" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.11_Getting_Started_-_View_Store_jynqgp.png" />+<img+ alt="View_Store"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.11_Getting_Started_-_View_Store_jynqgp.png"+/>With a little investment of your time, you can turn this into something presentable, shoppable, and on-brand without the need to hire developers (or even designers if it’s an MVP).-<img alt="Styled Store on Spree" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.12_Getting_Started_-_Modified_Store_tfdwxm.png" />+<img+ alt="Styled Store on Spree"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.12_Getting_Started_-_Modified_Store_tfdwxm.png"+/>#### Connect Your Own DomainAt the top of the Theme section, you’ll notice a prompt to connect your own domain. Clicking on this will lead you to the Domains section of Settings where you can connect your domains and subdomains.-<img alt="Connect Your own Domain" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.13_Getting_Started_-_Connect_Your_own_Domain_ay8q1s.png" />+<img+ alt="Connect Your own Domain"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.13_Getting_Started_-_Connect_Your_own_Domain_ay8q1s.png"+/>#### Theme EditorTo edit the store’s default Theme, simply click on it or click the three dots on the left and select Edit.-<img alt="Theme Editor" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.14_Getting_Started_-_Theme_Editor_qxfbsu.png" />+<img+ alt="Theme Editor"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.14_Getting_Started_-_Theme_Editor_qxfbsu.png"+/>This will open the visual page builder UI that allows you to easily add or modify page sections, upload visual media, and change color schemes and fonts.-<img alt="Drag & Drop Visual Page Builder Composer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.15_Getting_Started_-_Page_Builder_c63a2a.png" />+<img+ alt="Drag & Drop Visual Page Builder Composer"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.15_Getting_Started_-_Page_Builder_c63a2a.png"+/>Themes are mobily-reponsive, and you can switch between views by clicking on the mobile or desktop icons in the top right corner.-<img alt="Page Builder Mobile View" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.16_Getting_Started_-_Page_Builder_Mobile_View_qbmdp9.png" />+<img+ alt="Page Builder Mobile View"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.16_Getting_Started_-_Page_Builder_Mobile_View_qbmdp9.png"+/>Important: Whenever you make changes to the storefront, it’s important to publish them before backing out of the page builder otherwise all progress will be lost. To publish changes, click the blue button in the top right corner.@@ -145,35 +209,63 @@ For a comprehensive guide to using the page builder, please refer to a separateThis where you can add static pages to your store, such as About Us, Contact Us, landing pages, etc.-<img alt="Content Pages" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.17_Getting_Started_-_Pages_didkze.png" />+<img+ alt="Content Pages"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.17_Getting_Started_-_Pages_didkze.png"+/>To add a new page, simply click on the blue button in the top right corner, give the page a name, edit the SEO settings, and then click Create at the bottom of the page.-<img alt="Add A New Page" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.18_Getting_Started_-_Add_A_New_Page_mmht9c.png" />+<img+ alt="Add A New Page"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.18_Getting_Started_-_Add_A_New_Page_mmht9c.png"+/>After creating the page, you’ll be redirected to the page builder where you can configure the layout and insert content for the new page.-<img alt="Publish New Page" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.19_Getting_Started_-_Publish_New_Page_huxsg6.png" />+<img+ alt="Publish New Page"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.19_Getting_Started_-_Publish_New_Page_huxsg6.png"+/>Once you’re finished, click Publish and the new page will be added to your store.-<img alt="New Page Added" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.20_Getting_Started_-_New_Page_Added_z5zikq.png" />+<img+ alt="New Page Added"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.20_Getting_Started_-_New_Page_Added_z5zikq.png"+/>You can edit pages at any time by simpling clicking on them, and you can delete the page by navigating to Page Settings at the top left of the page builder, and clicking Delete.-<img alt="Delete A Page" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327028/docs/Getting%20Started/1.21_Getting_Started_-_Delete_A_Page_nydiix.png" />+<img+ alt="Delete A Page"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327028/docs/Getting%20Started/1.21_Getting_Started_-_Delete_A_Page_nydiix.png"+/>### PostsHere you can make use of Spree’s built-in blog to add blog posts to your store. Adding blog posts to your store is a great way to improve SEO, and the posts themselves can be used for social sharing or ads.-<img alt="Posts" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.22_Getting_Started_-_Posts_axgngz.png" />+<img+ alt="Posts"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.22_Getting_Started_-_Posts_axgngz.png"+/>To add a new post, simply click on the blue button in the top right corner.Note: If you’re using Spree Enterprise Edition, you can import blog posts in bulk from your previous site by uploading a CSV file.-<img alt="Add A New Post" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.23_Getting_Started_-_Add_A_New_Post_kkg1kw.png" />+<img+ alt="Add A New Post"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.23_Getting_Started_-_Add_A_New_Post_kkg1kw.png"+/>This will redirect you to the blog post editor where you can add content, visual media, and modify SEO settings for the new post.@@ -181,19 +273,31 @@ Make sure to add a Published At date, otherwise it won’t appear on the live siOnce you’re done, click Create to add the new blog post to site.-<img alt="Publish New Post" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327028/docs/Getting%20Started/1.24_Getting_Started_-_Publish_New_Post_ee0xos.png" />+<img+ alt="Publish New Post"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327028/docs/Getting%20Started/1.24_Getting_Started_-_Publish_New_Post_ee0xos.png"+/>You can edit old blog posts by simply clicking on them, making changes, and then clicking Update at the bottom of the page.Here’s the new blog post on the storefront:-<img alt="New Post Storefront View" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.25_Getting_Started_-_New_Post_Storefront_View_meloyu.png" />+<img+ alt="New Post Storefront View"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.25_Getting_Started_-_New_Post_Storefront_View_meloyu.png"+/>### Storefront SettingsThis is where you can configure some important settings for the storefront, such as SEO, security, favicon and social sharing images, and social media links.-<img alt="Storefront_Settings" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.26_Getting_Started_-_Storefront_Settings_q94xc6.png" />+<img+ alt="Storefront_Settings"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.26_Getting_Started_-_Storefront_Settings_q94xc6.png"+/>Important: If you want your store to be shown in search engines, make sure to uncheck the box next to “Do not show in search engines” in the SEO section of the settings.@@ -203,11 +307,19 @@ To learn more about Storefront Settings, please refer to a separate support artiIf you’d like to add multiple storefronts with completely different user experiences, product offerings, payment methods, etc., you can easily add a new store by clicking on the store name in the top left corner, and selecting New Store from the dropdown.-<img alt="Add A New Store" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.27_Getting_Started_-_Add_A_New_Store_mrbisv.png" />+<img+ alt="Add A New Store"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.27_Getting_Started_-_Add_A_New_Store_mrbisv.png"+/>The popup that appears will ask you to give the new store a name, select the country and currency, and to select whether or not to import products and payment methods from the original store.-<img alt="Configure New Store Settings" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.28_Getting_Started_-_Configure_New_Store_Settings_p7mwlb.png" />+<img+ alt="Configure New Store Settings"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.28_Getting_Started_-_Configure_New_Store_Settings_p7mwlb.png"+/>To learn more about the multi-store feature, please refer to a separate support article.@@ -217,7 +329,11 @@ The home screen gives you an overview of your stores results over a time periodIt highlights some important sales KPIs and visitor metrics so you can see how business is going at a glance.-<img alt="Home Screen" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.29_Getting_Started_-_Home_Screen_pehjal.png" />+<img+ alt="Home Screen"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.29_Getting_Started_-_Home_Screen_pehjal.png"+/>### Key Sales KPIs@@ -225,27 +341,36 @@ At the top of the page, there’s a chart that depicts some of the key sales KPIYou change the time period by clicking on the date and then selecting the desired dates.-<img alt="Sales KPIs" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.30_Getting_Started_-_Sales_KPIs_pevyhk.png" />+<img+ alt="Sales KPIs"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.30_Getting_Started_-_Sales_KPIs_pevyhk.png"+/>### Top productsBelow the KPIs, you’ll see a section that shows a list of the top selling products, with the option to view the full report.-<img alt="Top_Products" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.31_Getting_Started_-_Top_Products_r37mpk.png" />+<img+ alt="Top_Products"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.31_Getting_Started_-_Top_Products_r37mpk.png"+/>### Visitor DataAt the bottom of the page, there are four sections that provide data on your audience, specifically:-* Referral site--* Top landing pages--* Visitor location--* Visitor devices+- Referral site+- Top landing pages+- Visitor location+- Visitor devices-<img alt="Visitor_Data" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.32_Getting_Started_-_Visitor_Data_pugv5j.png" />+<img+ alt="Visitor_Data"+ classname="block dark:hidden"+ src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.32_Getting_Started_-_Visitor_Data_pugv5j.png"+/>### Google Analyticsdiff --git a/docs/user/vendors/invite-vendor.mdx b/docs/user/vendors/invite-vendor.mdxindex dcf17b8d27..6c949a094c 100644--- a/docs/user/vendors/invite-vendor.mdx+++ b/docs/user/vendors/invite-vendor.mdx@@ -15,7 +15,7 @@ By default, vendors must be invited to start selling on the marketplace. If you'To invite a vendor, navigate to the Vendors tab of the admin dashboard.-<img src="/docs/images/user/vendors/4.1.1InviteAVendor-NavigateToTab.png" />+Here you would usually see a list of all the vendors that have been invited or are already onboarded to the marketplace, but for now it will be blank since you first need to invite some vendors.@@ -23,7 +23,7 @@ Here you would usually see a list of all the vendors that have been invited or aClick on "Invite Vendor" in the top right corner and a popup will appear.-<img src="/docs/images/user/vendors/4.1.2InviteAVendor-InvitePopup.png" />+You must fill in the following fields:@@ -37,11 +37,11 @@ You must fill in the following fields:## Send Invitation-Double check that you've added all of the information correctly, and then click "Sent Invitation".+Double check that you've added all of the information correctly, and then click "Send Invitation".The newly invited vendor will now be added to your list of vendors.-<img src="/docs/images/user/vendors/4.1.3InviteAVendor-InvitationSent.png" />+The vendor will receive an email invitation to the specified email address where they can begin the self-service onboarding process.@@ -51,19 +51,17 @@ If, for some reason, the vendor didn't receive the email, or they prefer to useTo do so, click on the vendor to open up their vendor profile.-<img src="/docs/images/user/vendors/4.1.4InviteAVendor-VendorProfile.png" />+-Click on "More actions" in the top right corner and select "Copy invitation link" from the dropdown menu.+Navigate to the "Invitations" subtab, click the three dots and select "Copy invitation link" from the dropdown menu.-<img src="/docs/images/user/vendors/4.1.5InviteAVendor-CopyInvitationLink.png" />+### Cancel InvitationIf, for whatever reason, you decide to terminate your partnership with the vendor before they start the onboarding process, you can cancel their invitation to block their access to the platform.-Simply click "More actions" in the top right corner of their vendor profile and select "Cancel Invitation" from the dropdown menu.--<img src="/docs/images/user/vendors/4.1.6InviteAVendor-CancelInvitation.png" />+Simply navigate to the "Invitations" subtab as shown previously, click the three dots and select "Delete" from the dropdown menu.## Next Steps