Mapp Intelligence enables the tracking of completed transactions as orders.
Order tracking forms the basis for all order-related analyses, such as:
How many orders were completed?
Which payment methods were used?
Which orders were returned or cancelled?
Order ID and Order Value
Each order is uniquely identified by an Order ID.
As soon as an order value is transmitted, an order is tracked. If no ID is submitted, Mapp Intelligence automatically generates one.
Note
Providing your own Order ID is recommended, as it prevents duplicate counting when a confirmation page is reloaded and allows easier reconciliation with external systems.
The Order Value represents the total transaction amount and may include discounts, shipping, or packaging costs. Mapp recommends submitting the net value (excluding shipment costs) to allow better comparison with campaign costs.
Parameters
E-Commerce Parameters enrich tracked order data with additional website-specific information or metrics.
They must be configured in Mapp Q3 before they can be tracked via the library. During setup, you define the data type (text or number) and other attributes for each parameter.
Mapp Intelligence provides a range of predefined E-Commerce Parameters for common order-related use cases, such as Payment Method, Coupon Value, and Shipping Costs. Alternatively, you can create custom E-Commerce Parameters to capture completely individual information — for example, shipping speed, delivery options, or special discounts.
For detailed setup instructions and a full overview of predefined parameters, see How to set up custom parameters.
Method | Description | Where to configure * | Where to analyze ** |
|---|---|---|---|
constructor | Initializes an order object and defines the total order value. Required for order tracking. | – | Metric: Order Value |
setValue | Sets the total order value. Required. Without this value, no order is tracked. | – | Metric: Order Value |
setId | Defines a unique order number. Prevents duplicate counting and supports reconciliation with other systems. | – | Orders |
setCurrency | Defines the order currency (ISO code). Used for conversion to the default account currency. | SYS > Data Collection | – |
setCouponValue | Transmits the value of an applied coupon. | EP > Coupon Value | Metric: Coupon Value |
setPaymentMethod | Transmits the payment method of the order. | EP > Payment Method | EC Params |
setShippingService | Transmits the shipping service used. | EP > Shipping Service | EC Params |
setShippingSpeed | Transmits the selected shipping speed. | EP > Shipping Speed | EC Params |
setShippingCosts | Transmits the shipping costs of the order. | EP > Shipping Costs | Metric: Shipping Costs |
setGrossMargin | Transmits the gross margin / mark-up of the order. | EP > Gross Margin | Metric: Gross Margin |
setOrderStatus | Transmits the order status (e.g. “confirmed”, “cancelled”). | EP > Order Status | EC Params |
setParameter | Adds custom e-commerce parameters to enrich order data with website-specific information. | EP > Own Configuration | EC Params |
* Configuration Path Abbreviations:
EP = Mapp Q3 > Configuration > Custom Parameters > E-Commerce Parameters > Preconfigured > …
SYS = Mapp Q3 > Configuration > System Configuration > Data Collection
** Analysis Path Abbreviations:
Orders = E-Commerce > Orders separately
EC Params = E-Commerce > E-Commerce Parameters
Metric: Indicates that the value is available as a metric (e.g. Order Value, Coupon Value, Shipping Costs)
constructor
/**
* MappIntelligenceOrder constructor.
* @param float $value
*/
$orderData = new MappIntelligenceOrder();setValue
/**
* @param float $value
* @return $this
*/
$orderData->setValue($value);setId
/**
* @param string $id
* @return $this
*/
$orderData->setId($id);setCurrency
/**
* @param string $currency
* @return $this
*/
$orderData->setCurrency($currency);setCouponValue
/**
* @param float $couponValue
* @return $this
*/
$orderData->setCouponValue($couponValue);setPaymentMethod
/**
* @param string $paymentMethod
* @return $this
*/
$orderData->setPaymentMethod($paymentMethod);setShippingService
/**
* @param string $shippingService
* @return $this
*/
$orderData->setShippingService($shippingService);setShippingSpeed
/**
* @param string $shippingSpeed
* @return $this
*/
$orderData->setShippingSpeed($shippingSpeed);setShippingCosts
/**
* @param float $shippingCosts
* @return $this
*/
$orderData->setShippingCosts($shippingCosts);setGrossMargin
/**
* @param float $grossMargin
* @return $this
*/
$orderData->setGrossMargin($grossMargin);setOrderStatus
/**
* @param string $orderStatus
* @return $this
*/
$orderData->setOrderStatus($orderStatus);setParameter
/**
* @param int $id
* @param string $value
* @return $this
*/
$orderData->setParameter($id, $value);$orderData = new MappIntelligenceOrder();
$orderData
->setValue(24.95)
->setCouponValue(10.99)
->setPaymentMethod('paypal')
->setOrderStatus('payed')
->setId('ABC123')
->setGrossMargin(6.95)
->setShippingService('dhl')
->setShippingSpeed('2d')
->setShippingCosts(3.95)
->setCurrency('EUR')
->setParameter(2, 'param2')
->setParameter(15, 'param15');
$mappIntelligence = MappIntelligence::getInstance();
$mappIntelligence->track((new MappIntelligenceDataMap())->order($orderData));