Update Transfer Destinations
PUT/api/send-planner/transfer-destinations
Choose which of your own warehouses the planner stocks by warehouse transfer. Applies from the next calculation.
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:
- warehouse_ids (integer[], required — send [] to clear, max 200): your own active warehouses or 3PLs.
Response data: warehouses — your own active warehouses and 3PLs (id, name, type, country_code, stocked_by_transfer) — and selected, the IDs stocked by transfer. A warehouse stocked by transfer becomes a destination of the plan (network warehouse_transfer) instead of a source, and its sends are drafted as warehouse transfers.
Returns 422 when an ID is not one of your own active warehouses, or when every warehouse would be stocked by transfer (at least one must remain a ship-from source).
Request
Responses
- 200
- 401
- 403
- 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.
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.