Skip to main content

Sales and product performance

Sales reports describe order and product activity. Start with an overview for a fixed brand and time window, compare two periods, then inspect the products and listings behind a change. If you need cleared money, fees, statements, or cost coverage, follow the separate profitability guide. Retail supply has its own vendor purchase order lifecycle.

Investigate a sales change​

Home supplies a dashboard aggregate. Overview returns sales performance for an optional brand and date selection; omitted brandIds use the caller's accessible brands. Period comparison requires both start and end dates for each of its two periods. These aggregate responses are distinct from paginated catalogs.

To investigate a fall in sales, first fix the brand and calendar window, then compare it with a second explicit window. This avoids confusing a different brand mix with a time trend:

curl --get 'https://backend.nasam.co/v1/overview' \
--data-urlencode 'brandIds=20' \
--data-urlencode 'startDate=2026-09-01' \
--data-urlencode 'endDate=2026-09-30' \
-H 'accept: application/json' \
-H 'key: YOUR_API_KEY'

The overview includes order counts, revenue, units, trend, stock alerts, channel share, and product performers. Use period comparison for two chosen windows; provide p1StartDate, p1EndDate, p2StartDate, and p2EndDate together. Use product performance when an aggregate change needs a product and channel explanation. These are sales activity views, so do not use their revenue alone as a payout or margin figure.

Compare like scopes before naming a cause​

Use the same brand, category, tier, and channel exclusions in both periods. The comparison operation accepts both windows in one request:

curl --get 'https://backend.nasam.co/v1/overview/period-comparison' \
--data-urlencode 'brandIds=20' \
--data-urlencode 'p1StartDate=2026-09-01' \
--data-urlencode 'p1EndDate=2026-09-30' \
--data-urlencode 'p2StartDate=2026-08-01' \
--data-urlencode 'p2EndDate=2026-08-31' \
-H 'accept: application/json' \
-H 'key: YOUR_API_KEY'

The date fields identify two explicit periods; they are not a request for a rolling comparison. Keep those request windows beside the returned p1, p2, and growth values when displaying a percentage change. A change in orders, average order value, or units suggests different next reads; the overview alone does not attribute a cause to a product, listing, or channel.

Find the products behind the movement​

Product detail and performance return one product's trends and channel breakdowns. Without a date window, the service uses the latest 30 days including today. Product period comparison compares two explicit windows. Top performers, declining, growing, and period metrics answer different list questions. Top performers can split by product or listing; its default page=2 is intentional because the overview supplies the first set. Follow each operation's filters and response shape instead of treating these reads as interchangeable.

InvestigationReadHow to use it
Which products contribute the most in one window?Top performersPass page=1 when building a standalone first page; its omitted-page default follows the overview's embedded first set.
Which products lost or gained momentum between two windows?Declining or growingSupply both periods and keep the same brand and channel scope as the overview comparison.
Did one product move differently across channel listings?Product performance with performanceBreakdown=ByListingUse its product ID from the catalog or report; inspect the listing and channel context before taking a catalog or stock action.
Do you need a small set of period totals for a dashboard?Period metricsSupply its required start and end dates; do not substitute a paginated product ranking.

The report operations can exclude sale channels with excludeSaleChannelIds. Profitability instead filters included saleChannelIds; the two families should not be sent the same query string without translating the selection. If a listing has stale captured data, read Sync Health before interpreting a sudden product change. Catalog review and inventory planning are the next workflows when the evidence points to listing mapping or stock availability.