Skip to main content

Part 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 a Checkout and My Account space, for example. In this guide, we'll teach you how to implement the Order Placed page, which displays a successful message right after the checkout process is completed, 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 finish this guide, you won't need to dive into VTEX IO concepts.

Before you start​

Before proceeding any further, make sure you already have:

  • Integrated your FastStore project with the VTEX Checkout. See this doc for more info.
  • The VTEX IO CLI installed on your machine. Please refer to this documentation for more information.
  • The vtex.edition-store 3.x or greater app version 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@3.x to be installed on your account so you can integrate your FastStore project with the VTEX platform.

Step by step​

Step 1 - Creating your app​

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

    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.

    vtex login {account}
caution

Replace the value between curly brackets with the name of your account.

  1. Create a new development workspace.

    vtex workspace use {workspace}
    caution

    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.

  2. Link your app to sync your local changes with the VTEX IO cloud development environment.

    vtex link

  3. 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.

  4. 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:

Order Placed page

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
...
"logo#desktop": {
  "props": {
    "title": "{altText}",
    "href": "https://{maindomain}",
    "url": "assets/{logoPath}",
    "width": "{widthValue}"
  }
}
...
  "logo#mobile": {
  "props": {
    "title": "{altText}",
    "href": "https://{maindomain}",
    "url": "assets/{logoPath}",
    "width": "{widthValue}"
  }
}
  1. 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 info, 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.
vtex use {workspace} --production
  1. Change to the faststore-vtex-integrations directory.
  2. Release a new app version.
vtex release major stable
  1. Publish your app as a candidate version.
vtex publish
  1. Install the candidate version indicating the app's version as in the following:
vtex install {vendor}.{name}@{version}
caution

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

vtex deploy {vendor}.{appname}@{appversion}
  1. Promote your Production workspace to master to make your changes publicly available to your store shoppers. 
    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.