Skip to main content

Update Purple Dot Connection

PUT 

/api/purple-dot/:instance

Partial settings update, token replacement and live ↔ paused. A given access_token is validated live before it replaces the old one.

Required scope: inventory:write

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

Body: settings (object, optional: supply_warehouse_ids, sku_match_key, push_planned_inventory, net_of_backorders, include_transfers, release_mode, priority_mode, eta_review_threshold_days, refund_on_return, poll_minutes, export_marker), access_token (string, optional), status (live | paused, optional).

Changing supply_warehouse_ids of a connection that went live queues the tracked job "Purple Dot Supply Warehouses: {connection}": every open pre-order line's demand moves out of warehouses that are no longer supply warehouses into the warehouse the settings now resolve to, then planned inventory and every release budget are re-pushed. Its tracked job log id is returned as meta.supply_change_tracked_job_log_id (null when nothing was queued). Requires integrations.update.

Request​

Responses​

OK

Response Headers
    Content-Type