Skip to main content

Update 3PL Inventory Comparison Settings

PUT 
/api/3pl-inventory/integration-instances/:integrationInstance/settings

Update the integration's comparison settings. New snapshots use them; history keeps the tolerance it was captured with.

Required scope: inventory:write

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

Authentication: Requires Bearer token (inventory:write scope) and the integrations update permission.

Body fields (all required unless noted):

  • cadence: hourly, every_6_hours or daily
  • daily_hour (0–23): account-timezone hour for the daily cadence
  • tolerance_units (≥ 0): a line within this many units counts as agreeing
  • tolerance_percent (nullable, 0–100): alternatively within this percent of the larger side
  • settle_delay_minutes (0–1440): wait before re-scoring SKU.io's side
  • alert_agreement_threshold (0–100): alert when settled agreement % falls below this
  • alert_drop_points (0–100): alert when agreement drops by at least this many points between settled snapshots
  • alert_on_warehouse_zero (boolean): alert when the 3PL reports no stock for a warehouse where SKU.io holds stock
  • include_kits (boolean): compare kit products instead of marking them not comparable

Request​

Responses​

OK

Response Headers
    Content-Type