B2B Store Theme is a front-end template to help your store get started with VTEX’s core features for businesses selling to other businesses.

⚠️

The B2B Store Theme is not compatible with the B2B Suite solution. Therefore, these instructions do not apply to stores using the B2B Suite. If you are using the B2B Suite, refer to the B2B New Store Theme documentation.

Prerequisites

Set up your development environment

Before starting with the B2B Store Theme setup itself, you must:

  1. Set up a workspace to develop in VTEX IO on your machine.
  2. Follow these instructions to make sure you meet all the prerequisites to develop using Store Framework.
  3. Make sure your store’s catalog is integrated with VTEX Intelligent Search, as described in this article.

Install required B2B apps

Now you must install the required apps listed below. They are mandatory for the B2B Store Theme to work properly.

Wishlist

Wishlist is an app that allows your store’s customers to bookmark their favorite products by clicking on a heart icon.

To install this app on your store, run the following command on the CLI:

vtex install [email protected]

Reviews and Ratings

The Reviews and ratings app enables your clients to submit reviews and ratings — using a star rating system — to your store’s products.

Install it using the command:

vtex install [email protected]

After that, go to your store's Admin to proceed with the installation.

Once you are logged in, follow these steps:

  1. Go to the Account Settings module.
  2. Click on Apps.
  3. Then, click on My apps.
  4. Then, find the Reviews and Ratings app card and click on Settings.
  5. It is recommended that you check the Display stars in product-rating-summary if there are no reviews option and uncheck the Display total reviews number on product-rating-summary block option, as illustrated below.
  6. Click on the Save button.

e683a71-image2e683a71-image2

Quick Order

Quick Order is an app that enables customers to make bulk orders.

To install it, use the following command:

 vtex install [email protected]

Location Availability

The Location Availability app shows product availability and shipping information in the storefront based on the customer’s location, providing a personalized shopping experience.

Install this app on your store using the [email protected] command.

Shopper Location

Shopper Location is a geolocation app. Once it is installed, the app tracks the customer’s location, after permission is granted.

To install it, use the following command:

vtex install [email protected]

Order Quote

Order Quote is an app that allows the B2B customer to save a cart’s information and use it later for any order.

To install it, use the following command:

vtex install [email protected]

Wordpress integration

The Wordpress integration app enables the account admin to create content on your store’s front through Wordpress’ API.

To install this app, run the following command on the CLI:

vtex install [email protected]

Admin Organizations

In brief, the Admin Organizations app is responsible for managing the Roles and Permissions modules on your store’s Admin.

To install it, run vtex install [email protected] on the CLI.

Organizations

The Organizations app allows you to create an organization — a business store — and manage users under that organization with different roles.

Run the command vtex install [email protected] to install it on your store.

Create fields in Master Data

After installing all the required apps, you need to create two new fields in Master Data: isOrgAdmin and organizationId. You must create these fields on the Client entity. To do so, check our step-by-step tutorial on how to create a field on Master Data.

Field nameType
isOrgAdminBoolean
organizationIdVarChar 100

When creating the isOrgAdmin field, you should check the following checkboxes:

  • Make readable without credential
  • Is searchable
  • Is filterable

When creating the organizationId field, you should check the following checkboxes:

  • Is nullable
  • Make readable without credential
  • Allow editing without credential
  • Allow filter without credential
  • Is searchable
  • Is filterable

⚠️

After creating the new fields, it is mandatory to Publish the CL entity and to Reindex it by clicking the buttons illustrated below. Otherwise, the B2B Store Theme will not be applied correctly.

0e71b5a-Group_1_60e71b5a-Group_1_6

Install B2B Easy Setup (optional)

If you are setting up a new store, you can follow the instructions in this guide to quickly set up a test store with sample data using the B2B Easy Setup app.

⚠️

We strongly advise that you do not run Easy Setup on a production environment. It will make irreversible changes and may delete some previous configurations on your store.

Create Master Data schemas

If you have installed B2B Easy Setup and selected Organizations resources, you can skip this step, because the required Master Data schemas will already have been created and you should have all Permissions and Roles ready.

If you have opted not to install B2B Easy Setup, you need to use the Save schema by name endpoint of the Master Data API - V2 to create the following schemas.

BusinessPermission schema

Path paramValue
data_entity_nameBusinessPermission
schema_namebusiness-permission-schema-v1

Request body:

{
    "properties": {
        "name": {
            "type": "string"
        },
        "label": {
            "type": "string"
        }
    },
    "v-default-fields": [
        "name",
        "label",
        "id"
    ],
    "required": [
        "name"
    ],
    "v-indexed": [
        "name"
    ],
    "v-security": {
        "allowGetAll": true,
        "publicRead": [
            "name",
            "label",
            "id"
        ],
        "publicWrite": [
            "name",
            "label"
        ],
        "publicFilter": [
            "name",
            "id"
        ]
    }
}

BusinessRole schema

Path paramValue
data_entity_nameBusinessRole
schema_namebusiness-role-schema-v1

Request body:

{
    "properties": {
        "name": {
            "type": "string"
        },
        "label": {
            "type": "string"
        },
        "permissions": {
            "type": "string"
        }
    },
    "definitions": {
        "permission": {
            "type": "string"
        }
    },
    "v-default-fields": [
        "name",
        "label",
        "id",
        "permissions"
    ],
    "required": [
        "name"
    ],
    "v-indexed": [
        "name"
    ],
    "v-security": {
        "allowGetAll": true,
        "publicRead": [
            "name",
            "label",
            "permissions",
            "id"
        ],
        "publicWrite": [
            "name",
            "label",
            "permissions"
        ],
        "publicFilter": [
            "name",
            "id"
        ]
    }
}

BusinessOrganization schema

Path paramValue
data_entity_nameBusinessOrganization
schema_namebusiness-organization-schema-v1

Request body:

{
    "properties": {
        "name": {
            "type": "string"
        },
        "telephone": {
            "type": "string"
        },
        "address": {
            "type": "string"
        },
        "email": {
            "type": "string"
        }
    },
    "v-default-fields": [
        "name",
        "telephone",
        "id",
        "address",
        "email"
    ],
    "required": [
        "name",
        "telephone"
    ],
    "v-indexed": [
        "name",
        "telephone",
        "email"
    ],
    "v-security": {
        "allowGetAll": true,
        "publicRead": [
            "name",
            "telephone",
            "id",
            "address",
            "email"
        ],
        "publicWrite": [
            "name",
            "telephone",
            "address",
            "email"
        ],
        "publicFilter": [
            "name",
            "telephone",
            "id",
            "email"
        ]
    }
}

UserOrganization schema

Path paramValue
data_entity_nameUserOrganization
schema_nameuser-organization-schema-v1

Request body:

{
    "properties": {
        "email": {
            "type": "string"
        },
        "businessOrganizationId": {
            "type": "string",
            "link": "http://api.vtex.com/{{accountName}}/dataentities/BusinessOrganization/schemas/business-organization-schema-v1"
        },
        "roleId": {
            "type": "string",
            "link": "http://api.vtex.com/{{accountName}}/dataentities/BusinessRole/schemas/business-role-schema-v1"
        },
        "status": {
            "type": "string"
        }
    },
    "v-default-fields": [
        "email",
        "id",
        "businessOrganizationId",
        "roleId",
        "status"
    ],
    "required": [
        "email",
        "businessOrganizationId",
        "roleId",
        "status"
    ],
    "v-indexed": [
        "email",
        "businessOrganizationId",
        "roleId",
        "status"
    ],
    "v-security": {
        "allowGetAll": true,
        "publicRead": [
            "email",
            "id",
            "businessOrganizationId",
            "businessOrganizationId_linked",
            "roleId",
            "roleId_linked",
            "status"
        ],
        "publicWrite": [
            "id",
            "email",
            "businessOrganizationId",
            "roleId",
            "status"
        ],
        "publicFilter": [
            "email",
            "id",
            "businessOrganizationId",
            "roleId",
            "status"
        ]
    },
    "v-triggers": [
        {
            "name": "organization-assignment-accept-email",
            "active": true,
            "condition": "status=APPROVED",
            "action": {
                "type": "email",
                "provider": "default",
                "subject": "Organization Assignment Acceptance",
                "to": [
                    "{!email}"
                ],
                "replyTo": "[email protected]",
                "body": "You have been assigned to {!businessOrganizationId_linked.name}."
            }
        },
        {
            "name": "organization-assignment-decline-email",
            "active": true,
            "condition": "status=DECLINED",
            "action": {
                "type": "email",
                "provider": "default",
                "subject": "Organization Assignment Decline",
                "to": [
                    "{!email}"
                ],
                "replyTo": "[email protected]",
                "body": "You have left the organization {!businessOrganizationId_linked.name}."
            }
        }
    ]
}

Installation

After following the steps above, you are ready to install the B2B Store Theme. You must:

  1. Run the vtex install [email protected] command on the CLI.
  2. Run the vtex browse command to see the B2B Store Theme on your browser.

Finally, your storefront should look like this:

d6eeb9f-image3d6eeb9f-image3

Customization

After installing the B2B Store Theme, you can customize it according to your store’s business needs. Check our guide on Customizing the B2B Store Theme for more information.


Did this page help you?