Theme SDK API reference

This reference is generated from the real public @upstorr/theme-sdk/v1 entry every time Help is built. It cannot silently become a hand-maintained list of old exports.

Start with the human-friendly SDK and commerce guides. Open a reference group when you need an exact exported name, TypeScript signature or return shape. The generated .upstorr-theme/sdk/ folder provides the same contract to VS Code autocomplete.

Reference groups

  • Accounts and addresses — Sign-in, account state, address forms and account editor attributes. (32 exports)
  • Analytics and consent — Storefront analytics events, page views and shopper cookie choices. (15 exports)
  • Bookings — Booking lists, offers, availability, slots and booking actions. (18 exports)
  • Cart — Cart state, line-item views, cart mutations and cart editor attributes. (21 exports)
  • Checkout and payments — Checkout drafts, validation, submission and payment-facing presentation data. (26 exports)
  • Commerce helpers — Shared helpers used by more than one storefront commerce feature. (106 exports)
  • Digital delivery — Protected digital-order delivery views and download actions. (12 exports)
  • Editor integration — Safe section and block attributes used by the visual editor. (6 exports)
  • Gift cards — Gift-card display and shopper actions. (3 exports)
  • Images — Responsive theme images and safe media source resolution. (3 exports)
  • Liquid rendering — Liquid section, block, context and rendering helpers. (28 exports)
  • Markets and money — India-first market presentation, currencies and money formatting. (19 exports)
  • Navigation and routes — Theme links, route builders, menus and client-side navigation. (27 exports)
  • Orders and returns — Order lists, shipment presentation, tracking, cancellations and returns. (56 exports)
  • Products and listings — Product, collection, search, review, variant and recommendation views. (80 exports)
  • Runtime events and attributes — Stable browser events and data attributes for custom theme JavaScript. (15 exports)
  • Shared exports and icons — Public shared exports and the supported icon set. (11 exports)
  • Storefront types — Core data shapes shared by storefront themes. (4 exports)
  • Wishlist — Wishlist state, mutations and update events. (8 exports)