Start Ship-With-Preorder Preview
POST/api/v2/inventory-allocations/ship-with-preorder/previews
Starts a dry run over every open order waiting on a PO-backed line and stores what would move (one row per planned reservation). Nothing changes until the preview is applied. Works whether or not the feature is switched on. Runs in the background; poll the run or the returned tracked job.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
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.