Skip to main content

Delete Instance

DELETE 

/api/shipbob/:instance

Disconnect a ShipBob integration instance. Webhook subscriptions are removed at ShipBob and all mirrored data is deleted in the background; the request returns immediately.

Required scope: integrations:write

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

Authentication: Requires Bearer token.

Returns 422 (nothing is removed) while ShipBob billing has capitalised receiving fees into purchase orders received in a locked accounting period; data.locked_lines lists them. Unlock the period or keep the integration.

Closed periods: the delete is refused with 422 IntegrationInstanceDeletionBlocked when it would remove any accounting record dated on or before the accounting lock date (for example journal entries built from the connection's payouts). Nothing is removed. data.deletion_impact lists what blocked it. Pause the connection's sync instead, or lower the hard close date first. Get Integration Instance Deletion Impact checks this beforehand.

Request​

Responses​

OK

Response Headers
    Content-Type