Skip to main content

Evaluate Clearance Plan

POST 

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

Run today's evaluation of a plan now instead of waiting for the daily run. A filter-scoped plan first re-runs its filter and enrols newly matching products. Then, for each product with stock and no open suggestion, the next unskipped step is checked against its trigger and a suggestion is created per price tier when due (held when it breaks the floor or a guardrail). With auto_apply on, unheld suggestions are applied immediately.

Required scope: products:write

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

No body. Response: data (suggested, held, auto_applied, enrolled, push_warnings) and message. The message also says how many markdowns were applied automatically and pushed to channels, and names any push that did not happen ("Not pushed: ..."). push_warnings lists channel pushes that did not happen for markdowns applied automatically (auto_apply), one "<channel>: <reason>" string each - the prices are saved and reach those channels on the next price push. Ended plans return 422.

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

Request​

Responses​

OK

Response Headers
    Content-Type