MM-API reference
MM stands for Marketplace Management. Find your task below, read its guide, then open the operation. The API reference sidebar lists every operation by area; each page shows the method and path, the permission it requires, every parameter and field, and example responses. Download the OpenAPI 3.1 file for code generation.
Account and marketplace identity
| Area | Question it answers | Start here |
|---|---|---|
| Account | Which key and user is this? | Authentication · Get current key |
| Brands | Which brands can this integration work with? | Brands and marketplace accounts · List brands |
| Marketplace connections | Which marketplace accounts does a brand have, and how does each handle stock? | Brands and marketplace accounts · List a brand's accounts |
For work that spans several marketplaces, read the multi-channel guide.
Commerce and operations
| Area | Question it answers | Start here |
|---|---|---|
| Catalog and listing review | Which products are linked, which marketplace items need review, and what price or stock should be pushed? | Catalog and listings · List products |
| Orders and fulfillment | Which orders need handling, and which pack, ship, return or compensation step follows? | Orders and fulfillment · List orders |
| Inventory and planning | What stock is where, what needs restocking, and where has a marketplace drifted? | Inventory and planning · List forecasts |
| Vendor purchase orders | What has a retailer requested, what was accepted, and what arrived? | Vendor purchase orders · List purchase orders |
Measurement and signals
| Area | Question it answers | Start here |
|---|---|---|
| Sales and product performance | How are sales and products performing in a period? | Sales performance · Sales overview |
| Profitability and settlements | How do revenue, fees, costs and marketplace payouts reconcile? | Profitability · Money summary |
| Brand health | Which operational dimensions need attention, and which records explain it? | Brand health · List brand health |
| Sync health | Is a brand's marketplace data current enough to act on? | Sync health · Brand sync health |
Webhooks
| Area | Question it answers | Start here |
|---|---|---|
| Webhook endpoints | How do I get told when something changes? | Webhooks · Create an endpoint |
| Webhook events | What does each event contain? | Order created and the other pages under Webhook events |
Conventions
- Base URL
https://api.nasam.co/mm-api/v1(sandboxhttps://backend-test.nasam.co/mm-api/v1), withAuthorization: Bearer <key>. See authentication and sandbox. - Lists use
pageandlimitwith apaginationobject, per operation. See pagination and filters. - Errors are
application/problem+json; the limit is reported inRateLimitheaders; writes acceptIdempotency-Key. See errors, rate limits and retries. - v1 changes only by addition. Ignore unknown fields and tolerate unknown enum values. See versioning.