Preview Customer Matching Results
POST/api/qbo/integration-instances/:integrationInstance/matching-config/dry-run
Preview how the currently saved matching configuration would classify a sample of unlinked QuickBooks Online customers, without creating a match run or persisting any proposals. Up to sample_size active, unlinked QuickBooks customers are scored against the SKU.io customer pool and the response reports how many would land in each bucket.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Buckets: auto (score at or above the auto threshold), review (between the review and auto thresholds), hidden (below the review threshold), plus unmatched for customers with no scoring candidate at all.
This is a read-only preview computed synchronously from locally synced data - nothing is written in SKU.io and nothing is modified in QuickBooks. Save configuration changes first: the preview always uses the saved configuration, not values sent in this request.
Returns 404 if the integration instance does not exist.
Authentication: Requires Bearer token.
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
Response Headers
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.