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]9c79d780b459
diff --git a/docs/docs.json b/docs/docs.jsonindex f4497085e2..85f02272c7 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -1782,7 +1782,8 @@{"group": "Vendors","pages": [- "user/vendors/invite-vendor"+ "user/vendors/invite-vendor",+ "user/vendors/vendor-onboarding"]},{@@ -1817,6 +1818,13 @@"user/storefront/storefront-settings","user/storefront/create-new-store"]+ },+ {+ "group": "Settings",+ "pages": [+ "user/settings/locations",+ "user/settings/shipping-methods"+ ]}]}diff --git a/docs/images/user/settings/locations/10.13.1Locations-NavigateToTab.png b/docs/images/user/settings/locations/10.13.1Locations-NavigateToTab.pngnew file mode 100644index 0000000000..7317d09d45Binary files /dev/null and b/docs/images/user/settings/locations/10.13.1Locations-NavigateToTab.png differdiff --git a/docs/images/user/settings/locations/10.13.2Locations-CreateaNewLocation.png b/docs/images/user/settings/locations/10.13.2Locations-CreateaNewLocation.pngnew file mode 100644index 0000000000..04a7fc26c3Binary files /dev/null and b/docs/images/user/settings/locations/10.13.2Locations-CreateaNewLocation.png differdiff --git a/docs/images/user/settings/locations/10.13.3Locations-LocationCreated.png b/docs/images/user/settings/locations/10.13.3Locations-LocationCreated.pngnew file mode 100644index 0000000000..d9e25a69f3Binary files /dev/null and b/docs/images/user/settings/locations/10.13.3Locations-LocationCreated.png differdiff --git a/docs/images/user/settings/locations/10.13.4Locations-SetDefaultLocation.png b/docs/images/user/settings/locations/10.13.4Locations-SetDefaultLocation.pngnew file mode 100644index 0000000000..21ff575674Binary files /dev/null and b/docs/images/user/settings/locations/10.13.4Locations-SetDefaultLocation.png differdiff --git a/docs/images/user/settings/locations/10.13.5Locations-DeleteLocation.png b/docs/images/user/settings/locations/10.13.5Locations-DeleteLocation.pngnew file mode 100644index 0000000000..59a1779f06Binary files /dev/null and b/docs/images/user/settings/locations/10.13.5Locations-DeleteLocation.png differdiff --git a/docs/images/user/settings/locations/10.13.6Locations-LocationDeleted.png b/docs/images/user/settings/locations/10.13.6Locations-LocationDeleted.pngnew file mode 100644index 0000000000..7320921426Binary files /dev/null and b/docs/images/user/settings/locations/10.13.6Locations-LocationDeleted.png differdiff --git a/docs/images/user/settings/shipping/10.10.1.10Shipping-MethodCreated.png b/docs/images/user/settings/shipping/10.10.1.10Shipping-MethodCreated.pngnew file mode 100644index 0000000000..eeca9eda7cBinary files /dev/null and b/docs/images/user/settings/shipping/10.10.1.10Shipping-MethodCreated.png differdiff --git a/docs/images/user/settings/shipping/10.10.1.1Shipping-NavigateToTab.png b/docs/images/user/settings/shipping/10.10.1.1Shipping-NavigateToTab.pngnew file mode 100644index 0000000000..98ed9aca4eBinary files /dev/null and b/docs/images/user/settings/shipping/10.10.1.1Shipping-NavigateToTab.png differdiff --git a/docs/images/user/settings/shipping/10.10.1.2Shipping-AddANewShippingMethod.png b/docs/images/user/settings/shipping/10.10.1.2Shipping-AddANewShippingMethod.pngnew file mode 100644index 0000000000..3b1ef2c67bBinary files /dev/null and b/docs/images/user/settings/shipping/10.10.1.2Shipping-AddANewShippingMethod.png differdiff --git a/docs/images/user/settings/shipping/10.10.1.3Shipping-Presentation.png b/docs/images/user/settings/shipping/10.10.1.3Shipping-Presentation.pngnew file mode 100644index 0000000000..6069d5a8caBinary files /dev/null and b/docs/images/user/settings/shipping/10.10.1.3Shipping-Presentation.png differdiff --git a/docs/images/user/settings/shipping/10.10.1.4Shipping-TrackingURL.png b/docs/images/user/settings/shipping/10.10.1.4Shipping-TrackingURL.pngnew file mode 100644index 0000000000..2f861b319fBinary files /dev/null and b/docs/images/user/settings/shipping/10.10.1.4Shipping-TrackingURL.png differdiff --git a/docs/images/user/settings/shipping/10.10.1.5Shipping-Zones.png b/docs/images/user/settings/shipping/10.10.1.5Shipping-Zones.pngnew file mode 100644index 0000000000..202faa43a3Binary files /dev/null and b/docs/images/user/settings/shipping/10.10.1.5Shipping-Zones.png differdiff --git a/docs/images/user/settings/shipping/10.10.1.6Shipping-ShippingCategories.png b/docs/images/user/settings/shipping/10.10.1.6Shipping-ShippingCategories.pngnew file mode 100644index 0000000000..49cb7b9b2aBinary files /dev/null and b/docs/images/user/settings/shipping/10.10.1.6Shipping-ShippingCategories.png differdiff --git a/docs/images/user/settings/shipping/10.10.1.7Shipping-TaxCategory.png b/docs/images/user/settings/shipping/10.10.1.7Shipping-TaxCategory.pngnew file mode 100644index 0000000000..101377a415Binary files /dev/null and b/docs/images/user/settings/shipping/10.10.1.7Shipping-TaxCategory.png differdiff --git a/docs/images/user/settings/shipping/10.10.1.8Shipping-Calculator.png b/docs/images/user/settings/shipping/10.10.1.8Shipping-Calculator.pngnew file mode 100644index 0000000000..9c2badf476Binary files /dev/null and b/docs/images/user/settings/shipping/10.10.1.8Shipping-Calculator.png differdiff --git a/docs/images/user/settings/shipping/10.10.1.9Shipping-EstimatedTransit.png b/docs/images/user/settings/shipping/10.10.1.9Shipping-EstimatedTransit.pngnew file mode 100644index 0000000000..4f83a9c316Binary files /dev/null and b/docs/images/user/settings/shipping/10.10.1.9Shipping-EstimatedTransit.png differdiff --git a/docs/images/user/vendors/4.2.10VendorOnboarding-WooCommercePopup.png b/docs/images/user/vendors/4.2.10VendorOnboarding-WooCommercePopup.pngnew file mode 100644index 0000000000..ad366169fcBinary files /dev/null and b/docs/images/user/vendors/4.2.10VendorOnboarding-WooCommercePopup.png differdiff --git a/docs/images/user/vendors/4.2.11VendorOnboarding-ApproveAccess.png b/docs/images/user/vendors/4.2.11VendorOnboarding-ApproveAccess.pngnew file mode 100644index 0000000000..792c1c9cc4Binary files /dev/null and b/docs/images/user/vendors/4.2.11VendorOnboarding-ApproveAccess.png differdiff --git a/docs/images/user/vendors/4.2.12VendorOnboarding-WooCommerceConnected.png b/docs/images/user/vendors/4.2.12VendorOnboarding-WooCommerceConnected.pngnew file mode 100644index 0000000000..fb3edcc6feBinary files /dev/null and b/docs/images/user/vendors/4.2.12VendorOnboarding-WooCommerceConnected.png differdiff --git a/docs/images/user/vendors/4.2.13VendorOnboarding-DashboardOnboarding.png b/docs/images/user/vendors/4.2.13VendorOnboarding-DashboardOnboarding.pngnew file mode 100644index 0000000000..b597a596e3Binary files /dev/null and b/docs/images/user/vendors/4.2.13VendorOnboarding-DashboardOnboarding.png differdiff --git a/docs/images/user/vendors/4.2.14VendorOnboarding-StoreCreated.png b/docs/images/user/vendors/4.2.14VendorOnboarding-StoreCreated.pngnew file mode 100644index 0000000000..1cc1759f56Binary files /dev/null and b/docs/images/user/vendors/4.2.14VendorOnboarding-StoreCreated.png differdiff --git a/docs/images/user/vendors/4.2.15VendorOnboarding-Addproducts.png b/docs/images/user/vendors/4.2.15VendorOnboarding-Addproducts.pngnew file mode 100644index 0000000000..ba958b85cdBinary files /dev/null and b/docs/images/user/vendors/4.2.15VendorOnboarding-Addproducts.png differdiff --git a/docs/images/user/vendors/4.2.16VendorOnboarding-AddBillingAddress.png b/docs/images/user/vendors/4.2.16VendorOnboarding-AddBillingAddress.pngnew file mode 100644index 0000000000..4cb25c59a7Binary files /dev/null and b/docs/images/user/vendors/4.2.16VendorOnboarding-AddBillingAddress.png differdiff --git a/docs/images/user/vendors/4.2.17VendorOnboarding-BillingAddressAdded.png b/docs/images/user/vendors/4.2.17VendorOnboarding-BillingAddressAdded.pngnew file mode 100644index 0000000000..7d99fbbdecBinary files /dev/null and b/docs/images/user/vendors/4.2.17VendorOnboarding-BillingAddressAdded.png differdiff --git a/docs/images/user/vendors/4.2.18VendorOnboarding-ConnectStripeAccount.png b/docs/images/user/vendors/4.2.18VendorOnboarding-ConnectStripeAccount.pngnew file mode 100644index 0000000000..f4c6cf27ceBinary files /dev/null and b/docs/images/user/vendors/4.2.18VendorOnboarding-ConnectStripeAccount.png differdiff --git a/docs/images/user/vendors/4.2.19VendorOnboarding-StripeOnboardingComplete.png b/docs/images/user/vendors/4.2.19VendorOnboarding-StripeOnboardingComplete.pngnew file mode 100644index 0000000000..40c5cac323Binary files /dev/null and b/docs/images/user/vendors/4.2.19VendorOnboarding-StripeOnboardingComplete.png differdiff --git a/docs/images/user/vendors/4.2.1VendorOnboarding-EmailInvite.png b/docs/images/user/vendors/4.2.1VendorOnboarding-EmailInvite.pngnew file mode 100644index 0000000000..c9d0a5bfa6Binary files /dev/null and b/docs/images/user/vendors/4.2.1VendorOnboarding-EmailInvite.png differdiff --git a/docs/images/user/vendors/4.2.20VendorOnboarding-CompleteStripeOnboarding.png b/docs/images/user/vendors/4.2.20VendorOnboarding-CompleteStripeOnboarding.pngnew file mode 100644index 0000000000..842cd03152Binary files /dev/null and b/docs/images/user/vendors/4.2.20VendorOnboarding-CompleteStripeOnboarding.png differdiff --git a/docs/images/user/vendors/4.2.21VendorOnboarding-ReturnAddress.png b/docs/images/user/vendors/4.2.21VendorOnboarding-ReturnAddress.pngnew file mode 100644index 0000000000..f2e6cefb2eBinary files /dev/null and b/docs/images/user/vendors/4.2.21VendorOnboarding-ReturnAddress.png differdiff --git a/docs/images/user/vendors/4.2.22VendorOnboarding-ReturnAddressAdded.png b/docs/images/user/vendors/4.2.22VendorOnboarding-ReturnAddressAdded.pngnew file mode 100644index 0000000000..14db63e7cbBinary files /dev/null and b/docs/images/user/vendors/4.2.22VendorOnboarding-ReturnAddressAdded.png differdiff --git a/docs/images/user/vendors/4.2.23VendorOnboarding-SetShippingRates.png b/docs/images/user/vendors/4.2.23VendorOnboarding-SetShippingRates.pngnew file mode 100644index 0000000000..be404f8321Binary files /dev/null and b/docs/images/user/vendors/4.2.23VendorOnboarding-SetShippingRates.png differdiff --git a/docs/images/user/vendors/4.2.24VendorOnboarding-ShippingMethods.png b/docs/images/user/vendors/4.2.24VendorOnboarding-ShippingMethods.pngnew file mode 100644index 0000000000..4e9a734064Binary files /dev/null and b/docs/images/user/vendors/4.2.24VendorOnboarding-ShippingMethods.png differdiff --git a/docs/images/user/vendors/4.2.25VendorOnboarding-ShippingRatesConfirmed.png b/docs/images/user/vendors/4.2.25VendorOnboarding-ShippingRatesConfirmed.pngnew file mode 100644index 0000000000..55f9ef000dBinary files /dev/null and b/docs/images/user/vendors/4.2.25VendorOnboarding-ShippingRatesConfirmed.png differdiff --git a/docs/images/user/vendors/4.2.26VendorOnboarding-ReturnsPolicy.png b/docs/images/user/vendors/4.2.26VendorOnboarding-ReturnsPolicy.pngnew file mode 100644index 0000000000..f3daca65e0Binary files /dev/null and b/docs/images/user/vendors/4.2.26VendorOnboarding-ReturnsPolicy.png differdiff --git a/docs/images/user/vendors/4.2.27VendorOnboarding-ReturnsPolicyAdded.png b/docs/images/user/vendors/4.2.27VendorOnboarding-ReturnsPolicyAdded.pngnew file mode 100644index 0000000000..ebe562e8d1Binary files /dev/null and b/docs/images/user/vendors/4.2.27VendorOnboarding-ReturnsPolicyAdded.png differdiff --git a/docs/images/user/vendors/4.2.2VendorOnboarding-AccountCreation.png b/docs/images/user/vendors/4.2.2VendorOnboarding-AccountCreation.pngnew file mode 100644index 0000000000..c8359755feBinary files /dev/null and b/docs/images/user/vendors/4.2.2VendorOnboarding-AccountCreation.png differdiff --git a/docs/images/user/vendors/4.2.3VendorOnboarding-CommercialTerms.png b/docs/images/user/vendors/4.2.3VendorOnboarding-CommercialTerms.pngnew file mode 100644index 0000000000..5bb113781cBinary files /dev/null and b/docs/images/user/vendors/4.2.3VendorOnboarding-CommercialTerms.png differdiff --git a/docs/images/user/vendors/4.2.4VendorOnboarding-VendorDashboard.png b/docs/images/user/vendors/4.2.4VendorOnboarding-VendorDashboard.pngnew file mode 100644index 0000000000..b3913597f8Binary files /dev/null and b/docs/images/user/vendors/4.2.4VendorOnboarding-VendorDashboard.png differdiff --git a/docs/images/user/vendors/4.2.5VendorOnboarding-ConnectShop.png b/docs/images/user/vendors/4.2.5VendorOnboarding-ConnectShop.pngnew file mode 100644index 0000000000..cafa6cfaccBinary files /dev/null and b/docs/images/user/vendors/4.2.5VendorOnboarding-ConnectShop.png differdiff --git a/docs/images/user/vendors/4.2.6VendorOnboarding-InstallApp.png b/docs/images/user/vendors/4.2.6VendorOnboarding-InstallApp.pngnew file mode 100644index 0000000000..bca577ca09Binary files /dev/null and b/docs/images/user/vendors/4.2.6VendorOnboarding-InstallApp.png differdiff --git a/docs/images/user/vendors/4.2.7VendorOnboarding-SetupScreen.png b/docs/images/user/vendors/4.2.7VendorOnboarding-SetupScreen.pngnew file mode 100644index 0000000000..e13ee8e8ceBinary files /dev/null and b/docs/images/user/vendors/4.2.7VendorOnboarding-SetupScreen.png differdiff --git a/docs/images/user/vendors/4.2.8VendorOnboarding-Synchronization.png b/docs/images/user/vendors/4.2.8VendorOnboarding-Synchronization.pngnew file mode 100644index 0000000000..0693eb5e63Binary files /dev/null and b/docs/images/user/vendors/4.2.8VendorOnboarding-Synchronization.png differdiff --git a/docs/images/user/vendors/4.2.9VendorOnboarding-StoreConnected.png b/docs/images/user/vendors/4.2.9VendorOnboarding-StoreConnected.pngnew file mode 100644index 0000000000..ca21519751Binary files /dev/null and b/docs/images/user/vendors/4.2.9VendorOnboarding-StoreConnected.png differdiff --git a/docs/user/settings/locations.mdx b/docs/user/settings/locations.mdxnew file mode 100644index 0000000000..606fde22d3--- /dev/null+++ b/docs/user/settings/locations.mdx@@ -0,0 +1,46 @@+---+title: "Locations"+description: "In this Spree user doc, you'll learn how to create and manage stock locations."+---++For large businesses with multiple warehouses, the ability to add multiple stock locations is essential for efficiently managing inventory across different regions.++It ensures accurate stock tracking, optimizes order fulfillment, and enables faster shipping by routing orders from the nearest warehouse.++To set up and manage stock locations, navigate to the Locations tab of the Settings menu.++<img src="/docs/images/user/settings/locations/10.13.1Locations-NavigateToTab.png" />++## Add a New Location++To add a new Location, click on the 'New Stock Location' button in the top right corner. This will open the Location creation page.++<img src="/docs/images/user/settings/locations/10.13.2Locations-CreateaNewLocation.png" />++Simply enter a name, the address, and (optionally) a phone number, and click then click the 'Create' button at the bottom of the page to create the Location.++The new Location will now be added to your list of stock locations.++<img src="/docs/images/user/settings/locations/10.13.3Locations-LocationCreated.png" />++## Edit a Location++To edit a Location, simply click the ‘Edit’ button on the right side of the Location’s row, and update the information as necessary.++## Set a Default Location++To set your default Location, click the three dots on the right hand side of the Location’s row and select 'Mark as default' from the menu.++<img src="/docs/images/user/settings/locations/10.13.4Locations-SetDefaultLocation.png" />++## Delete a Location++To delete a Location, click the 'Edit' button on the right side of the Location’s row to open the Location editor, and find the ‘Delete’ button at the bottom of the page.++<img src="/docs/images/user/settings/locations/10.13.5Locations-DeleteLocation.png" />++Click ‘Delete’ and the Location will be removed from your list of stock locations.++<img src="/docs/images/user/settings/locations/10.13.6Locations-LocationDeleted.png" />++Congratulations, you now know how to create, edit, and delete stock locations!\ No newline at end of filediff --git a/docs/user/settings/shipping-methods.mdx b/docs/user/settings/shipping-methods.mdxnew file mode 100644index 0000000000..96b81e1a8e--- /dev/null+++ b/docs/user/settings/shipping-methods.mdx@@ -0,0 +1,111 @@+---+title: "Shipping Methods"+description: "In this Spree user doc, you'll learn how to setup up shipping methods for your store."+---++If you want to run a successful online business, having shipping methods in place is essential. These methods appear at checkout, representing the carriers and services used to deliver your products to customers.++<Warning>+ If you don’t set up at least one shipping method for each region you sell to, customers in those regions won’t be able to complete their checkout.+</Warning>++To set up shipping methods, navigate to the Shipping tab of the admin dashboard, found in Settings menu.++++## Add a New Shipping Method++To add a new shipping method, click 'New Shipping Method’ in the top right corner. This will open the shipping method creation page.++++This page is divided into seven sections, so let’s take a look at each individually.++### Presentation++++Here you can set a descriptive name for the shipping method (e.g., UPS Standard, Fed Ex Next Day), and choose where it should be displayed.++<Warning>+ Make sure the ‘Display on’ setting includes ‘storefront’ if you want customers to see this shipping method on the checkout.+</Warning>++### Tracking URL++++Here you can add the tracking URL format for the shipping carrier that’s associated with the payment method, e.g.:++- [<u>https://www.fedex.com/wtrk/track/?trknbr=:tracking</u>](https://www.fedex.com/wtrk/track/?trknbr=:tracking)+- [<u>https://www.ups.com/track?loc=en_US&tracknum=:tracking</u>](https://www.ups.com/track?loc=en_US&tracknum=:tracking)+- [<u>https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=:tracking</u>](https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=:tracking)++This way, you can simply enter the tracking number when fulfilling an order that’s using the shipping method, and the customer will receive the correct tracking link to track their order.\+\+<Warning>+ Make sure to verify the tracking link format for each shipping carrier you plan on using and test them before going live.+</Warning>+++### Zones++++Even if you sell to multiple regions, not every shipping method should be available in every country. With Zones, you can set regional restrictions to control where each shipping method applies. Simply select the appropriate Zones for each method.++<Note>+ Customers will only see shipping methods that apply to their delivery address based on the assigned Zones.+</Note>++### Shipping Categories++++Shipping Categories allow you to specify which products a shipping method applies to.++For example:++- If you sell digital products, selecting the "Digital" category ensures they bypass the delivery address step at checkout.+- If you offer large or heavy items, creating a "Freight" category helps separate those shipping methods from standard products.++### Tax Category++++Here you can select the tax category that should apply to the shipping method.++Tax categories can impact shipping methods by determining the applicable tax rates based on the type of product being shipped.++Certain tax rules may apply differently to specific product categories, affecting the final shipping cost and compliance with regional tax regulations.++### Calculator++++The calculator section is where you can define the rules for calculating the cost of the shipping method. The calculator types are are follows:++- Flat Percent+- Flat Rate+- Flexible Rate per package item+- Flat Rate per package item+- Price Sack+- Digital Delivery++For a more detailed guide on shipping calculators, please refer to another support article.++### Estimated Transit Business Days++++Here you can set an estimated delivery time that the customer will be able to see on both PDPs and checkout.++While it’s not necessary to add this, estimated delivery times can improve conversions by setting clear expectations, giving customers confidence in when they will receive their order.++### Click Create++Once you’ve configured all of the above settings, all you need to do is click the ‘Create’ button at the bottom of the page to save your new shipping method. It will become immediately available to customers provided the order details match the method’s conditions.++Congratulations, you’ve just created your first shipping method\!++\ No newline at end of filediff --git a/docs/user/vendors/invite-vendor.mdx b/docs/user/vendors/invite-vendor.mdxindex b299cee58a..dcf17b8d27 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:@@ -41,7 +41,7 @@ Double check that you've added all of the information correctly, and then clickThe 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,11 +51,11 @@ 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.-+<img src="/docs/images/user/vendors/4.1.5InviteAVendor-CopyInvitationLink.png" />### Cancel Invitation@@ -63,7 +63,7 @@ If, for whatever reason, you decide to terminate your partnership with the vendoSimply 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" />## Next Stepsdiff --git a/docs/user/vendors/vendor-onboarding.mdx b/docs/user/vendors/vendor-onboarding.mdxnew file mode 100644index 0000000000..f16eac21cf--- /dev/null+++ b/docs/user/vendors/vendor-onboarding.mdx@@ -0,0 +1,230 @@+---+title: "Vendor Onboarding"+description: "In this Spree user doc, you'll learn how to onboard as a vendor to a multivendor marketplace."+---++<Warning>Vendor onboarding is a feature available only in Spree Enterprise Edition.</Warning>++<Note>This guide is intended for vendors, but may also be useful for marketplace owners should they wish to understand the onboarding process more clearly.</Note>++Vendors are the backbone of any marketplace - without them, there is no marketplace. The onboarding process, including product catalog synchronization, must be as simple as possible to avoid deterring potential partners with technical complexity or disrupting their daily operations.++For vendors, connecting to a marketplace couldn't be easier thanks to the guided, self-service vendor onboarding process available in Spree Enterprise Edition.++Here are the steps you should follow to connect with a Spree-powered marketplace.++## Accept Invitation++<img src="/docs/images/user/vendors/4.2.1VendorOnboarding-EmailInvite.png" />++First things first, you should have been sent an email invitation or provided with an invitation link to join the marketplace.++Simply click on the link and you'll be directed to the next step.++<Note>The above screenshot is the default email template. The actual email and content may be quite different.</Note>++## Create an Account++<img src="/docs/images/user/vendors/4.2.2VendorOnboarding-AccountCreation.png" />++Next, you'll need to set up a vendor account with the marketplace. The name and email fields should already be filled, so all you'll need to do is enter a password.++If you'd like to review the commercial terms, click on 'View your commercial terms' to reveal them.++<img src="/docs/images/user/vendors/4.2.3VendorOnboarding-CommercialTerms.png" />++<Note>The above screenshots show the default sign up page. The design, content, and commercial terms may differ.</Note>++Once you've entered a password and reviewed the commercial terms, click 'Create Account' to continue.++## Vendor Dashboard++Once you've created your account, you'll be redirected to your vendor dashboard.++<img src="/docs/images/user/vendors/4.2.4VendorOnboarding-VendorDashboard.png" />++In the 'Getting Started' tab, you'll see six onboarding tasks that need to be completed before you can start selling on the marketplace. Clicking on the tasks will reveal the actions that need to be taken. Let's look at each task in more detail.++<Note>There are six tasks by default, but the marketplace you're joining may have more or less depending on its business model.</Note>++### Connect or Create a Shop++<img src="/docs/images/user/vendors/4.2.5VendorOnboarding-ConnectShop.png" />++The first task, and arguably the most important, is to connect or create a shop.++Right now there are three self-service options available for use (Shopify, WooCommerce, and CSV/admin dashboard) but more will be available in the future.++<Note>Custom integrations can be developed to sync products and inventory if the vendor's store is not running on any of the available platforms. Please reach out to us if you require integration support.</Note>++#### Shopify++If you are running a Shopify store, you'll be glad to know that onboarding is completely automated.++To connect your store to the marketplace, click the 'Shopify' button.++Doing so will redirect you to the Shopify app store with a prompt to install the marketplace's app.++Click 'Install' and you'll be redirected to your Shopify dashboard with another prompt to install the app.++<img src="/docs/images/user/vendors/4.2.6VendorOnboarding-InstallApp.png" />++Click 'Install' again to install the app, and you'll be redirected to the setup screen.++<img src="/docs/images/user/vendors/4.2.7VendorOnboarding-SetupScreen.png" />++Simply click 'Start Setup' and your store will start synchronizing with the marketplace.++<img src="/docs/images/user/vendors/4.2.8VendorOnboarding-Synchronization.png" />++Here's a summary of how it works:++- Active products are synced with the marketplace+- Inventory levels are synced both ways in real-time+- Shipping methods (including prices) are synced with marketplace+- Orders are routed to your Shopify dashboard for fulfillment+- Fulfillment status and shipment tracking is synced with the marketplace+- Future price updates are synced with the marketplace+- Content updates are synced with the marketplace (if not previously edited by the marketplace owner)++Of course, you can select which products you'd like to make available to the marketplace by adding/removing the sales channel to the products.++<Note>Once the app is set up, it's essentially business as usual for Shopify stores - no need to use the Spree vendor dashboard other than for completing the rest of the onboarding steps and accessing payout information or invoices on occasion.</Note>++Navigating back to the vendor dashboard, you'll see that this task is now marked as completed.++<img src="/docs/images/user/vendors/4.2.9VendorOnboarding-StoreConnected.png" />++#### WooCommerce++The WooCommerce store connector works similarly to the Shopify connector by automating important parts of the onboarding process.++To connect your WooCommerce store to the marketplace, click 'WooCommerce'.++Doing so will open a popup that requires you to enter your WooCommerce store's URL.++<img src="/docs/images/user/vendors/4.2.10VendorOnboarding-WooCommercePopup.png" />++Enter the URL, click 'Continue', and you'll be redirected to a page that asks you to approve the marketplace's connection to your store.++<img src="/docs/images/user/vendors/4.2.11VendorOnboarding-ApproveAccess.png" />++Click 'Approve' and you'll be redirected to the vendor dashboard and the task will be marked as complete.++<img src="/docs/images/user/vendors/4.2.12VendorOnboarding-WooCommerceConnected.png" />++Here's a summary of how it works:++- Active products are synced with the marketplace+- Inventory levels are synced both ways in real-time+- Shipping methods (not including prices) are synced with marketplace+- Orders are routed to your WooCommerce dashboard for fulfillment+- Fulfillment status and shipment tracking is synced with the marketplace+- Future price updates are synced with the marketplace+- Content updates are synced with the marketplace (if not previously edited by the marketplace owner)++#### Use CSV and/or Admin dashboard++As the name suggests, this method requires you to add products manually one-by-one or by uploading a product CSV file.++To use this method to add products to the marketplace, click 'Use CSV and/or Admin dashboard' and the task will be checked off.++<img src="/docs/images/user/vendors/4.2.14VendorOnboarding-StoreCreated.png" />++While the task is complete, you'll still need to add products to your store if you want to sell anything on the marketplace.++To do so, navigate to the Products tab of the vendor dashboard.++<img src="/docs/images/user/vendors/4.2.15VendorOnboarding-Addproducts.png" />++Please refer to the Products section of our user docs for guides on how to add products to your vendor account.++### Add billing address++Adding your company's billing address is essential as it is needed for vendor payouts and invoices.++Simply click on the task to reveal the form and enter your company's billing information.++<img src="/docs/images/user/vendors/4.2.16VendorOnboarding-AddBillingAddress.png" />++Fill in all the required fields, click 'Save', and the task will be marked as completed.++<img src="/docs/images/user/vendors/4.2.17VendorOnboarding-BillingAddressAdded.png" />++<Note>If you use the Shopify store connector, your billing address will be automatically imported.</Note>++### Connect Stripe account++<img src="/docs/images/user/vendors/4.2.18VendorOnboarding-ConnectStripeAccount.png" />++Stripe is used to process payments and to send vendor payouts. In order to receive your payouts, you'll need to connect a Stripe account to the marketplace's account.++An existing Stripe account is not required. Clicking on 'Connect your bank account' will lead you through a short Stripe onboarding process which should only take a few minutes.++When an order is placed, you'll receive the money instantly whenever you ship the order.++If you're not in charge of the financial responsibilities of your company, you can invite another team member to complete this task instead.++Once Stripe onboarding is complete, the associated task will be checked off.++<img src="/docs/images/user/vendors/4.2.19VendorOnboarding-StripeOnboardingComplete.png" />++If you've missed any information when submitting your Stripe account, the task will not be marked off and you'll be asked to complete onboarding.++<img src="/docs/images/user/vendors/4.2.20VendorOnboarding-CompleteStripeOnboarding.png" />++<Warning>While Stripe is popular among marketplace platforms, the marketplace you are joining may not use Stripe. However, you will likely still be required to connect a bank account to receive payouts unless they are reconciling them manually.</Warning>++### Add returns address++Adding a return address as a vendor is important because it ensures customers know where to send returns, streamlining the return process and helping maintain a positive customer experience.++Simply click on the task to reveal the form, and enter your company's return address.++<img src="/docs/images/user/vendors/4.2.21VendorOnboarding-ReturnAddress.png" />++Fill in all the required fields, click 'Save', and the task will be marked as completed.++<img src="/docs/images/user/vendors/4.2.22VendorOnboarding-ReturnAddressAdded.png" />++<Note>If you use the Shopify store connector, your billing address will be automatically imported.</Note>++### Set shipping rates++<img src="/docs/images/user/vendors/4.2.23VendorOnboarding-SetShippingRates.png" />++Shipping rates must be set up and confirmed. Otherwise, customers will not be able to order your products.++Click on 'Manage Shipping Rates' and you'll be redirected to 'Shipping Methods' section of the vendor dashboard's Settings menu.++<img src="/docs/images/user/vendors/4.2.24VendorOnboarding-ShippingMethods.png" />++How you completed the first task (Connect or Create a Shop) determines what you'll need to do here:++- If you connected Shopify, your shipping methods and rates will be synced. You'll just need to click 'Confirm Shipping Rates' in the top right corner.+- If you connected WooCommerce, your shipping methods will be synced. You'll need to set the rate of each method, and then click 'Confirm Shipping Rates'.+- If you imported a product CSV, you'll need to add shipping methods and rates, and then click 'Confirm Shipping Rates'.++Whatever the case, please refer to our support article on Shipping Methods to learn how to setup and manage shipping methods.++After confirming the shipping rates, the task will be marked as completed.++<img src="/docs/images/user/vendors/4.2.25VendorOnboarding-ShippingRatesConfirmed.png" />++<Note>You can edit existing shipping methods or add new ones at any time.</Note>++### Add returns policy++Last but not least, you'll need to add a return policy. Adding a return policy as a vendor is important because it builds trust with customers, sets clear expectations, and helps prevent disputes over returns and refunds.++Simply click on the task to reveal the text field.++<img src="/docs/images/user/vendors/4.2.26VendorOnboarding-ReturnsPolicy.png" />++Copy and paste your returns policy into the field, click 'Save' and the task will be completed.++<img src="/docs/images/user/vendors/4.2.27VendorOnboarding-ReturnsPolicyAdded.png" />++## Onboarding Completed!++Congratulations, you have successfully completed the onboarding process. All that's left now is for the marketplace owner to approve your vendor profile, merchandise your products and brand page, and start selling!\ No newline at end of file