Build a tool that a merchant can install on their DZBuild store. Start with a working example, connect your coding agent, or use the API directly.
You host the app. The merchant chooses which store data it can access.
From an API request to a catalog export.
cloudflare-catalogExample appThe catalog starter lists a store’s products and lets the merchant download them as a CSV file.
OAuthproducts:readCSVCreate it in the developer console. You get a client_id, a client secret shown once, and a signing secret for webhooks and launch links.
Get startedSend the merchant to the authorize URL with a PKCE challenge. They approve on a DZBuild consent screen, and your server exchanges the code for one install token per store.
The OAuth flowSend the token to api.dzbuild.app/v1. Poll GET /v1/orders?since= for new orders, or receive signed order events on a webhook URL on a domain you own (DZBuild refuses workers.dev addresses). Test on your own store, then submit the app for review.
DZBuild is the e-commerce platform for Algerian merchants. A DZBuild app is a web service you host, on your own Cloudflare account or your own server. A merchant installs it on their store, and your app reads and changes that store's orders, products, delivery, customers and WhatsApp messages through the REST API.
The merchant approves on DZBuild
Install orders-bot on your store
orders-bot asks for access to your store. Once you approve, it can only do the following.
What this app will be able to do
View orders (read only; it cannot create or change orders) orders:read
You can remove the app at any time from the Extensions page.
Your server exchanges the code for the install token
POST https://dzbuild.com/oauth/apps/token
200 OK
{
"access_token": "dzpk_live_0a1b2c3d4e5f67.9f8e...",
"token_type": "Bearer",
"scope": "orders:read",
"store_id": 141,
"install_id": 7,
"stores": [
{
"store_id": 141,
"store_name": "My test store",
"install_id": 7,
"access_token": "dzpk_live_0a1b2c3d4e5f67.9f8e..."
}
]
}One scope per kind of store data. The merchant sees one line per resource on the consent screen and grants only what you ask for. All scopes
Read orders and their items. Create orders, change their status, cancel them.
orders:readorders:writeHand an order to the store's courier.
delivery:sendCatalogue and categories, with images, variants, offers, quantity rules and stock.
products:readproducts:writeCustomers and each customer's orders.
customers:readLanding pages and their sections, and the check that runs before publishing.
landing_pages:readlanding_pages:writeRates and settings, linked couriers, coverage, the wilaya and commune lists.
shipping:readshipping:writeProfile, design, home page sections and themes.
store:readstore:writeDiscount codes and tracking pixels.
promos:readpromos:writepixels:readpixels:writeStore analytics and KPIs.
analytics:readApproved order templates, the store's wallet balance, the message log, and sending.
whatsapp:readwhatsapp:sendGET /v1/orders?since= once a minute.Beyond the app platform, DZBuild gives away two tools. Use them with or without a store.
Create and track cash-on-delivery parcels from your own application. DZShip is a separate service by DZBuild: use your courier credentials, with no DZShip signup or API key.
The API is free to use. Your courier’s delivery charges still apply.
A till and stock program for shops in Algeria: barcode scanner, receipts, credit (kridi), backups. It works without internet. Link it to a DZBuild store and the catalogue, stock and online orders sync with the counter.
Free and open source (GPL-3.0-or-later). Windows 10 and 11, 64 or 32 bit.
The developer console lives in your DZBuild dashboard. Any account that owns a store can open it, and a draft app installs on your own store right away.