Push Purple Dot Planned Inventory
POST/api/purple-dot/:instance/planned-inventory/push
Starts a background push of planned inventory to Purple Dot for the given products, or every product when product_ids is empty. Items are re-sent even when unchanged since the last push (the automatic pushes skip those); ETA slips over the connection's review threshold are held for review instead of being pushed. Returns the id of the background job to follow. 422 not_live when the connection is not live, push_disabled when the planned-inventory push is off.
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.