Skip to main content

End Clearance Plan

DELETE 

/api/v2/clearance-plans/:clearancePlan

End a clearance plan. The plan is not deleted: it moves to ended (listed with filter[archived]=1) and its open suggestions are closed.

Required scope: products:write

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

Body:

  • end_action (required): keep (leave the clearance prices in place) or restore (put the original prices back — only for products that were reactivated to Active; every other product keeps its clearance price).

Products the plan marked down then get a price push to the plan's channels (or every channel they are listed on), which also clears the compare-at price. A channel that cannot take a push right now is reported in push_warnings; its scheduled push sends the price later.

Response: data (restored, kept, kept_not_active, push_warnings) and message. Ending an already-ended plan returns 422.

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

Request​

Responses​

OK

Response Headers
    Content-Type