# Shippo (v1) Information note **Shippo is supported by the Singer community** This integration is powered by [Singer's](https://www.singer.io/) Shippo tap. For support, [visit the GitHub repo](https://github.com/singer-io/tap-shippo) or [join the Singer Slack](https://singer-slackin.herokuapp.com/). ## Shippo integration summary Stitch’s Shippo integration replicates data using the [Shippo API](https://goshippo.com/docs/intro/). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/shippo#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](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on March 1, 2017 | **Supported by**

the Info icon

Indicates if the integration is supported by Stitch or the Singer community. | [Singer Community](https://www.singer.io/) | | **Stitch plan**

the Info icon

The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**

the Info icon

Indicates if the integration is available as a source in Stitch Connect. | the Success icon

This version of the integration is available via the API.


Available | | **Singer GitHub repository** | [singer-io/tap-shippo](https://github.com/singer-io/tap-shippo) | | | | **REPLICATION SETTINGS** | | | | | **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**

the Info icon

A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**

the Info icon

A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Table-level reset**

the Info icon

Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon

Table-level resets are not supported for this integration. Resets are only supported at the integration level.


Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**

the Info icon

Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon

Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.


Unsupported | | **DATA SELECTION** | | | | | **Table selection**

the Info icon

The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Remove icon

Table selection is not supported for this integration. All available table and fields will be automatically selected for replication.


Unsupported | **Column selection**

the Info icon

The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Remove icon

Column selection is not supported for this integration. All available columns in tables set to replicate will be selected.


Unsupported | | **Select all**

the Info icon

Indicates if the integration supports selecting all available tables and columns. | the Remove icon

As this integration doesn't support table or column selection, all available tables and columns are automatically replicated.


Unsupported | | | | **TRANSPARENCY** | | | | | **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**

the Info icon

Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**

the Info icon

Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


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.](https://help.qlik.com/en-US/stitch/images/integrations/shippo-api-credentials.png)Shippo API token.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](https://app.stitchdata.com/). 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](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide. ### Step 4: Create a replication schedule Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information. In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). 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](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency) * [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling) * [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only) To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) 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.** Information note **Initial replication jobs with Anchor Scheduling** If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information. #### 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. Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage. ## Shippo table reference Information note **Schemas and versioning** Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing. The schema and info displayed below is for **version 1** of this integration. This is the latest version of the Shippo integration. Information note **Table and column names in your destination** Depending on your destination, table and column names may not appear as they are outlined below. For example: Object names are lowercased in Redshift (`CusTomERs` > `customers`), while case is maintained in PostgreSQL destinations (`CusTomERs` > `CusTomERs`). Refer to the [Loading Guide](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info. ### addresses The `addresses` table contains info about address objects. These are used to create shipments, obtain rates, and print labels. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | object\_id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | object\_updated | | **Useful links** | [Shippo documentation](https://goshippo.com/docs/reference#addresses "Opens in new tab: Shippo documentation")


[addresses schema on GitHub](https://github.com/singer-io/tap-shippo/blob/master/tap_shippo/schemas/addresses.json "Opens in new tab: addresses schema on GitHub")


[Shippo API method](https://goshippo.com/docs/reference?version=2016-10-25 "Opens in new tab: Shippo API method") | addresses table foreign keys | Join addresses with | on | | --- | --- | | [shipments](https://help.qlik.com/en-US/stitch/integrations/saas/shippo#shipments) | ```
addresses.object_id = shipments.object_from
```

```
addresses.object_id = shipments.object_to
```

```
addresses.object_id = shipments.object_return
``` | addresses table schema | **city**


STRING | | --- | | **company**


STRING | | **country**


STRING | | **email**


STRING | | **is\_residential**


BOOLEAN | | **messages**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **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 [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | object\_id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | object\_updated | | **Useful links** | [Shippo documentation](https://goshippo.com/docs/reference#parcels "Opens in new tab: Shippo documentation")


[Shippo API method](https://goshippo.com/docs/reference?version=2016-10-25#parcels-list "Opens in new tab: Shippo API method") | parcels table foreign keys | Join parcels with | on | | --- | --- | | [shipments](https://help.qlik.com/en-US/stitch/integrations/saas/shippo#shipments) | ```
parcels.object_id = shipments.object_parcel
``` | parcels table schema | **distance\_unit**


STRING | | --- | | **extra**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **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 [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | object\_id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | object\_updated | | **Useful links** | [Shippo documentation](https://goshippo.com/docs/reference#refunds "Opens in new tab: Shippo documentation")


[refunds schema on GitHub](https://github.com/singer-io/tap-shippo/blob/master/tap_shippo/schemas/refunds.json "Opens in new tab: refunds schema on GitHub")


[Shippo API method](https://goshippo.com/docs/reference?version=2016-10-25#refunds-list "Opens in new tab: Shippo API method") | refunds table foreign keys | Join refunds with | on | | --- | --- | | [transactions](https://help.qlik.com/en-US/stitch/integrations/saas/shippo#transactions) | ```
refunds.transaction = transactions.object_id
``` | refunds table schema | **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 [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | object\_id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | object\_updated | | **Useful links** | [Shippo documentation](https://goshippo.com/docs/reference#shipments "Opens in new tab: Shippo documentation")


[shipments schema on GitHub](https://github.com/singer-io/tap-shippo/blob/master/tap_shippo/schemas/shipments.json "Opens in new tab: shipments schema on GitHub")


[Shippo API method](https://goshippo.com/docs/reference?version=2016-10-25#shipments-list "Opens in new tab: Shippo API method") | shipments table foreign keys | Join shipments with | on | | --- | --- | | [addresses](https://help.qlik.com/en-US/stitch/integrations/saas/shippo#addresses) | ```
shipments.object_from = addresses.object_id
```

```
shipments.object_to = addresses.object_id
```

```
shipments.object_return = addresses.object_id
``` | | [parcels](https://help.qlik.com/en-US/stitch/integrations/saas/shippo#parcels) | ```
shipments.object_parcel = parcels.object_id
``` | shipments table schema | **carrier\_accounts**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | --- | | **customs\_declaration**


STRING | | **extra**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **insurance\_amount**


STRING | | **insurance\_currency**


STRING | | **messages**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **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

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **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 [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | object\_id | | **Useful links** | [Shippo documentation](https://goshippo.com/docs/reference#transactions "Opens in new tab: Shippo documentation")


[transactions schema on GitHub](https://github.com/singer-io/tap-shippo/blob/master/tap_shippo/schemas/transactions.json "Opens in new tab: transactions schema on GitHub")


[Shippo API method](https://goshippo.com/docs/reference?version=2016-10-25#transactions-list "Opens in new tab: Shippo API method") | transactions table foreign keys | Join transactions with | on | | --- | --- | | [refunds](https://help.qlik.com/en-US/stitch/integrations/saas/shippo#refunds) | ```
transactions.object_id = refunds.transaction
``` | transactions table schema | **commercial\_invoice\_url**


STRING | | --- | | **label\_url**


STRING | | **messages**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **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

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **tracking\_number**


STRING | | **tracking\_status**


STRING | | **tracking\_url\_provider**


STRING |