Skip to main content

Rebalance Send Plan Products

POST 

/api/send-plans/:sendPlan/rebalance

Re-share the source pool for some products of a ready plan after you have overridden lines. Every line with an override keeps its quantity (as do any lines listed in pinned_line_ids), and the rest of each product's sendable stock is shared again among that product's other networks. Pools and plan totals are recalculated.

Required scope: send-plans:write

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

Authentication: Bearer Personal Access Token with the send-plans:write scope. The token's user also needs permission to edit the send planner.

Body fields:

  • product_ids (integer[], required, 1-50000): products to rebalance.
  • pinned_line_ids (integer[], optional): extra lines whose current quantity must not change.

Up to 200 products are rebalanced synchronously and the updated plan is returned (200). Larger selections are rebalanced in the background, a batch at a time: the response is 202 with tracked_job_log_id, queued and products — poll Get Send Plan for the result.

Returns 422 when the plan is not ready.

Request​

Responses​

OK

Response Headers
    Content-Type