ReturnOrderEvent

com.salesforce.marketingcloud.sfmcsdk.components.events

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

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

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

The order data containing details about the order being returned.

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

The priority level of the event.

Returns the Event attributes for this event.

Returns: A map containing event attributes.

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:

Parameter	Type	Default	Description
id	String	required	A unique identifier representing the order.
lineItems	List<LineItem>	listOf()	A list of Line Item Data values.
totalValue	Double?	null	The total value of the order.
currency	String?	null	The currency of the total value for the order.
attributes	Map<String, Any>	mapOf()	A map of user-supplied values.

A unique identifier representing the order.

An list of Line Item Data values.

The total value of the order.

The currency of the total value for the order.

A map of user-supplied values.

• 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