Skip to main content

Create Integration Instance

POST 
/api/starshipit/integration-instances

Creates a new StarShipIt integration instance.

Not yet available to API tokens

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

Body fields:

  • name (string, required) — must be unique across all integration instances.
  • connection_settings (object, required) — credentials: apiKey (StarShipIt API key), subscriptionKey (subscription key), and optionally webhookSecret for verifying inbound webhook signatures.
  • integration_settings (object, optional) — behavioural settings such as sync_days_back, order_start_date, and fulfillment warehouse routing (enabledWarehousesIds, automatedWarehousesIds).
  • is_automatic_sync_enabled (boolean, optional) — whether scheduled syncs run automatically.

Creating an instance immediately queues a background job that backfills orders from StarShipIt. Shipping methods are derived from carriers observed on synced orders, so the same backfill also populates shipping method data. Progress is reported through the tracked background job facilities.

Returns 422 when validation fails (missing/duplicate name, missing connection_settings).

Authentication: Requires Bearer token.

Requires the integrations.create permission.

Only one Starshipit account can be connected. A second connection is refused with 422 under errors.integration; change the existing connection instead.

Request​

Responses​

OK

Response Headers
    Content-Type