Add Clearance Plan Products
POST/api/v2/clearance-plans/:clearancePlan/products
Enrol more products in an active plan, by id or by a products-list filter. Each product's current price in the plan's tiers is saved as its original price. Products already in another active plan, or with no price in the plan's tiers, are skipped. Adding a product that was removed from this plan earlier lifts its removal, so the plan's filter can pick it up again. When anything was added the plan is evaluated straight away, so due markdowns are suggested.
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body (send product_ids, filters, or both):
- product_ids (array of up to 5000 distinct integer product ids)
- filters (object): a products-list filter payload, e.g. {"filter": {"lifecycle_state.is": "discontinued"}}.
Response: data (added, skipped: product id => reason), evaluation (suggested, held, auto_applied, enrolled, push_warnings; null when nothing was added), message. Ended plans return 422.
Requires a Bearer token with the products read/write scope and the products.manage_pricing permission.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.