Regenerate Credentials
POST/api/shiprush/instances/:integration_instance/regenerate-credentials
Regenerates the SS store credentials the merchant uses to authenticate the ShipRush export feed. The previous username/password stop working immediately, so the merchant must paste the new values into ShipRush. Returns the new ONE-TIME plaintext pair (username, password) plus the feed URL — shown only once.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Path parameter:
- instance: the numeric ID of the ShipRush integration instance.
No request body is required.
Returns 200 with the new credentials; 404 when the instance does not exist.
Authentication: Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.