Developer API
By Support1 author35 articles
- DZBuild API — IntroductionBuild on DZBuild — full REST API for stores, products, orders, customers, landing pages, signups, and webhooks.
- AuthenticationLearn how to authenticate API requests with platform keys and public keys, including Bearer tokens and HMAC signatures for secure DZBuild API access.
- Rate limitsDZBuild API rate limits explained — Enterprise-only access, the per-store per-minute cap, expensive-endpoint budgets, and why these limits never affect your storefront or dashboard.
- Idempotency
- ErrorsComplete reference for DZBuild API error codes, HTTP status codes, error response format, and how to handle API errors in your integration.
- PaginationLearn how DZBuild API uses cursor-based pagination for list endpoints. Efficient data fetching with next_cursor and has_more parameters.
- StoreGET /v1/store — your store's profile (name, slug, theme, custom domain, public URL).
- ProductsFull CRUD for the product catalog — list, get, create, update, delete. With variants, images, plan limits.
- OrdersCreate, read, transition, and cancel orders. Full variants support, multi-line carts, server-authoritative pricing.
- CustomersRead your customer list, look up by phone or email, view all orders for a customer.
- Landing pagesCRUD for landing pages — single-product conversion pages with sections (image carousels, order forms, fake visitors, countdowns, special offers).
- Keys (your own keys)Mint, list, and revoke API keys for your store. Both platform (Bearer) and public (HMAC) keys.
- UsageView your month-to-date API usage and historical hourly rollups.
- QuotasSee the Enterprise tier limits, any per-store overrides set by support, and your effective limits.
- SignupsPOST /v1/signups — count an end-user signup against your monthly quota. The headline metered unit. HMAC-signed, accepted asynchronously, deduplicated by nonce + email.
- EventsPOST /v1/events — generic merchant-tracked events (page views, leads, custom analytics). Same HMAC scheme as signups, no email/phone dedup.
- Custom themes & storefrontsBuild a fully custom storefront in React, Vue, Next.js, Flutter, or any stack — backed by DZBuild's API.
- For resellersHow to use the DZBuild API to resell stores, manage clients at scale, and integrate with your own back-office.
- Environment & .env setupHow to safely store DZBuild API credentials in your application — from .env files to KMS to GitHub Secrets.
- Webhooks overviewHow DZBuild webhooks work — what events fire, how delivery + retries behave, security guarantees, and what your endpoint must do.
- Registering a webhookCreate, list, test, and delete webhook subscriptions for your store.
- Event catalogEvery webhook event DZBuild can fire, with the exact shape of its payload data field.
- Verifying signaturesHow to authenticate inbound DZBuild webhooks. Constant-time HMAC comparison + freshness check, with copy-paste code in Node.js, PHP, Python, and Go.
- Changelog
- WhatsApp messagesRead the WhatsApp order templates, the store's WhatsApp wallet and message log, and send a template to an order's buyer from your own code.
- Home page sectionsRead and change the sections of a store's home page from your own code, with ten section types, then add, update, hide, reorder, delete, replace or undo.
- ThemesList the storefront themes, fast-checkout form themes and variant picker styles a store can use, then switch each of them from your own code.
- CategoriesList, read, create, rename, move, delete and reorder the product categories of a store from your own code, then undo a rename, a move or a delete.
- Promo codesList, create, update and delete a store's promo codes from your own code, with the add-on rule, the 100% discount confirmation and undo.
- Tracking pixelsList, add, update and delete a store's tracking pixels for Meta, TikTok, Snapchat, Pinterest and Google from your code. Access tokens are write-only.
- ShippingRead and set delivery prices per wilaya and the free-shipping rules, link, test and sync couriers, check courier coverage, and list wilayas and communes.
- AnalyticsRead a store's dashboard figures for a period with GET /v1/analytics: orders, revenue, profit, visitors and conversion, their change, and the chart series.
- Changes and undoList the configuration changes made through the API, read one with the values it replaced, and undo it to put those values back on the store.
- DZBuild POSHow the free DZBuild POS Windows till links to a store, and the calls it makes for products, photos, stock, sales documents, orders, customers and the events feed.
- Agent discoveryWhere AI agents and assistants find the DZBuild machine files, the MCP connector, the REST API description and every store catalog, and the rules they follow.