Skip to main content

Brands and marketplace accounts

Every other part of the API needs three identities, and they answer different questions:

IdentityRead it fromWhat it identifies
Brand idList brandsA brand inside your key's scope. Most reads filter by it.
Sale channel idList sale channelsA marketplace in a region, for example the same marketplace in two countries is two sale channels.
Connected account idList a brand's marketplace accountsOne brand's connection to one sale channel, with its status and settings.

Store all three. A sale channel ID filters cross-channel reads such as orders and sales reports. A connected account ID goes in account paths such as catalog review, branches and inventory settings. Do not substitute one for the other, and do not key your records on a display name.

Find your brands​

curl 'https://api.nasam.co/mm-api/v1/brands' \
-H "Authorization: Bearer $NASAM_API_KEY"

List brands returns the brands the key's user can access. Optional status is Active, Inactive or All, and search narrows by name. Without limit you get the whole set; with page and limit read the pagination object. Read one brand for its detail, search brands with a required query, or check that a brand exists when you hold an ID from an earlier run.

A brand ID in a path, query or body selects a brand inside the key's scope; it never widens it. A brand outside the scope returns 403. See authentication.

Find a brand's marketplace accounts​

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

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

List sale channels returns every marketplace and region Nasam supports. List a brand's marketplace accounts separates connected accounts from available channels. A connected entry has its own account id, its sale channel, status, fulfillmentModel, inventoryScope, and an attentionCount of catalog items waiting for review. An available channel is one the brand could connect; it has no listings or orders.

Read status before you act on an account. An inactive account, or one still connecting, does not supply current listings, stock or orders. Read Sync Health to tell an account that is connected from one whose data is current.

Brands connect, reauthorize and disconnect marketplace accounts in the Nasam app, because those steps take marketplace credentials or consent. Your integration works with the accounts that are connected. When an account shows ConnectionFailed or AuthExpired in Sync Health, ask the brand to reconnect it in the app.

Set how an account handles stock​

Update inventory settings (requires inventory.write) sets inventoryScope to BrandPool (the account draws from the brand's shared pool), Independent (it tracks its own stock) or Untracked, and inventoryExternallyManaged when stock for the account is managed outside Nasam. Omitted settings keep their value. A D2C storefront can also take an inventoryBranchId; list the account's branches to see whether the channel has branches and which ones you can pick. Transfer time and shelf-life overrides on the account feed the inventory forecast.

Changing the scope changes how Nasam reads and pushes future stock for that account. Before you change it:

  1. Read the account's current settings from its brand's account list.
  2. Read the brand's inventory source. If there is no source, an account set to the shared pool has nothing to anchor to.
  3. Send only the fields you mean to change, then read the account again and check the forecast and Sync Health.

A successful response, { "updated": true }, means the settings are saved. It does not mean every listing quantity at the marketplace has changed yet.