Skip to content

How-To Guide

This guide provides step-by-step workflows for common tasks with UTM Source - Marketing Parameter.

How the Plugin Works

Data Flow Overview

Customer visits shop → Data captured → Stored on order → Visible in admin
        ↓                   ↓                ↓                   ↓
   URL parameters      Cookie/Session    Order assignment    Order details
   + Referrer          + Server DB       + Device data       + Reports
   + Device

Example Flow: 1. Customer clicks on Google ad with ?utm_source=google&utm_campaign=winter_sale 2. Plugin captures: Referrer (google.com), Parameters (utm_source, utm_campaign), Device (Mobile, iOS, Safari) 3. Data is stored in cookie and/or server session 4. Customer places order → All data is assigned to the order 5. You see the complete marketing data in the order detail view

Common Workflows

Goal: Ensure your marketing links are correctly tracked

Prerequisites: - Plugin is installed and activated - Access to your marketing platform (Google Ads, Facebook, newsletter tool)

Steps:

  1. Determine base URL
  2. Select the target page in your shop

  3. Example: https://my-shop.com/offer

  4. Add UTM parameters

  5. Append parameters to the URL: 

    https://my-shop.com/offer?utm_source=google&utm_medium=cpc&utm_campaign=winter_2024

  6. Use standard parameters

Parameter Purpose Example values
utm_source Where traffic comes from google, facebook, newsletter
utm_medium Marketing channel cpc, social, email
utm_campaign Campaign name winter_2024, black_friday
utm_content Ad content red_banner, text_link
utm_term Search term buy_shoes
  1. Test the link
  2. Open the link in an incognito window
  3. Complete a test order
  4. Check the marketing data in the order view

Result: All orders through this link show the configured UTM parameters.

How to: Analyze Marketing Success of a Campaign

Goal: Find out which orders came from a specific campaign

Prerequisites: - Completed orders with UTM data - Access to the admin area

Steps:

  1. Open order overview

  2. Navigate to: Orders

  3. Search through orders

  4. Open individual orders

  5. Scroll to the UTM Source - Marketing Parameter card

  6. Identify campaign data

  7. Look for the utm_campaign parameter

  8. Note the value (e.g., "winter_2024")

  9. For deeper analysis: Use API

  10. Export orders via the Shopware Admin API
  11. UTM data is available in the utmConfiguration field

Result: You know which orders came from which campaign.

Tip: For comprehensive analyses, we recommend exporting to an analysis tool or spreadsheet.

Goal: Capture marketing data even when cookies are declined

Prerequisites: - Admin access to plugin settings

Steps:

  1. Open plugin configuration
  2. Navigate to: Extensions → My Extensions
  3. Find UTM Source - Marketing Parameter

  4. Click Configure

  5. Enable setting

  6. Enable: Record referrer without setting a cookie

  7. Click Save

  8. Adjust cleanup interval (optional)

  9. Set Clean session table entries older than to an appropriate value

  10. Recommendation: 30 days

  11. Test functionality

  12. Open your shop in an incognito window
  13. Decline all cookies
  14. Come through a referrer link
  15. Complete a test order
  16. Check if the referrer appears in the order

Result: Referrers are captured even without cookie consent.

How to: Organize Recognized Parameters

Goal: Give automatically recognized parameters meaningful names

Prerequisites: - Orders with captured marketing data

Steps:

  1. Open parameter management

  2. Navigate to: Marketing → UTM Source - Marketing Parameter

  3. Identify parameters

  4. Look for parameters with technical names (e.g., "fbclid")

  5. These were automatically created on first occurrence

  6. Rename parameters

  7. Click on the parameter
  8. Change the Title to an understandable name
    • Example: "fbclid" → "Facebook Click ID"

  9. Click Save

  10. Deactivate unused parameters

  11. Find parameters you no longer use
  12. Set Active to "Off"
  13. Save the change

Result: Your parameter list is organized and understandable.

Quick Reference

Task Key Steps Required Settings
View marketing data Orders → Open order → UTM card None
Enable cookie-less tracking Plugin config → Enable without cookie Without cookie: On
Rename parameters Marketing → UTM Source → Parameter → Change title None
Delete old session data faster Plugin config → Reduce cleanup days Cleanup: e.g., 7

Best Practices

  1. Consistent UTM structure: Use the same naming convention across all marketing channels for utm_source, utm_medium, and utm_campaign

  2. Use lowercase: Consistently use lowercase letters in UTM parameters (google instead of Google) to avoid duplicates

  3. Regular review: Check the parameter management monthly and name/organize new entries

  4. Test before launch: Always test new marketing links with a test order before starting the campaign

  5. Documentation: Maintain a list of your used UTM values so the entire team works consistently

What to Avoid

  • Spaces in parameter values – Use underscores or hyphens
  • Special characters – Limit yourself to letters, numbers, and _/-
  • Too long parameter values – Keep values short and concise (max 50 characters)
  • Inconsistent capitalization – "Google", "google", and "GOOGLE" are captured as three different sources