This page is the curated reference. The complete, generated type reference lives at /kit/api/core and is regenerated from the published typings. Every type here is exported from
@quickbutik/kit and @quickbutik/kit/sdk.Money is always an integer in the currency’s minor unit (öre, cents):
24900 is 249.00. The MinorUnits alias marks every such field. Prices include VAT. Divide by 100 or use formatMoney, with the currency the response states (product.currency, cart.currency). See Currencies.Page
CatalogPricing
Who a catalog response was priced for:page.meta.pricing on a product list or search, product.pricing on a single read. Absent from a platform older than the field.
A guest, a logged-in customer in no group, or one priced with their group’s prices.
How the group shows prices. A display hint only; the amounts are the same either way.
Product
What every price on this product is in: the client’s chosen currency when the shop offers it, else the shop’s own. Format with this. Absent on a platform older than the field.
Optional on the wire; the variant matrix rebuilds groups from the variants when absent.
Only from
products.get().Who the product was priced for. Only from
products.get() and getBySlug(); lists carry it once per page.products.search({ categoryId }).
ProductVariant
ProductImage
ProductOptionType and ProductOptionValue
ProductSection
[STOCKLEFT], [PRICE] and [BEFOREPRICE] merge tags are replaced.
RelatedProducts
category: up to 8 from the same category, newest first. specific: the merchant’s hand-picked list, up to 12. none: always empty.Category
Shop
The shop’s own (base) currency, upper-case ISO 4217. Absent on a platform older than the field.
Every currency a shopper may browse in, base first. Only the base entry when the merchant’s currency converter is off; read a missing field the same way.
The merchant’s tracking ids as configured in the admin, already validated by the platform. What the kit’s analytics loads by default (
destinationsFromShop). Absent on a platform older than the field.demo.enabled, not declared on the type: true while the shop has not activated Quickbutik Payments and its checkout runs in demo mode.
Cart
What every amount in this response is in. A cart is priced per request, so the same cart can read in SEK on one request and EUR on the next.
How
currency relates to the checkout. A missing field means mode: "base".CartItem
CheckoutSession
Returned bycreateSession() and as session on a v2 start result.
The currency the checkout shows an approximate amount in, set when the session was created with a
"display" currency. null when none applies (no currency sent, the shop’s own, or a "charge" currency, in which case data.pricing.value.currency is it).Shopper-supplied values with the server’s verdict:
value, status (empty, valid, invalid), errors, updatedAt.CheckoutSessionSnapshot
Returned bygetSession() and syncCart(). The same fields as a session (without sessionId and theme), plus:
The data nodes worth reading (CheckoutDataNodes):
order_total.total is the figure the shopper is charged. Never recompute it.
SessionConfirmation
processing_payment: paid, order being created (typically 6 to 17 seconds). no_attempt: no payment attempt known yet.ConfirmationOutcome
orderNumber can be null on completed. Fall back to checkout.parseReturnUrl(location.href)?.orderNumber for display.
CurrencyInfo
WhatdescribeCurrency(shop, selected) and useCurrency() resolve a currency choice to.
What prices are shown in: the choice when the shop offers it, else the shop’s own.
null only before the shop is known with nothing chosen.ConsentState
The shopper’s cookie decision, asshopkit.consent.read(), readConsentCookie() and the consent store report it. ConsentSnapshot (the store’s snapshot) adds open: boolean, whether the preferences panel is open.
ConsentCategory is "necessary" | "analytics" | "marketing"; ConsentChoice is { analytics: boolean; marketing: boolean }. See Consent and analytics.
Customer
The logged-in customer, ascustomers.login(), customers.register(), customers.resetPassword(), customers.me() and useCustomer() return it. See Customer accounts.
CustomerSession
Whatcustomers.login() and customers.resetPassword() resolve with, and what a logged_in CustomerRegisterResult carries. CustomerSessionInput, which setSession() takes, has the same fields without customer, and everything but accessToken optional.
CustomerRegisterInput
Whatcustomers.register() takes. See Registration.
Also join the customer club, when the shop’s club takes members at registration (
customerClub.joinMethod is registration or auto_and_registration). Ignored otherwise.CustomerRegisterResult
Whatcustomers.register() resolves with. Check status before reading the session fields.
CustomerPasswordResetRequestInput, CustomerPasswordResetInput
Whatcustomers.requestPasswordReset() and customers.resetPassword() take.
CustomerPasswordResetInput only. The one-time code from the email. Case, spaces and dashes don’t matter.CustomerPasswordResetInput only. The new password, with the same rules as for registration.CustomerState
Whatcustomers.onChange() listeners get, or null when nobody is logged in. The qb:customer DOM event carries { customerId } only.
The profile, when this client has read it. A session set with
setSession() has none until me() reads it.CustomerClub
CustomerAccountsConfig
The shop’s customer-account settings, fromcustomers.config().