Skip to content

Commit 441540e

Browse files
authored
Short-term fixes for the Catalyst/B2B guide (#1145)
## What changed? This is a minimal update to the Catalyst/B2B guide, just to correct what is currently inaccurate. This includes: * The appropriate branch to fork * The env var to use for B2B REST API access
1 parent 7174854 commit 441540e

File tree

1 file changed

+6
-7
lines changed
  • docs/storefront/catalyst/development

1 file changed

+6
-7
lines changed

docs/storefront/catalyst/development/b2b.mdx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# B2B Edition
22

33
<Callout type="warning">
4-
The information in this doc is **deprecated**.
4+
Note that the Catalyst/B2B integration is **experimental**.
55

6-
The current integration is experimental, and the code branch `integrations/b2b-buyer-portal` is deprecated. A more robust guide is in development and will be published soon.
6+
A more robust setup/deployment guide is in development.
77
</Callout>
88

99
Following these steps will help you integrate Catalyst with B2B Edition's Open Source Buyer Portal, which is a traditional client-side rendered React application. The steps below also document the process for running the B2B Buyer Portal React application locally, so that you can customize the experience inside of the Buyer Portal if required.
@@ -26,12 +26,11 @@ To create a B2B storefront on the Catalyst platform, you will need the following
2626
- Git and a GitHub account.
2727
- Node.js and PNPM.
2828
- A Vercel account. Using your GitHub account to sign up is recommended for ease.
29-
- A V3 BC API token.
30-
- A V3 B2B API token. You can retrieve this from the B2B control panel under the "API Accounts" tab by clicking "Create API account." Ensure it is a V3 API token.
29+
- A V3 BC API token. Note that this token must be granted the `modify` scope for B2B Edition.
3130

3231
### 1. Using Catalyst CLI
3332

34-
Carefully follow the process at [Manual Installation](/docs/storefront/catalyst/development/manual-installation). Ensure you have met the prerequisites linked at the top of that page. Replace the Catalyst CLI command with: `pnpm create @bigcommerce/catalyst@latest --gh-ref integrations/b2b-buyer-portal`.
33+
Carefully follow the process at [Manual Installation](/docs/storefront/catalyst/development/manual-installation). Ensure you have met the prerequisites linked at the top of that page. Replace the Catalyst CLI command with: `pnpm create @bigcommerce/catalyst@latest --gh-ref integrations/b2b-makeswift`.
3534

3635
Supply a name for your project and answer all subsequent questions. Connect your BigCommerce account and select the target store. Installing sample data is optional.
3736

@@ -57,14 +56,14 @@ Also add the B2B related environment variables:
5756

5857
- B2B_API_HOST: https://api-b2b.bigcommerce.com.
5958
- This is the domain of the B2B API. NOTE: Make sure this value does not have a trailing slash.
60-
- B2B_API_TOKEN: The V3 B2B API token obtained during the preparation step.
59+
- BIGCOMMERCE_ACCESS_TOKEN: The V3 API token obtained during the preparation step.
6160

6261
Once all environment variables are set, we can proceed with deployment.
6362

6463
1. Sign in to your Vercel account. You should be redirected to your projects dashboard.
6564
2. Click on `Add new > Project`.
6665
3. Select the repository you created a fork for. If this is your first time deploying with Vercel, you will need to grant access to one or more repositories. It is recommended to give Vercel access only to specific repositories.
67-
4. In the "New Project" form, ensure the framework preset is set to Next.js and the root directory is core. Make sure the project points to the `integrations/b2b-buyer-portal` branch.
66+
4. In the "New Project" form, ensure the framework preset is set to Next.js and the root directory is core. Make sure the project points to the `integrations/b2b-makeswift` branch.
6867
5. Click `Deploy`.
6968

7069
If you need to redeploy your project, go to `Deployments > Create` deployment and specify the desired branch. You can also configure Vercel to automatically monitor for changes and deploy them by going to `Project -> Settings -> Environments` and selecting the desired branch for tracking.

0 commit comments

Comments
 (0)