Skip to main content

Multi-channel marketplace API

Nasam MM-API is a multi-channel API for brands that operate on more than one marketplace account. An integration can discover accessible brands and sale channels, inspect each brand's connected accounts, and use that context to read catalog, inventory, orders, and reports. Nasam's API calls a marketplace and region a sale channel; a sale-channel account is one brand's connection to it. The brands and marketplace accounts guide covers how to read them.

Start with the right identity​

IdentityRead it fromWhat it identifies
Brand idList brandsThe brand whose records your key can access.
Sale channel idList sale channelsA marketplace and region, used in channel filters and requests.
Connected account idRead a brand's connected accountsThat brand's particular connection, including its status and inventory or fulfillment settings.

Start with the channel definitions:

curl 'https://api.nasam.co/mm-api/v1/sale-channels' \
-H 'accept: application/json' \
-H "Authorization: Bearer $NASAM_API_KEY"

This read returns saleChannels. Next, read /brands/{brandId}/sale-channels for the selected brand: its connected accounts and available channels answer different questions. Do not substitute a channel ID for a connected account ID, or use a channel name where an operation requires a numeric ID. The API key and its brand scope still apply to every request; authentication and scope explains them.

curl 'https://api.nasam.co/mm-api/v1/brands/20/sale-channels' \
-H 'accept: application/json' \
-H "Authorization: Bearer $NASAM_API_KEY"

Store the brand ID with each connected account's id and saleChannel.id. An account can be inactive or still connecting; read its status, fulfillmentModel, and inventoryScope before choosing an operational workflow. A channel definition in available is a possible connection, not a source of that brand's listings or orders. If a marketplace account is shared across brands, use each brand's returned account association rather than treating one brand's path ID as universal.

Read the channel on a response​

Every response that names a sale channel carries it as saleChannel, one object with the same three fields everywhere: id, name and region. A list of channels is saleChannels, an array of those objects. Orders, returns, compensations, listings, stock alerts, sales and profitability rows, ads, purchase orders and Brand Health all use it.

{
"saleChannel": { "id": 7, "name": "Amazon", "region": "SA" }
}

The name alone does not identify a channel: Amazon in Saudi Arabia and Amazon in the UAE share it. Match, group and key on saleChannel.id, and show name with region. region is null for a channel with none, and where a row may name no channel (a warehouse destination, a trend above listing level) saleChannel itself is null. Requests are unchanged: filters still take saleChannelId or saleChannelIds, and money fields keep their Sar names. Operations that show more about a channel, such as the connected accounts, keep their extra fields beside id, name and region.

Build a per-channel work queue​

  1. Discover scope. List accessible brands, channel definitions, and each selected brand's connected accounts. Keep the region with the sale-channel ID so a same-named marketplace in another region is not conflated.
  2. Check capture. Read Sync Health for the brand. Inspect the account and stream that supplies the data you plan to act on. A healthy order stream does not establish that inventory or settlements are current.
  3. Read the domain queue. Choose catalog review, inventory planning, orders and fulfillment, sales performance, or profitability according to the decision being made. Pass the IDs and filters that the selected operation supports; these resources do not share one universal channel filter.
  4. Act within the right account. A review path takes a connected account ID. A listing update takes sale-channel IDs and existing product identity. Seller order actions take an order or shipment ID after you have checked its fulfillment state.
  5. Verify downstream state. Inspect the write's row outcomes, re-read the affected resource, and check its relevant sync stream. A successful HTTP response may mean validation or scheduling succeeded before a marketplace applies the change.

This sequence matters when an integration serves several brands. Discovering a brand does not grant a new scope; the key still limits every read and write. Keep pagination state and filters with each resource queue, and do not merge IDs or financial amounts from different channels without their context.

Follow the work across channels​

TaskWhere to startChannel detail that matters
Catalog and listingsList products and read listing detailA Nasam product can have several channel listings. Each listing belongs to a connected account.
Stock planningRead the inventory forecastsaleChannelIds selects product rows with a matching destination; other destinations remain on those rows.
OrdersList ordersUse brandIds and the operation's channel exclusion filter to choose the work to process. Read fulfillment state before taking a seller action.
Sales activityRead sales overviewThe overview can exclude selected sale-channel IDs; it does not use the profitability reads' inclusion filter.
Settled moneyRead profitabilityProfitability supports saleChannelIds and keeps currencies separate.
Capture freshnessRead Sync HealthCheck channel capture and processing state before acting on catalog, stock, or order data.

For each area, follow its linked workflow guide and operation page for exact filters, permissions, request fields, and response shapes. There is no separate generic /multi-channel endpoint: MM-API represents multi-channel work through its brand, account, catalog, inventory, order, and reporting resources.

Before you write to a channel​

Marketplace accounts are connected and authorized in the Nasam app; the API works with the accounts that are already connected. Bulk listing update updates existing listings and schedules price or inventory pushes after validation; it does not create a new marketplace listing or prove that a channel has applied the change. Read the affected listings and Sync Health afterward.

To explore the complete contract, open the API reference or download OpenAPI 3.1. Create an API key in the Nasam app to start.