Get Integration Instance
GET/api/starshipit/integration-instances/:integration_instance
Returns the configuration for a single StarShipIt integration instance, including connection credentials and behavioural settings.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
connection_settings keys:
apiKey— StarShipIt API key.subscriptionKey— StarShipIt subscription (Ocp-Apim) key sent with every API call.webhookSecret— optional; used to verify signatures on inbound webhook notifications.
integration_settings keys (all optional):
fulfillment.enabledWarehousesIds/fulfillment.automatedWarehousesIds— warehouse routing selection (see the warehouse routing endpoint).sync_days_back— default sync window in days when no start date is set (default 30).order_start_date— earliest order date to sync.last_sync.orders/last_sync.tracking_info— timestamps maintained automatically by the background sync processes.
Returns 404 when the instance does not exist.
Authentication: Requires 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.