# BlanxerAPI

> BlanxerAPI lets an AI agent or developer build a custom Next.js website for a Blanxer store (Blanxer is a Nepali e-commerce platform) and deploy it to the merchant's own Cloudflare account. Blanxer stays the admin: products, stock, orders, payments, delivery and SEO data live in Blanxer. The site reads the public API at https://api.blanxer.com (no key, CORS *) and uses the @blanxer-dev/storefront package for the checkout. The agent changes store data only through the Blanxer MCP (OAuth); the site holds no key.

The merchant's prompt usually is: "Build my Blanxer store website in Next.js and deploy it to my Cloudflare account. Follow https://developers.blanxer.com/llms.txt My store is <subdomain>.blanxer.io."

Start with https://developers.blanxer.com/api-docs/quickstart.md and follow its steps in order, confirming each with the merchant. The merchant tells you their store's subdomain (`<subdomain>.blanxer.io`).

Hard rules (full text: https://developers.blanxer.com/api-docs/rules.md):

1. Next.js only: TypeScript, App Router.
2. Start from blanxer-storefront-starter and keep @blanxer-dev/storefront. Restyle the checkout; never rewrite payment, delivery, coupon or order logic, never call payment endpoints directly. The checkout always shows "Checkout Powered by Blanxer" ("Blanxer" links to https://blanxer.com) under the place-order button: restyle it via `.bx-powered-by`, never remove or hide it.
3. Required routes at these exact paths: /checkout, /payment/success, /payment/failed, /track/[id].
4. Send the site's own origin as `url`; never hardcode it.
5. Orders, coupons, payment starts, hold release, back-in-stock, forms, cancel and review run in the browser only.
6. No secrets in the site (no sk_ key, MCP token, login or gateway key). Never ask the merchant for a key.
7. No customer login: no /customer/auth calls, no account, login, wishlist or rewards pages.
8. Don't invent data: prices, stock, delivery and payment methods come only from the API.
9. Payment methods come from the store's settings via the package; never add or remove them by hand.
10. Use the paths /product/[slug], /collections/[slug], /brand/[slug]. Don't build a product feed or catalog sitemap; Blanxer serves both.
11. Optimise every image (npx blanxer-storefront images: AVIF + WebP, hero 2560 px, banner 1600, card 800, no EXIF), load with next/image, product photos go into Blanxer via the MCP, at most 2 fonts via next/font.
12. The site's design lives in the site: don't use the MCP page-builder tools.
13. Confirm with the merchant before bulk store changes.

Install:

- Claude Code skill: `/plugin marketplace add blanxer-dev/blanxer-agent-skills` then `/plugin install blanxer-website@blanxer`
- Blanxer MCP: `claude mcp add --transport http blanxer https://mcp.blanxer.com/mcp` (the merchant signs in to Blanxer in the browser). Other agents: add https://mcp.blanxer.com/mcp as a remote MCP server.

## Guides

- [Quickstart](https://developers.blanxer.com/api-docs/quickstart.md): the 12-step procedure from store lookup to live site; start here
- [The 13 hard rules](https://developers.blanxer.com/api-docs/rules.md): the rules every BlanxerAPI site follows, and why
- [Store and theme](https://developers.blanxer.com/api-docs/store-and-theme.md): check_domain fields, logo, theme colours, font, menus, plugins
- [Catalog](https://developers.blanxer.com/api-docs/catalog.md): products, variants (option_name, variant _id), stock rules, categories, brands, search, sale, flash sales
- [Checkout](https://developers.blanxer.com/api-docs/checkout.md): every field and limit, delivery charges and COD per place, coupons, the order request, each payment flow, stock holds, the three required pages
- [Forms and extras](https://developers.blanxer.com/api-docs/forms-and-extras.md): custom forms, back-in-stock alerts, order cancel and review, blog
- [SEO and tracking](https://developers.blanxer.com/api-docs/seo-and-tracking.md): server-built sitemap and feed, sitemap index, robots, metadata, JSON-LD, Search Console, GA/GTM, Meta Pixel and CAPI
- [Images and speed](https://developers.blanxer.com/api-docs/images-and-speed.md): rule 11 in full, image sizes per slot, product image loader, fonts, Lighthouse ≥ 90 and LCP < 2.5 s
- [Package](https://developers.blanxer.com/api-docs/package.md): the @blanxer-dev/storefront entry points, theming, the "Checkout Powered by Blanxer" line, and the check/images CLI (see the package README for the released API)

## Store data and shipping

- [MCP for your website](https://developers.blanxer.com/api-docs/mcp-for-website.md): connecting the Blanxer MCP, which tools to use while building, blanxer_set_storefront_url, what not to touch
- [Testing](https://developers.blanxer.com/api-docs/testing.md): the 0000000000 test order, the sandbox store, the live check
- [Deploy to Cloudflare](https://developers.blanxer.com/api-docs/deploy-cloudflare.md): OpenNext, wrangler login on the merchant's account, the 3 MiB limit, linking the site, custom domain, retiring the subdomain
- [Troubleshooting](https://developers.blanxer.com/api-docs/troubleshooting.md): 404 after payment, place not found, COD refused, coupon ignored, 3 MiB, images, check failures

## Reference

- [OpenAPI spec](https://developers.blanxer.com/openapi.yaml): every public endpoint a custom site uses, with request and response schemas
- [All guides in one file](https://developers.blanxer.com/llms-full.txt): every guide above, concatenated