Skip to main content

List Clearance Plan Suggestions

GET 

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

List a plan's markdown suggestions — one per product, price tier and due step — ordered pending, held, applied, skipped, then oldest first. A suggestion is held when its price breaks the plan floor or a pricing guardrail; held_reason says why, with amounts in the price's currency (e.g. "Below landed cost ($18.40)", "Pricing guardrail “MAP”: below its floor of €80.00").

Required scope: products:read

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

Fields: id, clearance_plan_id, product_id, product (id, sku, name, lifecycle_state), product_pricing_tier_id, price_tier (id, name, currency_code), step_position, discount_pct, original_price, current_price, proposed_price (the applied price once applied), reference_price (compare-at price), reference_warning, sell_through_pct, weeks_of_cover, weeks_left, reason (why the step is due), evidence (the full snapshot at suggestion time: discount_pct, trigger_type, original_price, sell_through_pct, planned_sell_through_pct, weeks_of_cover, weeks_left, weeks_elapsed, on_hand, reference_rule, reference_warning), status, held_reason, resolved_by_user_id, resolved_at, created_at.

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

Request​

Responses​

OK

Response Headers
    Content-Type