Skip to content
Skip to main contentWhere does your team stand on AI adoption?
CONTACT SALESSTART BUILDING

Elastic Path V2 E-commerce Plugin

You can use your Elastic Path products and categories within Builder with the Elastic Path V2 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 Elastic Path Commerce Manager

In order to enable the plugin to communicate with Elastic Path, you can copy your client ID from Commerce Manager. This step will provide you with the information needed to complete the plugin setup below.

For more information, check out Elastic Path's documentation.

Setup within Builder

  1. Go to Plugins.
  2. On the Elastic Path v2 plugin tile, click the toggle to enable the plugin.
  3. When the page refreshes, click the Settings button to configure the plugin with your Elastic Path Client id.
  4. When you've added your Elastic Path Client id, click Save.

The following video shows going to the Plugins section of Builder and opening the settings of the Elastic Path v2 tile:

Custom types

The Elastic Path V2 plugin provides eight custom types:

  • Elasticpath Product, referred to as ElasticpathProduct in code
  • Elasticpath Product Preview (ElasticpathProductPreview)
  • Elasticpath Product Handle (ElasticpathProductHandle)
  • Elasticpath Products List (ElasticpathProductsList)
  • Elasticpath Category (ElasticpathCategory)
  • Elasticpath Category Preview (ElasticpathCategoryPreview)
  • Elasticpath Category Handle (ElasticpathCategoryHandle)
  • Elasticpath Categories List (ElasticpathCategoriesList)

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

Usage

For more information on how to use the Elastic Path V2 plugin, read:

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?