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.

[Skip CI] Docs - added intergations tab

Damian Legawiec85e977fac777
diff --git a/docs/developer/customization/quickstart.mdx b/docs/developer/customization/quickstart.mdx
index 3daf1d7f23..9e031f3252 100644
--- a/docs/developer/customization/quickstart.mdx
+++ b/docs/developer/customization/quickstart.mdx
@@ -23,7 +23,7 @@ There are several ways you can achieve this:
<Accordion title="Configuration">
Global application configuration allows you to tweak Spree's behavior without having to modify the source code.
- Please see [Preferences](/developer/core-concepts/preferences) section for more information.
+ Please see [Preferences](/developer/customization/configuration) section for more information.
</Accordion>
<Accordion title="Authentication">
diff --git a/docs/docs.json b/docs/docs.json
index 573e9ce1a9..8d769332ae 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -845,6 +845,29 @@
}
]
},
+ {
+ "tab": "Integrations",
+ "groups": [
+ {
+ "group": "Integrations",
+ "pages": [
+ "integrations/integrations"
+ ]
+ },
+ {
+ "group": "Payments",
+ "pages": [
+ "integrations/payments/stripe"
+ ]
+ },
+ {
+ "group": "Marketing",
+ "pages": [
+ "integrations/marketing/klaviyo"
+ ]
+ }
+ ]
+ },
{
"tab": "User Docs",
"groups": [
@@ -996,8 +1019,7 @@
"developer/core-concepts/promotions",
"developer/core-concepts/shipments",
"developer/core-concepts/addresses",
- "developer/core-concepts/i18n",
- "developer/core-concepts/preferences"
+ "developer/core-concepts/i18n"
]
},
{
diff --git a/docs/images/integrations/logos/klaviyo.png b/docs/images/integrations/logos/klaviyo.png
new file mode 100644
index 0000000000..528dbe1764
Binary files /dev/null and b/docs/images/integrations/logos/klaviyo.png differ
diff --git a/docs/images/integrations/logos/stripe.png b/docs/images/integrations/logos/stripe.png
new file mode 100644
index 0000000000..26b7ce66fb
Binary files /dev/null and b/docs/images/integrations/logos/stripe.png differ
diff --git a/docs/integrations/integrations.mdx b/docs/integrations/integrations.mdx
new file mode 100644
index 0000000000..e8d3709f64
--- /dev/null
+++ b/docs/integrations/integrations.mdx
@@ -0,0 +1,23 @@
+---
+title: "3rd party integrations"
+sidebarTitle: "All Integrations"
+description: "Learn how to connect your Spree Commerce store to third-party services and platforms."
+---
+
+## Payments
+
+<CardGroup>
+ <Card title="Stripe" href="/integrations/payments/stripe" img="/images/integrations/logos/stripe.png">
+ Stripe is a popular payment gateway that allows you to accept payments from your customers. Credit cards, wallets, buy-now-pay-later, installment payments and more.
+ </Card>
+</CardGroup>
+
+## Marketing
+
+<CardGroup>
+ <Card title="Klaviyo" href="/integrations/marketing/klaviyo" img="/images/integrations/logos/klaviyo.png">
+ Klaviyo is a marketing automation platform that allows you to send email campaigns to your customers.
+ </Card>
+</CardGroup>
+
+## Analytics
diff --git a/docs/integrations/marketing/klaviyo.mdx b/docs/integrations/marketing/klaviyo.mdx
index c526001e92..709f92596b 100644
--- a/docs/integrations/marketing/klaviyo.mdx
+++ b/docs/integrations/marketing/klaviyo.mdx
@@ -1,5 +1,6 @@
---
-title: "Klaviyo"
+title: "Connect Klaviyo email marketing platform to Spree Commerce"
+sidebarTitle: Klaviyo
description: "Learn how to set up and manage Spree's native Klaviyo integration."
---
@@ -7,19 +8,29 @@ Klaviyo is a powerful marketing automation platform used for email and SMS campa
With Spree’s native integration, you can start collecting meaningful data for segmentation and automation with just a few clicks.
-<Warning>
+<Info>
You must have an existing Klaviyo account to connect this integration.
-</Warning>
+</Info>
+
+## Installation
+
+To install the Klaviyo integration, you need to run the following command:
-To start using Klaviyo with Spree, navigate to the Integrations tab of the admin dashboard.
+```bash
+bundle add spree_klaviyo && bundle exec rails spree_klaviyo:install
+```
-![](/docs/images/integrations/klaviyo/1.klaviyo.png)
+After that, you need to make sure to restart the server.
## Connect Klaviyo
+Sign in to your Spree admin dashboard and navigate to the Integrations tab.
+
+![](/images/integrations/klaviyo/1.klaviyo.png)
+
To connect Klaviyo, locate the Klaviyo tile under the Marketing section and click Connect Klaviyo to open the setup form.
-![](/docs/images/integrations/klaviyo/2.creation_form.png)
+![](/images/integrations/klaviyo/2.creation_form.png)
You’ll need to enter the following:
@@ -30,19 +41,19 @@ You’ll need to enter the following:
Click **Create** to finalize the integration.
-<Warning>
+<Info>
You must configure your Private API Key in Klaviyo before you can finalize the integration (see below).
-</Warning>
+</Info>
## Configure API Key Permissions in Klaviyo
Before you can finalize the creation of your Klaviyo integration, you’ll need to create a Private API Key. To do so navigate to Settings → Account → API Keys in Klaviyo.
-![](/docs/images/integrations/klaviyo/3.create_private_key.png)
+![](/images/integrations/klaviyo/3.create_private_key.png)
Click Create Private API Key to open the key creation form.
-![](/docs/images/integrations/klaviyo/4.configure_private_key.png)
+![](/images/integrations/klaviyo/4.configure_private_key.png)
When generating your Private API Key in Klaviyo, you must enable specific access scopes for the integration to function properly:
@@ -82,7 +93,7 @@ These events populate the Audience → Profiles section in Klaviyo, where you ca
## Managing Your Integration
-![](/docs/images/integrations/klaviyo/5.manage_integration.png)
+![](/images/integrations/klaviyo/5.manage_integration.png)
After setup, you can revisit the integration form at any time to:
diff --git a/docs/integrations/payments/stripe.mdx b/docs/integrations/payments/stripe.mdx
new file mode 100644
index 0000000000..f1e9664636
--- /dev/null
+++ b/docs/integrations/payments/stripe.mdx
@@ -0,0 +1,71 @@
+---
+title: Connect Stripe payments to Spree Commerce
+sidebarTitle: Stripe
+---
+
+Get paid instantly when someone makes a purchase on your store. Supports all major credit cards, wallets and more.
+
+## Features
+
+- 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
+
+## What's new?
+
+### 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)
+
+## Installation
+
+To install the Stripe integration, you need to run the following command:
+
+```bash
+bundle add spree_stripe && bundle exec rails spree_stripe:install
+```
+
+After that, you need to make sure to restart the server.
+
+## Connect Stripe
+
+Sign in to your Spree admin dashboard and navigate to **Settings -> Payment Methods**.
+
+
+## Enabling Apple Pay
+
+
+## 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/):
+
+- Automated split payments between marketplace and vendors
+- Support for multiple payment methods including cards and digital wallets
+- Configurable marketplace fees and commission structures
+- Automated payouts to vendors
+- 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