Campaign
interface Campaign {
id?: number;
currency: string;
language: string;
name: string;
packages: Package[];
payment_env_key: string;
shipping_methods: ShippingOption[];
offers?: Offer[];
available_currencies?: { code: string; label: string }[];
available_shipping_countries?: { code: string; label: string }[];
available_express_payment_methods?: { code: string; label: string }[];
available_payment_methods?: { code: string; label: string }[];
}Source: global.ts:1156
The campaign a page is selling — its packages, pricing currency, shipping options, and the payment/currency/country choices available to the shopper. Loaded once at init and held in useCampaignStore (on its .data field), and delivered with the campaign:loaded event.
Properties
id: number
Internal NEXT campaign id.
currency: string
ISO currency code all package prices are quoted in.
language: string
Campaign language code (e.g. "en").
name: string
Campaign display name.
packages: Package[]
Every package (offer) the campaign sells.
payment_env_key: string
Public key used to initialise the payment gateway.
shipping_methods: ShippingOption[]
Shipping options the shopper can choose from.
offers: Offer[]
Offers/discount rules configured for the campaign, if any.
available_currencies: { code: string; label: string }[]
Currencies the shopper may switch between, with display labels.
available_shipping_countries: { code: string; label: string }[]
Countries the campaign can ship to, with display labels.
available_express_payment_methods: { code: string; label: string }[]
Express payment methods enabled (PayPal, Apple Pay, …).
available_payment_methods: { code: string; label: string }[]
Standard payment methods enabled for checkout.