MM-API reference

MM stands for Marketplace Management. Start with the business task you need to complete. Each area below links to a workflow guide and a representative operation. The API reference sidebar groups the complete operation set by resource: open a group to find its methods and paths. Each operation page shows the exact request, response, authentication, and schema. Download the OpenAPI document when you need a machine-readable contract.

Account context and marketplace identity

Most integrations begin with an account's accessible brands. A brandId identifies the brand in paths and filters. A sale channel identifies a marketplace and region; a connected account is the brand's credentialed connection to that channel. Keep these identities separate when joining products, listings, orders, reports, or advertising data.

Work area	Business question	Start here
Brands and organizations	Which brands can this integration work with?	Brand and channel guide · List brands
Access and assignments	Which users, permissions, and brand assignments are in scope?	Access guide · Read my assignments
Marketplace connections	Which marketplace accounts belong to a brand, and what is their connection state?	Sale channel API guide · Connect a sale channel

For a workflow that spans those connections, start with the multi-channel marketplace API guide.

Commerce and operations

Catalog products are Nasam's product records. Listings are the channel-specific offers connected to them. Inventory reads draw from connected sources; orders and fulfillment represent distinct stages of customer demand and shipment work. Use the guides to understand when each resource changes and what identifiers carry across calls.

Work area	Business question	Start here
Catalog and listing review	Which products are linked, which listings need review, and what can be updated?	Catalog and listings guide · List products
Orders and fulfillment	Which orders need handling, and which shipment or return step follows?	Orders and fulfillment guide · List orders
Inventory and planning	What stock is available, and how do demand inputs affect a forecast?	Inventory and planning guide · Read forecast
Vendor purchase orders	What has been requested, accepted, received, or rejected in vendor supply?	Vendor PO lifecycle guide · List purchase orders

Measurement and operational signals

Reports aggregate commerce activity; profitability and settlement resources explain money movements. Brand Health gives a band and supporting evidence for nine operational dimensions. Sync Health describes the freshness and state of marketplace ingestion. Advertising joins performance and campaign controls to the brand and sale-channel context.

Work area	Business question	Start here
Sales and product performance	How are sales and products performing in a selected period?	Sales performance guide · Read overview
Profitability and settlements	How do revenue, costs, and settlements reconcile?	Profitability guide · Read money summary
Brand Health	Which operational dimensions need attention, and which records explain the band?	Brand Health guide · Read summaries
Sync Health	Is connected marketplace data current enough for a downstream decision?	Sync Health guide · Read brand sync health
Advertising	How do campaigns, metrics, coverage, and suggestions vary by brand and sale channel?	Ads guide · Read advertising performance

Documents and bulk data

Work area	Business question	Start here
Invoices and credit notes	Which financial documents exist, and how can their PDF be retrieved?	Invoicing guide · List invoices
Exports	How can a larger operational data set be extracted?	Exports guide · Export orders

Contract conventions

• Calls use https://backend.nasam.co/v1 and the key request header. Authentication covers credential handling.
• Pagination is operation specific. Read each response schema and the pagination and errors guide before assuming a collection shape or retry rule.
• Filter IDs, date boundaries, payload casing, and response envelopes are defined per operation. The OpenAPI document is suitable for generators; keep generated clients aligned with its version.
• A write can change a business workflow. Read its domain guide and its operation response before sequencing another write; do not assume all writes are synchronous or idempotent.