Skip to main content

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.

Required scope: inventory:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Request​

Responses​

OK

Response Headers
    Content-Type