Get Integration Instance
GET/api/shipstation/integration-instances/:integration_instance
Returns a single ShipStation integration instance with its connection settings and integration settings.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Response fields:
- id (int), name (string), integration_id (int)
- connection_settings (object): apiKey, apiSecret, timezone
- integration_settings (object): connection_name, enable_fulfillment, order_start_date, auto_submit_fulfillments, settings (legacy ShipStation options such as productFieldToPass, gift_card_note_sales_order_custom_field_id, saturday_delivery_sales_order_custom_field_id, send_sales_order_tags_as_notes), fulfillment_cost_financial_line_type_id, and fulfillment (per-warehouse routing: enabledWarehousesIds / automatedWarehousesIds)
- is_automatic_sync_enabled (boolean)
- created_at / updated_at (ISO 8601)
Authentication: Requires Bearer token.
Requires the integrations.show permission.
connection_settings never contains saved credentials: each secret key (API keys, secrets, passwords, tokens) is left out and replaced by a has_<snake_case_key> boolean saying whether one is saved (apiKey → has_api_key, password → has_password).
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
Response Headers
Not Found
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.