Release Status Open Beta Availability Free
Status Page Shippo Status Page Default Historical Sync 1 year
Whitelist Tables/Columns Unsupported/Unsupported Default Replication Frequency 30 minutes
Full Table Endpoints 0 Incremental Endpoints 5
Destination Incompatibilities None

Connecting Shippo

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 token.

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

Add 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.

Define 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.

Before setting the Replication Frequency, note that:

  • The more often Shippo is set to replicate, the higher the number of replicated rows.

  • The number of rows in the source may not equal the number of rows replicated by Stitch. Tables that use Full Table Replication will result in a higher number of replicated rows.

  • If you’re using a data warehouses that doesn’t natively support nested structures, you’ll see a higher number of replicated rows due to the de-nesting Stitch performs.

To help prevent overages, we recommend setting the Replication Frequency to something less frequent - like 6 hours instead of 30 minutes. For tips on reducing your row count, check out the Reducing Your Row Count section of our Billing Guide.

After selecting a Replication Frequency, click Save Integration.

Shippo’s Intial Sync

After you finish setting up Shippo, you might see its Sync Status 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 sync for the integration. This may take some time to complete.

Shippo Schema

Stitch's Shippo integration includes these tables:


addresses

Replication Method: Incremental
Primary Key: object_id
Contains Nested Structures?: Yes

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

Table Info & Attributes

addresses & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

addresses Attributes

While we try to include everything Shippo has here, this may not be a full list of attributes. Refer to Shippo's documentation for a full list and description of each attribute.

  • object_id

  • object_state

  • object_purpose

  • object_source

  • object_created

  • object_updated

  • object_owner

  • name

  • company

  • street1

  • street2

  • city

  • state

  • zip

  • country

  • phone

  • email

  • is_residential

  • metadata

  • type

  • messages*

parcels

Replication Method: Incremental
Primary Key: object_id
Contains Nested Structures?: No

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

Table Info & Attributes

parcels Attributes

While we try to include everything Shippo has here, this may not be a full list of attributes. Refer to Shippo's documentation for a full list and description of each attribute.

  • object_id

  • object_state

  • object_purpose

  • object_source

  • object_created

  • object_updated

  • object_owner

  • template

  • length

  • width

  • height

  • distance_unit

  • weight

  • mass_unit

  • extra

  • test

refunds

Replication Method: Incremental
Primary Key: object_id
Contains Nested Structures?: No

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

Table Info & Attributes

Refund Processing Time & 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.

refunds Attributes

While we try to include everything Shippo has here, this may not be a full list of attributes. Refer to Shippo's documentation for a full list and description of each attribute.

  • object_id

  • object_state

  • object_purpose

  • object_created

  • object_updated

  • object_owner

  • transaction

  • test

shipments

Replication Method: Incremental
Primary Key: object_id
Contains Nested Structures?: Yes

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

Table Info & Attributes

shipments & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

shipments Attributes

While we try to include everything Shippo has here, this may not be a full list of attributes. Refer to Shippo's documentation for a full list and description of each attribute.

  • object_id

  • object_state

  • object_purpose

  • object_created

  • object_updated

  • object_owner

  • object_from

  • object_to

  • object_return

  • object_parcel

  • submission-date

  • insurance_amount

  • insurance_currency

  • extra

  • customs_declaration

  • reference1

  • reference2

  • rates_url

  • rates_list

  • carrier_accounts

  • metadata

  • test

  • messages*

transactions

Replication Method: Incremental
Primary Key: object_id
Contains Nested Structures?: Yes

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

Table Info & Attributes

transactions & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

transactions Attributes

While we try to include everything Shippo has here, this may not be a full list of attributes. Refer to Shippo's documentation for a full list and description of each attribute.

  • object_id

  • object_state

  • object_purpose

  • object_created

  • object_updated

  • object_owner

  • test

  • rate

  • tracking_number

  • tracking_status

  • tracking_history

  • tracking_url_provider

  • label_url

  • commercial_invoice_url

  • metadata

  • messages*

Related Troubleshooting
Questions? Feedback?

Did this article help? If you have questions or feedback, please reach out to us.

Tags: saas integrations