Skip to content

Modules

Every area of the API, as a property of the client.

1 min readUpdated View as Markdown

Each module maps to an area of the storefront API.

Module Use it for
dash.products list(...), getCore(slug) for fast server rendering, full product data, search.
dash.categories, dash.brands Catalog structure for menus and filters.
dash.cart, dash.checkout Cart lines, totals, tax and shipping quotes, placing the order.
dash.payment, dash.paymentMethods Tokenized payments and saved methods.
dash.auth Shopper sign-up, sign-in and account.
dash.blog, dash.pages, dash.seo Posts, storefront pages and SEO data.
dash.pageGroup(slug) One page group: .all(), .get(slug).
dash.media, dash.legal, dash.htmlTemplates Media, legal documents, HTML fragments.
dash.contact, dash.forms, dash.survey Contact forms, forms and surveys.
dash.calendar Availability and bookings.
dash.loyalty, dash.earnPoints, dash.discountStore, dash.referrals, dash.affiliates Loyalty and referral programs.
dash.subscriptions Customer subscriptions.
dash.shipping, dash.tax Shipping options and tax.
dash.coa Lab reports (certificates of analysis) for products.
dash.insights, dash.tracking Privacy-first analytics.
dash.sitemap Everything your sitemap needs.
dash.admin Secret-key only: write blog posts, page groups, products, media.
TypeScript
const { global } = await dash.getGlobalData();              // site settings, menus, in one call
const { products } = await dash.products.list({ limit: 12 });
const { items } = await dash.pageGroup("services").all();

Privacy defaults

  • Payment calls send line items as Item 1, Item 2: processors never see product names.
  • dash.insights sends opaque visitor and session ids, paths without query strings, referrer domains and device class. Never a customer id or page title.
  • Third-party pixels you call yourself (Meta, TikTok, Klaviyo) receive what you pass them. On a health catalog, only send product names to vendors covered by a BAA.

Keep reading

Something wrong or missing on this page? Email support@dashfordevs.com.