Test Store Credentials
POST/api/magento1/instances/test-connection
Verify a set of Magento 1 SOAP credentials without saving them — use this before creating an integration instance. The probe walks the three places a Magento 1 connection breaks, and the response reports each check separately:
reachable— the store answered at all (URL / DNS / TLS / firewall)authenticated— the SOAP login succeeded (API user + key)orders_readable/products_readable— the SOAP role actually grants those resources. This is the failure that masquerades as a working connection: login succeeds, but every poll is refused because the role's Resource Access was never granted in Magento Admin.
A failed probe returns HTTP 422 and still carries the full check breakdown plus a message naming the Magento Admin screen to fix. Nothing is persisted by this endpoint.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
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.
Unprocessable Entity
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.