Availability

The order signal is included into all Connect subscriptions (Pro, Premium and Ultimate).

Configuration

The Connect library provides a method, TLT.logSignal() with which to send the signal to the Acoustic Connect endpoint, as a JSON object.

Required fields

Field	Values	Definition
`category`	String. Valid value - `Behavior`.	The category of the signal. Do not edit.
`currency`	String. Valid values - ISO 4217 currency codes.	The currency in which the price of the product is being represented
`effect`	String. Valid values: - `negative` - `positive`	Describes the effect of the signal on engagement. It is intended to be used for engagement index scoring. We suggest sending `positive` for all order signals.
`name`	String, up to 256 characters	Assign a name to the signal to differentiate it from other signals.
`orderId`	String	Identifier of the order
`signalType`	String. Valid value - `order`.	The type of signal to enable. Do not edit.

Optional fields

Field	Values	Definition
`orderDiscount`	Number	Discount amount for the order
`orderedItems`	Array	The list of products in the order
`orderShippingHandling`	Number	Shipping and handling amount for the order
`orderSubtotal`	Number	The subtotal of the order (net of discount)
`orderTax`	Number	Tax amount for the order
`orderValue`	Number	The total value of the order
`signalCustomAttributes`	Array of objects	Allows for additional custom attributes. For each custom attribute, add an object with two string fields:`name` and `value`.

Example

{
  "signalType": "order",
  "name": "order from product page",
  "category": "Behavior",
  "orderId": "UEKDXIPUE",
  "orderSubtotal": 29,
  "orderCurrency": "USD",
  "orderShippingHandling": 7,
  "orderDiscount": 0,
  "orderValue": 36,
  "effect": "positive"
}