Test Connection
POST/api/magento2/test-connection
Validates the supplied Magento 2 credentials by calling the REST API. Returns the store views and MSI (Multi-Source Inventory) sources the merchant has access to — used by the UI to preview before persisting.
Nothing is persisted by this endpoint.
Body parameters:
base_url(required, URL): The storefront base URL — e.g.https://shop.example.com. Trailing slash is trimmed server-side.access_token(required, string, min 8 chars, max 255): The integration access token from Magento Admin → System → Integrations.
Error responses:
422— validation failure OR Magento rejected the credentials (success: falsewith a human-readablemessage).401— caller is not authenticated to SKU.io.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Unprocessable Entity
Response Headers
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.