Get Endpoint Info
GET/api/shiprush/instances/:integration_instance/webhooks/endpoint
Returns the store-endpoint info card the merchant needs to configure ShipRush: the feed URL to paste in, the store username, and a masked password placeholder. The plaintext password is NEVER returned here — regenerate it via Regenerate Credentials to obtain a fresh one-time value.
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.
The response "data" object contains:
- feed_url: the store-endpoint URL the merchant pastes into ShipRush (or null when no webhook route is provisioned).
- store_username: the SS-UserName for the feed.
- store_password_masked: a masked placeholder for the password (dots), never the real value.
Authentication: Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.