Skip to main content

Create Integration Instance

POST 
/api/shipstation/integration-instances

Creates a new ShipStation integration instance.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

On success the manager immediately dispatches the initial background sync jobs for the new instance: auto-subscribe webhooks, sync warehouses, sync shipping methods, sync orders, and sync shipments (tracking info). Each sync surfaces via the tracked job log endpoints.

Body fields:

  • name (string, required): display name for the instance. Must be unique across all integration instances (validated by a unique rule and re-checked in the manager, which returns 422 with Provider name (X) already exists on conflict).
  • connection_settings (object, required): ShipStation V1 API credentials.
    • connection_settings.apiKey (string, required in practice): ShipStation API Key.
    • connection_settings.apiSecret (string, required in practice): ShipStation API Secret.
    • connection_settings.timezone (string, optional): IANA timezone used to interpret ShipStation's local timestamps. Defaults to America/Los_Angeles (ShipStation V1 returns PST/PDT timestamps).
  • integration_settings (object, optional): initial integration settings (see Update for the full key list). Defaults to {}.
    • integration_settings.sync_enabled (boolean): whether automatic order syncing is on.
    • integration_settings.order_start_date (date string or null): earliest order date to sync. When not set, syncs fall back to the Inventory Start Date, then a fixed 30-day window.
    • integration_settings.auto_submit_fulfillments (boolean): submit fulfillments automatically without manual review.
  • is_automatic_sync_enabled (boolean, optional): toggle the hourly scheduled syncs for this instance.

Response: data.id and data.name of the created instance.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type