Get Transfer Destinations
GET/api/send-planner/transfer-destinations
List your own warehouses and 3PLs and whether the planner stocks each one by warehouse transfer.
send-plans:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Bearer Personal Access Token with the send-plans:read scope. The token's user also needs permission to view the send planner.
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.
Request
Responses
- 200
- 401
- 403
- 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.
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.