Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

source-shipstation contribution from JohnnyRafael #49985

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

JohnnyRafael
Copy link

@JohnnyRafael JohnnyRafael commented Dec 21, 2024

What

This PR adds a new connector for source Shipstation (source-shipstation).

Contributor-provided connector description:

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.

Details

Expand for list of spec properties and streams

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

Reviewer checklist

  • Run /format-fix to resolve any formatting errors
  • Help the contributor upload an icon that follows our icon design guidelines
  • Click into the CI workflows that wait for a maintainer to run them, which should trigger CI runs

Copy link

vercel bot commented Dec 21, 2024

@JohnnyRafael is attempting to deploy a commit to the Airbyte Growth Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant
Copy link

CLAassistant commented Dec 21, 2024

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation community connectors/source/shipstation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants