Skip to main content

Test Saved Shiptheory Connection

POST 

/api/shiptheory/:integration_instance/test-connection

Validates the credentials stored on a saved Shiptheory instance (no body) and records the outcome so the connection panel reflects it.

Required scope: integrations:write

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

Path parameter:

  • integration_instance: the numeric id of the Shiptheory integration instance.

Authentication: requires a Bearer token.

Returns 200 with { data: { connected: true } } when the stored credentials work, or 422 with a code (invalid_credentials, rate_limited, api_error) and message when they do not.

Request​

Responses​

OK

Response Headers
    Content-Type