Documentation
Feedback
Guides

Store FrameworkB2B setup
Installing B2B Easy Set Up
Use the B2B Easy Set Up to quickly get your store configured for B2B ecommerce.

B2B Easy Set Up is an app that helps you quickly get your store configured for B2B ecommerce.

Installation

  1. Download and install the VTEX IO CLI.
  2. Log in to your account with vtex login {accountName}.
  3. Create a new workspace with vtex use easysetupworkspace.
  4. Install the app on your store with vtex install vtex.easy-setup.

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.

Store configuration

Now that the Easy Setup app is installed in your store, proceed to operate the app on the Admin.

  1. Open your Admin panel and navigate to Store Settings > Easy Setup.

  2. On the right side of the screen, select which resources you want to apply on your store. If you want to configure all the options, select All Resources.

️ If you are using the B2B Suite solution, you must not select the Organizations resource. Otherwise this will alter the user profile Master Data schema and prevent the B2B Suite apps from creating users."

  1. Click on the Start Easy Setup button. {"base64":"  ","img":{"width":1289,"height":798,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":131273,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/installing-b2b-easy-set-up-0.PNG"}}

  2. Click on the I Understand button that will appear in the Are you sure you want to proceed? dialog.

Once you click I Understand, this step is irreversible.

{"base64":"  ","img":{"width":1210,"height":749,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":124185,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/installing-b2b-easy-set-up-1.PNG"}}

Wait a few seconds for the setup to complete.

When the configuration is complete, you will receive a positive feedback on the screen.

{"base64":"  ","img":{"width":1158,"height":719,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":111578,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/installing-b2b-easy-set-up-2.PNG"}}

️ If you get an error message for some of the resources, try again this time only selecting the troublesome resources. If the error persists, contact support.

Check out the Resources section below for details on the sample data used by the app in the initial setup.

Resources

Users

This resource creates some users with priceTables data.

View Sample Data

Brands

This resource creates one brand.

View Sample Data
  • Name: Brand (9280)

Categories

This resource creates seven categories.

View Sample Data
  • Name: Apparel (9281)
  • Name: Food and beverage (9282)
  • Name: Sporting (9283)
  • Name: Agribusiness (9284)
  • Name: Home Appliance (9285)
  • Name: Computer & Software (9286)
  • Name: Power tools (9287)

Collections

This resource creates a collection with all products.

View Sample Data
  • Name: All
  • Type: Inclusive
  • BrandId: 9280 (Brand)

Fields

This resource creates a group with two fields containing a variety of field values for two specifics categories.

View Sample Data
  • Group: Specifications

  • Category: Apparel (9281)
    • Field: Clothes Size
    • Field Values: S, M, L and XL

  • Category: Sporting (9283)
    • Field: Shoes Size
    • Field Values: 8, 8.5, 9, 9.5 and 10

Products

This resource creates an assortment of products and SKUs and sets their specifications, images and attachments (related to customizations and subscriptions).

View Sample Data
    Category: Apparel (9281)
    • Product Name: adidas Men's Performance Polo - Blast Blue (880001)
      • SKU Name: S (880010)
      • SKU Name: M (880011)
      • SKU Name: L (880012)
      • SKU Name: XL (880013)

    • Product Name: adidas Men's Performance Polo - Green Night (880002)
      • SKU Name: S (880020)
      • SKU Name: M (880021)
      • SKU Name: L (880022)
      • SKU Name: XL (880023)

    • Product Name: adidas Women's Microdot Polo - Night Indigo (880003)
      • SKU Name: S (880030)
      • SKU Name: M (880031)
      • SKU Name: L (880032)
      • SKU Name: XL (880033)

    • Product Name: adidas Women's Microdot Polo - True Pink (880004)
      • SKU Name: S (880040)
      • SKU Name: M (880041)
      • SKU Name: L (880042)
      • SKU Name: XL (880043)
    Category: Food and beverage (9282)
    • Product Name: Yellow Onions (10 lbs.) (880026)
      • SKU Name: same name (880260)

    • Product Name: Cauliflower Fresh (880027)
      • SKU Name: same name (880270)

    • Product Name: Asparagus Green Conventional (880028)
      • SKU Name: same name (880280)

    • Product Name: Fresh Hass Avocadoes (880029)
      • SKU Name: same name (880290)

    • Product Name: Fresh Coconuts (880030)
      • SKU Name: same name (880300)

    • Product Name: Whole Watermelon Mini Fresh (880031)
      • SKU Name: same name (880310)

    • Product Name: Navel Oranges Grown Large Fresh (880032)
      • SKU Name: same name (880320)

    • Product Name: Navel Oranges Grown Large Fresh, Pack of 10 (880039)
      • SKU Kit: same name (880390)
      • SKU Components: 10un of Navel Oranges Grown Large Fresh
    Category: Sporting (9283)
    • Product Name: Nike Men's Roshe G Spikeless Golf Shoes (880005)
      • SKU Name: 8 (880050)
      • SKU Name: 8.5 (880051)
      • SKU Name: 9 (880052)
      • SKU Name: 9.5 (880053)
      • SKU Name: 10 (880054)

    • Product Name: Nike Men's Air Max 1 G Spikeless Golf Shoes (880006)
      • SKU Name: 8 (880060)
      • SKU Name: 8.5 (880061)
      • SKU Name: 9 (880062)
      • SKU Name: 9.5 (880063)
      • SKU Name: 10 (880064)

    • Product Name: Nike Air Max 270 G Spikeless Golf Shoes (880007)
      • SKU Name: 8 (880070)
      • SKU Name: 8.5 (880071)
      • SKU Name: 9 (880072)
      • SKU Name: 9.5 (880073)
      • SKU Name: 10 (880074)

    • Product Name: Skechers Women's Go Golf Drive 4 Dogs At Play Spikeless Golf Shoes (880008)
      • SKU Name: 8 (880080)
      • SKU Name: 8.5 (880081)
      • SKU Name: 9 (880082)
      • SKU Name: 9.5 (880083)
      • SKU Name: 10 (880084)
    Category: Agribusiness (9284)
    • Product Name: 2020 APACHE AS1040 (880033)
      • SKU Name: same name (880330)

    • Product Name: 2 POST CANOPY (880034)
      • SKU Name: same name (880340)

    • Product Name: 2020 AMACSA PH390 (880035)
      • SKU Name: same name (880350)

    • Product Name: Faceplate Combine Snout (880036)
      • SKU Name: same name (880360)

    • Product Name: 2016 MK MARTIN ENT MKGB788 Blades/Box Scraper (880037)
      • SKU Name: same name (880370)

    • Product Name: 1998 JOHN DEERE 8400T (880038)
      • SKU Name: same name (880380)
    Category: Home Appliance (9285)
    • Product Name: Weber 45010001 Spirit II E-310 3-Burner Liquid Propane Grill, Black (880021)
      • SKU Name: same name (880210)

    • Product Name: iRobot Roomba 675 Robot Vacuum-Wi-Fi Connectivity, Works with Alexa, Good for Pet Hair, Carpets, Hard Floors, Self-Charging (880022)
      • SKU Name: same name (880220)

    • Product Name: ALROCKET Dehumidifier 35oz(1000ml) Small Dehumidifier for 2100 Cubic Feet (260 sq ft) Portable and Compact Ultra Quiet (880023)
      • SKU Name: same name (880230)

    • Product Name: McCulloch MC1375 Canister Steam Cleaner with 20 Accessories (880024)
      • SKU Name: same name (880240)

    • Product Name: Cuisinart GR-4N 5-in-1 Griddler (880025)
      • SKU Name: same name (880250)
    Category: Computer & Software (9286)
    • Product Name: Acer Aspire Z24-890-UA91 AIO Desktop - Windows 10 (880015)
      • SKU Name: same name (880150)

    • Product Name: Lenovo IdeaCentre AIO 3 - Windows 10 (880016)
      • SKU Name: same name (880160)

    • Product Name: Acer Aspire TC-885-UA92 Desktop - Windows 10 (880017)
      • SKU Name: same name (880170)

    • Product Name: CYBERPOWERPC Gamer Xtreme VR Gaming PC - Windows 10 (880018)
      • SKU Name: same name (880180)

    • Product Name: Acer Aspire 5 Slim Laptop - Windows 10 (880019)
      • SKU Name: same name (880190)

    • Product Name: Jumper EZbook X3 Windows 10 Laptop (880020)
      • SKU Name: same name (880200)

    • Product Name: Acer Aspire z24 890 + Acer Aspire ATC 885 (880040)
      • SKU Kit: same name (880400)
    • SkuComponents:
      • 1un of Acer Aspire Z24-890-UA91 AIO Desktop - Windows 10 (880015)
      • 1un of Acer Aspire TC-885-UA92 Desktop - Windows 10 (880017)
    Category: Power tools (9287)
    • Product Name: BLACK+DECKER 20V MAX Drill & Home Tool Kit, 68 Piece (LDX120PK),Black/Orange (880009)
      • SKU Name: same name (880090)

    • Product Name: BLACK+DECKER 20V MAX Cordless Drill / Driver with 30-Piece Accessories (LD120VA) (880010)
      • SKU Name: same name (880100)

    • Product Name: BLACK+DECKER 20V Max Cordless Chainsaw, 10-Inch, Tool Only (LCS1020B) (880011)
      • SKU Name: same name (880110)

    • Product Name: BLACK+DECKER 20V MAX Cordless Drill Combo Kit, 2-Tool (BD2KITCDDI),Black/Orange Impact Combo Kit (880012)
      • SKU Name: same name (880120)

    • Product Name: BLACK+DECKER 20V MAX 5-1/2-Inch Cordless Circular Saw, Tool Only (BDCCS20B) (880013)
      • SKU Name: same name (880130)

    • Product Name: BLACK+DECKER 20V MAX 5-1/2-Inch Cordless Circular Saw (BDCCS20C) (880014)
      • SKU Name: same name (880140)

Attachments

Customization
View Sample Data
  • Name: T-Shirt Customization (T-Shirt Name - 15 characters)
  • Products: adidas Men's Performance Polo - Blast Blue (880001)
Subscriptions

It is mandatory to follow these additional steps if you want to enable subscriptions.

View Sample Data
  • Name: Subscription
  • Products: All from category Food and beverage (9282)

Prices

This resource sets sample prices and price tables.

Most products

View Sample Data
  • ListPrice: 30.00
  • BasePrice: between 50.00 and 2000.00
  • Markup: 0%

Quantity prices

View Sample Data
  • Product Name: BLACK+DECKER 20V MAX Cordless Drill / Driver with 30-Piece Accessories (LD120VA) (880100)
  • ListPrice: null
  • BasePrice: 100.00
  • FixedPrices:
    • Minimum Quantity: 1
    • Value: 100.00
    • Minimum Quantity: 10
    • Value: 90.00
    • Minimum Quantity: 50
    • Value: 80.00
    • Minimum Quantity: 100
    • Value: 70.00

Price Tables

View Sample Data
  • Name: silver
    • Percentual Modifier: -5%

  • Name: gold
    • Percentual Modifier: -10%

  • Name: platinum
    • Percentual Modifier: -15%

Payments

This resource sets 3 affiliations (Promissory, Test and CreditControlV2), the custom payment Promissories and the payment condition using them, the VISA credit card condition and the Customer Credit condition.

View Sample Data
  • Affiliation: Promissory
    • Custom Payment: Promissory (201)
    • Payment Condition: Promissory

  • Affiliation: Test
    • Payment Condition: VISA (credit card)

  • Affiliation: CreditControlV2
    • Payment Conditions:
    • 15 days (0% interest)
    • 30 days (0% interest)
    • 15 and 30 days (1% interest)
    • 15, 30 and 45 days (1.5% interest)

Benefits

This resource sets a Progressive Discount promotion.

View Sample Data
  • Name: Progressive Discount
  • Conditions:
  • Start: 2010-01-01
  • End: 2070-01-01
  • Collection: All
  • Benefit:
    • Quantity: 5
    • Discount: 5%
    • Quantity: 10
    • Discount: 15%
    • Quantity: 15
    • Discount: 25%
    • Quantity: 20
    • Discount: 35%

Taxes

This resource sets VAT and ICMS taxes.

View Sample Data
  • Name: VAT
    • Condition:
    • Start: 2010-01-01
    • End: 2070-01-01
    • Category: Agribusiness (9284)
    • Tax: 5%

  • Name: ICMS
    • Condition:
    • Start: 2010-01-01
    • End: 2070-01-01
    • Category: Agribusiness (9284)
    • Tax: 12%

Logistics

This resource updates the Logistics module using sample docks, warehouse and carrier.

View Sample Data
  • Freight Values:
    • Country: BRA
    • ZipCodeStart: 0
    • ZipCodeEnd: 9999999
    • Country: USA
    • ZipCodeStart: 0
    • ZipCodeEnd: 99999999
  • Docks:
    • Name: Doca Principal (1)
      • Country: BRA
    • Name: Main Dock (2)
      • Country: USA
  • Warehouse:
    • Name: Estoque (1_1)
    • Docks:
      • Doca Principal (1)
      • Main Dock (2)

Organizations

This resource creates Master Data schemas that are necessary to set up Roles and Permissions in your store's Admin, as described in this guide.

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page