You can use your Elastic Path Product Experience Manager (PXM) products and hierarchies within Builder with the Elastic Path PXM e-commerce plugin.
The plugin provides custom types that can be used to:
- Provide products and hierarchies as inputs for your custom code components.
- Target content based on products or hierarchies instead of URL paths with hard-coded resource handles or IDs.
- Preview products and hierarchies 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.
In order to enable the plugin to communicate with Elastic Path PXM, you can copy your client ID and client secret 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.
You can install the plugin from the Integrations page by clicking Enable on the Elastic Path PXM plugin entry.
Afterwards, click Settings to configure the plugin with your Elastic Path account information.
Completing the plugin setup requires your Elastic Path client ID and client secret, which can be found within Commerce Manager.
For more information, check out Setting Up E-commerce Plugins.
The Elastic Path PXM plugin provides eight custom types:
- ElasticpathPXM Product, referred to as
ElasticpathPCMProduct
in code - ElasticpathPXM Product Preview (
ElasticpathPCMProductPreview
) - ElasticpathPXM Product Handle (
ElasticpathPCMProductHandle
) - ElasticpathPXM Products List (
ElasticpathPCMProductsList
) - ElasticpathPXM Hierarchy (
ElasticpathPCMHierarchy
) - ElasticpathPXM Hierarchy Preview (
ElasticpathPCMHierarchyPreview
) - ElasticpathPXM Hierarchy Handle (
ElasticpathPCMHierarchyHandle
) - ElasticpathPXM Hierarchies List (
ElasticpathPCMHierarchiesList
)
For details on the shape of each type's values, refer to E-commerce Custom Types.
For more information on how to use the Elastic Path PXM plugin, please refer to our e-commerce plugin docs:
Check out the Builder GitHub repo for the plugin's source as well as instructions on how to modify or develop it.