Preview Bulk Swap and Release
POST/api/sales-orders/bulk-swap/preview
Dry-run for the Swap & Release confirmation step: for each selected order, reports exactly which lines would be swapped (original SKU → substitute SKU, quantity, and the rule's mode), which orders would be skipped and why, and how many lines are already swapped. Makes no changes.
Authentication: Requires Bearer token.
Statuses per order: eligible (has planned line swaps) or skipped (with a human-readable reason).
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.