API Reference
This reference is auto-generated from TSDoc comments in src/ via pnpm docs:sync-api. For narrative guides with runnable examples, see Guides.
Classes
- AIOTShopifyClient — the main SDK client
- X402FacilitatorClient — low-level x402 facilitator HTTP client
- ShopifyAdminClient — Shopify admin GraphQL client
- CheckoutSessionManager — session lifecycle
- PriceConverter — fiat-to-USDC conversion
Types and errors
The wire-format types (CreateOrderBody, CreateOrderResponse, PaymentDetails, etc.) and the error classes (AIOTError, CheckoutExpiredError, PaymentFailedError, ShopifyAPIError, PriceConversionError, X402APIError) are documented on their respective individual pages linked from the sidebar.
Middleware
The Express middleware is documented on its own page:
- createAIOTPaymentRoutes — mounts the full
/aiot-pay/*route set
Class and module pages under /reference carry an
AUTO-GENERATED banner and are regenerated on every release.
Edit the TSDoc comments in src/ instead, then run
pnpm docs:sync-api.
When to use reference vs guides
- Guides answer “how do I do X?” — step-by-step, with full code samples and tradeoff discussion.
- Reference answers “what does this method return?” — exact signatures, every parameter, every overload.
If you’re starting out, begin with the SDK client guide. Come back here once you know the shape of the library and need to look up a specific field.