The specified version of the app (0.x.0) does not exist. This page is about the latest stable version, which is 1.0.5.

Offer your clients to record a greeting in the sales for gift.

1. Install StoryDots - QR Virtual Greeting from the AppStore or, if using VTEX CLI, login to the desired VTEX account and run the following command:

2. If you installed the App from VTEX AppStore, you will be prompted with the following Settings screen. Fill and submit the required data so the App can create a new account linked to your store. If you installed the App via terminal using VTEX CLI, you can access this same Settings screen going to your store's Admin > Apps > App management > Installed > Storydots | QR Gift Virtual Greeting.

3. Add storydots-virtual-greeting app to your theme's dependencies in the manifest.json file:

4. Add the virtual-greeting block to the desired theme's block e.g:

You can see an implemented example with minicart.v2 here

5. You can now follow the same steps you would follow upon a new release of your store's theme. If you would like to test the integration in a production workspace different from master, you can repeat the same steps in the desired production workspace. Keep in mind that you will need to submit the settings data again (step 2) after promoting the test production workspace to the master workspace for the App to sync with the master workspace.

Widget example (Minicart):

---

Prop name	Type	Description	Default value
title	string	Virtual greeting widget title	Are you making a gift?
subtitle	string	Virtual greeting widget subtitle	Add a free virtual greeting!

---

When an order is marked as a gift purchase, the orderForm object will be populated with the QR Image URL. This URL can be found in the orderForm[customData]. You will then be able to get it from within your ERP or with a GET request to VTEX's Orders API for printing and attaching it to the package. We use the orderFormId to identify an order prior to its payment approvement.

Although the URL of the QR image is already available when the buyer completes the checkout, the image will not be available until the payment of the order has been confirmed, thus, when we receive the "payment-approved" event.

We attach to the orderForm 2 versions of the QR: the isolated Greeting QR (qrImage field), or the Greeting QR embedded in a pre-designed tag (tagImage field).

We also provide the raw URL that should be sent (or encoded as a QR) to the gift receiver in order to watch their greeting, in the field storyUrl, along with unique code that is assigned to that greeting. e.g:

Prop name	Type	Description
tagImage	string	Virtual greeting qr tag image
qrImage	string	Virtual greeting isolated qr image
storyUrl	string	Virtual greeting URL for receiver
code	string	Virtual greeting unique code

So, if you get the tagImage from within your system, you could extract the URL as:

You may provide us with a product SKU item Id and that product will be added to the cart whenever a user adds Storydots Virtual Greeting.

No CSS Handles are available yet for the app customization.