Update Send Plan Line
PATCH/api/send-plans/:sendPlan/lines/:line
Override the quantity to send on one line. The override is audited, the product's pool and the plan totals are recalculated, and the override carries forward into the next working plan while the line is still pending.
send-plans:writeGrant 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:
- final_qty (integer, required, 0-10000000): units to send.
- reason (string, optional): promo | listing_issue | cash | expedite | other | network_recommendation | stock_changed | unspecified. Omit it to save a quick edit (recorded as unspecified); the reason can be added afterwards.
- note (string, max 255): required when reason is other.
- use_protected_stock (boolean, optional): confirm that a quantity above the product's sendable pool may use stock kept for self-fulfilled orders. The line records the units used in
protected_stock_usedand is flagged uses_protected_stock; without it such an edit is refused.
Returns 404 when the line is not on this plan, and 422 when the plan is not ready or the line was already drafted.
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 Content
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.