Skip to main content

ShipStation (Source)

Overview

The ShipStation source connector lets you connect to the ShipStation API using an API Key and API Secret.

Status

This connector is currently in development.

  • Authentication (credential validation) is implemented.
  • Schema discovery and extraction are not yet available.

Requirements

  • A ShipStation account with API access
  • A ShipStation API Key and API Secret

Authentication

ShipStation uses HTTP Basic Authentication:

  • Username: API Key
  • Password: API Secret

The connector validates credentials by calling the ShipStation API endpoint:

  • GET https://ssapi.shipstation.com/stores

Configuration

FieldTypeRequiredDescription
api_keystringYour ShipStation API Key (used as the Basic Auth username).
api_secretstringYour ShipStation API Secret (used as the Basic Auth password).

Setup

  1. In ShipStation, generate or locate your API Key and API Secret.
  2. In your workspace, create a new ShipStation source.
  3. Enter api_key and api_secret.
  4. Save and test the connection.

Streams

No streams are currently exposed.

  • Catalog discovery currently returns an empty catalog.
  • Extraction is not yet implemented.

Limitations

  • Incremental sync, historical backfills, and stream selection are not yet supported because extraction is still under development.