PlatformFrom Growth
Developer API for custom storefront and back-office integrations
A REST developer API reads and writes catalogue, order, customer and stock data directly, authenticated per shop, for anything a webhook event does not cover — building a custom app, syncing a third-party system, or pulling a live report into your own dashboard. It is the same layer ERP integrations run on.
yourstore.com
API access
- GET /orders200 OK
- POST /stock/updateAuthenticated
- ScopeShop A only
How it works
How it works
- 1
Authenticate
Request access scoped to a single shop, with per-shop credentials.
- 2
Read or write
Pull catalogue, order, customer or stock data, or push updates back.
- 3
Combine with webhooks
Use the API for on-demand pulls, webhooks for real-time pushes.
- 4
Build on it
Power a custom app, a BI dashboard or a third-party sync.
Configuration
What you can configure
| Setting | What it does |
|---|---|
| Per-shop authentication | API access scoped to one shop’s data. |
| Catalogue & order endpoints | Read and write products, stock, orders and customers. |
| Marketplace connections | The same layer that ties franchise and marketplace shops together. |
| Pairs with webhooks | Pull on demand where a webhook event is not enough. |
FAQ
Frequently asked questions
Is the developer API the same thing as webhooks?
No, webhooks push events to you in real time; the developer API is for pulling or pushing data on demand, and the two are usually used together.
What data can the API read and write?
Catalogue, order, customer and stock data, scoped to the authenticated shop.
Can I use the API to build a custom storefront on top of the platform?
Yes, the same API and marketplace-connection layer that powers ERP integrations is available for a custom-built frontend or internal tool.
Put this to work in your store today
Get started and turn this on for your store in minutes.
No card required · Live in a day · Support in Arabic and English