Webshop integration

Server-side tracking for VTEX

ROASaurus registers a VTEX order hook for approved payments, fetches each order through the OMS API and sends it to your ad platforms from the server.

VTEX at a glance
Orders arrive byOrder hook on payment approval, plus a check every 5 minutes
CredentialsApp key and app token with OMS and Feed v3 and Hook permissions
Paid ordersPayment approved and every later status, up to invoiced
Webhook setupOne click: Create webhook

How VTEX connects

  1. Add the ROASaurus script to your storefront.
  2. Generate an app key with a role that can list and view orders and manage the order hook, and enter your account name, app key and app token in ROASaurus.
  3. Press Create webhook. VTEX then reports each approved payment instantly. ROASaurus renews the hook daily, because VTEX drops hooks that stay quiet for three days.

What ROASaurus reads from each order

The order id and sequence number, total and currency, the customer's email, name, phone and profile id, the delivery address, and each SKU's product, quantity and selling price.

Limits

  • When the Conversation Tracker is in hard mode, VTEX replaces the customer email with an alias. Set it to soft mode so ad platforms can match the real email.
  • The connector is built from the platform's official API documentation. Press Test connection after saving your credentials, then place a test order and check the Event log.

Related

FAQ

Questions, answered

Which VTEX permissions does the app key need?

OMS List Orders and View order, and Feed v3 and Hook Admin for the order hook. The predefined role "OMS - Full access" covers them.

Why do some VTEX orders have no email?

With the Conversation Tracker in hard mode, VTEX hides the email behind an alias. ROASaurus leaves the alias out; soft mode keeps the real email.

Every sale, traced to the ad that earned it

Server-side tracking, profit and lifetime value in one app. Free plan, no credit card.

Start free →