Developers
Start building
Themes/Theme SDK/Modules/store/Types

Types

The types of @poltura/theme-sdk/store.

On this page
import { … } from '@poltura/theme-sdk/store';

BankAccount

The bank account shoppers pay a bank transfer into.

bankNamerequiredstring

The bank's name.

holderrequiredstring

The account holder's name.

numberrequiredstring | null

The domestic account number, or null when only the IBAN is used.

ibanrequiredstring | null

The IBAN, or null outside IBAN countries.

bicrequiredstring | null

The BIC (SWIFT) code, or null.

CompanyRegistration

One labelled registration of the company behind the store, in the wording of its country.

kindrequiredCompanyRegistrationKind

What the entry identifies, for icons or ordering.

labelrequiredstring

The label in the page language, as that country names the register.

valuerequiredstring

The registered value exactly as the merchant entered it.

CompanyRegistrationKind

What a company registration entry identifies.

type CompanyRegistrationKind = 'taxId' | 'vatId' | 'registrationNumber' | 'registryCourt' | 'other'

CountryCode

An ISO 3166-1 alpha-2 country code in upper case, such as HU or DE.

type CountryCode = string

CurrencyCode

An ISO 4217 currency code in upper case, such as HUF or EUR.

type CurrencyCode = string

A link to one of the store's legal pages.

kindrequiredLegalLinkKind

Which legal page this is.

labelrequiredstring

The link text in the page language.

hrefrequiredstring

Where the link goes.

LegalLinkKind

Which legal page a footer or checkout link points at.

type LegalLinkKind = 'terms' | 'termsOfUse' | 'privacy' | 'imprint' | 'returns' | 'shipping' | 'cookies'

Market

Where the visitor buys: their country, the countries the store sells to, the currency and tax display.

countryrequiredCountryCode

The country checkout pre-selects: the chosen market's first.

countriesrequiredreadonly CountryCode[]

Every country the store sells to, in any market.

deliveryCountriesrequiredreadonly CountryCode[]

Where checkout ships from this page: the chosen market's countries, `country` first.

currencyCoderequiredCurrencyCode

The currency prices and carts are in: the shopper's pick among `currencies`.

currenciesrequiredreadonly CurrencyCode[]

Every currency this storefront offers, its default first; fewer than two means no choice.

taxIncludedrequiredboolean

Whether the market's prices include tax.

A link to one of the store's social profiles.

networkrequiredSocialNetwork

Which network the profile is on, for picking its icon.

urlrequiredstring

The profile URL.

labelrequiredstring

The network's brand name, for accessible link text.

SocialNetwork

A social network the store can link to.

type SocialNetwork = 'instagram' | 'facebook' | 'tiktok' | 'youtube' | 'pinterest' | 'linkedin' | 'x' | 'threads' | 'discord'

Store

The store's identity: name, address on the web, contact and the company behind it.

idrequiredStoreId

The Poltura store id.

namerequiredstring

The store's name as shoppers see it.

urlrequiredstring

The storefront's absolute URL, without a trailing slash.

timeZonerequiredstring

The store's IANA time zone; every store date renders in it.

contactrequiredStoreContact

How shoppers reach the store.

companyrequiredStoreCompany | null

The company behind the store, or null when the merchant has not given it.

bankAccountrequiredBankAccount | null

The account bank transfers go to, or null when the store takes none.

legalLinksrequiredreadonly LegalLink[]

Links to the store's legal pages, in footer order.

StoreBrand

The store's logos, colours and slogan.

logorequiredMediaImageRef | null

The logo for light backgrounds, or null to show the store name instead.

logoDarkrequiredMediaImageRef | null

The logo for dark backgrounds, or null to reuse `logo`.

markrequiredMediaImageRef | null

The square brand mark, used where a full logo does not fit.

colorsrequired{ readonly primary: string | null; readonly accent: string | null; }

The brand colours as CSS colour strings, null where the merchant set none.

sloganrequiredstring | null

A short slogan, or null.

descriptionrequiredstring | null

A sentence or two about the store, or null.

StoreCompany

The legal entity that runs the store.

namerequiredstring

The registered company name.

addressrequiredstring

The registered address on one line.

registrationsrequiredreadonly CompanyRegistration[]

The company's registrations, in the order its country lists them.

StoreContact

How shoppers reach the store's people.

emailrequiredstring | null

The general contact address, or null when the store shows none.

phonerequiredstring | null

The contact phone number as the merchant wrote it, or null.

supportEmailrequiredstring | null

The address for order and support questions, or null to fall back to `email`.

StoreFeatures

Which optional storefront features the store has switched on.

customerAccountsrequiredboolean

Shoppers can sign in and keep an account.

registrationrequiredboolean

Shoppers can open an account themselves; otherwise only the shop opens or invites them.

stockNoticesrequiredboolean

Shoppers can ask to be told when a sold-out variant is back.

chatrequiredboolean

The store answers live chat.

reviewsrequiredboolean

Product reviews are shown and collected.

preordersrequiredboolean

Products can be pre-ordered.

digitalDeliveryrequiredboolean

The store sells digital products delivered by email.

StoreId

The store's Poltura id, an opaque string that themes never parse.

type StoreId = string
Last updated