Skip to content

Commit

Permalink
Merge pull request #4 from vtex-apps/documentation-update
Browse files Browse the repository at this point in the history
Updated README.md and CHANGELOG.md
  • Loading branch information
julia-rabello authored Mar 22, 2022
2 parents a736815 + babdb35 commit 827cc98
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 16 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

### Changed

- Reviewed README.md file

## [0.0.4] - 2022-03-11

### Added
Expand Down
33 changes: 17 additions & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,34 @@
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- DOCS-IGNORE:end -->

The B2B Suite is a collection of apps that add various B2B functionalities to your VTEX IO store. By installing this app, the following dependency apps are automatically installed:
The **B2B Suite** is a collection of VTEX IO apps that allow stores to manage organizations, storefront roles and permissions and checkout settings for B2B commerce relationships.

## B2B Organizations
These capabilities are particularly useful for B2B stores: in commerce relations between businesses, it is essential to simplify the purchase flow, reduce costs, and provide a personalized shopping experience.

An app that allows B2B storefront users to be grouped into buyer organizations and further subdivided into cost centers. Price tables, product collections, and payment methods can then be assigned to an organization so that they are shared by all of its users.
B2B customers frequently have distinct roles within their organization, such as professional buyer, manager, or supervisor. Each role is associated with a different set of storefront permissions, depending on the actions the user needs to perform.

[Further Documentation](https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations)
Grouping different users from the same company under an organization, as well as defining custom payment methods, product selections and prices for each customer, are also common needs in the B2B context.

## Storefront Permissions
In addition, it is often necessary to provide customized options for B2B customers during checkout, such as a specific selection of payment methods per organization or cost center, pre-filled addresses, purchase order numbers, and order quotes.

An app that enables B2B roles to be assigned to users, permissions to be configured for those roles, and those permissions to be checked by other apps.
By installing the **B2B Suite**, you have access to four apps with the following functionalities for the B2B scenario:

[Further Documentation](https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions)

## B2B Checkout Settings
| **App name** | **Description** |
|---|---|
| [Storefront Permissions](https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions) | Stores a predefined set of roles and permissions related to what B2B users can access and do in your storefront, making this information available for other integrated apps to check. This is useful for stores who want to set specific permissions for users with different roles in an organization. |
| [Storefront Permissions UI](https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions-ui) | Provides an interface for the [Storefront Permissions](https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions) app, communicates with its stored roles and permissions and provides the following features for this scenario: <ul><li><b>Roles management:</b> allows VTEX Admin users to manage B2B roles and associated app permissions through an interface.</li> <li><b>Theme blocks configuration:</b> enables conditional theme blocks so that only users with the required permissions can access determined parts of the content in your storefront.</li></ul> |
| [B2B Organizations](https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations) | Enables you to group B2B users into organizations, to which you can assign specific payment methods, price tables, and product collections. This allows all of the organization’s users to share the same commercial conditions. Each organization is further segmented into one or more cost centers, with its own shipping addresses which are available to that cost center's users during checkout. |
| [B2B Checkout Settings](https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-checkout-settings) | Extends the checkout experience for users who are members of B2B organizations. With this app, you can allow specific payment methods for the user’s organization, provide pre-filled addresses based on each user’s cost center, include a purchase order number in the order, and allow customers to create an order quote before making an actual purchase. |
| [B2B Orders History](https://github.com/vtex-apps/b2b-orders-history) | Provides a new **Orders** page under **My Account** so that B2B users can view all prior orders placed by users in their organization or cost center, depending on their role. |
| [Admin Customers](https://developers.vtex.com/vtex-developer-docs/docs/vtex-admin-customers) | Provides additional customer data management capabilities on the VTEX Admin, allowing store administrators to create, edit and search for customers. |

An app that modifies your store's checkout to check the user's permissions as well as show shipping addresses and payment methods appropriate to the user's organization.
Make sure you read each app’s documentation to learn more about their capabilities and configurations.

[Further Documentation](https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-checkout-settings)
> ⚠️ After installing the **B2B Suite**, make sure to hide the default **Order History** link within **My Account** by configuring `vtex.my-account`. Otherwise, **B2B Orders History** will not work as expected. You can do this at `https://{{accountName}}.myvtex.com/admin/apps/vtex.my-account@1.x/setup/`, by unselecting the **Visible** option in the **Orders** section.
## B2B Orders History
For additional functionalities, you can also install the [Quick Order](https://developers.vtex.com/vtex-developer-docs/docs/vtex-quickorder) app, which creates a custom page in your store aimed at purchases in bulk, offering tools such as uploading a spreadsheet to make bulk orders more agile.

An app that provides a new order history page under My Account so that B2B users can view all prior orders placed by their organization or cost center (depending on role).

⚠️ After installing the B2B Suite, make sure to hide the default Order History link within My Account by configuring `vtex.my-account`. This can be done at this URL: `https://{{accountName}}.myvtex.com/admin/apps/vtex.my-account@1.x/setup/`

[Further documentation coming soon]

<!-- DOCS-IGNORE:start -->

Expand Down

0 comments on commit 827cc98

Please sign in to comment.