Wameed Partner API: connect your own software to your store with API keys and signed webhooks
Give your developers, ERP or online store secure access to a branch’s catalogue, orders, stock, customers and reports through the Wameed Partner API, and push events — new orders, stock changes, ZATCA results — to your systems with signed webhooks. A key per integration, each with only the permissions it needs.
4 min read
The Wameed Partner API connects your own software to your store. Adocumented REST API (OpenAPI) gives your developers, ERP or online store secure access to a branch’s catalogue, orders, stock, customers and reports, andsigned webhooks with automatic retries push new orders, stock changes and ZATCA results to your systems. You createa key per integration with its own permissions and expiry. Enterprise (API access); about 5 minutes.Reviewed November 2026.
What the Wameed Partner API integration does
- REST API documented with OpenAPI, with a developer reference.
- A key per integration, with its own permissions — catalogue, orders, stock, customers, reports or webhooks — and an optional expiry date.
- Signed webhooks with automatic retries to your own HTTPS address for the events you choose.
- Daily usage for every key, and the last request per key.
What you need
- A plan that includesAPI access (Enterprise; the pricing page also lists an API access add-on).
- A developer or a system that cancall a REST API.
- For webhooks, anHTTPS address of your own system reachable from the internet.
Set up in 5 steps
- Open the Partner API screen (Partner API → Keys).
- SelectNew key, name it (for example “Online store”), choose its permissions and, if you like, an expiry date.
- Copy the secret now: it starts with
sk_and is shown only once; only a fingerprint is kept. If lost, rotate the key to get a new one. - Your system sends the secret as aBearer token with every request to the API address shown; the developer documentation lists every endpoint with examples.
- Optional: on theWebhooks tab add YOUR system’s HTTPS address and choose the events; Wameed posts each event to it, signed.
What to know — and what it does not do
- A key works for this branch only; create one per branch for several branches.
- Give each keyonly the permissions its system needs; you canrevoke a key at any time and its requests stop at once.
- Each webhook delivery carries
X-Wameed-Signature: t=<time>,v1=<HMAC-SHA256 of "time.body" with the endpoint’s secret>—reject one older than 5 minutes andde-duplicate onX-Wameed-Delivery. - A webhook address thatkeeps failing is switched off automatically; fix it and switch it back on from the Webhooks tab. A lost or leaked signing secret can berotated — the old one stops working at once.
- Wameed shows warnings when every key has expired, a key is about to expire, or a webhook was switched off. Your software calls Wameed, not the other way round, so there isnothing to test from the integration screen.
- The third-partyapp marketplace is small; installing an app mints a partner key with exactly the permissions you consent to, and uninstalling revokes it.
Where it fits in Wameed
The Partner API is the route for what the hub does not ship ready-made — for example a custom link to Salla or Zid, an ERP, a BI tool or your own app. It is the developer side of thebest POS integrations story; the first-party connectors cover payments, delivery, accounting, WhatsApp, SMS, e-mail, analytics and ZATCA. Read thefeature page and theapp marketplace.
More answers
Best POS integrations ·Partner API feature page ·All integrations
Frequently asked questions
Which plan includes the Partner API?
Enterprise (API access). The pricing page also lists an API access add-on; check which plans it can be added to.
How do I secure webhooks?
Verify the X-Wameed-Signature (HMAC-SHA256 of “time.body” with the endpoint’s secret), reject deliveries older than 5 minutes and de-duplicate on X-Wameed-Delivery.
Can one key serve several branches?
No. A key works for one branch; create one per branch.
Is there a ready-made Salla or Zid connector?
No. Use the Partner API for a custom link.
- #واجهة برمجية
- #واجهة الشركاء
- #ربط الأنظمة
- #ويب هوك
- #Partner API
- #Wameed Partner API
- #REST API OpenAPI webhooks
- #POS API Saudi Arabia
Share this article
Ask about your own shop
Thirty minutes on your products, your tax setup and your hardware — not a slide deck.
Keep reading
4 min read
ZATCA (Fatoora) with Wameed POS: Phase 2 e-invoicing for every sale, onboarded with a one-time password
Wameed POS is a Phase 2 e-invoicing solution. Every sale is signed with this branch’s cryptographic stamp, carries the ZATCA QR code and goes to ZATCA through Fatoora: simplified (B2C) invoices are reported within 24 hours, standard (B2B) invoices are cleared before issue.
4 min read
WhatsApp Business with Wameed POS: talk to your customers on WhatsApp from your own business number
Connect your own WhatsApp Business number through Meta’s Embedded Signup. Customer messages arrive in Wameed POS, order and booking updates go out from your number, and you choose which branches each number serves. Meta bills WhatsApp message fees to your own Meta account; Wameed adds no markup.
4 min read
Microsoft Clarity with Wameed POS: heatmaps and session recordings of your online store
See how shoppers really use your online store with Microsoft Clarity’s heatmaps and session recordings. Wameed adds the Clarity tag only after a visitor accepts, marks each shopping step as an event, and masks order, checkout and booking details in the recordings.

