Create Integration Instance

POST 
/api/shiphero/integration-instances

Create a new ShipHero integration instance.

Not yet available to API tokens

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

Authentication: Requires Bearer token.

Requires the integrations.create permission.

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

Request

Responses

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden

Response Headers

Content-Type

422

Unprocessable Entity

Response Headers

Content-Type

429

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.