Get Lifecycle Overview
GET/api/v2/product-lifecycle/overview
Summary of products that are leaving the range (every state where demand planning is capped or excluded, such as Phasing out and Discontinued): stat cards, per-state totals, sell-through status counts, prioritised items needing action this week, upcoming dated events and chart series. Also queues the first lifecycle suggestions run if the account has never had one.
products:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Query:
- chart_days (optional): 30, 90 or 365 - the stock-value chart window. Any other value falls back to 90.
Response fields:
- cards: phasing_out and discontinued ({count, units, value}), at_risk ({count, behind_target, fba_surcharge_soon - FBA surcharge band within 30 days, stalled}), sold_out_this_month, scheduled_next_30_days (pending scheduled lifecycle changes), open_suggestions, fba_products (exiting products with FBA stock)
- by_state: [{key, label, color, count, units, value}] for unarchived exiting products
- status_counts: product count keyed by on_track, at_risk, stalled, sold_out
- banner.no_active_supplier_count: open suggestions where every supplier source is discontinued
- needs_action: up to 8 items [{kind (fba_surcharge, final_buy, at_risk, sold_out, suggestions), severity (error, warning, info), title, caption (dates in the account's date format), product_id, action (fba_checklist, view_product, clearance, filter_sold_out, suggestions)}]
- coming_up: up to 20 events in the next 30 days [{date, kind (schedule, last_order, clearance_target, fba_cutoff), title, caption, product_id}]
- charts.stock_value: {states: [{key, label, color}], points: [{date, <state key>: value}]} daily stock value per exiting state
- charts.clearance: active clearance plans [{plan_id, name, target_sell_out_on, start_units, points: [{date, actual_pct, plan_pct}]}] - weekly cumulative sell-through vs a straight line to the target
- first_run: {generating, message} while the first suggestions run is queued
Requires a Bearer token with the products read/write scope and the products.show permission.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.