Skip to content

Guides

Guides are task-oriented walkthroughs — the layer above the API reference, which documents endpoints one at a time. Each combines several endpoints to accomplish something real, with TypeScript samples you can lift directly.

Most guides below assume the tenant header (x-organization-slug) and, for writes, a merchant bearer token — the exceptions are Self-serve signup, a public flow that needs neither, and Google Analytics 4 on hosted litecheckout, which is configured in Merchant Admin and your GA4 property and makes no authenticated API call. Paths are under the /api/v1 prefix.

Available guides

  • Storefront integration — the public-read-first path for building a storefront, and the cart/checkout boundary (what's an estimate today vs. what an order actually persists). Start here if you're building a storefront.
  • Hosted litecheckout — the litecommerce-hosted, tenant-branded checkout + customer-account surface at {tenant}.litecheckout.io, and how a storefront hands off to it per area.
  • Google Analytics 4 on hosted litecheckout — your own GA4 tag on the hosted checkout page: the exact events sent, what is never sent, environment separation, and cross-domain attribution.
  • BYO checkout API — build a tenant-owned checkout on the public checkout-session APIs without bypassing server-side pricing, tax, payment, or order creation.
  • Customer accounts & sign-in — passwordless (magic link / OTP) auth and the authenticated account API: profile, addresses, order history, and returns.
  • Order status links — the post-purchase, tokenized order-status page delivered with the confirmation email; no customer sign-in required.
  • Tenant payment accounts (Connect) — connect a tenant's own Stripe account so it is the merchant of record: the capability gate and the connected-account charge contract. (M3.5 — live in production; a tenant takes real money once its connected account reaches VERIFIED.)
  • Self-serve signup — submit a tenant signup over the public API and understand the review + provisioning lifecycle.
  • Catalog: products & variants — create and publish products, manage variants, archive and restore.
  • Collections & pages — group products into collections and publish CMS pages.
  • Inventory — read stock levels and apply adjustments, reservations, and low-stock thresholds.
  • Media uploads — the signed-URL flow for attaching images to items and collections.
  • Settings & onboarding — read and update tenant settings and drive the onboarding checklist.
  • Pricing rules — coupons, automatic discounts, sale windows, bundles, and compare-at pricing.
  • Orders & fulfillment — create orders and manage status, fulfillment, and notes.
  • Shipping — configure zones and rates; read them at the cart.
  • Returns / RMA — the customer request flow, merchant state machine, refunds, restock, and notifications.
  • Abandoned cart capture and review — capture in-progress carts for merchant review. Recovery emails are unavailable.
  • Product reviews — collect moderated star ratings on product pages; read published reviews + the rating aggregate.
  • Newsletter signup — capture mailing-list subscribers with a double opt-in flow.
  • Support messenger embed — embed a connected support provider's messenger on your own storefront: the CSP allowances an enforcing policy needs, what the AI agent can answer anonymously vs. authenticated, and the environment rule that keeps beta prices away from production shoppers.

These guides cover the shipped M1–M3 surface — hosted litecheckout, BYO checkout, customer accounts, and order-status links. Tenant payment accounts (Stripe Connect) are complete on staging but gated from real-money launch by the M3.5 readiness pass, so that guide documents the contract rather than a launched capability. The full per-endpoint reference is generated from the OpenAPI spec; see API reference.