airbyte/docs/integrations/sources/shipstation.md

Shipstation

This page contains the setup guide and reference information for Shipstation source connector.

Documentation reference: Visit https://www.shipstation.com/docs/api/ for API documentation

Authentication setup

To get your API key and secret in ShipStation:

↳ Go to Account Settings.

↳ Select Account from the side navigation, then choose API Settings.

↳ Click "Generate New API Keys" if no key and secret are listed yet.

** IMPORTANT ** ↳If you've already generated your API keys, the existing API keys will be displayed here and the button will read Regenerate API Keys.

If you already have API keys, do NOT generate new ones. Instead, copy your existing key and secret.

Copy your key and secret and paste them into the respective fields.

Configuration

Input	Type	Description	Default Value
username	string	API Key.
password	string	API Secret.

Streams

Stream Name	Primary Key	Pagination	Supports Full Sync	Supports Incremental
carriers	shippingProviderId	No pagination	✅	❌
customers	customerId	DefaultPaginator	✅	❌
fulfillments	fulfillmentId	DefaultPaginator	✅	❌
orders	orderId	DefaultPaginator	✅	❌
products	productId	DefaultPaginator	✅	❌
shipments	shipmentId	DefaultPaginator	✅	❌
marketplaces	name.marketplaceId	No pagination	✅	❌
stores	storeId	No pagination	✅	❌
users	userId	No pagination	✅	❌
warehouses	warehouseId	No pagination	✅	❌
webhooks	WebHookID	No pagination	✅	❌

Changelog

Expand to review

Version	Date	Pull Request	Subject
0.1.2	2025-02-15	54047	Update dependencies
0.1.1	2025-02-08	53551	Update dependencies
0.1.0	2025-02-03	52707	Change auth method
0.0.6	2025-02-01	53109	Update dependencies
0.0.5	2025-01-25	52405	Update dependencies
0.0.4	2025-01-18	51911	Update dependencies
0.0.3	2025-01-11	51328	Update dependencies
0.0.2	2024-12-28	50726	Update dependencies
0.0.1	2024-12-21		Initial release by @JohnnyRafael via Connector Builder