Events

Event payload types for the Marketfront SDK.

Event Summary

Event	Payload Type	Description
onReady	None	Marketfront initialized
onError	MarketfrontError	Error occurred
onStoreSelected	StoreEvent	User selected a store
onItemAdded	ItemAddedEvent	Item added to cart
onCheckoutStarted	CheckoutStartedEvent	Checkout began
onOrderComplete	Order	Order placed successfully
onOrderFailed	OrderFailedEvent	Order placement failed

Error Types

MarketfrontError

Web

interface MarketfrontError {
  code: string;
  message: string;
  details?: unknown;
}

iOS

struct MarketfrontError: Error {
    let code: String
    let message: String
    let details: Any?
}

Android

data class MarketfrontError(
    val code: String,
    val message: String,
    val details: Any? = null
) : Exception(message)

Store Events

StoreEvent

Web

interface StoreEvent {
  storeId: string;
  name: string;
  distance?: number;
  estimatedDeliveryTime?: number;
}

iOS

struct StoreEvent {
    let storeId: String
    let name: String
    let distance: Double?
    let estimatedDeliveryTime: Int?
}

Android

data class StoreEvent(
    val storeId: String,
    val name: String,
    val distance: Double?,
    val estimatedDeliveryTime: Int?
)

Cart Events

ItemAddedEvent

Web

interface ItemAddedEvent {
  lineItemId: string;
  itemId: string;
  name: string;
  quantity: number;
  price: number;
  modifiers?: Array<{
    name: string;
    price: number;
  }>;
}

iOS

struct ItemAddedEvent {
    let lineItemId: String
    let itemId: String
    let name: String
    let quantity: Int
    let price: Decimal
    let modifiers: [Modifier]?
}

Android

data class ItemAddedEvent(
    val lineItemId: String,
    val itemId: String,
    val name: String,
    val quantity: Int,
    val price: BigDecimal,
    val modifiers: List<Modifier>?
)

Checkout Events

CheckoutStartedEvent

Web

interface CheckoutStartedEvent {
  storeId: string;
  itemCount: number;
  subtotal: number;
}

iOS

struct CheckoutStartedEvent {
    let storeId: String
    let itemCount: Int
    let subtotal: Decimal
}

Android

data class CheckoutStartedEvent(
    val storeId: String,
    val itemCount: Int,
    val subtotal: BigDecimal
)

Order Events

OrderFailedEvent

Web

interface OrderFailedEvent {
  reason: string;
  message: string;
}

iOS

struct OrderFailedEvent {
    let reason: String
    let message: String
}

Android

data class OrderFailedEvent(
    val reason: String,
    val message: String
)