Save Send Lanes
PUT/api/send-planner/lanes
Create or update source → destination lanes: which of your warehouses may supply each network, in what priority order, and with what lead time. Each lane is upserted by its source and destination pair.
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:
- lanes (array, required, max 200)
- lanes[].source_warehouse_id (integer, required): must exist.
- lanes[].destination_warehouse_id (integer, required): must exist.
- lanes[].priority (integer, required, 1-1000): lower is tried first.
- lanes[].enabled (boolean, required).
- lanes[].lead_days_override (integer, 0-180, nullable).
Response: the full network list, as in List Send Networks.
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 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.