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

Pinterest is a visual discovery engine for finding ideas to create a life they love. With billions of Pins on Pinterest, you'll always find ideas to spark inspiration. When users discover Pins they love, they save them to boards to keep their ideas organized and easy to find. It's also possible to create Pins and share ideas with other people on Pinterest.

The Pinterest app for VTEX allows merchants to connect their VTEX store to Pinterest and reach shoppers with high intent.

In just a few steps, merchants that install the app can onboard, authenticate, upload a product catalog, and activate server-to-server conversion tracking (Conversions API). With this integration, you can easily unlock your shopping business and inspire consumers that are ready to buy.

To use the Pinterest app for VTEX, you need to meet the following requirements:

• VTEX IO store account
• Access to the VTEX admin UI
• Pinterest business account

NOTE: The app isn’t compatible with Legacy (or headless) stores

The Pinterest app for VTEX supports the following features for the stores running on Vtex IO:

1. Automatic website claiming
2. Track conversions using the frontend JavaScript and backend API tracking. Conversions API installation outside of this app can take 2-4 weeks. With this app it will be implemented in ~30 minutes.
3. Sync your product catalog with your Pinterest business account to automatically create product Pins, making your products visible to all Pinners. And with real time price updates, you can highlight your products with the best deals as soon as they are available.

After installing the Pinterest app for VTEX, connect to your Pinterest account.

1. In VTEX Admin go to Application and click on the Pinterest Tab to open the Pinterest App
2. Click on the connect button.

Upon clicking the connect button, the Pinterest Business Connect Plugin will open up in a popup. This will allow the user to authenticate with Pinterest, select the Ad Account, and select their assets like the Pinterest tag and choose the features they wish to enable.

Once the connection is completed, the connection popup will automatically close and you will be logged in.

The Pinterest app for Vtex allows the user to sync catalogs with Pinterest. The products will be ingested daily to ensure they are up to date. To register the feed, please follow the steps below:

By default, we will provide you with Automatic Feed Ingestion.

1. Under Apps, go to Pinterest.
2. Click on the Manage Feeds button on the Home Page.
3. Provide the Store URL and Trade Policy ID. Store URL should be the URL on which the products are visible. To see all trade policy options, under Store Settings, go to Trade Policies.
4. Click on the Register Feed button.
5. You will be redirected to the Connected Feed Page.

Alternatively, another option is to provide a feed file generated from the VTEX XML Integration channel. This method is recommended for merchants with more than 150,000 products. To register the feed, please follow the steps below:

1. In VTEX Admin, go to Store Settings.
2. Under Channels, click XML Integration.
3. Click New XML.
4. On XML Type, select Feed: RSS 2.0.
5. On the File name, add a file name that can used to identify the feed (eg PinterestShopping.xml)
6. On the Price currency symbol, select the currency you want the prices to be available in. The currency should be in ISO-4217 format.
7. On the Collection field, select a previously registered collection of products.
8. Unselect the option Show product with default SKU. With this selection, you must define the XML structure following the definitions of the example below.
9. Review the model, making the desired alterations.
10. Ensure that the availability field is set with the tag name availability
11. Ensure that the Product ID is set with the tag name item_group_id
12. Ensure that the Sku ID is set with the tag name id
13. Click Save. The URL to access the XML will be generated automatically. The URL should be in the format: {domain}/XMLData/{feedName}

1. Under Application, go to the Pinterest App
2. Click on the Manage Feed button on the Home Page
3. Click on the toggle to switch to Manual Feed Registration
4. Provide the Feed URL, Default Country, Default Language and Currency Values
5. Click on the Register Feed Button
6. If the feed is successfully registered, you will be redirected to the Connected Feeds page.

1. Under Apps, go to Pinterest.
2. Click on the Manage Feeds button on the Home Page.
3. Once Feed Setup is complete, for automatic feeds, you should see the Store URL, Trade Policy ID, Country/Region, Language, and Default Currency for your connected feed. For XML registered feeds, you should see the Registered Feed URL, Country/Region, Language, and Default Currency for your connected feed.
4. If you would like to edit the feed details, click on the Delete Feed button to delete the feed from Pinterest. You can now register a new feed.

Conversion tracking provided by the plugin allows merchants to track conversions using both frontend JavaScript and server to server API tracking. The setup is automatic and no user action is required after connection. The Conversions API allows the merchant to fire certain events directly from VTEX servers, ensuring the relevant data reaches Pinterest independently from front-end implementations and/or network failures.

The following events are supported out of the box:

Event	Tag	Conversions API
Page Visit	Yes	Yes
Search	Yes	Yes
Add to Cart	Yes	Yes
Checkout	Yes	Yes

Preventing sending conversion events until user consents to tracking must be associated with a third-party cookie consent system. To enable the blocking of pixel and server events, you must activate the flag through the settings in the admin (admin/apps/pinterestpartnerbr.pinterest@1.x/setup/):

After activating this functionality, the Pinterest app will not send any event data either via Pinterest Tag or via Conversions API. To allow the emission of events after the user's consent, the cookie value for cookie (pinterest_consent) must be set to true through a script implemented by the store within the third-party tool:

To disconnect from Pinterest, click on the Disconnect Button. Be aware that upon disconnecting, the app will stop sending conversion events (Pinterest tag and conversions api). It will automatically also delete the feed registered with Pinterest via the Pinterest app for VTEX.

After disconnecting, it is possible to reactivate the integration at any time by repeating the steps described in the Getting Started section.

For any questions regarding this plugin please contact our Help Center via https://help.pinterest.com/en/contact

Website verification: Website claiming is an important step for conversion and catalog ingestion to proceed.

• Before we claim the website, the Pinterest app for VTEX adds a meta tag to the website. This is required to ensure that the website belongs to the user trying to claim it.

  • To check if the meta is set up, go to the website using Chrome and open the Developer Tools. In the Elements tab, search for the Pinterest Meta Tag by looking for the meta element with name p:domain_verify.

    

  • Please go to https://www.pinterest.com/settings/claim to see a list of claimed websites to verify all your websites were claimed successfully. Note: We don’t claim websites if the user is on a development workspace.

  Note: The Vtex app will try to claim the websites for all the stores in the account. Please ensure the app is installed on all stores. You can ignore the warnings for website claiming failing on websites not belonging to the current store.

To verify the data that is being sent, use the Conversion Test tool provided by Pinterest: https://ads.pinterest.com/advertiser/<YOURACCOUNTID>/conversions/tag-events/. Provide the URL the environment you wish to test and then browse that site in the new tab that opens.

Deduplication Verification

User event data is sent to Pinterest from both the server side and the client side on each page load. Pinterest then takes all that data and tries to merge the same event data fired from the client side to the same event data fired from the server side for each unique page load. This is called deduplication. Pinterest has a tool to help verify your data can be deduplicated properly. You may need several days of test event data to use this tool effectively in development and test environments. This is the most effective way to verify server side event data.

https://ads.pinterest.com/advertiser/<YOURACCOUNTID>/conversions/deduplication/

Test Pinterest Tag

Install Pinterest Tag Helper

Install the official Pinterest Tag Helper Chrome Plugin: While browsing the site you will see events populate the Chrome Plugin if everything is set up correctly.

Search Client Side

To check that Pinterest fires on the search page, search for an item and load the search page and check the Pinterest Test events tool.

• you should see a SEARCH event
• the event should have a defined property of ‘search_query’

Page Visit Client Side

To check that Pinterest fires the Page Visit Event, navigate to a page where events are enabled.

If you navigate to a non product page and check the Pinterest Test events tool.

• you should see a PAGE_VISIT event

If you navigate to a product page and check the Pinterest Test events tool.

• you should see a PAGE_VISIT event
• the event should have a defined property of ‘product_id’

Add to Cart Client Side

To check that Pinterest fires on add to cart events, navigate to a product page and add an item to cart. Check the Pinterest Test events tool.

• you should see an ADD_TO_CART event
• the event should have a defined property named ‘line_items’

Checkout Client Side

To check that Pinterest fires on the checkout confirmation page, add a product to cart and complete a purchase. Once on the order confirmation page check the Pinterest Test events tool:

• you should see an CHECKOUT EVENT event
• the event should have a defined property names ‘line_items’ and ‘order_id’

Test Conversions API

To verify that conversion API is sending data look in your event history for conversion data and select the conversion API option in the drop down (near the top right of the graph in the page) https://ads.pinterest.com/advertiser/<YOURACCOUNTID>/conversions/event-history/.

NOTE: Sometimes it takes a few minutes for our ingestion pipelines to process the events.

• Once Feed Setup Status shows Success, visit https://www.pinterest.com/product-catalogs/data-source/ and verify that your feed is registered and processing has started. It might take a few minutes to a few hours depending on the size of your catalog to completely process.
• Once catalog ingestion is complete, verify any issues and the number of products ingested by expanding the feed profile card and viewing the specific ingestion run’s details.
• You will need to wait up to 24 hours to see your product groups and the associated Pins on your Pinterest account.

Q: Can I use the plugin with a personal Pinterest account? A: No, the plugin is designed to work only with Pinterest business accounts.

Q: Can I use an account which has access through Pinterest business access share feature? A: No, please use the original/main account’s login credentials to connect

Q: Can I install the Conversions API feature without installing the Pinterest JS Tag? A: No, Conversions API and Pinterest JS Tag are installed together.

Q: Can I turn off Pinterest conversions? A: Pinterest conversions can be turned off during app connect. To change the behavior after the connection is complete, please disconnect the app and reconnect with the updated behavior.

Q: Can I turn off Pinterest catalog sync? A: Pinterest catalog sync can be turned off during app connect. To change the behavior after the connection is complete, please disconnect the app and reconnect with the updated behavior.

Q: How often is the product catalog updated with Pinterest? A: The catalog is updated daily.

Q: Does the integration support real time updates? A: Currently, the app does not support real-time updates.

Q: Can I track Pinterest conversions? A: Yes, the plugin provides a frontend JavaScript tracking code. It also provides backend Conversions API tracking for more accurate conversion data.