Skip to main content

Get Product Lifecycle

GET 

/api/v2/products/:product/lifecycle

A product's current lifecycle: its state, reason and dates, who changed it, its successor and predecessors, any pending scheduled change, its recent history and — for a matrix parent — each variant's state and a rollup. Archived products are included.

Required scope: products:read

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

Response fields: product_id, sku, name, type, archived_at, lifecycle_state, lifecycle_state_label, lifecycle_state_color, lifecycle_changed_at, lifecycle_reason (brand_decision, supplier_discontinued, seasonal_end, low_performance, replaced, quality_issue, other), lifecycle_reason_label, lifecycle_note, discontinue_on, last_order_date, discontinued_at, sold_out_at, lifecycle_archived_by_sell_out (true when the sell-out action archived it), changed_by {id, name} (who made the latest change), successor (the product that replaces this one, or null: id, sku, name, lifecycle_state, lifecycle_state_label, lifecycle_state_color, succession_id, pack_factor, history_transfer_pct, history_transfer_until, use_up_first, auto_substitute), predecessors (products this one replaces, same shape), schedule (the pending scheduled change, or null: id, product_id, product, from_state, from_state_label, to_state, to_state_label, effective_on, status, origin, discontinue_on, last_order_date, reason, note, cancel_reason (why it was cancelled, e.g. "Replaced by a new change on 2026-11-06"; null unless cancelled), created_by, created_at, cancelled_at - null unless the schedule was cancelled), rollup (matrix parents only, else null: total, counts {state: n}, dominant_state, dominant_label, dominant_color, dominant_count, partly, label such as "Partly discontinued · 3 of 8"), recent_transitions (latest changes, newest first — see List Product Lifecycle History for fields), variants (matrix parents only: id, sku, name, lifecycle_state, attributes {name: value}, lifecycle_state_label, lifecycle_state_color), longest_lead_time_days (longest supplier lead time; null for matrix parents), transition_id (on a change: the id of the transition just recorded, for undo; null when scheduled).

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

Request​

Responses​

OK

Response Headers
    Content-Type