Made in Builder

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

Magento E-commerce Plugin

You can use your Magento products and categories within Builder with the Magento 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 Magento

In order to enable the plugin to communicate with Magento, you can copy your store URL from your store's admin panel. This step will provide you with the information needed to complete the plugin setup below.

For more information, check out Magento's documentation.

Setup within Builder

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

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

Completing the plugin setup requires your Magento store URL.

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

Custom types

The Magento plugin provides eight custom types:

  • Magento Product, referred to as MagentoProduct in code
  • Magento Product Preview (MagentoProductPreview)
  • Magento Product Handle (MagentoProductHandle)
  • Magento Products List (MagentoProductsList)
  • Magento Category (MagentoCategory)
  • Magento Category Preview (MagentoCategoryPreview)
  • Magento Category Handle (MagentoCategoryHandle)
  • Magento Categories List (MagentoCategoriesList)

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 Magento 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?