List Purple Dot Preview Rows
GET/api/purple-dot/:instance/preview/rows
Lists the rows of the latest dry-run, oldest first. The payload depends on kind: planned_inventory (product, purchase_order, source_label, quantity_expected net of backorders, quantity_arrived, date_expected, location_name), preorder (reference, customer_name, sku, quantity, coverage = covered | shelf | uncovered | unmapped, purchase_order with eta; a pre-order line split across purchase orders gives one row per part) or release (sku, product, held_units, available_units). Rows are dropped when the connection goes live. Requires integrations.show.
inventory:readGrant 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.