Skip to main content

List Clearance Plan Products

GET 

/api/v2/clearance-plans/:clearancePlan/products

List the products enrolled in a plan with their sell-through, ladder step and prices.

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).

Row fields: id (enrolment id), product_id, sku, name, lifecycle_state, current_step (0 = not marked down yet), steps_total, next_step_discount_pct, last_step_at, price_tier_id + price_tier_name (the tier of the open suggestion, else the plan's first tier), original_price (at enrolment), current_price, proposed_price and suggestion_status (of the open suggestion, if any), reference_price (the locked compare-at price), reference_warning, on_hand, start_units, started_at, units_sold, sell_through_pct, weekly_velocity (30-day sales rate), weeks_of_cover, weeks_left (to target_sell_out_on), weeks_elapsed, planned_sell_through_pct (straight-line pace to the target date), status (on_track, at_risk, stalled — no sales for 14+ days, sold_out).

Alongside the pagination keys the response carries brands: the distinct brands of the plan's products (value = brand id, title = brand name).

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

Request​

Responses​

OK

Response Headers
    Content-Type