List Purple Dot Planned Inventory
GET/api/purple-dot/:instance/planned-inventory
The planned inventory SKU.io last sent to Purple Dot, one row per supply source: a purchase order line, an inbound shipment carrying it, or an inbound warehouse transfer line into a supply warehouse. Quantities and date_expected are what Purple Dot last accepted; pending_date_expected and eta_review_id describe an ETA slip waiting for review. netted_backorder_units are units held back for SKU.io's own backorders. status pending = Purple Dot did not acknowledge the last push (5xx, 429 or network); the item is retried automatically with backoff using the values computed at retry time, last_error shows the failure and next_retry_at when it is next tried (null for any other status). error = Purple Dot rejected the item (4xx); it is not retried automatically.
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Filters: filter[search] (sent SKU, product SKU or name, PO number, source label; a number also matches the id; narrow with search_columns = id, match_value, product, po_number, source_label and search_strict_columns), filter[id.<operator>] (numeric), filter[status] (pushed, held_for_review, error, pending), filter[source_type] (purchase_order_line, inbound_shipment_line, warehouse_transfer_line), filter[purchase_order_id], filter[product_id].
Advanced filters: filter_groups = base64 of a JSON tree {conjunction, children:[{type:'condition', condition:{column, operator, value}}]}. Columns: status, source_type, match_value (text), id, quantity_expected, quantity_arrived (numeric), date_expected (date), pushed_at (datetime).
Sorts: id, quantity_expected, quantity_arrived, date_expected (default), status, pushed_at. Prefix with - for descending.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.