Skip to main content

List Product Successors

GET 

/api/v2/product-successions

Every "replaced by" link between products, newest first, paginated, with both products' SKU, name and lifecycle state.

Required scope: products:read

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

Filters use filter[field]=value (exact match) or filter[field.operator]=value. 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, 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. between takes two comma-separated values. filter_groups accepts a JSON string of grouped AND/OR conditions using the same field names.

Allowed sorts: id, predecessor, predecessor_sku, successor, successor_sku, predecessor_state, successor_state, pack_factor, history_transfer_pct, history_transfer_until, use_up_first, auto_substitute, created_at.

Successor link fields: id, predecessor_product_id, successor_product_id, predecessor and successor {id, sku, name, lifecycle_state, lifecycle_state_label, lifecycle_state_color}, pack_factor (successor units per predecessor unit), history_transfer_pct (share of the predecessor's sales history credited to the successor in planning), history_transfer_until (history stops transferring after this date), use_up_first (sell the predecessor's stock before the successor), auto_substitute (none, when_unavailable, always), product_substitution_id (the order-time substitution rule created for auto_substitute, or null), created_at.

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

Request​

Responses​

OK

Response Headers
    Content-Type