ExchangeOrderEvent

1com.salesforce.marketingcloud.sfmcsdk.components.events

An E-commerce event to manage details of exchanging an order. This class is part of the Salesforce Marketing Cloud Unified SDK and is used to track order exchange activities in your Android application.

• Target: androidJvm
• SDK Version: 11.0.0 (also available in 10.0.0)
• SFMC SDK: v3.1.0

1class ExchangeOrderEvent : OrderEvent

1Event (abstract)
2  └── EngagementEvent (sealed)
3      └── OrderEvent (sealed)
4          └── ExchangeOrderEvent

Based on the OrderEvent pattern, the constructor accepts:

1ExchangeOrderEvent(order: Order)

• order: Order - An Order object containing the details of the order being exchanged

1val order: Order

Contains order information associated with the event.

1open override var category: Event.Category

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

1open override val priority: Priority

Priority level for the event.

1@JvmField
2val id: String

Event identifier.

1val producer: Event.Producer

The Event Producer Name. Producer contains list of allowed values.

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 tracking functionality.

Returns: Event name as a String

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

The Event attributes for this event.

Returns: A map of attribute names to values

1fun track(): void

Method to track this Event via EventManager to subscriber EventSubscriber.

1fun toJson(): JSONObject

Converts the event to JSON format.

Returns: JSONObject representation of the event

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

• id: String (required) - A unique identifier representing the order
• lineItems: List<LineItem> (default: empty list) - A list of Line Item Data values
• totalValue: Double? (default: null) - The total value of the order
• currency: String? (default: null) - The currency of the total value for the order
• attributes: Map<String, Any> (default: empty map) - A map of user-supplied values

1@JvmOverloads
2constructor(
3    catalogObjectType: String,
4    catalogObjectId: String,
5    quantity: Int,
6    price: Double? = null,
7    currency: String? = null,
8    attributes: Map<String, Any> = mapOf()
9)

• catalogObjectType: String (required) - A type name representing the catalog object referenced in the line item
• catalogObjectId: String (required) - A unique identifier representing the catalog object referenced in the line item
• quantity: Int (required) - The number of catalog objects in this line item
• price: Double? (optional) - The price of the catalog object referenced in the line item
• currency: String? (optional) - The currency for the price field
• attributes: Map<String, Any> (default: empty map) - A map of user-supplied values

List of possible Category values for sending Events:

• APPLICATION
• ENGAGEMENT
• IDENTITY
• SYSTEM
• BILLING
• CUSTOM

List of possible Producer values for sending Events:

• CUSTOMER_APP - Represents events from the customer’s application
• UNIFIED_SDK - Represents events from the unified SDK
• MCE_MODULE - Represents events from the MCE module
• DC_MODULE - Represents events from the DC module
• MAM_MODULE - Represents events from the MAM module
• PUSH_FEATURE_MODULE - Represents events from the push feature module
• IAM_FEATURE_MODULE - Represents events from the in-app messaging feature module

Other OrderEvent subclasses for tracking different order lifecycle events:

• PurchaseOrderEvent - An E-commerce event for when a user makes a purchase
• PreorderEvent - An E-commerce event for when a user places a preorder
• CancelOrderEvent - An E-commerce event for when a user cancels an order
• ShipOrderEvent - An E-commerce event to manage details of an order shipment
• DeliverOrderEvent - An E-commerce event to manage details of an order delivery
• ReturnOrderEvent - An E-commerce event to manage details of returning an order

1// Create line items for the exchange
2val lineItem = LineItem(
3    catalogObjectType = "product",
4    catalogObjectId = "PROD-12345",
5    quantity = 2,
6    price = 49.99,
7    currency = "USD",
8    attributes = mapOf("color" to "blue", "size" to "M")
9)
10
11// Create an order object
12val order = Order(
13    id = "ORDER-98765",
14    lineItems = listOf(lineItem),
15    totalValue = 99.98,
16    currency = "USD",
17    attributes = mapOf("reason" to "size_exchange")
18)
19
20// Create and track the exchange event
21val exchangeEvent = ExchangeOrderEvent(order)
22exchangeEvent.track()

• This is a concrete implementation of the sealed class OrderEvent
• The @JvmOverloads annotation on Order and LineItem constructors provides Java interoperability with multiple constructor overloads
• The event name must match the Event Name configured in the Marketing Cloud UI for proper tracking
• Use the track() method to send the event to the Marketing Cloud SDK for processing