Skip to content

Checkout and Basket Events

For developers

The CHECKOUT and BASKET_OPERATIONS families — the conversion funnel. Business meaning: Event Catalog.

CHECKOUT family

BasketView (step: view-basket)

Method

events.BasketView(params)

Parameter details

  • Required (type) totalPrice
  • Required (type) cartUrl
  • Required (type) productList

Runtime note

Example app uses cartUrl: 'shopapp://basket' in basket screen flow.

SDK-added fields

  • basketId is auto-created as basketId_{userId}

Purchase (step: purchase)

Method

events.Purchase(params)

Parameter details

  • Required (type) totalPrice
  • Required (type) orderNo
  • Required (type) productList
  • Optional paymentType, discounts, shipment, tax, coupon

Runtime note

Checkout success maps route orderId to payload orderNo, matching type contract.

Additional checkout steps

  • events.CustomerInformation(...) -> step: customer-info
  • events.PaymentInformation(...) -> step: payment-info

Use these when your checkout has dedicated customer/payment stages.

BASKET_OPERATIONS family

BasketAdd (step: add)

  • Required (type) productId
  • Required (type) quantity
  • Optional price

BasketRemove (step: remove)

  • Required (type) productId
  • Required (type) quantity (type contract)
  • Runtime note: shared cart hook sends productId, quantity, and price

BasketClear (step: clear)

  • method has no input argument
  • SDK sends only family/step plus auto basketId

Concrete example payload fragment

productList: cart.items.map((item) => ({
productId: item.productId,
quantity: item.quantity,
price: item.price,
}));

Where these are used

Use useEffect or navigation-focus handlers for BasketView and Purchase so each user action produces one deterministic event.