Smootify.getConsent()

the visitor’s consent; loads Shopify’s Customer Privacy script when the page has not yet New in 2.0.

getConsent(): Promise<ConsentSnapshot>

Types

ConsentSnapshot

/** The visitor's consent, from Shopify's Customer Privacy API. */
export interface ConsentSnapshot {
  /** Shopify's script answered */
  loaded: boolean;
  /** the visitor's region asks for consent and it is not given yet (the banner shows) */
  required: boolean;
  /** US privacy laws: the "do not sell my data" choice applies */
  saleOfDataRegion: boolean;
  region: string;
  answers: Record<ConsentKey, ConsentAnswer>;
  allowed: Record<ConsentKey, boolean>;
  /** the visitor answered at least one category */
  interacted: boolean;
}