Documentation
Feedback
Guides
Storefront Development

Storefront Development
FastStoreGoing live
5. Integrating the VTEX Order Placed and My Account
To create a complete digital commerce experience for your FastStore project, you need to provide shoppers with essential features like a Checkout and My Account space. This guide will teach you how to implement the Order Placed page, which displays a successful message right after a successful checkout, and a My Account space, which allows customers to manage their orders and personal data (e.g., profile info, password, addresses, and credit cards) on a single page.
Notice that, since we're using a subdomain for these integrations that is unrelated to FastStore itself, we'll use VTEX IO in this guide. VTEX IO is a VTEX solution to create VTEX apps, but don't worry: to complete this guide, you won't need to dive into VTEX IO concepts.

Before you begin

Before proceeding any further, make sure you already have:
  • Integrated your FastStore project with the VTEX Checkout. See this guide for more information.
  • The VTEX IO CLI installed on your machine. Please refer to this documentation for more information.
  • The vtex.edition-store 5.x version installed on your VTEX account.
  • Stores using Legacy CMS Portal technology: the vtex.edition-store 3.x version should be installed on your VTEX account.
  • Run vtex edition get to check if the vtex.edition-store app is installed on your account. If not, open a support ticket communicating you need the vtex.edition-store@5.x to be installed on your account so you can integrate your FastStore project with the VTEX platform.

Step by step

Step 1 - Creating the Order Placed and My Account app

  1. Open the terminal and clone the faststore-vtex-integrations project into your local files.

    _10
    npx degit vtex/faststore-vtex-integrations

  2. Open the faststore-vtex-integrations directory in any code editor of your preference.
  3. Open the manifest.json file and update the value of the vendor field with the name of your VTEX account.
  4. Using the terminal, log in to your VTEX account.

    _10
    vtex login {account}

    Replace the value between curly brackets with the name of your account.
  5. Create a new development workspace.

    _10
    vtex workspace use {workspace}

    Replace the value between curly brackets with any name of your preference, making sure the name you choose is not already taken.
    Enter Y to continue creating the new workspace.
  6. Link your app to sync your local changes with the VTEX IO cloud development environment.

    _10
    vtex link

  7. Now, open a new browser window and access https://{workspace}--{account}.myvtex.com to see your changes live. Remember to replace the values between curly brackets according to your scenario.
  8. Add items to your shopping cart and proceed to checkout. Place an order and observe if you are being taken to the Order Placed page:
    {"base64":"  ","img":{"width":1200,"height":643,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":90974,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/order-placed-page___1c8555354e041450be5fb90f7ba1f7d6.png"}}
After accessing the Order Placed page, you probably noticed the FastStore logo. Let's update it, so the Order Placed and My Account pages are presented with your store logo.
  1. Save your logo inside the assets folder.
  2. Open the store/blocks/header.jsonc file and update the title, href, url, and width values of your store logo (logo#desktop and logo#mobile) according to your scenario:
    store/blocks/header.json

    _18
    ...
    _18
    "logo#desktop": {
    _18
    "props": {
    _18
    "title": "{altText}",
    _18
    "href": "https://{maindomain}",
    _18
    "url": "assets/{logoPath}",
    _18
    "width": "{widthValue}"
    _18
    }
    _18
    }
    _18
    ...
    _18
    "logo#mobile": {
    _18
    "props": {
    _18
    "title": "{altText}",
    _18
    "href": "https://{maindomain}",
    _18
    "url": "assets/{logoPath}",
    _18
    "width": "{widthValue}"
    _18
    }
    _18
    }

  3. Save your changes.

Step 3 - (Optional) Styling the Order Placed and My Account header

If you want to change the style of the header presented in the Order Placed and My Account pages, you can update the vtex.flex-layout.css and vtex.store-header.css files contained in the styles/css folder. For more information, please refer to this guide.

Step 4 - Publishing your app

Now that everything is as expected, you need to make your changes publicly available to your store shoppers. To do that, take the following steps:
  1. Open the terminal and create a production workspace.

    _10
    vtex use {workspace} --production

  2. Change to the faststore-vtex-integrations directory.
  3. Release a new app version.

    _10
    vtex release major stable

  4. Publish your app as a candidate version.

    _10
    vtex publish

  5. Install the candidate version indicating the app's version as in the following:

    _10
    vtex install {vendor}.{name}@{version}

    Replace the values between curly brackets according to the manifest.json file of your faststore-vtex-integrations app.
  6. Deploy the candidate version as a stable version.

    _10
    vtex deploy {vendor}.{appname}@{appversion}

  7. Promote your Production workspace to master to make your changes publicly available to your store shoppers.

    _10
    vtex workspace promote

That's all. Now, if you place an order in your store, you'll be presented with the Order Placed page. Similarly, you'll also have access to the My Account page.
Contributors
3
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 3 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
See also
Creating a Development workspace
Guides
Creating a Production workspace
Guides
Linking an app
Guides
Deploying a new app version
Guides
Contributors
3
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 3 contributors
On this page