Shippo integration summary

Stitch’s Shippo integration replicates data using the Shippo API. Refer to the Schema 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.

STITCH
Release status

Released on March 1, 2017

Supported by

Singer Community

Stitch plan

Standard

API availability

Available

Singer GitHub repository

singer-io/tap-shippo

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Unsupported

Column selection

Unsupported

Select all

Unsupported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Shippo

Step 1: Retrieve 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 token.

    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 the Add Integration button.

  3. Click the Shippo 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 called stitch_shippo in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the Shippo 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 data equal 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 of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication 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:

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

Initial and historical replication jobs

After you finish setting up Shippo, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending 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

The addresses table contains info about address objects. These are used to create shipments, obtain rates, and print labels.

Replication Method

Key-based Incremental

Primary Key

object_id

Replication Key

object_updated

Useful links

Shippo documentation

addresses schema on GitHub

Shippo API method

Join addresses with on
shipments
addresses.object_id = shipments.object_from
addresses.object_id = shipments.object_to
addresses.object_id = shipments.object_return

city

STRING

company

STRING

country

STRING

email

STRING

is_residential

BOOLEAN

messages

ARRAY

metadata

STRING

name

STRING

object_created

DATE-TIME

object_id

STRING

object_owner

STRING

object_purpose

STRING

object_source

STRING

object_state

STRING

object_updated

DATE-TIME

phone

STRING

state

STRING

street1

STRING

street2

STRING

test

BOOLEAN

zip

STRING

parcels

The parcels table contains info about parcel objects. Parcels are used to create shipments, obtain rates, and print labels.

Replication Method

Key-based Incremental

Primary Key

object_id

Replication Key

object_updated

Useful links

Shippo documentation

Shippo API method

Join parcels with on
shipments
parcels.object_id = shipments.object_parcel

distance_unit

STRING

extra

OBJECT

height

STRING

length

STRING

mass_unit

STRING

metadata

STRING

object_created

DATE-TIME

object_id

STRING

object_owner

STRING

object_state

STRING

object_updated

DATE-TIME

template

STRING

test

BOOLEAN

weight

STRING

width

STRING

refunds

The refunds table contains info about refunds, which are reimbursements for successfully created but unused transactions.

Refund processing time and data discrepancies

If the data in this table doesn’t look like you’d expect it to, keep in mind that refunds can take up to 14 days to be processed.

Replication Method

Key-based Incremental

Primary Key

object_id

Replication Key

object_updated

Useful links

Shippo documentation

refunds schema on GitHub

Shippo API method

Join refunds with on
transactions
refunds.transaction = transactions.object_id

object_created

DATE-TIME

object_id

STRING

object_owner

STRING

object_status

STRING

object_updated

DATE-TIME

test

BOOLEAN

transaction

STRING

shipments

The shipments table contains info about shipment objects. Shipment objects are made up of to and from addresses and the parcel to be shipped.

Replication Method

Key-based Incremental

Primary Key

object_id

Replication Key

object_updated

Useful links

Shippo documentation

shipments schema on GitHub

Shippo API method

Join shipments with on
addresses
shipments.object_from = addresses.object_id
shipments.object_to = addresses.object_id
shipments.object_return = addresses.object_id
parcels
shipments.object_parcel = parcels.object_id

carrier_accounts

ARRAY

customs_declaration

STRING

extra

OBJECT

insurance_amount

STRING

insurance_currency

STRING

messages

ARRAY

metadata

STRING

object_created

DATE-TIME

object_from

STRING

object_id

STRING

object_owner

STRING

object_parcel

STRING

object_purpose

STRING

object_return

STRING

object_state

STRING

object_status

STRING

object_to

STRING

object_updated

DATE-TIME

rates_list

ARRAY

rates_url

STRING

reference1

STRING

reference2

STRING

submission_date

DATE-TIME

test

BOOLEAN

transactions

The transactions table contains info about transactions, which are the purchases of shipping labels from a shipping provider for a specific service.

Replication Method

Key-based Incremental

Primary Key

object_id

Useful links

Shippo documentation

transactions schema on GitHub

Shippo API method

Join transactions with on
refunds
transactions.object_id = refunds.transaction

commercial_invoice_url

STRING

label_url

STRING

messages

ARRAY

metadata

STRING

object_created

DATE-TIME

object_id

STRING

object_owner

STRING

object_state

STRING

object_status

STRING

object_updated

DATE-TIME

rate

STRING

test

BOOLEAN

tracking_history

ARRAY

tracking_number

STRING

tracking_status

STRING

tracking_url_provider

STRING


Questions? Feedback?

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