Skip to main content

Shopify Integration

Set up Colter Lens on your Shopify store with one-click install.

TL;DR: Shopify installs Colter through the embedded app flow, provisions a Lens site, and injects the storefront beacon through a theme extension. No theme edits are required for the standard install path.

Install Flow

  1. Merchant starts the Shopify app install.
  2. Colter completes OAuth and stores the offline token.
  3. A Lens site is provisioned for the shop.
  4. The theme extension injects the storefront beacon.

Traffic usually appears in Lens within seconds of the first agent visit.

Required Scopes

ScopePurpose
read_productsCatalog inspection and readiness checks
read_ordersRevenue attribution in Lens
write_metafieldsStore the Lens site ID on the shop

What Gets Added

  • a storefront beacon for agent traffic telemetry
  • a colter.lens_site_id metafield for site resolution
  • Shopify webhooks for revenue attribution and analytics

Revenue Webhook Example

Non-Shopify stores can send the same shape manually:

curl -X POST https://agenticcom.ai/api/v1/lens/revenue-webhook \
  -H "Authorization: Bearer $COLTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "site_id": "site_abc123",
    "order_id": "order_123",
    "currency": "USD",
    "amount_cents": 31900,
    "items_count": 3,
    "session_id": "sess_abc123"
  }'

Troubleshooting

IssueFix
OAuth scope errorReinstall the app and approve the requested scopes
Beacon not firingEnable the Colter App Embed in Shopify theme settings
No Lens traffic yetConfirm the beacon is installed and wait for agent visits
Revenue not attributedMake sure the order flow includes the session_id correlation path

Next Steps