Skip to content

serverTracker.trackBeginCheckout()

Server-side begin_checkout. Symmetric with tracker.trackBeginCheckout() but requires clientId for GA4 stitching.

Signature

serverTracker.trackBeginCheckout(input: ServerBeginCheckoutInput): Promise<ServerHelperResult>;

`ServerBeginCheckoutInput`

type ServerBeginCheckoutInput = {
  transactionId?: string;
  value?: number;
  currency?: string;
  items?: TrackbridgeItem[];
  coupon?: string;
  clientId: string;
  userId?: string;
  gclid?: string;
  gbraid?: string;
  wbraid?: string;
  userData?: UserData;
  consent?: ServerConsent;
};

Field	Required	Notes
`transactionId`	no	Auto-generated when missing; standard dual-send-disabled warning fires.
`clientId`	yes	GA4 client ID from the browser.
`value`, `currency`, `items`, `coupon`	no	GA4 params.
`gclid` / `gbraid` / `wbraid`	no	Click identifiers.
`userData`	no	Hashed per enhanced conversions. Dropped if `consent.ad_user_data === 'denied'`.
`consent`	no	Per-call consent signals.

Returns

Promise<ServerHelperResult> — same shape as trackPurchase.

Example

const result = await serverTracker.trackBeginCheckout({
  transactionId: cart.id,
  value: cart.total,
  currency: cart.currency,
  items: cart.items,
  clientId: cart.gaClientId,
});

See also