Create Integration Instance
POST/api/integration-instances
Create a new integration instance.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token + Power User access.
Required: integration_id. Either name or integration_settings.settings.connectionName must be provided.
The store ID from integration_settings.settings.store.id will create an associated sales channel. For Shopify: triggers location, webhook, products, and orders download if credentials are present. For ShipStation: fetches shipping services and creates webhooks. For ShipMyOrders: queues warehouse initialization. For Veracore: converts linked warehouse type to 3PL.
Note: name must be unique across all integration instances.
Requires permission: integrations.create
Deprecated integrations: If the supplied integration_id belongs to a permanently deprecated integration (e.g. ShipMyOrders), the request is rejected with 400 Bad Request and code IsUnacceptable. Existing instances and their historical data are retained read-only, but no new instance can be connected.
Request
Responses
- 200
- 400
- 401
- 403
- 422
- 429
OK
Bad Request
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.
Unprocessable Entity
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.