Skip to main content

Create Integration Instance

POST 
/api/shipfusion/integration-instances

Create a new Shipfusion 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.

Request Body:

  • name (string, required) — Unique name for the integration instance
  • integration_id (integer, required) — ID of the integration record (must exist in integrations table)
  • connection_settings (object, optional) — Shipfusion API credentials
    • username (string) — Shipfusion API username
    • password (string) — Shipfusion API password
  • integration_settings (object, optional) — Integration behavior settings
    • enable_fulfillment (boolean) — Enable automated fulfillment via Shipfusion
    • pass_tags (boolean) — Pass order tags to Shipfusion
  • is_automatic_sync_enabled (boolean, optional, default: false) — Enable automatic order/inventory syncing

Requires the integrations.create permission.

Returns 422 on integration_id when a Shipfusion connection with this name already exists.

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​

Created

Response Headers
    Content-Type