Skip to main content

Test Shiptheory Connection

POST 

/api/shiptheory/test-connection

Validates a Shiptheory account email + password without saving a connection. The credentials are exchanged for a short-lived Shiptheory token and a delivery-services probe is run, so you can confirm the login is correct before creating an instance.

Required scope: integrations:write

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

Body fields:

  • email (string, required): the Shiptheory account email. Max 255 characters.
  • password (string, required): the Shiptheory account password. Max 255 characters.

Returns 200 with { data: { connected: true } } when the credentials are accepted. Returns 422 with a "code" (invalid_credentials, rate_limited, or api_error) and a user-facing message when Shiptheory rejects the login or cannot be reached, or field errors when the body itself is invalid.

Authentication: requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type