BigCommerce parameters

After you install the BigCommerce integration, the following parameter types are available. You can use these to incorporate content from BigCommerce into your components and compositions.

BigCommerce product#

This parameter type allows a Uniform user to select a single BigCommerce product.

Add parameter to component#

To allow a user to select a product from BigCommerce, you must add a parameter to a component. The parameter is used to store the identifier to the selected product when the user selects a product.

1. In Uniform, navigate to your component.

2. Add a new parameter using the parameter type BigCommerce Product.

3. The following values can be specified:

   Name	Description
   Required	Indicates whether the value is required when the component is used.

   

   BigCommerce Product parameter configuration.

Edit parameter value#

When you use a component with a BigCommerce Product parameter, by default no product will be selected. You are prompted to select a product.

1. Click Select.

   

2. Click the product you want to select.

   

   About this step

   A couple of filters are available. The dropdown allows you to filter by content type. The text box allows you to filter by product name.

3. Click Accept to save your selection.

   

4. You will see details about the product you selected, including the title and some metadata.

   

   About this step

   After your selection is saved, you are presented with the following options:

   • If you want to edit the selected product in BigCommerce, click Edit.
   • If you want to deselect the product, click Unlink.

Configure an enhancer#

When a product is selected, Uniform only stores the identifier for the product. Your front-end application must retrieve the details for the product. Uniform provides an enhancer to simplify this process.

How Uniform stores the selected product#

The following is an example of what Uniform stores for the parameter.

The product ID is stored as the value.

Add the enhancer#

Uniform provides an enhancer so you don't need to write the API calls to BigCommerce to retrieve data for products.

1. Add the following npm packages to your front-end application:

   @uniformdev/canvas @uniformdev/canvas-bigcommerce

   CopyCopied!

2. In a text editor, open the file where you retrieve the composition definition from Uniform.

   About this step

   You are looking for the code calls the async function getComposition. The code below assumes the object returned is set in a variable composition.

3. Add the following import statements:

   import { EnhancerBuilder, enhance } from '@uniformdev/canvas'; import { createBigCommerceEnhancer, createBigCommerceClient, CANVAS_BIGCOMMERCE_PARAMETER_TYPES, } from '@uniformdev/canvas-bigcommerce';

   CopyCopied!

4. Add the following code:

   const bigCommerceEnhancer = createBigCommerceEnhancer({ client: createBigCommerceClient({ storeHash: "!!! YOUR BIGCOMMERCE STORE HASH !!!", token: "!!! YOUR BIGCOMMERCE API TOKEN !!!", }), createProductOptions: () => { return { // Modify or exclude this property if you want // more fields returned from the BigCommerce API include_fields: ['id', 'name'], }; }, createProductQueryOptions: () => { return { // Modify or exclude this property if you want // more fields returned from the BigCommerce API include_fields: ['id', 'name'], }; }, });

   CopyCopied!

   About this step

   We recommend you moving the BigCommerce credentials to environment variables rather than hard-coding them in the front-end app.

5. Add the following code:

BigCommerce Product List#

This parameter type allows a Uniform user to select multiple BigCommerce products.

Add parameter to component#

To allow a user to select multiple products from BigCommerce, you must add a parameter to a component. The parameter is used to store the identifiers to the selected products when the user selects products.

1. In Uniform, navigate to your component.

2. Add a new parameter using the parameter type BigCommerce Product List.

3. The following values can be specified:

   Name	Description
   Required	Indicates whether the value is required when the component is used.

   

   BigCommerce Product List parameter configuration.

Edit parameter value#

This parameter type works the same way as BigCommerce Product, adding the ability to select multiple products from the list when the parameter value is edited.

Example of the editing interface for a BigCommerce Product List parameter on a component.

Configure an enhancer#

This parameter type uses the same enhancer as the BigCommerce Product parameter type.

BigCommerce Product Query#

This parameter type allows a Uniform user to configure a query that will determine the BigCommerce products that are retrieved.

Add parameter to component#

In order to allow a user to configure a query to determine the products from BigCommerce to retrieve, you must add a parameter to a component. The parameter is used to store the query settings used to perform the search.

1. In Uniform, navigate to your component.

2. Add a new parameter using the parameter type BigCommerce Product Query.

3. The following values can be specified:

   Name	Description
   Required	Indicates whether the value is required when the component is used.

   

   BigCommerce Product Query parameter configuration.

Edit parameter value#

Configuring this parameter type involves specifying the way a product search should work. You are able to control the following search settings:

Example of the editing interface for a BigCommerce Product Query parameter on a component.

Configure an enhancer#

This parameter type uses the same enhancer as the BigCommerce Product parameter type.