Test Connection Credentials
POST/api/pinnacle/test
Validates a set of Pinnacle (Metropolitan Warehouse & Delivery) credentials without saving a connection. A token is granted with the Order API credentials, then the Tracking API key is probed.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields:
- connection_settings.environment (string, required): "production" or "sandbox".
- connection_settings.client_id (string, required, max 50): your MWD customer number.
- connection_settings.username (string, required, max 255): Pinnacle Order API username.
- connection_settings.password (string, required, max 255): Pinnacle Order API password.
- connection_settings.tracking_api_key (string, required, max 255): Pinnacle Tracking API key.
Returns 200 with ok=true and the granted token's expiry when both checks pass. When Pinnacle rejects the credentials the response is 422 with a machine-readable code (invalid_credentials, invalid_tracking_key, rate_limited, maintenance, unreachable, api_error) and errors keyed to the rejected field(s).
Authentication: requires a Bearer token (Personal Access Token).
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.