Made in Builder

×

Developers

Product

Use Cases

Pricing

Developers

Resources

Company

Get StartedLogin

Product

Features

Integrations

Talk to an Expert

Pricing

Blog

Home

Resources

Blog

Forum

Github

Login

Signup

×

Visual CMS

Drag-and-drop visual editor and headless CMS for any tech stack

Theme Studio for Shopify

Build and optimize your Shopify-hosted storefront, no coding required

Resources

Blog

Get StartedLogin

Commerce.js E-commerce Plugin

You can use your Commerce.js products and categories within Builder with the Commerce.js e-commerce plugin.

The plugin provides custom types that can be used to:

  • Provide products and categories as inputs for your custom code components.
  • Target content based on products or categories instead of URL paths with hard-coded resource handles or IDs.
  • Preview products and categories on product detail pages and inside of other content while editing.

For a general overview of what you can do with e-commerce plugins and where they fit into your site, you can check out E-commerce Plugins for Builder.

Setup within Commerce.js/Chec

In order to enable the plugin to communicate with Commerce.js, you can copy a preexisting public key from within your Chec account's dashboard or create a new one. This step will provide you with the information needed to complete the plugin setup below.

For more information, check out Commerce.js's Getting Started guide.

Setup within Builder

You can install the plugin from the Integrations page by clicking Enable on the Commerce.js plugin entry.

Afterwards, click Settings to configure the plugin with your Commerce.js account information.

Completing the plugin's setup requires your Chec account's public key.

For more information, check out Setting Up E-commerce Plugins.

Custom types

The Commerce.js plugin provides eight custom types:

  • Commerce.js Product, referred to as CommercejsProduct in code
  • Commerce.js Product Preview (CommercejsProductPreview)
  • Commerce.js Product Handle (CommercejsProductHandle)
  • Commerce.js Products List (CommercejsProductsList)
  • Commerce.js Category (CommercejsCategory)
  • Commerce.js Category Preview (CommercejsCategoryPreview)
  • Commerce.js Category Handle (CommercejsCategoryHandle)
  • Commerce.js Categories List (CommercejsCategoriesList)

Please refer to E-commerce Custom Types for details on the shape of each type's values.

Usage

For more information on how to use the Commerce.js plugin, please refer to our e-commerce plugin docs:

Source code

Check out the Builder GitHub repo for the plugin's source as well as instructions on how to modify or develop it.

Was this article helpful?