DZBuild developer documentation
DZBuild (dzbuild.com) is the e-commerce platform for Algerian merchants: online stores with cash on delivery, courier delivery across the wilayas, landing pages and WhatsApp order messages. A DZBuild app is a service you run on your own servers. A store owner installs it, and your server then reads and changes that store's data through the REST API. None of your code runs on DZBuild.
For example, a catalog-export app lets a merchant download their products as a CSV file. The merchant installs the app, your server reads that store's products with the granted permissions, and your app prepares the export. The cloudflare-catalog starter provides this example.
Choose a starting point
| You want to | Start here |
|---|---|
| Build and test your first app | Choose a starter, then follow Get started to register and install it. |
| Work with a coding agent | Connect your agent, then follow Build with AI. The connection gives it read-only access to the documentation. |
| Find an API operation or its permissions | Use the API reference and Scopes. |
What the platform offers
| Part | What it gives your app |
|---|---|
| Apps | You register an app in the developer console. It gets a client_id, a client secret and a signing secret. |
| Install flow | The store owner approves your app on a consent screen. The flow is OAuth 2.0 authorization code with PKCE S256. |
| Install tokens | Every store that installs your app gets its own bearer token, limited to the scopes the owner approved. |
| REST API | https://api.dzbuild.app/v1 covers the store, products, orders, delivery, customers, landing pages, promo codes, pixels, shipping, analytics and WhatsApp. |
| Webhooks | DZBuild posts order events and app.uninstalled to your URL, signed with X-DZ-Signature. |
| WhatsApp API | Your app sends the platform's approved order templates to buyers. Each message is paid from the store's WhatsApp balance. |
| Launch link | The Open button in the merchant dashboard sends the merchant to your app with a signed token in dz_launch. |
| Developer console | https://dzbuild.com/dashboard/developer is where you register apps, rotate secrets, test on your own store and submit for review. |
Who it is for
These pages are for developers who build tools that DZBuild merchants install from their dashboard. Any DZBuild account that has a store can open the developer console. While an app is a draft or in review, it installs only on stores that the developer account owns. Once DZBuild approves it, any store owner can install it, on any plan, unless you set a minimum plan.
The merchant documentation lives at dzbuild.com/docs. It explains the dashboard from the merchant's side.
DZShip: free shipping API
DZShip is a separate, free hosted API for creating and tracking parcels with Algerian couriers. It needs no DZShip signup or API key: you supply your own courier credentials with each request. Its sandbox lets you try requests without creating real parcels. API access is free; courier delivery charges still apply.
Use the DZShip repository and its API documentation for the request fields and examples. The app starters and other public projects are under DZBuild on GitHub.
Where to go next
- Get started: register an app, install it on your own store and make your first API call.
- Core concepts: apps, installs, stores, plans, test mode, the per-install limit and install tokens.
- OAuth: every authorize and token parameter, and every error code.
- Scopes: what each scope allows.
- Webhooks: events and signature verification.
- WhatsApp API: sending order templates.
- Rate limits: request budgets and retries.
- API reference: every
/v1endpoint and the OpenAPI description. - Review guidelines and Security: what DZBuild checks before it approves an app.
- Changelog: dated changes to the platform.