Skip to main content

List Clearance Plans

GET 

/api/v2/clearance-plans

List clearance plans — markdown ladders that step discontinued or phasing-out products down to sell-out. Active plans are returned by default; use filter[archived] for ended ones.

Required scope: products:read

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

Column filters use the pattern filter[<field>.<operator>]. 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. A nested AND/OR filter tree can be sent instead as filter_groups (base64-encoded JSON).

Plan fields: id, name, status (active | ended), end_action (keep | restore, set once ended), ended_at, scope (how products were chosen: product_ids and/or filters, plus excluded_product_ids - products removed from the plan that its filter must not enrol again; absent when there are none), price_tier_ids, integration_instance_ids, target_sell_out_on (Y-m-d), floor_type + floor_type_label, floor_value, auto_apply, reference_price_rule + reference_price_rule_label, bona_fide_days, merchandise_plan_id, products_count, pending_suggestions_count (pending + held), created_by_user_id, created_at, updated_at. Steps and the per-plan extras are only returned when getting a single plan.

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

Request​

Responses​

OK

Response Headers
    Content-Type