Skip to content
cartonium docs

Guides

Guides are task-oriented walkthroughs — the layer above the API reference, which documents endpoints one at a time. They explain integration workflows, examples and capability boundaries.

Credentials follow the operation's authority, not its HTTP method. Merchant operations use a merchant bearer token plus tenant context and the required permission; signed-in customer operations use that customer's session plus tenant context. Public writes can be anonymous, customer-session protected or token-scoped. Follow each operation's tenant-context and authentication rules, including documented tenant-header-free exceptions. Storefront API keys are a separate server-side credential, never a browser credential. API paths use the /api/v1 prefix.

Choose a guide

  • 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.
  • Agent storefront skill — install the complete skill package and its references to guide a coding agent through storefront integration and capability checks.
  • Hosted cartonium checkout — the cartonium-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 cartonium checkout — your own GA4 tag on the hosted checkout page: the exact events sent, what is never sent, environment separation, and cross-domain attribution.
  • Storefront analytics consent handoff — landed token-authenticated handoff/update API and hosted enforcement; adoption and consent-based analytics remain unavailable for live use. Includes the finite onboarding checklist.
  • BYO checkout API — build a tenant-owned checkout on the public checkout-session APIs without bypassing server-side pricing, tax, payment, or order creation.
  • Booking availability, holds & lifecycle — implemented staging contracts for service discovery, availability, holds, checkout and customer actions. Bookings remain in active development, with release and later workflow work outstanding.
  • Customer accounts & sign-in — passwordless (magic link / OTP) auth and the authenticated account API: profile, addresses, order history, and returns.
  • Subscriptions — implemented staging contracts for recurring offers, checkout, account reads, recovery and entitlements; adoption/release boundaries and remaining customer-management work.
  • 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. Connected-account payments are shipped; each tenant still needs a VERIFIED connected account before it can take a live charge.
  • Request access — request a tenant and learn what happens after approval.
  • 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.
  • Sales documents: quotes, invoices & contracts — merchant-authored documents, priced revisions, lifecycle actions and customer access through token-scoped links or a signed-in account.
  • Orders & fulfillment — create orders and manage status, fulfillment, and notes.
  • Shipping — configure zones and rates; read them at the cart.
  • Taxes — selected tax policies, merchant readiness, disclosures and authoritative tax-inclusive bind totals. The companion hosted tax preview remains pending acceptance/release, outside BYO adoption.
  • Returns / RMA — the customer request flow, merchant state machine, refunds, restock, and notifications.
  • Abandoned checkouts and cart capture — hosted contact capture and manual recovery in active development; legacy anonymous cart capture remains separate.
  • Product reviews — collect moderated star ratings on product pages; read published reviews + the rating aggregate.
  • Newsletter & subscribers — double opt-in signup, merchant subscriber filtering and pagination, and permission-controlled CSV export.
  • Email customization — fixed-template copy and sender settings, unsaved previews, and deliberate test sends; separate template customization from delivery eligibility and planned ESP sync.
  • 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.

Check capability status and the guide's adoption boundaries before integrating. A documented endpoint or staging implementation does not establish a Production release; a shipped capability can still require tenant configuration and environment readiness. See Environments & schema identity to compare an API deployment with the published reference contract.