Preview Purple Dot Connection
POST/api/purple-dot/:instance/preview
Starts a dry-run in the background. It builds the planned inventory the first push would send, reads every held pre-order from Purple Dot with the purchase order line that would cover it (or shelf stock, or nothing, or no matching product), and the release budget per SKU. Nothing is sent to Purple Dot and no SKU.io demand is created; only GET /pre-orders is read. Replaces the previous dry-run. The connection's preview block (state: none / running / succeeded / stale / failed, tracked_job_log_id, succeeded_at) records the result; Go live requires succeeded for the current settings. Returns the id of the background job to follow; read the rows with List Purple Dot Preview Rows when it completes. 422 no_token when no access token is stored. Requires integrations.sync.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
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.
Unprocessable Entity
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.