Join us for our biggest AI launch event on 10/31

Announcing Visual Copilot - Figma to production in half the time

Builder.io logo
Contact Sales
Platform
Developers
Contact Sales

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

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

The plugin provides custom types that you can use 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 plugins see Overview of Built-in Plugins for Builder.

To get the most out of this document, you should already have an API Client within your Commercetools account. For more information, see the Commercetools documentation, Create an API Client.

  1. Go to the Integrations section of Builder.
  2. On the Commercetools plugin tile, click the Enable button.
  3. Click the Settings to configure the plugin with your Commercetools account information.

The following video demonstrates this process:

Completing the plugin's setup requires the following information from your Commercetools API Client configuration:

  • Project ID
  • Client ID
  • Secret
  • API URL
  • Auth URL
  • Scopes (optional). See About Scopes below.
  • Locale (optional)

The minimum required scope for the plugin to function is view_products:${project name}, where ${project name} is your Commercetools project name.

When creating the API Client in Commercetools, make sure to set the appropriate scopes based on your requirements. Note that scopes cannot be modified after the API Client is created. If you need to change the scopes later, you'll have to delete and recreate the API Client.

For more detail on finding this information within Commercetools and setting the correct scopes, visit the Commercetools documentation, View Your API Client Configuration and Scopes.

The commercetools plugin provides eight custom types:

  • Commercetools Product: CommercetoolsProduct
  • Commercetools Product Preview: CommercetoolsProductPreview
  • Commercetools Product Handle: CommercetoolsProductHandle
  • Commercetools Products List: CommercetoolsProductsList
  • Commercetools Category: CommercetoolsCategory
  • Commercetools Category Preview: CommercetoolsCategoryPreview
  • Commercetools Category Handle: CommercetoolsCategoryHandle
  • Commercetools Categories List: CommercetoolsCategoriesList

For more information on the shape of each type's values, refer to E-commerce Custom Types.

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?

Product

Visual CMS

Theme Studio for Shopify

Sign up

Login

Featured Integrations

React

Angular

Next.js

Gatsby

Get In Touch

Chat With Us

Twitter

Linkedin

Careers

© 2020 Builder.io, Inc.

Security

Privacy Policy

Terms of Service

Newsletter

Get the latest from Builder.io

By submitting, you agree to our Privacy Policy

Product

Platform Overview

Integrations

What's New

Open Source

Builder

Builder

Mitosis

Mitosis

Qwik

Qwik

Partytown

Partytown

Popular Guides

From Design to Code Guide

Composable Commerce Guide

Headless CMS Guide

Headless Commerce Guide

Composable DXP Guide

Design to Code

Resources

Blog

Knowledge Base

Community Forum

Partners

Templates

Success Stories

Showcase

Resource Center

Frameworks

React

React

Next

Next.js

Qwik

Qwik

Gatsby

Gatsby

Angular

Angular

Vue

Vue

Svelte

Svelte

Remix logo

Remix

Nuxt

Nuxt

Hydrogen

Hydrogen

See All

© 2024 Builder.io, Inc.

Security

Privacy Policy

SaaS Terms

Security & Compliance

Cookie Preferences