VTEX Developer Portal

All ContributorsAll Contributors

Cookie Script app brings the solution to make your website cookies comply with GDPR and CCPA.

imageimage

Learn how to install and configure the app on the following sections.

Installing Cookie Script app

It is possible to install the Cookie Script in your store either by using App Store or the VTEX IO CLI.

Using VTEX App Store

  1. Access the Apps section in your account's admin page and look for the Cookie Script box;
  2. Then, click on the Install button;
  3. You'll see a warning message about needing to enter the necessary configurations. Scroll down and type in your Cookie Script ID.
  4. Click on Save.

Using VTEX IO Toolbelt

  1. In your terminal, install the [email protected] app.
  2. To confirm that the app has now been installed, run in your terminal vtex ls and check the installed apps' list.
  3. Access the Apps section in your account's admin page and look for the Cookie Script box. Once you find it, click on it.
  4. Fill in the Cookie Script ID field.
  5. Click on Save.

After installing the app, you must create an account in Cookie Script to make the app work on your store. Follow the steps on the Cookie Script Configuration section to create an account and configure the app.

Cookie Script Configuration

Once you have installed the app, you need to create an account in Cookie Script to be able to configure the app.

You must follow the steps described in this section to guarantee the cookies will work. Otherwise, they will break the purchases flow from your store.

  1. Go to the Cookie Script page and create your account.
  2. After creating your account, go to the Dashboard tab and click on Add website.

app-dashboardapp-dashboard

  1. Once you have added your website, go to the Cookie scanner tab and run a scan.
  2. After the scan is complete, go to Cookies tab and make sure the following cookies are categorized as Stricly Necessary: ASPXAUTH, checkout.vtex.com, CookieConsent, device, vtex_segment, vtex_session, VtexFingerPrint, VtexRCMacIdv7, VtexRCRequestCounter, VtexRCSessionIdv7 and VtexWorkspace.

Contributors ✨

Thanks goes to these wonderful people:

This project follows the all-contributors specification. Contributions of any kind are welcome!

Updated 2 months ago


Cookie Script


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.