Skip to main content

Get Brand Product Drilldown

GET 
/api/reporting/brands/:brand/products/:product

Single-product drill-down for one brand: the KPI strip (current vs previous window), on-hand units, the default supplier's quoted lead time vs the actual average across all suppliers, landed-cost trend, monthly units purchased vs sold, every supplier carrying the SKU, and the most recent PO lines (any supplier).

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token (scope: reports)

Path parameters:

  • brand: the ProductBrand ID
  • product: the Product ID

Required parameters:

  • period_mode: yoy | qoq | mom | custom

When period_mode=custom, date_from and date_to (YYYY-MM-DD or m/d/Y) are both required.

Response fields:

  • product {id, sku, name}
  • kpis: units_purchased, units_sold, purchase_volume, sales_volume, profit, margin_pct, sell_through_pct, gmroi — each {current, previous, delta_pct}. Amounts and GMROI report % growth (null when previous < 0); margin_pct / sell_through_pct report the percentage-point change (null when either side has no rate). GMROI = profit / inventory cost at window end.
  • inventory_on_hand: current on-hand units
  • lead_time: quoted lead time in days; avg_actual_lead_time: average days from PO date to full receipt
  • landed_cost_trend {dates, costs}: landed unit cost per PO in the current window
  • units_chart {buckets (Y-m), purchased, sold}: monthly units, zero-filled
  • recent_po_lines: last 10 non-draft PO lines, newest first
  • suppliers: [{supplier_id, name, landed_unit_cost, lead_time, is_default}]

Request​

Responses​

OK

Response Headers
    Content-Type