Already have an account? Sign in

Shippo (v1)

Shippo integration summary

Stitch’s Shippo integration replicates data using theShippo API. Refer to theSchema section for a list of objects available for replication.

Shippo feature snapshot

A high-level look at Stitch's Shippo (v1) integration, including release status, useful links, and the features supported in Stitch.

Connecting Shippo

Step 1: Retrieve your Shippo API token

1. Sign into your Shippo account.
2. In the left nav tab, clickAPI.

3. Locate theAPI LIve Token field in theTokens section:

   

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

Step 2: Add Shippo as a Stitch data source

1. Sign into your Stitch account.

2. On the Stitch Dashboard page, click theAdd Integration button.

3. Click theShippo icon.

4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

   For example, the name “Stitch Shippo” would create a schema calledstitch_shippo in the destination.Note: Schema names cannot be changed after you save the integration.

5. In theShippo Token field, paste your Shippo API Live token.

Step 3: Define the historical replication start date

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

Change this setting if you want to replicate data beyond Shippo’s default setting of1 year. For a detailed look at historical replication jobs, check out theSyncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In theReplication Frequency section, you’ll create the integration’sreplication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Shippo integrations support the following replication scheduling methods:

• Replication Frequency

• Anchor Scheduling

• Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.

Initial and historical replication jobs

After you finish setting up Shippo, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, aPending status indicates that Stitch is in the process of scheduling the initial replication job for the integration.This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Shippo table reference

addresses.object_id = shipments.object_from

addresses.object_id = shipments.object_to

addresses.object_id = shipments.object_return

parcels.object_id = shipments.object_parcel

refunds.transaction = transactions.object_id

shipments.object_from = addresses.object_id

shipments.object_to = addresses.object_id

shipments.object_return = addresses.object_id

shipments.object_parcel = parcels.object_id

transactions.object_id = refunds.transaction

Did this article help? If you have questions or feedback, feel free tosubmit a pull request with your suggestions,open an issue on GitHub, orreach out to us.