For the complete documentation index, see llms.txt. This page is also available as Markdown.

Converge integration

This guide applies only when selling pre-orders through Purple Dot's own checkout. Pre-orders sold through the Shopify checkout benefit from the same tracking as your regular sales.

If you have enabled Converge tracking from the Integration settings page in the Merchant Portal, then Purple Dot checkout will send the following event (with your desired event name) to your Converge account.

This is a client side integration.

event_name:
  '<Your custom event>',
distinct_id: [`urn:email:<Shopper's email>`],
gateway: 'Purple Dot',
properties: {
  id: <Purple Dot pre-order reference>,
  total_price: <total pre-order amount>,
  total_tax: <total pre-order tax amount>,
  total_shipping: <total pre-order shipping amount>,
  total_discount: <total pre-order discount amount>,
  currency: <pre-order currency>,
  coupon: <pre-order discount coupon>,
  items: <Array{
    product_id: <line-item product ID>,
    variant_id: <line-item variant ID>,
    name: <line-item product name>,
    variant_name: <line-item variant name>,
    sku: <line-item variant SKU>,
    price: <line-item price>,
    currency: <pre-order currency>,
    quantity: <line-item quantity>,
    discount: <line-item discount amount>,
  }>,
  profile_properties: {
    $email: <Shopper's email>,
    $phone_number: <Shopper's phone number>,
    $city: <Shopper's city>,
    $state: <Shopper's state>,
    $zip_code: <Shopper's zip code>,
    $countryCode: <Shopper's country code>,
    $first_name: <Shopper's first name>,
    $last_name: <Shopper's last name>,
  }
}

Last updated