List Swap Suggestions for a Line
GET/api/sales-order-lines/:salesOrderLineId/swap-suggestions
Ranked substitute products for a sales order line, from the active substitution rules for the line's product. Availability is scoped to the line's warehouse (falls back to all warehouses when the line has none) and resolves_shortfall marks substitutes that can cover the line's full outstanding quantity.
Authentication: Requires Bearer token.
Each suggestion includes the rule's mode (mode, mode_label) and free-text notes so the caller can show why the substitute exists.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.