Stitch Documentation
has moved!

Please update your bookmarks to https://www.stitchdata.com/docs

If you're not automatically redirected after 5 seconds, click here.

Connecting Shippo

Shippo Info
This integration was created by Stitch for Singer, an open-source, composable ETL platform. Check out & contribute to the repo on GitHub.

Shippo is currently in Open Beta. The info in this article is subject to change.

Connecting Stitch to Shippo is a four-step process:

  1. Retrieve your Shippo API token
  2. Add Shippo as a Stitch data source
  3. Define the Historical Sync
  4. Define the Replication Frequency

Retrieving Your Shippo API Token

  1. Sign into your Shippo account.
  2. In the left nav tab, click API.
  3. Locate the API LIve Token field in the Tokens section:

    shippo-api-credentials.png

Leave this page open for now - you’ll need it to complete the setup.

Adding Shippo as a Stitch Data Source

  1. On the Stitch Dashboard page, click the Add an Integration button.
  2. Click the Shippo icon.
  3. Enter a name for the integration. This is the name that will display on the for the integration; it’ll also be used to create the schema in your data warehouse.

    For example, the name “Stitch Shippo” would create a schema called stitch_shippo in the data warehouse. This schema is where all the tables for this integration will be stored.
  4. In the Shippo Token field, paste your Shippo API Live token.

Defining the Historical Sync

The Sync Historical Data setting will define the starting date for your Shippo integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to sync data beyond Shippo’s default setting of 1 year. For a detailed look at historical syncs, check out the Syncing Historical SaaS Data article.

Defining the Replication Frequency

The Replication Frequency controls how often Stitch will attempt to replicate data from your Shippo integration. By default the frequency is set to 30 minutes, but you can change it to better suit your needs.

Stitch & Replicating Shippo Data

Because the Shippo API doesn’t allow filtering records by date or ID, Stitch uses Full Table Replication for every table to ensure updates to existing records are accurately captured. This means that the entire integration will replicate fully every time a replication job runs.

We recommend setting Shippo integrations to replicate less frequently - for example, every 6 or 12 hours - to prevent row overages.

For more tips on reducing your row count, check out the Reducing Your Row Count article.

After setting the Replication Frequency, click Save Integration to wrap things up.

Related

Was this article helpful?
0 out of 0 found this helpful

Comments

Questions or suggestions? If something in our documentation is unclear, let us know in the comments!