Get Integration Instance Deletion Impact
GET/api/integration-instances/:integration_instance/deletion-impact
Preview what deleting a connection would remove and keep, before you delete it. Read-only.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
removed lists each kind of accounting record the delete removes, with count, locked_count (dated on or before the accounting lock date), posted_count (journal entries already posted) and the earliest_date/latest_date they span, in the account's timezone. Kinds with no records are left out. Counts stop just past count_cap (10000) so the preview stays fast on very large connections: a count above it means more than 10,000 (shown as "10,000+"). The date range is always exact. Possible keys: inventory_movements, fifo_layers and sales_orders (Amazon: the FBA warehouses and FBA-fulfilled orders), and journal_entries:<Source> for each payout or settlement type the connection owns (e.g. journal_entries:ShopifyPayout, journal_entries:AmazonFinancialEventGroup, journal_entries:EbayPayout, journal_entries:WalmartSettlement).
kept describes what survives, such as sales orders that stay as manual orders.
blocked is true when any removed record has a locked_count above 0. A blocked delete is refused with 422; message explains why and what to do instead (pause the connection's sync, or lower the hard close date first). lock_date is null when no period is locked.
Authentication: Requires Bearer token.
Requires permission: integrations.show
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.