Skip to content

Commit 656aec3

Browse files
authored
Merge pull request #1497 from ndeet/shopify-update
Cleanup, improve shopify v2 docs.
2 parents ef6feae + 0371e48 commit 656aec3

3 files changed

+10
-17
lines changed

docs/ShopifyV2.md

+10-17
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Our integration with Shopify allows you to connect your self-hosted BTCPay Serve
2020
- **Community-driven support**: Get responsive assistance from our dedicated community ([Mattermost](http://chat.btcpayserver.org/) or [Telegram](https://t.me/btcpayserver)).
2121

2222
:::warning
23-
This is more simplified of the previous Shopify V2 documentation (available from 30th December 2024 until 23rd February 2025) that required you to deploy the shopify app on a separate VPS. Now the app is deployed directly on your BTCPay Server and the BTCPay Shopify plugin has been changed. Everybody should switch to this setup as it is the only one we will maintain in the future.
23+
This is more simplified version of the previous Shopify V2 documentation (available from 30th December 2024 until 23rd February 2025) that required you to deploy the shopify app on a separate VPS. Now the app is deployed directly on your BTCPay Server and the BTCPay Shopify plugin has been changed. Everybody should switch to this setup as it is the only one we will maintain in the future.
2424
:::
2525

2626
## Prerequisites:
@@ -37,18 +37,7 @@ Before diving into the setup process, ensure you have the following:
3737

3838
## Set up a Shopify app
3939

40-
First, you need to setup a payment method on your [Shopify](https://www.shopify.com/) account.
41-
42-
1. In your Shopify admin page, click on `Settings` > `Payments` in the left sidebar, scroll down to "Manual payment methods", click on `(+) Manual payment method` and select `Create custom payment method` on the dropdown.
43-
2. In `Custom payment method name` fill in `Bitcoin with BTCPay Server`, optionally you can fill in other fields, but it's not required.
44-
3. Hit `Activate` and you've set up a payment method successfully.
45-
46-
:::tip
47-
"Custom Payment method name" **must** contain at least one of the following words (case-insensitive): `bitcoin`, `btcpayserver`, `btcpay server` or `btc` to work.
48-
:::
49-
50-
51-
Next we will create a new app in the Shopify partner portal. Make sure you are registered as a [Shopify partner](https://www.shopify.com/partners) (it's free to register).
40+
First we will create a new app in the Shopify partner portal. Make sure you are registered as a [Shopify partner](https://www.shopify.com/partners) (it's free to register).
5241

5342
1. On Shopify Partner [dashboard](https://partners.shopify.com), click on `Apps` > `All Apps` > `Create App` > `Create app manually`. Enter the name you want to call the app (e.g. BTCPay Server) and click `Create`.
5443
2. Once created displays your "Client ID" and "Client secret", which we need in a minute. Please note them down or come back to this page later.
@@ -139,9 +128,10 @@ Now it's time to install your Shopify app to the Shopify store (which will link
139128
![App install: select custom distribution](./img/shopifyv2/app-deploy_custom-distribution-1.png)
140129
![App install: confirm custom distribution](./img/shopifyv2/app-deploy_distribution-confirm.png)
141130

142-
2. On the next screen enter the Shopify store URL that you want to link the application to. This is typically the internal store url you see on configuring the store, e.g. your-store.myshopify.com.
143-
Make sure to uncheck "Allow multi-store install for one Plus organization"
144-
![App install: enter your store url](./img/shopifyv2/app-deploy_distribution-generate-link.png)
131+
2. On the next screen enter the Shopify store URL that you want to link the application to. This is typically the internal store url you see on configuring the store, e.g. `your-store.myshopify.com`.
132+
![app-deploy_copy-store-url.png](./img/shopifyv2/app-deploy_distribution-copy-store-url.png)
133+
Make sure to uncheck "Allow multi-store install for one Plus organization"
134+
![App install: enter your store url](./img/shopifyv2/app-deploy_distribution-generate-link.png)
145135
3. Click on `Generate link` and you will see a link generated. Copy that link and put it into your browser to start the installation.
146136
![App install: link generated](./img/shopifyv2/app-deploy_distribution-generated-link-copy.png)
147137
4. You will see your app listed and you can now install it by clicking on `Install`. (If you are not logged in you need to log in first)
@@ -173,11 +163,14 @@ Now it's time to install your Shopify app to the Shopify store (which will link
173163

174164
One last step is to set up a custom payment method in Shopify to display the Bitcoin payment option to your customers.
175165

176-
1. Go back to your dashboard, click on `Settings` >> `Payments` in the left sidebar, scroll down to "Manual payment methods", click on `(+) Manual payment method` and select `Create custom payment method` on the dropdown.
166+
1. Go back to your dashboard, click on `Settings` >> `Payments` on the left sidebar, scroll down to "Manual payment methods", click on `(+) Manual payment method` and select `Create custom payment method` on the dropdown.
177167
![Create payment method step 1](./img/shopifyv2/pm_step_1.png)
178168
2. In `Custom payment method name` fill in something like `Pay with Bitcoin (BTCPay Server)` (also see TIP box below), optionally you can fill in other fields, but it's not required.
179169
However, you would need to inform your customers that payment with Bitcoin comes on the next screen after checkout on the "Thank you" page. Ideally you would inform your customers in the `Additional details` field.
180170
The payment option can have a slight delay before it shows on the "Thank you" page, we suggest to communicate that to the customers. Suggested text: `Please note that the Bitcoin payment button "Complete payment" will be displayed on the "Thank you"-page. Please click on it to complete the payment.`
171+
:::tip
172+
"Custom Payment method name" **must** contain at least one of the following words (case-insensitive): `bitcoin`, `btcpayserver`, `btcpay server` or `btc` to work.
173+
:::
181174
3. Hit `Activate` and you've set up Shopify and BTCPay Server payment method successfully.
182175
![Create payment method step 2 and 3](./img/shopifyv2/pm_step_2_and_3.png)
183176

Loading
Loading

0 commit comments

Comments
 (0)