Skip to main content

Get Clearance Plan

GET 

/api/v2/clearance-plans/:clearancePlan

Get one clearance plan with its markdown ladder, its tiers and channels by name, and the projected markdown cost.

Required scope: products:read

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

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. The single-plan form also returns: merchandise_plan (id, retail_period, planned_markdown_value, or null), steps (id, position, discount_pct, trigger_type, trigger_label, trigger_params), price_tiers (id, name — the tiers the plan prices; the default tier when none were chosen), integration_instances (id, name) and projected_markdown_value (the markdown cost of the open and applied suggestions, in the plan's currency).

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

Request​

Responses​

OK

Response Headers
    Content-Type