International Enhancements for Multi-Storefront
These features are currently available for Enterprise stores and Partner Sandboxes. If the feature is not working as expected, please contact technical support, as the feature likely needs to be enabled for the individual store. To become an enterprise customer, contact your BigCommerce Customer Service Manager or our support team (opens in a new tab).
International Enhancements for Multi-Storefront allow merchants to deliver localized experiences to fit different shopper needs. You can express product details differently across cultures and countries. For example, when selling products internationally, you can add information for products in various languages. Shoppers can then see key product details in the language of their choice throughout the complete checkout and post-order experience for a personalized shopping experience. This personalized shopping experience helps shoppers find and learn information about a product before purchasing.
The following pages provide sample queries:
- Basic product information
- Product SEO information
- Product variant options
- Product modifier options
- Product URL
- Additional product attributes
- Product custom fields
You can create webhooks that trigger for the following events:
Use cases
To use these features, set product attributes to locales within storefront channels. This update overrides global product attributes. Product attributes you can customize include the product name, description, variant options, modifier options, and SEO settings.
This allows you to perform the following:
- Customize product name and description for culture or language
- Optimize SEO or display product options and variations based on country
- Create additional brands to position the same product to multiple market segments and shopper personas
- Tailor product content for different countries that have different compliance regulations
- Display relevant seasonal or featured products
- Enable two-way syncing of listings data to catalog between channels
GraphQL schema
The catalog features in International Enhancements for MSF are part of the GraphQL Admin API. You can use this GraphQL management API to set and query catalog data for a locale within a channel.
Request URL:
https://api.bigcommerce.com/stores/{{STORE_HASH}}/graphql
Path Parameters:
| Name | Type | Description | Required |
|---|---|---|---|
STORE_HASH | string | Unique ID for a store | Yes |
For a full schema, see the GraphQL Admin API reference (opens in a new tab).
Input fields
Setting or removing information requires that you specify ID fields in the input. These ID fields contain global IDs that you can retrieve from REST API endpoints.
For example, the productId field contains the global product ID. Retrieve the global product ID from the response body of the Get all products endpoint. A product with a global ID of 111 has a productId of "bc/store/product/111".
The following table describes the ID fields that you can use in inputs for mutations:
| Field in Input | Description | Global ID | Example |
|---|---|---|---|
productId | Product ID | Get all products | "bc/store/product/111" |
channelId | Channel ID | Get all channels | "bc/store/channel/2" |
optionId | Variant option ID | Get all product variant options | "bc/store/productOption/108" |
| Shared variant option ID | Navigate to Products >Product Options >OptionName in the control panel. Retrieve the global ID from the URL. | "bc/store/sharedProductOption/1" | |
modifierId | Modifier ID | Get all product modifiers | "bc/store/productModifier/121" |
| Shared modifier ID | Navigate to Products >Product Options >Shared Modifiers >ModifierName in the control panel. Retrieve the global ID from the URL. | "bc/store/sharedProductModifier/2" | |
valueId | Variant option value ID | Get all product variant option values | Product variant options: "bc/store/productOptionValue/68" Shared variant options: "bc/store/sharedProductOptionValue/123" |
| Modifier value ID | Get all modifier values | Product modifiers: "bc/store/productModifierValue/107" Shared modifiers: "bc/store/sharedProductModifierValue/107" | |
customFieldId | ID for a product custom field | Get product custom fields | "bc/store/productCustomField/1" |
Authentication
The GraphQL Admin API works with store-level API accounts.
Authentication header
Your requests should have the following for authentication.
| Header | Argument | Description |
|---|---|---|
X-Auth-Token | access_token | For more about API accounts that generate access_tokens, see API Accounts and OAuth Scopes. |
For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.
OAuth scopes
The API account should have the following OAuth scopes.
| UI Name | Permission | Parameter |
|---|---|---|
| Products | modify | store_v2_products |
| Products | read-only | store_v2_products_read_only |
For more about BigCommerce OAuth scopes, see API Accounts and OAuth Scopes.