BigCommerce Connector Configuration
Info: This feature in Bloomreach Content requires a standard or premium license. Contact Bloomreach for licensing details.
Overview
The .env file contains the connection settings required to integrate the brX GraphQL Service with BigCommerce. For general instructions, see Configure brX GraphQL Service.
Configuration Options
Configure the following environment variables in your .env file to connect to BigCommerce:
| Property Name (* required) | Description | Example Value(s) | Default Value |
|---|---|---|---|
| BIGCOMMERCE_API_BASE_URL* | Base URL for the BigCommerce Management API. | 'https://api.bigcommerce.com/stores' | |
| BIGCOMMERCE_STORE_KEY* | Store Key (Store Hash) used for BigCommerce Management API requests. | 'fdi08ydn0m' | |
| BIGCOMMERCE_CLIENT_ID | Client ID obtained when creating Store API Credentials. | 'bman1tnrjinwnm9f33eez19b4he179n' | |
| BIGCOMMERCE_API_ACCESS_TOKEN* | Access Token obtained when creating Store API Credentials. | 'h5qz4f87dnbo454qws4pawulst8wbm12' |
Authentication Scope
When creating Store API Credentials, enable the following scopes to ensure the connector can access all required resources:
| Scope GUI Name | Description |
|---|---|
| Orders | View orders /v2/orders |
| Products | View products, brands, categories, and related product information. /v3/catalog |
| Carts | View and modify carts /v3/carts |
| Checkouts | View and modify checkouts /v3/checkouts |
| Customer | View and modify customers and related addresses /v3/customers |
| Wishlists | View and modify wishlists /v3/wishlists |
Recover Customer Password
BigCommerce does not natively support customer password recovery in headless integrations. The brX GraphQL Service provides a compliant solution for the BigCommerce connector, following the OWASP Forgot Password cheatsheet.
To enable password recovery:
- Add the property below to your environment variables.
- Configure an external notification service (such as an email service) to send password reset instructions.
| Property Name | Description | Example Value(s) | Default Value |
|---|---|---|---|
| EMAIL_API_URL | URL of the trusted email service. The service must process requests from the brX GraphQL Service. The request body uses the following structure: json { "customer": { "email": "...", "firstName": "...", "middleName": "...", "lastName": "...", "title": "...", "salutation": "...", "locale": "..." }, "attrs": {...}, "token": "XXX" } | 'EMAIL_SERVICE_ENDPOINT' |
Customer Addresses
BigCommerce does not distinguish between billing and shipping addresses. All addresses are marked as both billing and shipping. BigCommerce also does not support default addresses; the brX GraphQL Service treats the first address in the list as the default.
Wishlist
BigCommerce does not support a "description" field for wishlist entities. Any attempt to update the description is ignored, and the "description" field remains an empty string. BigCommerce also does not support a "quantity" field in wishlist entries. Any attempt to update the quantity is ignored, and the "quantity" field is always set to 1.