Skip to main content

List Cancelled Lifecycle Schedules

GET 

/api/v2/products/:product/lifecycle/cancelled-schedules

A product's scheduled lifecycle changes that were cancelled - the latest 50, most recently cancelled first, not paginated. Each one keeps its note, which says why it was cancelled (for example cancelled by hand, replaced by a newer schedule, or cancelled because the product was archived). Use it alongside List Product Lifecycle History to show changes that were planned but never happened.

Required scope: products:read

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

Response data: a list of schedules - id, product_id, product (null here), from_state and from_state_label (null here), to_state, to_state_label, effective_on, status (cancelled), origin (manual, phase_out, ...), discontinue_on, last_order_date, reason, note, cancel_reason (why it was cancelled, in plain words), created_by {id, name}, created_at, cancelled_at. For a cancelled schedule from_state / from_state_label are the state the product was in when the schedule was cancelled (null for schedules cancelled before this was recorded), not its current state.

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

Request​

Responses​

OK

Response Headers
    Content-Type