Skip to content
Pidgely Docs

Stores (e-commerce)

VTEX

Connect a VTEX store to Pidgely with an application key to sync orders, customers and products and send order e-mails.

View as Markdown

VTEX stores connect with an application key you create in your VTEX admin.

  1. In Account settings → Roles, create a role (for example "Pidgely") with these resources:
    • OMS: View order and List Orders
    • Feed v3 and Hook Admin (order notifications)
    • Master Data: Read only documents (customer e-mails and names)
    • Catalog: Get Product and SKU (or another catalog read resource)
  2. In Account settings → Application keys, create a key with that role. Copy the app key and app token.
  3. In Pidgely, open Stores → VTEX → Connect and enter your account name (the aurora in aurora.myvtex.com), the key and the token.

Pidgely configures the VTEX order hook to notify it of every status change. VTEX allows one hook per application key, so use a key dedicated to Pidgely. Customers and products have no notifications on VTEX: they are updated by the periodic sync.

Abandoned carts are not available for VTEX stores yet. To revoke access, delete the application key in VTEX, or click Disconnect in Pidgely.