TURBO for Developers

Home > widget-integration > CountdownCampaign

CountdownCampaign interface

Campaign data as returned by sip-api GET /bc-sf-filter/countdown-timer. Shape matches Redis hash field in bc-sf-filter:{tenantId}:countdown_timer.

Signature:

export interface CountdownCampaign

Remarks

updated_at, start_date, and end_date are Unix timestamps in milliseconds. product_ids and collection_ids are present only when the campaign targets specific products or collections rather than the entire store.

Properties

Property	Type	Description
collection_ids?	number[]	(Optional)
countdown_timer_type	CountdownTimerType
country	string \| null
end_date?	number	(Optional)
product_ids?	number[]	(Optional)
scopes	CountdownPlacement[]
settings	{ timerSettings: CountdownTimerSettings; generalSettings: CountdownGeneralSettings; styleSettings: CountdownStyleSettings; styleSettingsCartDrawer?: CountdownStyleSettings; }
start_date?	number	(Optional)
timer_id	string
timer_type	TimerType
updated_at	number