Order

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.

Supported Methods

Methods

Example

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

const mappOrderData = new MappIntelligenceOrder();

/**
 * @param v Saves the total order value. This property must be entered if total order values are to be tracked
 */
const mappOrderData = new MappIntelligenceOrder(v: number);

setValue

/**
 * @param v Saves the total order value. This property must be entered if total order values are to be tracked
 *
 * @return MappIntelligenceOrder
 */
mappOrderData.setValue(v: number);

setId

/**
 * @param i Contains a unique order number (order ID). Use of this setting ensures that no orders are counted twice
 *
 * @return MappIntelligenceOrder
 */
mappOrderData.setId(i: string);

setCurrency

/**
 * @param c The currency of an order
 *
 * @return MappIntelligenceOrder
 */
mappOrderData.setCurrency(c: string);

setCouponValue

/**
 * @param cValue Contains the value of a coupon
 *
 * @return MappIntelligenceOrder
 */
mappOrderData.setCouponValue(cValue: number);

setPaymentMethod

/**
 * @param pMethod Use this to transmit the payment method of the order
 *
 * @return MappIntelligenceOrder
 */
mappOrderData.setPaymentMethod(pMethod: string);

setShippingService

/**
 * @param sService Use this to transmit the shipping service of the order
 *
 * @return MappIntelligenceOrder
 */
mappOrderData.setShippingService(sService: string);

setShippingSpeed

/**
 * @param sSpeed Use this to transmit the shipping speed of the order
 *
 * @return MappIntelligenceOrder
 */
mappOrderData.setShippingSpeed(sSpeed: string);

setShippingCosts

/**
 * @param sCosts Use this to transmit the shipping costs of the order
 *
 * @return MappIntelligenceOrder
 */
mappOrderData.setShippingCosts(sCosts: number);

setGrossMargin

/**
 * @param gMargin Use this to transmit the margin/mark-up of the order
 *
 * @return MappIntelligenceOrder
 */
mappOrderData.setGrossMargin(gMargin: number);

setOrderStatus

/**
 * @param oStatus Use this to transmit the order status of the order
 *
 * @return MappIntelligenceOrder
 */
mappOrderData.setOrderStatus(oStatus: string);

setParameter

/**
 * You can use parameters to enrich analytical data with your own website-specific information and/or metrics.
 * Observe the syntax guidelines when defining parameters.
 *
 * @param i ID of the parameter
 * @param v Value of the parameter
 *
 * @return MappIntelligenceOrder
 */
mappOrderData.setParameter(i: number, v: string);

const mic = new MappIntelligenceConfig(
	"111111111111111",
	"analytics01.wt-eu02.net"
);
const mit = new MappIntelligenceTracking(mic);

const mappOrderData = new MappIntelligenceOrder();
mappCustomerData.setValue(24.95)
	.setCouponValue(10.99)
	.setPaymentMethod("paypal")
	.setOrderStatus("paid")
	.setId("ABC123")
	.setGrossMargin(6.95)
	.setShippingService("dhl")
	.setShippingSpeed("2d")
	.setShippingCosts(3.95)
	.setCurrency("EUR")
	.setParameter(2, "param2")
	.setParameter(15, "param15");

mit.track((new MappIntelligenceDataMap()).order(mappOrderData));