Skip to main content

Get Product Supply Impact

GET 

/api/advertising/products/:product/supply-impact

Returns what extra ad-driven demand does to one product's supply, evaluated at the product's least-covered advertised inventory pool.

Required scope: advertising:read

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

Pass spend_change_pct to check a proposed ad spend change (e.g. 30 for +30%, -50 for -50%); the projected extra units per day (uplift_per_day) are derived from the product's current attributed ad units and the incrementality factor. Or pass goal (profit, growth, launch, liquidate, defend, hold) to check that goal at the spend change it plans by: growth +30%, launch +50%, liquidate +25%, and 0% for goals that plan no spend change. An explicit spend_change_pct wins over goal. Without either, only the uplift of already-active ad plans (planned_uplift_per_day) is checked. The response echoes goal (null when none was sent).

Key fields:

  • forecast_daily: forecast units/day before any ad plan.
  • cover_after_uplift_days = (available + inbound within lead time) / (forecast + planned + uplift).
  • blocked is true when stock runs out before the next inbound lands, or cover after uplift drops below lead time + safety stock; blocking_reason explains it.
  • max_uplift_per_day: the most extra demand supply can absorb (0 = none).
  • investment_needed = uplift x lead time x landed unit cost.
  • advertised is false when the product has no active ads (the check then uses all its stock).

Read-only: nothing is changed.

Requires the advertising.view permission.

Available only when the tenant has both the advertising and advertising-manager features enabled; otherwise every route here returns 404.

Request​

Responses​

OK

Response Headers
    Content-Type