Skip to main content

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.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

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.

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).

With a webhook secret saved, SKU.io rejects any Starshipit tracking webhook that is unsigned or wrongly signed (HTTP 401: "Webhook rejected: the x-starshipit-signature header is missing or does not match. …"), so tracking updates stop until the same secret is entered in Starshipit (Settings → Tracking & notifications). Leave it blank to accept unsigned webhooks.

Request​

Responses​

OK

Response Headers
    Content-Type