Order signals
An order represents a transaction placed by a user within an application.
- Retail: Typically an order confirmation
- Travel: Typically a booking confirmation
- Banking / Insurance: Typically an application confirmation
Configuration
Required fields
| Field | Values | Definition |
|---|---|---|
category | String. Valid value - Behavior | The category of the signal. For behavioral signals the category should always be “Behavior”. |
name | String | The name assigned to the signal. Can contain specific information about the signal that differentiates it from other signals. |
signalType | String. For order signals, useorder. | The type of signal being sent. Must be from the set of supported signals. |
orderId | String | Identifier of the order |
orderCurrency | String | Currency for the order |
Optional fields
| Field | Values | Definition |
|---|---|---|
effect | String. Valid values: - negative- positive | Describes the effect of the signal on engagement. It is intended to be used for engagement index scoring. |
signalCustomAttributes | String | Allows for custom attributes that are not predefined by the product |
orderSubtotal | Number or string | The subtotal of the order |
orderShippingHandling | Number or string | Shipping and handling amount for the order |
orderTax | Number or string | Tax amount for the order |
orderDiscount | Number or string | Discount amount for the order |
orderValue | Number or string | Total value of the order |
Sample payload
Data for the payload is collected when order confirmation is displayed.
{
"signalType": "order",
"name": "order from product page",
"category": "Behavior",
"orderId": "UEKDXIPUE",
"orderSubtotal": 29,
"orderCurrency": "USD",
"orderShippingHandling": 7,
"orderDiscount": 0,
"orderValue": 36,
"effect": "positive"
}
All data in the SDK payload must be collected manually, there is no automatic binding to the payload fields.
Important
Product Purchase core behaviors should always coincide with Order core behaviors. The Order contains metadata for the entire order / conversion. There should be individual Product Purchase core behaviors for each individual Product ID that is part of the order / conversion.
Updated 22 days ago