Class Flowbiz

Synchronizes the known attributes of the logged-in user without emitting a login event. Use it to refresh profile data mid-session; the login itself is reported by session.notifyLogin.

user.userId and user.email are both required by the SDK.

Example:

const modules = await Eitri.modules();
const accountSync = modules?.flowbiz?.accountSync;
if (!accountSync) return;

await accountSync({
  user: {
    userId: "cust-12345",
    email: "[email protected]",
    phone: "11987654321",
    name: "Ana Silva",
    plan: "gold"
  }
});
Copy

Tracks products added to the cart. Each item requires productId, sku, quantity and price.

Example:

const modules = await Eitri.modules();
const addToCart = modules?.flowbiz?.addToCart;
if (!addToCart) return;

await addToCart({
  products: [
    { productId: "p-001", sku: "sku-001", quantity: 2, price: 299.9, name: "Tênis Runner" }
  ]
});
Copy

Updates the quantity of a single cart line.

Example:

const modules = await Eitri.modules();
const cartItemUpdate = modules?.flowbiz?.cartItemUpdate;
if (!cartItemUpdate) return;

await cartItemUpdate({ cartId: "cart-001", productId: "p-001", sku: "sku-001", quantity: 3 });
Copy

Records a coupon applied to the cart.

Example:

const modules = await Eitri.modules();
const cartSetCoupon = modules?.flowbiz?.cartSetCoupon;
if (!cartSetCoupon) return;

await cartSetCoupon({ cartId: "cart-001", coupon: "PRIMEIRACOMPRA" });
Copy

Records the postal code applied to the cart (freight calculation).

Example:

const modules = await Eitri.modules();
const cartSetPostalCode = modules?.flowbiz?.cartSetPostalCode;
if (!cartSetPostalCode) return;

await cartSetPostalCode({ cartId: "cart-001", postalCode: "20510-000" });
Copy

Sends the full current state of the cart. An empty-items cart is valid and meaningful — it is how the platform learns the cart was emptied.

All five monetary totals (subtotal, total, freight, tax, discounts) are required.

Example:

const modules = await Eitri.modules();
const cartSync = modules?.flowbiz?.cartSync;
if (!cartSync) return;

await cartSync({
  cart: {
    cartId: "cart-001",
    subtotal: 299.9,
    total: 319.9,
    freight: 20,
    tax: 0,
    discounts: 0,
    currency: "BRL",
    items: [
      { productId: "p-001", sku: "sku-001", quantity: 1, price: 299.9 }
    ]
  }
});

// An empty cart is valid — it is how the platform learns the cart was emptied.
await cartSync({ cart: { cartId: "cart-001", subtotal: 0, total: 0, freight: 0, tax: 0, discounts: 0, items: [] } });
Copy

Tracks progress through the checkout funnel.

Example:

const modules = await Eitri.modules();
const checkoutStep = modules?.flowbiz?.checkoutStep;
if (!checkoutStep) return;

await checkoutStep({
  checkout: { cartId: "cart-001", step: 2, totalSteps: 4, stepName: "pagamento" }
});
Copy

Requests an immediate delivery attempt of the queued events. Delivery is otherwise handled by the SDK's own heartbeat schedule, so calling this is only useful before a foreseeable interruption.

Example:

const modules = await Eitri.modules();
const flush = modules?.flowbiz?.flush;
if (!flush) return;

await flush();
Copy

Decodes a Flowbiz cart-recovery link and returns the cart it points to, or undefined when the URL carries no Flowbiz recovery payload.

Use it when the app opens from a marketing link and should restore the abandoned cart.

Example:

const modules = await Eitri.modules();
const handleRecoveryLink = modules?.flowbiz?.handleRecoveryLink;
if (!handleRecoveryLink) return;

const recovered = await handleRecoveryLink({ url: deeplinkUrl });
if (recovered) {
  // restore recovered.products into the local cart
}
Copy

Tracks a cancelled order. At least one of orderId / cartId should be provided.

Example:

const modules = await Eitri.modules();
const orderCancel = modules?.flowbiz?.orderCancel;
if (!orderCancel) return;

await orderCancel({ orderId: "ORD-789", cartId: "cart-001" });
Copy

Tracks a completed order. Requires the same five monetary totals as cartSync.

Example:

const modules = await Eitri.modules();
const orderComplete = modules?.flowbiz?.orderComplete;
if (!orderComplete) return;

await orderComplete({
  order: {
    cartId: "cart-001",
    orderId: "ORD-789",
    subtotal: 299.9,
    total: 319.9,
    freight: 20,
    tax: 0,
    discounts: 0,
    currency: "BRL",
    items: [{ productId: "p-001", sku: "sku-001", quantity: 1, price: 299.9 }],
    paymentMethods: [{ type: "credit_card", amount: 319.9 }],
    deliveryMethods: [{ type: "standard", amount: 20 }]
  }
});
Copy

Tracks a page/screen view.

Example:

const modules = await Eitri.modules();
const pageView = modules?.flowbiz?.pageView;
if (!pageView) return;

await pageView({ path: "/carrinho", title: "Carrinho" });
Copy

Tracks a product view. The product must carry at least one variant, and each variant requires sku and price.

Example:

const modules = await Eitri.modules();
const productView = modules?.flowbiz?.productView;
if (!productView) return;

await productView({
  product: {
    productId: "p-001",
    category: "calcados",
    variants: [{ sku: "sku-001", price: 299.9 }]
  }
});
Copy

Enables or disables collection at runtime. While disabled the SDK drops events instead of queueing them, so use it to honour a consent decision taken inside the app.

Example:

const modules = await Eitri.modules();
const setEnabled = modules?.flowbiz?.setEnabled;
if (!setEnabled) return;

// Honour a consent decision taken inside the app.
await setEnabled({ enabled: false });
Copy