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.

root action_at

Action At

Type: stringFormat: date-time

root type
Type: enum (of string)

An enumeration.

Must be one of:

  • "physical"
  • "ecommerce"

root currency

Currency

Type: string

Currency code as ISO 4217
Example:

"USD"

root adjustments

Adjustments

Type: array
No Additional Items

Each item of this array must be:

root adjustments TransactionAdjustment
Type: object

root adjustments TransactionAdjustment price_adjustment

Price Adjustment

Type: number

Example:

50.0

root adjustments TransactionAdjustment adjusted_at

Adjusted At

Type: stringFormat: date-time

root adjustments TransactionAdjustment reason

Reason

Type: string

Example:

"gift card"

root custom_fields

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

Store Id

Type: string

Example:

"40bf96..."

root store type
Type: enum (of string)
    The type of store. 
    Note: `online` has been deprecated and may be removed in the future. 
    Use `ecommerce` instead.

Must be one of:

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

Example:

"ecommerce"

root store name

Name

Type: string

Example:

"St Kilda Outlet"

root store location
Type: object

root store location name

Location Name

Type: string

Example:

"St Kilda"

root store location coordinate
Type: object

root store location coordinate latitude

Latitude

Type: number

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

root store location coordinate longitude

Longitude

Type: number

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

root return_id

Return Id

Type: string

root products

Products

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:

root products ReturnProductReference
Type: object

root products ReturnProductReference product_reference
Type: object

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

An enumeration.

Must be one of:

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

root products ReturnProductReference product_reference dataset_id

Dataset Id

Type: string

Example:

"9wyqa53dnx"

root products ReturnProductReference price_paid

Price Paid

Type: number

Value must be lesser or equal to 0

root products ReturnProductReference quantity

Quantity

Type: integer

Value must be lesser or equal to -1