ReturnOrderEvent

com.salesforce.marketingcloud.sfmcsdk.components.events

An E-commerce event to manage details of returning an order.

1class ReturnOrderEvent : OrderEvent

• Target: androidJvm
• SDK Version: SFMC SDK v3.1.0
• API Documentation Version: 11.0.0

1Event
2  └── EngagementEvent
3        └── OrderEvent (sealed class)
4              └── ReturnOrderEvent

ReturnOrderEvent is a concrete implementation of the sealed class OrderEvent. It inherits all properties and methods from its parent classes without adding additional members.

The OrderEvent sealed class has the following inheritors:

• PurchaseOrderEvent
• PreorderEvent
• CancelOrderEvent
• ShipOrderEvent
• DeliverOrderEvent
• ReturnOrderEvent
• ExchangeOrderEvent

1val order: Order

The order data containing details about the order being returned.

1open override var category: Event.Category

The Event category name. Category contains list of allowed values.

1open override val priority: Priority

The priority level of the event.

1open override fun attributes(): Map<String, Any>

Returns the Event attributes for this event.

Returns: A map containing event attributes.

1open override fun name(): String

Returns the name for the event. This value must match the Event Name used when creating the event in the Marketing Cloud UI for any action to result from tracking this event.

Returns: The event name as a String.

The order property uses the Order data class, which has the following structure:

1data class Order @JvmOverloads constructor(
2    val id: String,
3    val lineItems: List<LineItem> = listOf(),
4    val totalValue: Double? = null,
5    val currency: String? = null,
6    val attributes: Map<String, Any> = mapOf()
7)

1val id: String

A unique identifier representing the order.

1val lineItems: List<LineItem>

An list of Line Item Data values.

1val totalValue: Double?

The total value of the order.

1val currency: String?

The currency of the total value for the order.

1val attributes: Map<String, Any>

A map of user-supplied values.

1// Create an order with return details
2val returnOrder = Order(
3    id = "ORDER-12345",
4    lineItems = listOf(
5        LineItem(
6            catalogObjectType = "product",
7            catalogObjectId = "PROD-789",
8            quantity = 1,
9            price = 49.99
10        )
11    ),
12    totalValue = 49.99,
13    currency = "USD",
14    attributes = mapOf(
15        "returnReason" to "Defective",
16        "refundMethod" to "Original payment method"
17    )
18)
19
20// Create a ReturnOrderEvent
21val returnEvent = ReturnOrderEvent()
22// Note: The actual constructor/initialization method would be
23// implementation-specific based on the parent OrderEvent class

• ReturnOrderEvent is used specifically for tracking when customers return orders.
• This event should be tracked when an order return is processed in your e-commerce system.
• The event name configured in this event must match the Event Name defined in the Marketing Cloud UI to trigger any associated actions or automations.
• The @JvmOverloads annotation on the Order constructor provides multiple constructor variants for Java interoperability.

• OrderEvent - The parent sealed class
• EngagementEvent - The grandparent sealed class
• Event - The root event interface
• LineItem - Used to represent individual items in the order
• Order - The data class containing order information