Skip to main content

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.

Required scope: inventory:write

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

Request​

Responses​

OK

Response Headers
    Content-Type