Commerce Layer Microstore

The Commerce Layer Microstore application (React) provides you with a production-ready microstore website powered by Commerce Layer APIs. Microstores are self-contained and fully functional hosted stores accessible via a unique URL, which can be embedded into any online or offline (e.g. using a QR code) content. You can fork this repository and deploy it to any hosting service or use it as a reference application to build your own. A hosted version is also available.

What is Commerce Layer?

Commerce Layer is a multi-market commerce API and order management system that lets you add global shopping capabilities to any website, mobile app, chatbot, wearable, voice, or IoT device, with ease. Compose your stack with the best-of-breed tools you already mastered and love. Make any experience shoppable, anywhere, through a blazing-fast, enterprise-grade, and secure API.

Table of contents

• Getting started
• Hosted version
• Contributors guide
• Help and support
• License

---

Getting started

1. Create your organization and get your credentials by following one of our onboarding tutorials.

2. Configure the selfHostedSlug property in /public/config.local.js to match your organization slug (subdomain). If this file does not exist, create it using the following content:

window.clAppConfig = {
  domain: "commercelayer.io",
  selfHostedSlug: "<your-org-slug>",
}

3. Deploy the forked repository to your preferred hosting service.

4. Get an access token for your application. You should generate this in your sales channel or use our JavaScript authentication library.

5. Create one or more SKUs associated with prices and inventories.

6. Create one or more SKU lists, either manual or dynamic using a regular expression. The name and description attributes of the SKU list will be used in the Microstore application as greetings and byline (e.g. "Hi there," and "This is a short selection of products just for you!" in the screenshot above).

7. Open the microstore using the URL format: <your-deployed-microstore-url>/microstore/list/<skuListId>?accessToken=<your-access-token>. For example: https://microstore.yourbrand.com/microstore/list/qkykhjYrGk?accessToken=eyJhbGciOiJIUzUxMiJ9.

Hosted version

Any Commerce Layer account comes with a hosted version of the Microstore application. You can customize it by adding your organization logo, favicon, and primary color.

You can use the hosted version of the Microstore application by building the related URL with the following format: https://<your-organization-subdomain>.commercelayer.app/microstore/list/<skuListId>?accessToken=<your-access-token>.

The default behavior is the Buy Now mode. This means that as soon as customers add a product to the shopping bag they are redirected directly to the Checkout application. If other line items are present in the order, they will be deleted.

URL parameters

Parameter	Description
skuListId	The SKU list ID. You can use the quantity attribute of the SKU list item to add a specific quantity. The default quantity is 1. Microstore will show up to 12 items belonging to the SKU list. The name and description attributes of the SKU list will be used in the Microstore application as greetings and byline.
accessToken	A valid sales channel access token.
all	If true, a Buy All button is activated on top of the products list. This will clear the line items of the order and add all the items listed on the page to the order (with the quantity set in the SKU list items).
cart	If true, the Microstore application will work together with the Cart one.
lang	en (default) or it. The Microstore application will use the language of the lang attribute for the UI and the order will have the attribute language_code set to the same value.

For example: https://yourbrand.commercelayer.app/microstore/list/qkykhjYrGk?accessToken=eyJhbGciOiJIUzUxMiJ9&all=true&lang=it

Cart options

When the Microstore application works in conjunction with the Cart application, we decided to disable the Buy Now mode, so as to avoid removing previous line items from the order on the "Buy now" button click.

Enabling the Cart application will add a behavior option about how the items are added to the shopping bag:

Parameter	Description
inline	If true, when customers click on the "Add to bag" button, they will remain on the page, otherwise they will be redirected immediately to the Cart application. On tablet and desktop devices, selecting the inline option will display the mini cart version of the hosted cart in the right sidebar of the microstore.

For example: https://yourbrand.commercelayer.app/microstore/list/qkykhjYrGk?accessToken=eyJhbGciOiJIUzUxMiJ9&cart=true&inline=true

Any Commerce Layer account comes with a hosted version of the Cart application.

Products with variants

Microstore can also be used to showcase products with variants. Given that Commerce Layer SKUs describe specific product variations that are being sold, we can still follow a convention to group a set of variants under the same product. To do that, we can leverage the reference attribute of the SKU. Each SKU with the same reference will be associated with a single product so that it will be possible to select a specific variant from a dropdown. When a customer changes the value of the dropdown all the information about the selected variant (e.g. image, price, availability, etc.) will be displayed.

Localizations

Please follow this convention to localize your SKUs:

Parameter	Description
microstore_i18n_${lang}_name	The localized name of the SKU.
microstore_i18n_${lang}_description	The localized description of the SKU.

Similarly, you can localize a set of them grouped by product:

Parameter	Description
microstore_i18n_${lang}_reference_name	The localized name of the product.
microstore_i18n_${lang}_reference_description	The localized description of the product.
microstore_i18n_${lang}_name	The localized name of the selected variant.
microstore_i18n_${lang}_description	The localized description of the selected variant.

When the customer adds an item to the cart, the name of the line item displayed on the cart/checkout will be localized (if the translations are available). In the case of a product with variants, the name of the line item will be composed according to the following convention:

microstore_i18n_${lang}_reference_name - microstore_i18n_${lang}_name

Contributors guide

1. Fork this repository (you can learn how to do this here).

2. Clone the forked repository like so:

git clone https://github.com/<your username>/mfe-microstore.git && cd mfe-microstore

3. First, install dependencies and run the development server:

pnpm install
pnpm dev

4. Set your environment with .env.local starting from .env.local.sample.

5. Open http://localhost:3000 with your browser to see the result. You can use the following format to open the Microstore: http://localhost:3000/microstore/list/<skuListId>?accessToken=<your-access-token>.

6. Make your changes and create a pull request (learn how to do this).

7. Someone will attend to your pull request and provide some feedback.

Need help?

1. Join Commerce Layer's Slack community.

2. Create an issue in this repository.

3. Ping us on X.

License

This repository is published under the MIT license.