Api
Modules
The engine's API modules, grouped by what they cover, with one page per module.
Check here before writing your own request: the engine probably has a module for it. A module is a small object of plain async functions plus a queries object of TanStack Query options, built on the shared client. Import each from its own subpath, for example @salla.sa/twilight-theme-engine/api/cart.
Every module page follows the same order: what it is for with a minimal example, a table of methods, the query keys, and gotchas. For how to call a module in a loader or a component, see the Overview.
Catalog
| Module | Covers |
|---|---|
product | One product, or a list from any source (latest, offers, brands, search and more) |
category | One category, or the whole category tree |
brands | A page of the brands directory, or one brand |
home | The home page components the merchant arranged |
page | One custom store page (such as "About us") by slug |
menu | The header and footer navigation menus |
blog | Articles, categories, tags and authors |
Shopping
| Module | Covers |
|---|---|
cart | One cart by id, with loyalty and gift information |
wishlist | The products the customer saved, paged by number |
order | Order lists, one order with shipments and ratings, and the thank-you data |
Customer
| Module | Covers |
|---|---|
user | The signed-in customer's profile, or null for a guest |
profile | Deleting the account and saving a preference |
wallet | Wallet balance and a page of transactions |
loyalty | The loyalty program and the customer's points balance |
notification | The customer's notifications, and marking them read |
Store
| Module | Covers |
|---|---|
store | Store info, theme settings, languages, currencies and payments in one request |
translations | The platform's translation messages for one language, and the merchant's own wording |
advertisement | The merchant's announcement bars, and which ones a page shows |
apps | Snippets and settings of the installed apps |
Next
Missing an endpoint? Write your own.