Skip to main content

List Lifecycle Schedules

GET 

/api/v2/product-lifecycle/schedules

Pending scheduled lifecycle changes across all products, soonest first, paginated. Only pending schedules are listed. Next to the pagination keys the response includes creators — the users who created a pending schedule, as {value: user id, title: name} — for filtering by creator.

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, effective_on, sku, product (by SKU), to_state, from_state, origin, reason, created_by_user_id, created_at.

Schedule fields: id, product_id, product {id, sku, name, lifecycle_state, lifecycle_state_label, lifecycle_state_color}, from_state and from_state_label (the product's current state), to_state, to_state_label, effective_on, status (pending, applied, cancelled), origin (manual — scheduled by a user; phase_out — the automatic move to discontinued created when a product is phased out; auto_return — a state's automatic return), discontinue_on, last_order_date, reason (brand_decision, supplier_discontinued, seasonal_end, low_performance, replaced, quality_issue, other), note, created_by {id, name}, created_at.

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

Each schedule also carries cancelled_at (when it was cancelled; always null here, since only pending schedules are listed).

Request​

Responses​

OK

Response Headers
    Content-Type