Pinterest Conversions API on Shopify

How to send Shopify events to the Pinterest Conversions API: required user data, the epik click id, deduplication with the Pinterest tag, and timing.

Short answer: send each Shopify event to POST https://api.pinterest.com/v5/ad_accounts/{ad_account_id}/events with an event_id that matches the Pinterest tag's eventID, at least one identifier (hashed email, hashed mobile ad id, or IP address with user agent), and the epik click id when you have it. Send within an hour and keep the tag running.

What each event needs

FieldWhat to send
event_nameFor example checkout (purchase), add_to_cart, page_visit
action_sourceweb for store events
event_idThe same value as the tag's eventID for that event
user_dataAt least one of: em (hashed email), hashed_maids, or client_ip_address with client_user_agent
click_idThe epik value from the URL or the _epik cookie

Personal data such as email is hashed with SHA-256 before sending.

Deduplication with the Pinterest tag

Pinterest matches a tag event and an API event when the tag's eventID equals the API's event_id. It keeps the first one it receives and removes duplicates within 48 hours. As with Meta, keying purchases on the order id keeps every copy of the same purchase on the same id.

The epik click id

Pinterest adds epik to ad click URLs, and its tag stores the value in the _epik first-party cookie. Pass the URL value when the visitor lands, and the cookie value on later pages when the parameter is gone.

Timing

Pinterest asks for events in real time or with a maximum lag of one hour. Queue and retry failures quickly rather than batching a day of events.

How TRACK ATLAS does it

TRACK ATLAS sends Pinterest page visits, product views, searches, add to cart, checkout steps and purchases (as checkout) to the v5 Conversions API next to your tag, with the same event id on both, hashed email, phone and external id, IP address, user agent and the epik click id captured on landing. Temporary failures are retried.

Questions

What is epik?

The External Pinterest ID Key, a click id Pinterest adds to ad click URLs. The Pinterest tag stores it in the _epik cookie, and you should send the cookie value when the URL parameter is missing.

How does Pinterest deduplicate tag and API events?

The tag's eventID must match the API event_id. Pinterest keeps the first event and removes duplicates received within 48 hours.

How fast must events be sent?

Pinterest asks for events in real time or with at most one hour of lag.

SOURCES

  1. Pinterest Developers: Track conversions in the API
  2. Pinterest Developers: Conversions overview
  3. Pinterest Help: Tag parameters and cookies
  4. Pinterest Help: The Pinterest API for conversions

Try TRACK ATLAS free for 14 days.

Start free trial
Pinterest Conversions API on Shopify, TRACK ATLAS