Basic Product Information

International Enhancements for Multi-Storefront

This feature is 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.

Using the Catalog features of the Admin API, you can set and query basic product information, for example, product name and description.

You can perform the following:

Set global basic product information for the catalog. Channels inherit these by default.
Create overrides for a channel and channel locale using the overridesForLocale mutation.
Remove overrides for a channel and channel locale. A channel then inherits global values.
Query basic product information, those set at the global level and the overrides.

For a full schema, see the GraphQL Admin API reference.

Input fields

Setting or removing information requires that you specify ID fields in the input. For more information on how to specify ID fields, see Input fields.

Set basic product information at the global level

The following example sets global basic product information for the store, from which channels inherit by default. You can set the product name and description.

Request

Response

Example mutation: Set basic product information at the global level

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/graphql
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 mutation (
7   $input: SetProductBasicInformationInput!
8 ) {
9   product {
10     setProductBasicInformation(input: $input) {
11       product {
12         id
13         basicInformation {
14           name
15           description
16         }
17       }
18     }
19   }
20 }

GraphQL variables

1 {
2   "input": {
3     "productId": "bc/store/product/111",
4     "data": {
5       "name": "Global Name",
6       "description": "Global Description"
7     }
8   }
9 }

Set basic product information for a locale

The following example sets basic product information for the specified storefront channel and locale within the channel. These will override global store information. You can set the product name and description.

Request

Response

Example mutation: Set basic product information for a locale

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/graphql
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 mutation (
7   $input: SetProductBasicInformationInput!
8 ) {
9   product {
10     setProductBasicInformation(input: $input) {
11       product {
12         id
13         overridesForLocale (localeContext: { channelId: "bc/store/channel/2", locale: "en" }) {
14           basicInformation {
15             name
16             description
17           }
18         }
19       }
20     }
21   }
22 }

GraphQL variables

1 {                                           
2   "input": {                                
3     "productId": "bc/store/product/111",    
4     "localeContext": {
5       "channelId": "bc/store/channel/2",      
6       "locale": "fr"
7     },                       
8     "data": {                               
9       "name": "name override",              
10       "description": "description override" 
11     }                                                       
12   }
13 }

Remove basic product information for a locale

The following example removes basic product information for the specified channel and locale.

Omitting the overridesToRemove field from the input removes all overrides for basic product information from the locale.

Request

Response

Example mutation: Remove basic product information for a locale

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/graphql
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 mutation (
7   $input: RemoveProductBasicInformationOverridesInput!
8 ) {
9   product {
10     removeProductBasicInformationOverrides(input: $input) {
11       product {
12         id
13         overridesForLocale (localeContext: { channelId: "bc/store/channel/2", locale: "fr" }) {
14           basicInformation {
15             name
16           }
17         }
18       }
19     }
20   }
21 }

GraphQL variables

1 {                                           
2   "input": {                                
3     "productId": "bc/store/product/111",    
4     "localeContext": {
5       "channelId": "bc/store/channel/2",      
6       "locale": "fr"
7     },
8     "overridesToRemove": ["PRODUCT_NAME_FIELD"]                                                                    
9   }
10 }

Query basic product information

The following example retrieves basic product information. You can retrieve global information for the store and overrides for the specified channel and locale.

Request

Response

Example query: Get basic product information

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/graphql
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 query {
7   store {
8     products (filters: {ids: ["bc/store/product/111"]}) {
9       edges {
10         node {
11           id
12           basicInformation {
13             name
14             description
15           }
16           overridesForLocale (localeContext: { channelId: "bc/store/channel/2", locale: "fr" }) {
17             basicInformation {
18               name
19               description
20             }
21           }
22         }
23       }
24     }
25   }
26 }

The id field contains the product’s global ID that you can retrieve from the Get all products endpoint. For example, a product with a global ID of 111 will have an id of "bc/store/product/111".
The channelId field contains the channel’s global ID that you can retrieve from the Get all channels endpoint. For example, a channel with a global ID of 2 will have a channelId of "bc/store/channel/2".

International Enhancements for Multi-Storefront

Using the Catalog features of the Admin API, you can set and query basic product information, for example, product name and description.

You can perform the following:

Set global basic product information for the catalog. Channels inherit these by default.
Create overrides for a channel and channel locale using the overridesForLocale mutation.
Remove overrides for a channel and channel locale. A channel then inherits global values.
Query basic product information, those set at the global level and the overrides.

For a full schema, see the GraphQL Admin API reference.

Input fields

Setting or removing information requires that you specify ID fields in the input. For more information on how to specify ID fields, see Input fields.

Set basic product information at the global level

The following example sets global basic product information for the store, from which channels inherit by default. You can set the product name and description.

Request

Response

Example mutation: Set basic product information at the global level

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/graphql
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 mutation (
7   $input: SetProductBasicInformationInput!
8 ) {
9   product {
10     setProductBasicInformation(input: $input) {
11       product {
12         id
13         basicInformation {
14           name
15           description
16         }
17       }
18     }
19   }
20 }

GraphQL variables

1 {
2   "input": {
3     "productId": "bc/store/product/111",
4     "data": {
5       "name": "Global Name",
6       "description": "Global Description"
7     }
8   }
9 }

Set basic product information for a locale

Request

Response

Example mutation: Set basic product information for a locale

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/graphql
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 mutation (
7   $input: SetProductBasicInformationInput!
8 ) {
9   product {
10     setProductBasicInformation(input: $input) {
11       product {
12         id
13         overridesForLocale (localeContext: { channelId: "bc/store/channel/2", locale: "en" }) {
14           basicInformation {
15             name
16             description
17           }
18         }
19       }
20     }
21   }
22 }

GraphQL variables

1 {                                           
2   "input": {                                
3     "productId": "bc/store/product/111",    
4     "localeContext": {
5       "channelId": "bc/store/channel/2",      
6       "locale": "fr"
7     },                       
8     "data": {                               
9       "name": "name override",              
10       "description": "description override" 
11     }                                                       
12   }
13 }

Remove basic product information for a locale

The following example removes basic product information for the specified channel and locale.

Omitting the overridesToRemove field from the input removes all overrides for basic product information from the locale.

Request

Response

Example mutation: Remove basic product information for a locale

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/graphql
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 mutation (
7   $input: RemoveProductBasicInformationOverridesInput!
8 ) {
9   product {
10     removeProductBasicInformationOverrides(input: $input) {
11       product {
12         id
13         overridesForLocale (localeContext: { channelId: "bc/store/channel/2", locale: "fr" }) {
14           basicInformation {
15             name
16           }
17         }
18       }
19     }
20   }
21 }

GraphQL variables

1 {                                           
2   "input": {                                
3     "productId": "bc/store/product/111",    
4     "localeContext": {
5       "channelId": "bc/store/channel/2",      
6       "locale": "fr"
7     },
8     "overridesToRemove": ["PRODUCT_NAME_FIELD"]                                                                    
9   }
10 }

Query basic product information

The following example retrieves basic product information. You can retrieve global information for the store and overrides for the specified channel and locale.

Request

Response

Example query: Get basic product information

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/graphql
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 query {
7   store {
8     products (filters: {ids: ["bc/store/product/111"]}) {
9       edges {
10         node {
11           id
12           basicInformation {
13             name
14             description
15           }
16           overridesForLocale (localeContext: { channelId: "bc/store/channel/2", locale: "fr" }) {
17             basicInformation {
18               name
19               description
20             }
21           }
22         }
23       }
24     }
25   }
26 }

The id field contains the product’s global ID that you can retrieve from the Get all products endpoint. For example, a product with a global ID of 111 will have an id of "bc/store/product/111".
The channelId field contains the channel’s global ID that you can retrieve from the Get all channels endpoint. For example, a channel with a global ID of 2 will have a channelId of "bc/store/channel/2".

1	POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/graphql
2	X-Auth-Token: {{ACCESS_TOKEN}}
3	Content-Type: application/json
4	Accept: application/json
5
6	mutation (
7	$input: SetProductBasicInformationInput!
8	) {
9	product {
10	setProductBasicInformation(input: $input) {
11	product {
12	id
13	basicInformation {
14	name
15	description
16	}
17	}
18	}
19	}
20	}

1	{
2	"input": {
3	"productId": "bc/store/product/111",
4	"data": {
5	"name": "Global Name",
6	"description": "Global Description"
7	}
8	}
9	}

1	{
2	"input": {
3	"productId": "bc/store/product/111",
4	"localeContext": {
5	"channelId": "bc/store/channel/2",
6	"locale": "fr"
7	},
8	"data": {
9	"name": "name override",
10	"description": "description override"
11	}
12	}
13	}