Create Send Plan Follow-up Warehouse Transfer
POST/api/send-plans/:sendPlan/drafts/:draft/transfer
Follow a manual draft group with a draft warehouse transfer from its source to the network's warehouse (default) or another of your warehouses that feeds it. The planner's stock hold moves onto the transfer lines and is released when the transfer is opened.
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 create send planner drafts and to create warehouse transfers (403 otherwise).
Body fields (optional):
- to_warehouse_id (integer): destination of the transfer, one of List Send Plan Draft Transfer Targets. Omit for the network's own warehouse.
Returns 201 with the updated draft group, whose warehouse_transfer holds the transfer's id, reference and route. Returns 404 when the group is not part of the plan, and 422 when the group is not a manual one, already has a transfer, has nothing left to transfer, the destination is not allowed, or the source is short.
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
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.