Rewrite Affected Orders
POST/api/v2/products/:product/component-revisions/:revision/rewrite-orders
Dispatch the background job that rewrites the affected orders' bundle component lines to the corrected recipe. Target either an explicit sales_order_ids list, or apply_to_all=true with a status filter. Unshipped orders are rewritten cleanly; shipped orders are skipped unless a system setting enables inventory/COGS compensation. The returned tracked_job_log_id can be polled for progress.
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Fields:
- sales_order_ids (required unless apply_to_all): order ids to rewrite.
- apply_to_all (optional, boolean): rewrite every affected order matching the status filter.
- status (optional): all | unshipped | shipped (scopes apply_to_all).
Authentication: Requires Bearer token.
Only orders inside the correction window whose bundle lines carry no fulfillment activity (nothing fulfilled, canceled or returned, no fulfillment lines or inventory movements) are rewritten; everything else is skipped and counted in the job result. The bundle's extended value on each order is preserved.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.