Skip to content
On this page

Magento 2

This page describes the installation procedure for owners of a Magento store (version 2.x).

Downloads

Click the button below to download the extension for Magento 2.x at the Magento Marketplace.

Install the module

  1. Unzip the extension
  2. Move the contents of this zip to the app/code directory of your Magento 2 installation
  3. Make sure the file structure looks like this: app/code/Spectrum/Colorlab
  4. Run php bin/magento setup:upgrade to install the module

Configure the module

1. Go to our store settings page

  1. Log in to your Magento store
  2. Navigate to Stores - Configuration
  3. Open the Colorlab menu on the left

2. Settings

  1. Enabled: Set to yes to activate our module on your store.
  2. Show thumb in cart: When set to yes the product image in the cart is replaced with an image of the customization.
  3. Shop ID: The Colorlab shop id, you can find this on the settings page in the Colorlab console.
  4. API key: The API key linked to your Colorlab Store, when set all orders containing a customization will be available in the Colorlab console. Contact our support to get your credentials.
  5. API Secret: The secret linked to your API key.
  6. Add To Cart Button Class: Enter a CSS-classname for your add to cart button (defaults to button.tocart which the app will use to change the add to cart button to a customize button)
  7. Add To Cart Button Name: Enter a text for the customize button (defaults to Customize this product)
  8. Change Customization Link Name: Enter a text for the customization link displayed in your shopping cart (defaults to Change customization)

Validate the settings and save your configuration by clicking Save config

Activate for one of your products

In order to activate Colorlab for one of your products, you need to navigate to Catalog - Manage products and add/edit a product.

  • Set the SKU of the product. This is important: The sku of your Magento product needs to be the same as the Template ID in the Colorlab console. If not we're unable to link your product with the correct template.
  • Optionally, enter a Colorlab ID. This value will be used instead of the SKU if it is not empty
  • Choose yes in the Enable Colorlab Customize switcher
  • save the product
  • Visit the product's detail page in your Magento store. The add to cart button should be replaced with the value of the Add To Cart Button Name setting and the app should open when clicking on it.

Contact

Did your Add to cart button not change to a Customize button? Please contact Colorlab using the Colorlab website.