ReturnEvent

Type: object

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

Type: stringFormat: date-time

Type: enum (of string)

An enumeration.

Must be one of:

  • "physical"
  • "ecommerce"

Type: string

Currency code as ISO 4217


Example:

"USD"

Type: array
No Additional Items

Each item of this array must be:

Type: object

Type: number

Example:

50.0

Type: stringFormat: date-time

Type: string

Example:

"gift card"

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"
}

Type: object

A store entity.

Type: string

Example:

"40bf96..."

Type: enum (of string)

An enumeration.

Must be one of:

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

Type: string

Example:

"St Kilda Outlet"

Type: object

Type: string

Example:

"St Kilda"

Type: object

Type: number

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

Type: number

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

Type: string

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

Type: object

Type: enum (of string)

An enumeration.

Must be one of:

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

Type: string

Example:

"9wyqa53dnx"

Type: number

Value must be lesser or equal to 0

Type: integer

Value must be lesser or equal to -1