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]fb6280d9484b
diff --git a/docs/docs.json b/docs/docs.jsonindex 39e9a2a6d3..870134ee2d 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -909,6 +909,13 @@"user/customers/exporting-customers"]},+ {+ "group": "Vendors",+ "pages": [+ "user/vendors/invite-vendor",+ "user/vendors/vendor-onboarding"+ ]+ },{"group": "Storefront","pages": [@@ -941,6 +948,19 @@"user/storefront/storefront-settings","user/storefront/create-new-store"]+ },+ {+ "group": "Settings",+ "pages": [+ "user/settings/store-details",+ "user/settings/emails",+ "user/settings/policies",+ "user/settings/checkout",+ "user/settings/locations",+ "user/settings/zones",+ "user/settings/shipping-methods",+ "user/settings/tax"+ ]}]}diff --git a/docs/images/user/settings/checkout/1.checkout.png b/docs/images/user/settings/checkout/1.checkout.pngnew file mode 100644index 0000000000..c130ca56b8Binary files /dev/null and b/docs/images/user/settings/checkout/1.checkout.png differdiff --git a/docs/images/user/settings/checkout/2.checkout_message.png b/docs/images/user/settings/checkout/2.checkout_message.pngnew file mode 100644index 0000000000..ddd7984d4cBinary files /dev/null and b/docs/images/user/settings/checkout/2.checkout_message.png differdiff --git a/docs/images/user/settings/checkout/3.storefront_checkout.png b/docs/images/user/settings/checkout/3.storefront_checkout.pngnew file mode 100644index 0000000000..805d0e57e6Binary files /dev/null and b/docs/images/user/settings/checkout/3.storefront_checkout.png differdiff --git a/docs/images/user/settings/checkout/4.guest_checkout.png b/docs/images/user/settings/checkout/4.guest_checkout.pngnew file mode 100644index 0000000000..51d3d7a77fBinary files /dev/null and b/docs/images/user/settings/checkout/4.guest_checkout.png differdiff --git a/docs/images/user/settings/emails/1.Emails.png b/docs/images/user/settings/emails/1.Emails.pngnew file mode 100644index 0000000000..bc939ec895Binary files /dev/null and b/docs/images/user/settings/emails/1.Emails.png differdiff --git a/docs/images/user/settings/emails/2.Logo.png b/docs/images/user/settings/emails/2.Logo.pngnew file mode 100644index 0000000000..5945bb6778Binary files /dev/null and b/docs/images/user/settings/emails/2.Logo.png differdiff --git a/docs/images/user/settings/emails/3.Addresses.png b/docs/images/user/settings/emails/3.Addresses.pngnew file mode 100644index 0000000000..a37b081f67Binary files /dev/null and b/docs/images/user/settings/emails/3.Addresses.png differdiff --git a/docs/images/user/settings/policies/policies.png b/docs/images/user/settings/policies/policies.pngnew file mode 100644index 0000000000..d84643ffd6Binary files /dev/null and b/docs/images/user/settings/policies/policies.png differdiff --git a/docs/images/user/settings/store-details/1.StoreDetails.png b/docs/images/user/settings/store-details/1.StoreDetails.pngnew file mode 100644index 0000000000..af8b2b99ccBinary files /dev/null and b/docs/images/user/settings/store-details/1.StoreDetails.png differdiff --git a/docs/images/user/settings/store-details/2.NameandLogo.png b/docs/images/user/settings/store-details/2.NameandLogo.pngnew file mode 100644index 0000000000..399cc77a81Binary files /dev/null and b/docs/images/user/settings/store-details/2.NameandLogo.png differdiff --git a/docs/images/user/settings/store-details/3.CurrenciesandCountries.png b/docs/images/user/settings/store-details/3.CurrenciesandCountries.pngnew file mode 100644index 0000000000..ad3bc45f8bBinary files /dev/null and b/docs/images/user/settings/store-details/3.CurrenciesandCountries.png differdiff --git a/docs/images/user/settings/store-details/4.Languageandcurrencyselector.png b/docs/images/user/settings/store-details/4.Languageandcurrencyselector.pngnew file mode 100644index 0000000000..455f63cdf4Binary files /dev/null and b/docs/images/user/settings/store-details/4.Languageandcurrencyselector.png differdiff --git a/docs/images/user/settings/store-details/5.StandardsandFormats.png b/docs/images/user/settings/store-details/5.StandardsandFormats.pngnew file mode 100644index 0000000000..bb20dc74e1Binary files /dev/null and b/docs/images/user/settings/store-details/5.StandardsandFormats.png differdiff --git a/docs/images/user/settings/store-details/6.DigitalAssets.png b/docs/images/user/settings/store-details/6.DigitalAssets.pngnew file mode 100644index 0000000000..d6c607f00bBinary files /dev/null and b/docs/images/user/settings/store-details/6.DigitalAssets.png differdiff --git a/docs/images/user/settings/store-details/7.JWTAuthentication.png b/docs/images/user/settings/store-details/7.JWTAuthentication.pngnew file mode 100644index 0000000000..ed3e2ddcb6Binary files /dev/null and b/docs/images/user/settings/store-details/7.JWTAuthentication.png differdiff --git a/docs/images/user/settings/store-details/8.VendorCommissionRates.png b/docs/images/user/settings/store-details/8.VendorCommissionRates.pngnew file mode 100644index 0000000000..ca3c1672edBinary files /dev/null and b/docs/images/user/settings/store-details/8.VendorCommissionRates.png differdiff --git a/docs/images/user/settings/store-details/9.VendorPayouts.png b/docs/images/user/settings/store-details/9.VendorPayouts.pngnew file mode 100644index 0000000000..67cd52468eBinary files /dev/null and b/docs/images/user/settings/store-details/9.VendorPayouts.png differdiff --git a/docs/images/user/settings/tax/1.tax.png b/docs/images/user/settings/tax/1.tax.pngnew file mode 100644index 0000000000..e30314374eBinary files /dev/null and b/docs/images/user/settings/tax/1.tax.png differdiff --git a/docs/images/user/settings/tax/2.tax_subtabs.png b/docs/images/user/settings/tax/2.tax_subtabs.pngnew file mode 100644index 0000000000..a85edc163cBinary files /dev/null and b/docs/images/user/settings/tax/2.tax_subtabs.png differdiff --git a/docs/images/user/settings/tax/3.tax_rates.png b/docs/images/user/settings/tax/3.tax_rates.pngnew file mode 100644index 0000000000..557ab3124bBinary files /dev/null and b/docs/images/user/settings/tax/3.tax_rates.png differdiff --git a/docs/images/user/settings/tax/4.add_new_rate.png b/docs/images/user/settings/tax/4.add_new_rate.pngnew file mode 100644index 0000000000..d77e9fd443Binary files /dev/null and b/docs/images/user/settings/tax/4.add_new_rate.png differdiff --git a/docs/images/user/settings/tax/5.edit_tax_rate.png b/docs/images/user/settings/tax/5.edit_tax_rate.pngnew file mode 100644index 0000000000..29fffae6c8Binary files /dev/null and b/docs/images/user/settings/tax/5.edit_tax_rate.png differdiff --git a/docs/images/user/settings/tax/6.tax_categories.png b/docs/images/user/settings/tax/6.tax_categories.pngnew file mode 100644index 0000000000..7a8c91d657Binary files /dev/null and b/docs/images/user/settings/tax/6.tax_categories.png differdiff --git a/docs/images/user/settings/tax/7.new_tax_category.png b/docs/images/user/settings/tax/7.new_tax_category.pngnew file mode 100644index 0000000000..8e0648c6e3Binary files /dev/null and b/docs/images/user/settings/tax/7.new_tax_category.png differdiff --git a/docs/images/user/settings/tax/8.edit_tax_category.png b/docs/images/user/settings/tax/8.edit_tax_category.pngnew file mode 100644index 0000000000..37dffd2213Binary files /dev/null and b/docs/images/user/settings/tax/8.edit_tax_category.png differdiff --git a/docs/images/user/settings/zones/1.zones.png b/docs/images/user/settings/zones/1.zones.pngnew file mode 100644index 0000000000..19d45428fcBinary files /dev/null and b/docs/images/user/settings/zones/1.zones.png differdiff --git a/docs/images/user/settings/zones/2.add_a_zone.png b/docs/images/user/settings/zones/2.add_a_zone.pngnew file mode 100644index 0000000000..876a71a89cBinary files /dev/null and b/docs/images/user/settings/zones/2.add_a_zone.png differdiff --git a/docs/images/user/settings/zones/3.general_settings.png b/docs/images/user/settings/zones/3.general_settings.pngnew file mode 100644index 0000000000..34cc485d5eBinary files /dev/null and b/docs/images/user/settings/zones/3.general_settings.png differdiff --git a/docs/images/user/settings/zones/4.country_based.png b/docs/images/user/settings/zones/4.country_based.pngnew file mode 100644index 0000000000..f87fe0c9b1Binary files /dev/null and b/docs/images/user/settings/zones/4.country_based.png differdiff --git a/docs/images/user/settings/zones/5.state_based.png b/docs/images/user/settings/zones/5.state_based.pngnew file mode 100644index 0000000000..602bc3282dBinary files /dev/null and b/docs/images/user/settings/zones/5.state_based.png differdiff --git a/docs/images/user/settings/zones/6.edit_zone.png b/docs/images/user/settings/zones/6.edit_zone.pngnew file mode 100644index 0000000000..8c12120cb2Binary files /dev/null and b/docs/images/user/settings/zones/6.edit_zone.png differdiff --git a/docs/images/user/vendors/vendor_onboarding_products.png b/docs/images/user/vendors/vendor_onboarding_products.pngnew file mode 100644index 0000000000..ad551d0d3fBinary files /dev/null and b/docs/images/user/vendors/vendor_onboarding_products.png differdiff --git a/docs/images/user/vendors/vendor_onboarding_shipping.png b/docs/images/user/vendors/vendor_onboarding_shipping.pngnew file mode 100644index 0000000000..d2e303ebc6Binary files /dev/null and b/docs/images/user/vendors/vendor_onboarding_shipping.png differdiff --git a/docs/images/user/vendors/vendor_onboarding_signup.png b/docs/images/user/vendors/vendor_onboarding_signup.pngnew file mode 100644index 0000000000..7384f60326Binary files /dev/null and b/docs/images/user/vendors/vendor_onboarding_signup.png differdiff --git a/docs/images/user/vendors/vendor_onboarding_tasks.png b/docs/images/user/vendors/vendor_onboarding_tasks.pngnew file mode 100644index 0000000000..688823d2fcBinary files /dev/null and b/docs/images/user/vendors/vendor_onboarding_tasks.png differdiff --git a/docs/user/settings/checkout.mdx b/docs/user/settings/checkout.mdxnew file mode 100644index 0000000000..874e3b397e--- /dev/null+++ b/docs/user/settings/checkout.mdx@@ -0,0 +1,34 @@+---+title: "Checkout"+description: "Learn how to add a checkout message and enable or disable guest checkout."+---++In Spree, you can easily modify certain checkout settings directly from the dashboard - no developers needed. This gives you more control over the customer experience and lets you adapt quickly to your store’s needs.++To edit checkout settings, navigate to the Checkout tab of the Settings menu.++<img src="/docs/images/user/settings/checkout/1.checkout.png" />++Here you’ll see two sections that allow you to modify certain aspects of the checkout:++## Checkout Message++<img src="/docs/images/user/settings/checkout/2.checkout_message.png" />++This message appears in the right sidebar during checkout, and can be used to share helpful info, reminders, promos, or reassurance with customers.++You can format the message using the available editor tools (bold, italics, links, headings, etc.).++<img src="/docs/images/user/settings/checkout/3.storefront_checkout.png" />++## Guest Checkout++<img src="/docs/images/user/settings/checkout/4.guest_checkout.png" />++Enable this option to let customers complete their purchase without creating an account or disable it to force users to create an account before purchasing.++<Note>By default this option is always enabled.</Note>++## Saving Changes++After making any updates, click Update at the bottom of the page to save your checkout settings, otherwise any changes you’ve made will not be saved.\ No newline at end of filediff --git a/docs/user/settings/emails.mdx b/docs/user/settings/emails.mdxnew file mode 100644index 0000000000..f5f0fef1e8--- /dev/null+++ b/docs/user/settings/emails.mdx@@ -0,0 +1,32 @@+---+title: "Emails"+description: "Learn to 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.++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:++- **Mail from address**: The email address used as the sender for all outgoing store emails.+- **Customer Support Email**: This will be shown in your store’s footer so customers know how to reach you.+- **New Order Notifications Email**: Want to be notified every time an order is placed? Enter the email address where those alerts should go.++## Saving Changes++After making any updates, click Update at the bottom of the page to save your email settings, otherwise any changes you’ve made will not be saved.\ No newline at end of filediff --git a/docs/user/settings/policies.mdx b/docs/user/settings/policies.mdxnew file mode 100644index 0000000000..037462fb13--- /dev/null+++ b/docs/user/settings/policies.mdx@@ -0,0 +1,40 @@+---+title: "Policies"+description: "In this Spree user doc, you’ll learn how to set your store’s policies."+---++Policies help define the rules of engagement between your store and your customers. They’re not just legal safeguards - they also build trust and set expectations.++All policies added here will appear in your store’s footer and will be available to customers during checkout.++To set up your store policies, navigate to the Policies tab of the Settings menu.++<img src="/docs/images/user/settings/policies/policies.png" />++In each case, simply copy and paste (or type) your policy into the associated text editor. Formatting is usually preserved when pasting, but you can also use the rich text editor tools to adjust the layout or style of your policies as needed.++## Terms of Service++This is a legal agreement between you and your customers. It outlines how your store operates, acceptable use, disclaimers, and liability limitations. Customers must accept it at signup. It's important for protecting your business in the event of disputes.++## Privacy Policy++This explains how customer data is collected, stored, and used. It's a legal requirement in most regions (like GDPR in the EU) and reassures customers that their data is handled responsibly.++## Returns Policy++Clearly states the conditions under which customers can return products. This reduces support queries and helps avoid misunderstandings. A transparent policy can also increase customer confidence and conversion rates.++## Shipping Policy++Provides details about delivery times, methods, and costs. It helps manage customer expectations and avoid frustration caused by delays or unexpected charges.++## Vendor Terms of Service (For marketplaces)++<Warning>The Vendor Terms of Service policy is only available (and relevant) to Spree Enterprise users running marketplaces.</Warning>++If you’re running a multi-vendor marketplace, this sets the rules vendors must agree to in order to sell on your platform. It could cover commission structure, responsibilities, content standards, and any platform-specific rules. This is essential for keeping vendor operations consistent and enforceable.++## Saving Changes++After making any updates, click Update at the bottom of the page to save your policy settings, otherwise any changes you’ve made will not be saved.\ No newline at end of filediff --git a/docs/user/settings/store-details.mdx b/docs/user/settings/store-details.mdxnew file mode 100644index 0000000000..5bda90a588--- /dev/null+++ b/docs/user/settings/store-details.mdx@@ -0,0 +1,98 @@+---+title: "Store Details"+description: "In this Spree user doc, you'll learn how to configure important store settings."+---++The Store Details section allows you to configure key settings that determine how your store is presented to customers and how it operates behind the scenes.++From your store’s name and logo to currency, locale, time zone, and units of measurement, this section is where you define your store’s identity and core operational preferences.++To configure these settings, navigate to the Store Details tab of the Settings menu.++<img src="/docs/images/user/settings/store-details/1.StoreDetails.png" />++## Name & Logo++<img src="/docs/images/user/settings/store-details/2.NameandLogo.png" />++- **Name**: This is the public-facing name of your store. It will appear in headers, footers, and other storefront areas.+- **Logo**: Upload a store logo (recommended size: 240x240 px). This image is used only in the admin dashboard. For the storefront logo see Storefront Themes → Theme Editor.++## Currencies & Countries++<img src="/docs/images/user/settings/store-details/3.CurrenciesandCountries.png" />++If you're running a multi-region store (or operate in a country with multiple languages or currencies) this section lets you configure how prices and languages are displayed to your customers, and allows you to limit the regions you ship to:++- **Default currency**: Choose the primary currency used for your store’s pricing and transactions.+- **Supported currencies**: Select additional currencies, if applicable.+- **Default country**: Set the primary country where your business is based.+- **Shipping zones**: Manage zones to define where products can be shipped.+- **Default locale**: Set the primary language for your storefront.+- **Default locales**: Define additional locales.++<Note>Currencies and languages are selected from predefined lists, whereas Shipping Zones can be configured in the Zones tabs of the Settings menu.</Note>++If you enable multiple locales or currencies, the storefront will automatically display a language and currency selector to your customers.++<img src="/docs/images/user/settings/store-details/4.Languageandcurrencyselector.png" />++## Standards and Formats++<img src="/docs/images/user/settings/store-details/5.StandardsandFormats.png" />++Here you can set the timezone, unit system, and weight units to match your region and business preferences:++- **Timezone**: Set your store’s timezone for accurate timestamps and order data.+- **Unit system**: Choose between imperial and metric. This affects how weights and measures are displayed across your storefront. Options include:+ - Imperial system+ - Metric system+- **Weight unit**: Choose the default unit for product weights. Option include:+ - Pound (lb) - imperial system+ - Ounce (oz) - imperial system+ - Kilogram (kg) - metric system+ - Gram (g) - metric system++## Digital Assets++<img src="/docs/images/user/settings/store-details/6.DigitalAssets.png" />++Here you can control how digital products (e.g., downloads) are handled after purchase:++- **Limit digital links download days**: Set how long download links remain active (in days).+- **Limit digital links download count**: Restrict the number of download attempts per purchase.++## Enterprise-only Features++<Warning>The following features are only available in Spree Enterprise Edition.</Warning>++### JWT Authentication++<img src="/docs/images/user/settings/store-details/7.JWTAuthentication.png" />++JWT (JSON Web Token) authentication allows secure, stateless communication between your store and external services or frontends. It’s commonly used when integrating with custom storefronts, mobile apps, or third-party platforms, ensuring users can be authenticated without relying on server-side sessions.++If your store uses JWT for authentication, specify the JWKS endpoint here. Ensure the URL includes a valid protocol (e.g., https://).++### Vendor Commission Rate++<img src="/docs/images/user/settings/store-details/8.VendorCommissionRates.png" />++Set a default commission percentage that your platform takes from vendor sales. This ensures consistent and automated revenue sharing across your marketplace.++Different commission rates can be set per vendor when inviting them to join your marketplace. See the support article on Invite a Vendor for more details.++### Vendor Payouts++<img src="/docs/images/user/settings/store-details/9.VendorPayouts.png" />++Here you can configure how and when vendors receive their earnings. Depending on your setup, this may involve automatic payouts via Stripe Connect or manual disbursements. The payout schedule can be:++- Daily+- Weekly+- Bi-weekly+- Monthly++## Save Changes++After making any updates, click Update at the bottom of the page to save your store settings, otherwise any changes you’ve made will not be saved.\ No newline at end of filediff --git a/docs/user/settings/tax.mdx b/docs/user/settings/tax.mdxnew file mode 100644index 0000000000..f5fa3865b1--- /dev/null+++ b/docs/user/settings/tax.mdx@@ -0,0 +1,136 @@+---+title: "Tax"+description: "Learn how to configure tax rates and categories for your Spree store."+---++Tax management is critical in eCommerce to ensure legal compliance, avoid costly penalties, and provide accurate pricing for customers across different regions.++Spree gives you a clear and customizable way to set up and manage taxes for any region, product type, or pricing style, whether you include tax in your prices (like VAT) or apply it at checkout (like U.S. sales tax).++To 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+- **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%)+- **Included in Price**: Whether this tax is part of the listed price+- **Show rate in label**: Whether this tax rate appears as part of the price label on the storefront++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>++### Add a New Tax Rate++To 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:++- Name+- Zone (select from existing zones)+- Tax Category (select from existing Tax Categories)+- Amount (e.g., for 5% enter 0.05)+- Included in Price (Yes/No)+- Show Rate in Label (Yes/No)++Once the data has been entered, click Create to save the new tax rate.++This tax rate can now be applied to products with the matching category and shipping to the selected zone.++### Edit a Tax Rate++To 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>++### Delete a Tax Rate++To delete a Tax Rate, simply navigate to the edit form for the Tax Rate you wish to delete, and click the ‘Delete’ button on the lower righthand side.++## 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.++Note: A product variant can be assigned one tax category at a time.++The Tax Categories overview displays all existing tax categories with key information such as:++- **Name**: e.g., Standard, Reduced, Exempt+- **Tax Code**: Optional code for integrations or accounting+- **Description**: Internal notes on what this category covers+- **Default**: Whether this is the default category for new products++From here, you can:++- Add new tax categories+- Edit existing tax categories++### Add a New Tax Category++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:++- Name+- Tax Code (optional)+- Description (optional)+- Default (Yes/No)++Once the data has been entered, click Create to save the new tax category.++This category will now be available for assignment to products and tax rates.++### Edit a Tax Category++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>++### Delete a Tax Category++To delete a tax category, simply navigate to the edit form for the tax category you wish to delete, and click the ‘Delete’ button on the lower righthand side.++## Complex Tax Rules & Integrations++Spree supports tax extensions and API integrations with services like:++- TaxJar+- Avalara+- Custom logic via Spree's extensible tax calculator system++Get in touch with us if you'd like help implementing advanced tax solutions tailored to your business.\ No newline at end of filediff --git a/docs/user/settings/zones.mdx b/docs/user/settings/zones.mdxnew file mode 100644index 0000000000..63b7e3e837--- /dev/null+++ b/docs/user/settings/zones.mdx@@ -0,0 +1,104 @@+---+title: "Zones"+description: "In this Spree user doc, you’ll learn how to create, edit and delete zones."+---++Zones allow you to define and group geographical areas (either by country or state) for greater control over how your store handles tax, shipping, and market settings. They allow you to carefully tailor your operations to specific regions.++To manage Zones, navigate to the Zones tab in the Settings menu.++## Zones Overview++++The Zones overview displays all existing zones with key details like:++- Name (e.g., “Asia”, “US States”, etc.)+- Description (e.g, Countries that make up the EU VAT zone)+- Default Tax Zone (Yes/No)++From here you can:++- Add a new zone+- Edit existing zones++## Add a New Zone++To add a new zone, click ‘New Zone’ in the top right corner, and you’ll be directed to a zone creation form.++++Here you’ll see two sections that allow you to define the new zone:++### General Settings++++Here you can set:++- **Name**: Internal name of the zone (e.g., "US States", "Europe", "Asia")+- **Description**: Optional, used for internal clarification+- **Default Tax Zone**: Toggle if this should be the fallback zone for tax rules+- **Type**: Choose between Country-based or State-based++### Location Selection++This section differs based on the chosen Type:++#### Country-Based++++If you choose the Country-based zone type, you’ll be presented with a multi-select list of countries. Select from options like:++- United States+- Japan+- Poland+- etc.++#### State-Based++++If you choose the State-based zone type, you’ll first be asked to choose a country (e.g., United States). Then, you can select individual states from that country.++For example, if you choose the U.S., the options would include:++- California+- Texas+- New York+- Armed Forces (Africa, Americas, Pacific)+- etc.++<Note>+ You can add multiple states or countries to each zone depending on your needs.+</Note>++## Edit a Zone++To edit a zone, simply click on the zone’s row in the Zones overview.++++The edit form looks more or less identical to the New Zone form, but with pre-filled data, and Update buttons rather than Create buttons.++Here you can:++- Update the name and description+- Change the type (Warning: switching types will reset the current selections, this is irreversible)+- Add/remove Countries or States+- Toggle default tax zone as needed++## Delete a Zone++To delete a zone, simply navigate to the editor for the zone you wish to delete, and click the ‘Delete’ button on the lower righthand side.++## Saving Changes++After making any updates (besides after deleting a zone), make sure to click Create or Update at the bottom of the page to save your zone settings, otherwise any changes you’ve made will not be saved.++## Pro Tips++- Use state-based zones when you need tax/shipping rules for specific U.S. states.+- Use country-based zones for international markets or VAT jurisdictions.+- Only one zone can be the Default Tax Zone.\ No newline at end of filediff --git a/docs/user/vendors/vendor-onboarding.mdx b/docs/user/vendors/vendor-onboarding.mdxindex f16eac21cf..4278de1292 100644--- a/docs/user/vendors/vendor-onboarding.mdx+++ b/docs/user/vendors/vendor-onboarding.mdx@@ -3,9 +3,13 @@ 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>+<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>+<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.@@ -15,67 +19,69 @@ 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>+<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.+Next, you'll need to set up a vendor account with the marketplace. Fill in all fields and click 'Create Account' to continue.-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.+<Note>+ The above screenshot shows the default sign up page. The design, content, and commercial terms may differ.+</Note>## Vendor DashboardOnce 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>+<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>+<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.+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.+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.+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:@@ -89,11 +95,13 @@ Here's a summary of how it works: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>+<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@@ -103,15 +111,15 @@ 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:@@ -129,13 +137,13 @@ As the name suggests, this method requires you to add products manually one-by-oTo 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.@@ -145,17 +153,19 @@ Adding your company's billing address is essential as it is needed for vendor paSimply 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>+<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.@@ -167,13 +177,15 @@ If you're not in charge of the financial responsibilities of your company, you cOnce 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>+<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@@ -181,23 +193,25 @@ Adding a return address as a vendor is important because it ensures customers knSimply 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>+<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:@@ -209,9 +223,11 @@ Whatever the case, please refer to our support article on Shipping Methods to leAfter 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>+<Note>+ You can edit existing shipping methods or add new ones at any time.+</Note>### Add returns policy@@ -219,12 +235,12 @@ Last but not least, you'll need to add a return policy. Adding a return policy aSimply 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!+## 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+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