Skip to main content

List Lifecycle Suggestions

GET 

/api/v2/product-lifecycle/suggestions

Paginated lifecycle suggestions: signals (dormant stock, discontinued suppliers, low-value erratic demand, inactive listings, ended seasons, a selling successor) that suggest moving a product to another lifecycle state. Suggestions are never applied automatically. Only open suggestions are returned unless you filter on status. The first call for an account that has never generated suggestions queues the first generation run in the background.

Required scope: products:read

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

Filters:

  • filter[status]: comma-separated open, accepted, dismissed, snoozed, or all (default: open)
  • filter[rule]: comma-separated rule keys (all_suppliers_discontinued, dormant, cz_classification, channel_inactive, season_ended, successor_launched)
  • filter[product_id]: exact product id
  • filter[search]: matches product id (exact), SKU or name; narrow with search_columns / search_strict_columns
  • Operator filters (filter[<field>.<operator>]): id, product_id (numeric); sku, name, current_state, rule, status, suggested_state, suggested_reason (text); created_at, snoozed_until (date)

Filter syntax: filter[<field>.<operator>]=<value>. A bare filter[<field>]=<value> means is where noted. Text operators: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty. Numeric operators: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between (two comma-separated values), is_empty, is_not_empty. Date operators: is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year, days_ago, days_from_now, past_days, next_days. For AND/OR logic, send filter_groups as base64-encoded JSON: {"conjunction":"and","children":[{"type":"condition","condition":{"column":"sku.contains","operator":"contains","value":"TEE"}}]}.

Sort: id, rule, status, suggested_state, created_at, snoozed_until, sku, product (by SKU), current_state. Prefix with - for descending. Default: -id.

Pagination: page, per_page (1-200, default 10).

Suggestion fields: id, product_id, product (id, sku, name, lifecycle_state, lifecycle_state_label, lifecycle_state_color), rule (all_suppliers_discontinued, dormant, cz_classification, channel_inactive, season_ended, successor_launched), rule_label, suggested_state (state key, e.g. discontinued or phasing_out), suggested_state_label, suggested_state_color, suggested_reason (brand_decision, supplier_discontinued, seasonal_end, low_performance, replaced, quality_issue, other), suggested_reason_label, evidence (the signal behind the suggestion: a human-readable summary, rule-specific numbers such as days, on_hand, stock_value, last_sold_at, supplier_count or successor_sku, links [{label, url}] and evaluated_at), status (open, accepted, dismissed, snoozed), dismiss_reason, snoozed_until (date), suppressed_until (date), resolved_by_user_id, resolved_at, created_at, updated_at.

Requires a Bearer token with the products read/write scope and the products.index permission.

Request​

Responses​

OK

Response Headers
    Content-Type