Bitcommerz App Publishing Guide

Bitcommerz is an e-commerce platform for Bangladesh merchants. Merchants run their stores without writing code — you build the apps and themes they install.

This guide documents what the platform actually does today. Where something is planned but not built, it says so explicitly.

Two things you can publish

Apps Themes
Where it runs Your own infrastructure, any stack Compiled into the storefront by us
What you submit Metadata only (JSON form in the Partner Panel) A dist/theme.zip package
How it connects OAuth + Merchant API + webhooks Components, templates and widgets
Pricing Per-plan: monthly, yearly, lifetime, one-time Free or one-time only
Start here Building Your App Theme Development

Both are submitted from the Partner Panel, reviewed by a Bitcommerz super-admin, and sold through the merchant marketplace on the same revenue split.

Publishing an app — the path

  1. Set up your partner account — register, verify the email OTP, log in. There is no separate developer account type and no vetting step before you can submit.
  2. Configure the app — name, version, URLs, permissions, events. Everything is entered in the Partner Panel form; there is no config file to commit and nothing to upload.
  3. Build the integration — exchange the one-time launch code for an access token, call the Merchant API, verify webhook signatures.
  4. Set pricing — a flat price or a set of plans.
  5. Check it against the validator before you submit — every rule is enforced at submit time and returns a hard error.
  6. Submit for review. See Distribution & Lifecycle for what happens next, and Contact & Testing for how review works in practice.

On approval the platform issues your client_id and client_secret — the secret is displayed once.

Publishing a theme — the path

  1. Clone the theme preset kit (React + TypeScript + Tailwind).
  2. Build against Theme Development, and use Custom Theme Widgets, Landing Page Templates, Header / Footer Builder and Default page builder for the extension points.
  3. npm run package → dist/theme.zip, then upload it from the Partner Panel.
  4. The package is validated on upload — see Automated Checks & Compliance.
  5. After approval, the storefront build runs. See Post-Submit Pipeline & Checklist.

What is not available

Do not build against any of this — none of it exists today:

  • No GraphQL API. The Merchant API is REST.
  • No SDK, no npm package, no App Bridge. Integration is plain HTTPS + OAuth, so any language works.
  • No POS embedding, and no POS surface for apps.
  • No custom / unlisted distribution. Approved apps are listed in the App Store for all merchants; there are no private install links.
  • No GDPR compliance webhooks (customer/shop data request or erasure).
  • ui_slots do not render. You may declare them and they are validated and stored, but nothing on the storefront or dashboard renders them yet.
  • No app icon upload, no screenshot upload, no listing media for apps. The App Store listing is built from the name, category and description.

Ports and hosts (local development)

Service Local What it serves
Merchant API http://localhost:7204 /app-oauth/*, /merchant-order — no version prefix
Partner Panel see your local .env Where you register and submit
This guide http://127.0.0.1:7013 mkdocs serve

Production hosts are provided to you when your app is approved.