BigCommerce Connector Configuration
Introduction
As explained in Configure brX GraphQL Service, the .env file contains the connection settings to integrate with BigCommerce.
Configuration Options
The following options are supported:
| Property Name (* required field) | Description | Example Value(s) | Default Value |
|---|---|---|---|
|
BIGCOMMERCE_API_BASE_URL* |
The Base URL of the BigCommerce Management API. | 'https://api.bigcommerce.com/stores' | |
|
BIGCOMMERCE_STORE_KEY* |
The Store Key, aka Store Hash, used for the BigCommerce Management API requests |
'fdi08ydn0m' | |
|
BIGCOMMERCE_CLIENT_ID |
The Client ID received while creating the Store API Credentials | 'bman1tnrjinwnm9f33eez19b4he179n' | |
|
BIGCOMMERCE_API_ACCESS_TOKEN* |
The Access Token received while creating the Store API Credentials | 'h5qz4f87dnbo454qws4pawulst8wbm12' |
Authentication Scope
It is recommended to enable the following scopes while creating the Store API Credentials:
| Scope GUI Name | Description |
|---|---|
| Orders | View orders |
| /v2/orders | |
| Products | View products, brands, categories and other product information. |
| /v3/catalog | |
| Carts | View and modify carts |
| /v3/carts | |
| Checkouts | View and modify checkouts |
| /v3/checkouts | |
| Customer | View and modify customers and the related addresses |
| /v3/customers | |
| Wishlists | View and modify wishlists |
| /v3/wishlists |
Recover Customer Password
BigCommerce does not support the recover customer password flow in the case of headless integrations. However, the GraphQL Service is able to provide this feature for the BigCommerce connector: this solution is compliant to the OWASP Forgot Password cheatsheet. In case you are interested in supporting the forgot password flow, please add the property described in the table below as part of your environment variables. Moreover, please also ensure to use an external notification service (e.g. email service), responsible for sending the method to reset the customer password.
| Property Name | Description | Example Value(s) | Default Value |
|---|---|---|---|
|
EMAIL_API_URL |
The URL of the trusted email service. The email service implementation (e.g. REST service) must be able to process the request triggered by the brX GraphQL Service. The request body has the following structure: {
"customer": {
"email": "...",
"firstName": "...",
"middleName": "...",
"lastName": "...",
"title": "...",
"salutation": "...",
"locale": "..."
},
"attrs": {...},
"token": "XXX"
}
|
'EMAIL_SERVICE_ENDPOINT' |
Customer Addresses
BigCommerce does not seem to differentiate between Billing and Shipping addresses: for that reason all the addresses are marked both as billing and shipping. Moreover, BigCommerce doesn't seem to handle the concept of default addresses: the GraphQL Service then considers the first address of the list as the default.
Wishlist
BigCommerce does not support "description" field for a wishlist entity; therefore, any description update trials are just ignored. The "description" fields will always be an empty string. BigCommerce does not support "quantity" in a wishlist entry, either; therefore, any quantity update trials are just ignored. The "quantity" fields will always be 1.