Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Documentation edits made through Mintlify web editor

mintlify[bot]0fa293da9f36
diff --git a/docs/images/integrations/google-analytics/1.get_started.png b/docs/images/integrations/google-analytics/1.get_started.png
new file mode 100644
index 0000000000..fd96f4e9a8
Binary files /dev/null and b/docs/images/integrations/google-analytics/1.get_started.png differ
diff --git a/docs/images/integrations/google-analytics/2.setup_form.png b/docs/images/integrations/google-analytics/2.setup_form.png
new file mode 100644
index 0000000000..b992883c12
Binary files /dev/null and b/docs/images/integrations/google-analytics/2.setup_form.png differ
diff --git a/docs/images/integrations/google-analytics/3.integration_added.png b/docs/images/integrations/google-analytics/3.integration_added.png
new file mode 100644
index 0000000000..568fc47dba
Binary files /dev/null and b/docs/images/integrations/google-analytics/3.integration_added.png differ
diff --git a/docs/images/integrations/stripe/1.get_started.png b/docs/images/integrations/stripe/1.get_started.png
new file mode 100644
index 0000000000..f7823c2162
Binary files /dev/null and b/docs/images/integrations/stripe/1.get_started.png differ
diff --git a/docs/images/integrations/stripe/2.setup_form.png b/docs/images/integrations/stripe/2.setup_form.png
new file mode 100644
index 0000000000..bcd676e89d
Binary files /dev/null and b/docs/images/integrations/stripe/2.setup_form.png differ
diff --git a/docs/images/integrations/stripe/3.stripe_enabled.png b/docs/images/integrations/stripe/3.stripe_enabled.png
new file mode 100644
index 0000000000..82d50b2075
Binary files /dev/null and b/docs/images/integrations/stripe/3.stripe_enabled.png differ
diff --git a/docs/images/integrations/stripe/4.additional_settings.png b/docs/images/integrations/stripe/4.additional_settings.png
new file mode 100644
index 0000000000..077b0a5c75
Binary files /dev/null and b/docs/images/integrations/stripe/4.additional_settings.png differ
diff --git a/docs/integrations/analytics/google-analytics.mdx b/docs/integrations/analytics/google-analytics.mdx
new file mode 100644
index 0000000000..2ebd626e45
--- /dev/null
+++ b/docs/integrations/analytics/google-analytics.mdx
@@ -0,0 +1,75 @@
+---
+title: "Connect Google Analytics to Spree Commerce"
+description: "Learn how to set up and manage Spree’s native Google Analytics integration."
+---
+
+Spree Commerce comes with a native Google Analytics integration that allows you to track user behavior, sales performance, and marketing effectiveness across your store. 
+
+With minimal setup required, you can gain valuable insights into how visitors interact with your site, which can help you make informed decisions to improve conversions, user experience, and overall business strategy.
+
+<Warning>
+ To set up the Google Analytics integration, you must have a Google Analytics account and an associated property.
+</Warning>
+
+## Installation
+
+Before you can enable Stripe, it must be installed. To do so, you need to run the following commands:
+
+- Add this extension to your Gemfile:
+
+```bash
+bundle add spree_google_analytics
+```
+
+- Run the install generator:
+
+```bash
+bundle exec rails g spree_google_analytics:install
+```
+
+After that, make sure to restart your server if it was running.
+
+## Connect Google Analytics
+
+Sign in to your Spree admin dashboard and navigate to the **Integrations** tab.
+
+![](/docs/images/integrations/google-analytics/1.get_started.png)
+
+Locate the Google Analytics tile under Analytics, and click **Connect Google Analytics**.
+
+This will redirect you to the setup page for Google Analytics integration.
+
+![](/docs/images/integrations/google-analytics/2.setup_form.png)
+
+Simply enter the **Measurement ID** from your Google Analytics account into the field and click **Create** to finalize the integration.
+
+<Note>
+ You can find the **Measurement ID** in the Home screen of your Google Analytics dashboard, if no data has been collected yet. Otherwise, it can be found by navigating to Admin settings \> Data Streams and then clicking on the property associated with your Spree site.
+</Note>
+
+![](/docs/images/integrations/google-analytics/3.integration_added.png)
+
+## Event Tracking
+
+By default, the following events will be tracked in Google Analytics:
+
+- page_view
+- first_visit
+- session_start
+- user_engagement
+- search
+- add_payment_info
+- add_shipping_info
+- add_to_cart
+- add_to_wishlist
+- begin_checkout
+- purchase
+- remove_from_cart
+- view_cart
+- view_item
+
+## Manage Your Integration
+
+If you’d like to remove Google Analytics from your site, simply revisit the integration’s setup form and click **Delete** on the lower right hand side.
+
+You can also switch out the Measurement ID if you’d like to switch the Google Analytics property that your site is connected to.
\ No newline at end of file
diff --git a/docs/integrations/payments/stripe.mdx b/docs/integrations/payments/stripe.mdx
index f1e9664636..07fe09085b 100644
--- a/docs/integrations/payments/stripe.mdx
+++ b/docs/integrations/payments/stripe.mdx
@@ -1,65 +1,108 @@
---
-title: Connect Stripe payments to Spree Commerce
-sidebarTitle: Stripe
+title: "Connect Stripe payments to Spree Commerce"
+description: "Learn how to set up and manage Spree's native Stripe integration."
---
-Get paid instantly when someone makes a purchase on your store. Supports all major credit cards, wallets and more.
+Stripe is a widely used payment processor that enables secure and seamless transactions for online businesses. It supports multiple payment methods, automates payouts, and ensures a smooth checkout experience for customers.
-## Features
+In Spree Enterprise Edition, Stripe can also be used to power marketplace payments, enabling automated vendor payouts, split payments, and secure transaction handling.
-- Support for quick checkout using Apple Pay, Google Pay, Stripe Link
-- Support for 3D Secure and other security standards
-- Support for off-session payments
-- Support for Storefront API integration (see the API docs [here](https://spreecommerce.org/docs/api-reference/storefront/stripe)).
-- Accept payments in over 130 currencies
-- Accept Credit Cards, Apple Pay, Google Pay, and more
-- Accept SEPA Direct Debit payments
-- Accept iDEAL payments
-- Accept SOFORT payments
-- Accept Bancontact payments
-- Accept Alipay payments
-- Accept WeChat Pay payments
-- Accept Afterpay, Klarna, Affirm, and more
+<Warning>
+ You must have an existing Stripe account to enable Stripe payments in Spree.
+</Warning>
-## What's new?
+## Installation
-### Installment (BNPL) payments indicator on PDP (Product Detail Page)
+Before you can enable Stripe, it must be installed. To do so, you need to run the following command:
-![Spree_x_Stripe_-_BNPL_Installment_payments_Product_Card_PDP_Product_Detail_Page](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742983146/docs/github/Spree_x_Stripe_-_BNPL_Installment_payments_Product_Card_PDP_Product_Detail_Page_amhfkw.jpg)
+```bash
+bundle add spree_stripe && bundle exec rails spree_stripe:install
+```
-### Quick payment options on the cart (Apple Pay, Google Pay, Link)
+After that, you need to make sure to restart the server.
-![Apple_Pay_Google_Pay_Link_-_Quick_payment_options_on_the_cart](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742930027/docs/github/Spree_x_Stripe_-_Apple_Pay_Google_Pay_Link_-_Quick_payment_options_on_the_cart_aw45x9.jpg)
+## Connect Stripe
-### Quick payments bypassing checkout 1st step (Apple Pay, Google Pay, Link)
+Sign in to your Spree admin dashboard and navigate to **Settings → Payments**.
-![Apple_Pay_Google_Pay_Link_-_Quick_payments_bypassing_checkout](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742930027/docs/github/Spree_x_Stripe_-_Apple_Pay_Google_Pay_Link_-_Quick_payments_bypassing_checkout_on_Cart_n6gbh6.jpg)
+![](/docs/images/integrations/stripe/1.get_started.png)
-### Various payment options on the payment step (cards, BNPL, Apple Pay, Google Pay, Link)
+Find Stripe under Available Payment Methods and click **Add**.
-![Quick payments bypassing checkout 1st step (Apple Pay, Google_Pay, Link)](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742930027/docs/github/Spree_x_Stripe_-_Apple_Pay_Google_Pay_Link_-_Checkout_payment_step_rxxnr9.jpg)
+This will redirect you to the Stripe setup form.
-## Installation
+![](/docs/images/integrations/stripe/2.setup_form.png)
-To install the Stripe integration, you need to run the following command:
+Simply copy and paste the **Publishable Key** and **Secret Key** from your Stripe dashboard into their respective fields and click **Create** to enable Stripe as a payment method on your store.
-```bash
-bundle add spree_stripe && bundle exec rails spree_stripe:install
-```
+<Note>
+ The **Publishable Key** and **Secret Key** can be found in the Get Started section of the Home screen in your Stripe dashboard. Alternatively, they can be found out in **Developers → API Keys**.
+</Note>
-After that, you need to make sure to restart the server.
+![](/docs/images/integrations/stripe/3.stripe_enabled.png)
-## Connect Stripe
+### Additional Settings
+
+![](/docs/images/integrations/stripe/4.additional_settings.png)
+
+You can optionally configure the following settings for your Stripe payment method:
+
+- **Name**: Customize the display name shown for this payment method on the storefront.
+- **Display**: Choose where Stripe should be available:
+ - Storefront only
+ - Admin panel only
+ - Both (recommended)
+- **Auto Capture**: Decide whether payments should be automatically captured at the time of authorization (recommended), or manually captured later.
+- **Active Status**: Enable or disable the payment method. Inactive methods are hidden from checkout but not removed.
+
+### Enable Apple Pay 
+
+To enable Apple Pay (including Apple Pay quick checkout) as a payment method, follow these steps:
+
+1. Find ‘payment method domains’ in your Stripe dashboard
+2. Click ‘Add new domain’ and enter your store’s domain
+3. Click ‘Download file’ and attach it using the ‘Choose file’ button in Spree
+4. Click ‘Update’ at the bottom of the page
+5. Click ‘Verify’ to verify the file was uploaded correctly
+
+### Test Mode
+
+If you'd like to test your checkout flow without processing real payments, Stripe's test mode is a safe and effective way to simulate transactions. To enable it, simply switch your Stripe dashboard to **Test mode** and paste the corresponding **test API keys** into the payment method settings in Spree.
+
+## Features
+
+Spree’s native Stripe integration supports a wide range of features and payment methods to help you offer a fast, secure, and flexible checkout experience:
-Sign in to your Spree admin dashboard and navigate to **Settings -> Payment Methods**.
+- Support for quick checkout using Apple Pay, Google Pay, Stripe Link
+- Support for 3D Secure and other security standards
+- Support for off-session payments
+- Support for Storefront API integration (see the API docs here).
+- Accept payments in over 130 currencies
+- Accept Credit Cards, Apple Pay, Google Pay, and more
+- Accept SEPA Direct Debit payments
+- Accept iDEAL payments
+- Accept SOFORT payments
+- Accept Bancontact payments
+- Accept Alipay payments
+- Accept WeChat Pay payments
+- Accept Afterpay, Klarna, Affirm, and more
+### Storefront Display
-## Enabling Apple Pay
+Spree’s Stripe integration enhances the customer experience with dynamic, context-aware payment options across the storefront:
+- Installment (BNPL) payments indicator on PDP (Product Detail Page)
+ ![Spree_x_Stripe\_-\_BNPL_Installment_payments_Product_Card_PDP_Product_Detail_Page](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742983146/docs/github/Spree_x_Stripe_-_BNPL_Installment_payments_Product_Card_PDP_Product_Detail_Page_amhfkw.jpg)
+- Quick payment options on the cart (Apple Pay, Google Pay, Link)
+ ![Apple_Pay_Google_Pay_Link\_-\_Quick_payment_options_on_the_cart](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742930027/docs/github/Spree_x_Stripe_-_Apple_Pay_Google_Pay_Link_-_Quick_payment_options_on_the_cart_aw45x9.jpg)
+- Quick payments bypassing checkout 1st step (Apple Pay, Google Pay, Link)
+ ![Apple_Pay_Google_Pay_Link\_-\_Quick_payments_bypassing_checkout](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742930027/docs/github/Spree_x_Stripe_-_Apple_Pay_Google_Pay_Link_-_Quick_payments_bypassing_checkout_on_Cart_n6gbh6.jpg)
+- Various payment options on the payment step (cards, BNPL, Apple Pay, Google Pay, Link)
+ ![Quick payments bypassing checkout 1st step (Apple Pay, Google_Pay, Link)](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742930027/docs/github/Spree_x_Stripe_-_Apple_Pay_Google_Pay_Link_-_Checkout_payment_step_rxxnr9.jpg)
## Stripe Connect
-Spree Commerce [Enterprise Edition](https://spreecommerce.org/spree-commerce-version-comparison-community-edition-vs-enterprise-edition/) comes with a fully automated Stripe Connect integration for a [multi-vendor marketplace use case](https://spreecommerce.org/marketplace-ecommerce/):
+Spree Commerce [Enterprise Edition](https://spreecommerce.org/spree-commerce-version-comparison-community-edition-vs-enterprise-edition/) comes with a fully automated Stripe Connect integration for [multi-vendor marketplace use cases](https://spreecommerce.org/marketplace-ecommerce/):
- Automated split payments between marketplace and vendors
- Support for multiple payment methods including cards and digital wallets
@@ -68,4 +111,4 @@ Spree Commerce [Enterprise Edition](https://spreecommerce.org/spree-commerce-ver
- Comprehensive transaction reporting
- Built-in fraud prevention tools
-Feel free to [reach out](https://spreecommerce.org/get-started/) to learn more.
\ No newline at end of file
+Feel free to [reach out](https://spreecommerce.org/get-started/) to learn more.
\ No newline at end of file