Actions reference

Runtime methods are grouped into namespaces and addressed as namespace.method. The same catalog backs three things: data-action, data-source, and window.appmint in a page script.

18 namespaces. The tables below list the methods most pages use; the full catalog — 211 methods — is what appmint.manifest() returns at runtime.

How to read this

Use as tells you where a method belongs:

Column value	Where it goes
Action	`data-action` — runs on an event
List	`data-source` — fetches and sets a context
Bind	`data-bind` — a live value, read-only
—	No panel hint; usable from a script

A ● marks the methods surfaced first in the property panel — the common ones.

`cart` — Storefront cart.

Method	Use as	Required params	Description
`cart.current` ●	List	—	Get the live cart.
`cart.add` ●	Action	`id`	Add a product to the cart.
`cart.remove` ●	Action	—	Remove an item.
`cart.update` ●	Action	`id`, `quantity`	Set / increment / decrement quantity.
`cart.clear`	Action	—	Empty the cart.
`cart.count` ●	Bind	—	Total item count (read-only — bind via data-bind="cart.count").
`cart.total` ●	Bind	—	Subtotal (read-only — bind via data-bind="cart.total").
`cart.toggle` ●	Action	—	Toggle the cart drawer.
`cart.open`	Action	—	Open the cart drawer.
`cart.close`	Action	—	Close the cart drawer.

`product` — Catalog browse / search.

Method	Use as	Required params	Description
`product.list` ●	List	—	List products.
`product.get` ●	Action	—	Get one product.
`product.categories`	List	—	Category tree.
`product.brands`	List	—	Brand list.
`product.collections`	List	—	Curated collections.
`product.related`	—	—	Related products.
`product.attributes`	—	—	Facet attributes.

`order` — Customer orders.

Method	Use as	Required params	Description
`order.list` ●	List	—	List the customer
`order.get` ●	Action	—	Get an order by id.
`order.cancel`	Action	`orderNumber`	Cancel an order.
`order.guestLookup`	Action	—	Guest order tracking.
`order.refund`	—	—	Request a refund.
`order.getByNumber`	—	—	Get by order number.
`order.myOrders`	—	—	All my orders.

`storefront` — Checkout, shipping, payments.

Method	Use as	Required params	Description
`storefront.paymentGateways` ●	List	—	Available payment gateways.
`storefront.checkout` ●	Action	—	Checkout the active cart.
`storefront.buyNow` ●	Action	—	Express single-product checkout.
`storefront.config` ●	List	—	Public storefront config.
`storefront.pricing` ●	—	—	Calculate price for a product/variant.
`storefront.cartPricing` ●	—	—	Recalculate full cart pricing.
`storefront.applyCoupon` ●	Action	—	Apply a coupon code.
`storefront.validateCoupon` ●	Action	—	Validate a coupon.
`storefront.activePromotions` ●	List	—	Currently-running promotions.
`storefront.shippingRates` ●	List	`destination`	Shipping rates for a basket + destination.
`storefront.verifyAddress` ●	Action	`street`, `city`, `state`, `zip`, `country`	Validate a shipping address.
`storefront.saveCart` ●	Action	—	Persist cart server-side.
`storefront.productSearch` ●	List	—	Full-text product search.

`rental` — Equipment / item rental.

Method	Use as	Required params	Description
`rental.catalog` ●	List	—	Browse rental items.
`rental.get` ●	Action	—	Get a rental item.
`rental.availability` ●	Action	—	Item availability.
`rental.quote` ●	Action	`sku`, `startDate`, `endDate`	Price for a date range.
`rental.book` ●	Action	—	Create a booking.
`rental.list`	List	—	My rentals.
`rental.cancel`	Action	—	Cancel a rental.

`customer` — Authentication & customer dashboard.

Method	Use as	Required params	Description
`customer.current` ●	Bind	—	Currently signed-in customer.
`customer.isSignedIn` ●	Bind	—	Sync sign-in check.
`customer.signIn` ●	Action	—	Sign in with email + password.
`customer.signUp` ●	Action	`firstName`, `lastName`	Create an account.
`customer.signOut` ●	Action	—	Sign out.
`customer.resetPassword`	Action	—	Send reset email.
`customer.addresses`	List	—	Address book.
`customer.wishlist`	List	—	Get wishlist.
`customer.wishlistAdd`	Action	—	Add to wishlist.
`customer.wishlistRemove`	Action	—	Remove from wishlist.

`ticket` — Support tickets.

Method	Use as	Required params	Description
`ticket.list` ●	List	—	Customer tickets.
`ticket.get` ●	—	—	Get one ticket.
`ticket.create` ●	Action	`collection`, `subject`, `message`	Open a ticket.
`ticket.guestCreate` ●	Action	`collection`, `subject`, `message`	Open a ticket as a guest.
`ticket.guestLookup`	Action	—	Look up by email + number.
`ticket.collections` ●	List	—	Ticket categories.

`reservation` — Bookings / reservations.

Method	Use as	Required params	Description
`reservation.list` ●	List	—	My reservations.
`reservation.get` ●	—	—	Get one.
`reservation.create` ●	Action	`reservationDefinitionId`, `serviceDate`, `startTime`, `customerName`	Make a reservation.
`reservation.availableSlots` ●	List	`reservationDefinitionId`, `serviceDate`	Open slots.
`reservation.cancel`	Action	—	Cancel.
`reservation.definitions` ●	List	—	Reservation services.

`events` — Public events.

Method	Use as	Required params	Description
`events.list` ●	List	—	Browse events.
`events.get` ●	—	—	Get an event.
`events.ticketTypes`	List	—	Ticket types/prices.
`events.register` ●	Action	`eventId`, `ticketTypeId`	Free registration.
`events.purchaseTickets` ●	Action	—	Buy tickets.

`repository` — READ-ONLY generic data access.

Method	Use as	Required params	Description
`repository.find` ●	List	—	Filter query against any datatype.
`repository.findOne` ●	—	—	Get by id.
`repository.search` ●	List	—	Search.

`media` — Audio / video / animation.

Method	Use as	Required params	Description
`media.play` ●	Action	—	Play.
`media.pause` ●	Action	—	Pause.
`media.stop`	Action	—	Stop.
`media.volume`	Action	`level`	Set volume 0..1.
`media.seek`	Action	`seconds`	Seek to seconds.
`media.toggleMute`	Action	—	Mute / unmute.
`media.loadTrack`	Action	`url`	Load + play in BottomAudioPlayer.
`media.animate`	Action	`target`, `action`	Toggle CSS animation.

`ui` — UI controls.

Method	Use as	Required params	Description
`ui.drawer` ●	Action	`id`	Open / close / toggle a wm-drawer.
`ui.dialog` ●	Action	`id`	Open / close / toggle a wm-dialog.
`ui.modal`	Action	`id`	Open / close / toggle a modal.
`ui.scrollTo`	Action	`target`	Scroll to an element.
`ui.notify` ●	Action	`message`	Show a toast.

`state` — In-memory reactive store.

Method	Use as	Required params	Description
`state.get`	—	—	Read at path.
`state.set` ●	Action	—	Write at path.
`state.inc` ●	Action	—	Increment number.
`state.dec` ●	Action	—	Decrement number.
`state.toggle` ●	Action	—	Toggle boolean.

`files` — File management.

Method	Use as	Required params	Description
`files.list` ●	List	—	List my files.
`files.upload` ●	—	—	Upload a file.
`files.delete`	Action	—	Delete a file.

`site` — Site / org info.

Method	Use as	Required params	Description
`site.current` ●	—	—	Current site.
`site.org`	—	—	Org info.

`page` — Page lookup.

Method	Use as	Required params	Description
`page.getBySlug`	—	—	Get a page by slug.

`form` — Form helpers.

Method	Use as	Required params	Description
`form.serialize`	—	—	Serialize form to object.
`form.validate`	—	—	Validate.
`form.reset`	—	—	Reset to defaults.

`contentPlayer` — Posts played page by page (courses, applications, trainings).

The post, page and access code default to the address — /<Content Player page>/<post>/<page>?code=… — so a page needs only the action. See Content Player.

Method	Use as	Required params	Description
`contentPlayer.mine` ●	List	—	My programs: status, % and next page. Signed in.
`contentPlayer.outline` ●	List	—	The post, its outline with each page's status, and my progress.
`contentPlayer.enroll` ●	Action	—	Start. Signed in.
`contentPlayer.item` ●	List	—	One page: content, prev / next, my saved answer.
`contentPlayer.complete` ●	Action	—	Finish this page (waits for review when it has reviewers).
`contentPlayer.progress`	—	`percent` or `score`	Report watched % or a score.
`contentPlayer.answer` ●	Action	form	Send the page's answer (`data-payload="form"`); files upload first.
`contentPlayer.saveDraft`	Action	form	Keep the answer as a draft.

Calling from a script

Every method is also on window.appmint:

(async () => {
  if (appmint.customer.isSignedIn()) {
    const me = await appmint.customer.current();
    appmint.ui.notify('Welcome back, ' + (me?.firstName || 'friend'), { kind: 'success' });
  }
  const count = await appmint.cart.count();
  appmint.state.set('cart.count', count);
})();

No build step and no framework — the API is on the page.

`repository` is read-only

repository.find, findOne and search reach any datatype the visitor is allowed to read. There is no write counterpart in the runtime — writes go through a specific action such as cart.add or ticket.create.

Runtime attributesHow to wire these into a page.Effects and formatsWhat runs after an action succeeds or fails.AppEngine APIThe server endpoints behind these methods.

How to read this

cart — Storefront cart.

product — Catalog browse / search.

order — Customer orders.

storefront — Checkout, shipping, payments.

rental — Equipment / item rental.

customer — Authentication & customer dashboard.

ticket — Support tickets.

reservation — Bookings / reservations.

events — Public events.

repository — READ-ONLY generic data access.

media — Audio / video / animation.

ui — UI controls.

state — In-memory reactive store.

files — File management.

site — Site / org info.

page — Page lookup.

form — Form helpers.

contentPlayer — Posts played page by page (courses, applications, trainings).