Skip to content

DisplaySharingPageParamsType

DisplaySharingPageParamsType = { attribution?: AttributionParams | null; checkoutToken?: string; link?: string; metadata?: { homepageLink?: string; i18n?: I18nConfig; logo?: string; targetInteraction?: InteractionTypeKey; }; products?: SharingPageProduct[]; }

Defined in: types/rpc/displaySharingPage.ts:42

Parameters to display the sharing page

optional attribution?: AttributionParams | null

Defined in: types/rpc/displaySharingPage.ts:70

Optional attribution overrides for the outbound sharing URL.

When provided (even as an empty object), Frak adds utm_source=frak alongside fCtx; every other param (utm_medium, utm_campaign, utm_content, utm_term, via, ref) is added only when you or the merchant’s resolved config supplies it. Existing UTMs on the base URL are preserved (gap-fill). Set this to null to disable attribution params entirely (only fCtx is added).

{} — defaults applied

optional checkoutToken?: string

Defined in: types/rpc/displaySharingPage.ts:58

Opaque per-order token (Shopify’s checkout token, or a plugin equivalent). Lets the sharing page derive an identity from the order when the caller’s own clientId is missing, so the install CTA still carries a credential.


optional link?: string

Defined in: types/rpc/displaySharingPage.ts:52

Optional link override for sharing If not provided, the sharing link will be generated from the current page URL + merchant context


optional metadata?: { homepageLink?: string; i18n?: I18nConfig; logo?: string; targetInteraction?: InteractionTypeKey; }

Defined in: types/rpc/displaySharingPage.ts:74

Optional metadata overrides for the sharing page

optional homepageLink?: string

Link to the homepage of the calling website

optional i18n?: I18nConfig

i18n overrides for the sharing page

optional logo?: string

Logo override for the sharing page header

optional targetInteraction?: InteractionTypeKey

The target interaction behind this sharing page


optional products?: SharingPageProduct[]

Defined in: types/rpc/displaySharingPage.ts:47

Products to showcase on the sharing page If provided, they will be displayed in a product card section