Developer docs
Which API?
New: Application API docs
Pick the API you are reading here — the Merchant API for your own store, the Application API for partner apps.
Developer docs
New: Application API docs
Pick the API you are reading here — the Merchant API for your own store, the Application API for partner apps.
For partner applications: browse merchants and products, hand customers a checkout link, and follow the orders it creates.
Which merchants you can reach depends on your whitelist. Every endpoint applies it, and no filter can widen it.
| Your whitelist | What the endpoints return |
|---|---|
| None at all | Unrestricted — every live merchant. The full public catalogue. |
| One or more merchants | Only those merchants, and only while they are live. |
| Merchants listed, but none currently live | An empty page. You stay scoped to your merchants; you never fall back to the whole catalogue. |
A merchant is live when all of these hold: is_active = 1,
is_miniapp_live = 1, and it has a domain. A whitelisted merchant that is not live
is invisible on every endpoint.
Categories and subcategories appear only when at least one visible product from one of your visible merchants sits under them.
Filters such as client_id can only ever narrow your scope. Naming an existing
merchant outside it returns an empty page — never that merchant's data. A client_id that does
not exist at all fails validation with a 400.
{
"data": [],
"hasMore": false,
"totalPages": 0,
"totalCount": 0
}