PurchaseEvent

Type: object

A purchase event object record_type=purchase.
Represents transaction data and is used to enrich profiles with their complete purchase history.

root action_at
Type: stringFormat: date-time

root type
Type: enum (of string)

An enumeration.

Must be one of:

  • "physical"
  • "ecommerce"

root currency
Type: string

Currency code as ISO 4217
Example:

"USD"

root adjustments
Type: array
No Additional Items

Each item of this array must be:

root adjustments TransactionAdjustment
Type: object

root adjustments TransactionAdjustment price_adjustment
Type: number

Example:

50.0

root adjustments TransactionAdjustment adjusted_at
Type: stringFormat: date-time

root adjustments TransactionAdjustment reason
Type: string

Example:

"gift card"

root custom_fields
Type: object

Custom Fields. Properties are open, but a dataset may be configured to accept only particular fields to facilitate automated processing in the Lexer CDP.
Example:

{
    "is_damaged": true,
    "customer_reason": "glass broken on delivery"
}

root store
Type: object

A store entity.

root store store_id
Type: string

Example:

"40bf96..."

root store type
Type: enum (of string)

An enumeration.

Must be one of:

  • "physical"
  • "online"
  • "concession"
  • "outlet"

root store name
Type: string

Example:

"St Kilda Outlet"

root store location
Type: object

root store location name
Type: string

Example:

"St Kilda"

root store location coordinate
Type: object

root store location coordinate latitude
Type: number

Value must be greater or equal to -90 and strictly lesser than 90

root store location coordinate longitude
Type: number

Value must be greater or equal to -180 and strictly lesser than 180

root purchase_id
Type: string

Example:

"53059a..."

root payment_types
Type: array
No Additional Items

Each item of this array must be:

root payment_types PaymentType
Type: object

root payment_types PaymentType name
Type: string

Example:

"visa"

root payment_types PaymentType total
Type: number

Example:

100.0

root products
Type: array

Contains the 'order lines' in the purchase event. Each record in this array represents a specific product that was purchased including details such as quantity, price paid etc.

 No Additional Items

Each item of this array must be:

root products PurchaseProductReference
Type: object

root products PurchaseProductReference product_reference
Type: object

root products PurchaseProductReference product_reference id_type
Type: enum (of string)

An enumeration.

Must be one of:

  • "sku"
  • "upc"
  • "product_id"

root products PurchaseProductReference product_reference dataset_id
Type: string

Example:

"9wyqa53dnx"

root products PurchaseProductReference price_paid
Type: number

Value must be greater or equal to 0


Example:

90.0

root products PurchaseProductReference quantity
Type: integer

Value must be greater or equal to 1


Example:

2

root products PurchaseProductReference full_price
Type: number

Example:

50.0

root products PurchaseProductReference discount
Type: number

Example:

10.0