Guides
Guides
End-to-end flows for building checkout, auth, and commerce pages in your app.
What these guides cover
Guides walk through real storefront flows — not just API reference, but how pieces fit together in your app.
Before you start: Install @storeos/storefront-client and set your tenant UID.
Commerce guides
| Guide | What you'll build | API area |
|---|---|---|
| Checkout | Cart → coupon → place order → confirmation | Orders |
| Phone OTP auth | SMS login without password | Auth |
How StoreOS fits your app
StoreOS provides data and business rules. Your app provides everything the customer sees.
| Layer | StoreOS (API / package) | Your app |
|---|---|---|
| Products & prices | ✅ | Display UI |
| Delivery charge rules | ✅ | Show totals, pick area |
| Place order | ✅ | Checkout form |
| Customer accounts | ✅ | Login pages, save token |
| Cart | ✅ You track items until checkout | |
| Payment gateway UI | ✅ For ONLINE payments | |
| Pages & branding | ✅ |
Pages to build
Typical routes in a storefront you implement:
| Route | Purpose | See |
|---|---|---|
/ | Home — featured products | Catalog methods |
/shop | Product listing | getProducts |
/product/[handle] | Product detail, add to cart | getProduct |
/auth | Email login / register | Auth |
/auth/phone | OTP login | Phone OTP |
/checkout | Shipping, payment, place order | Checkout |
/order-confirmation/[id] | Thank you page | createOrder response |
/track-order/[id] | Public tracking | getOrder |
/dashboard/orders | Order history | getMyOrders |
Need API details?
| Topic | Docs |
|---|---|
| Every SDK method explained | Methods |
| React providers & hooks | React SDK |
| REST routes | REST API |
| GraphQL operations | GraphQL API |
| Swagger (try it live) | storefront-api.storeos.dev/docs |