DOCS >INTEGRATIONS >SAAS >SHIPHERO (V1)

Get started with a free trial today

Already have an account? Sign in

ShipHero (v1)

ShipHero is supported by the Singer community
This integration is powered bySinger's ShipHero tap. For support,visit the GitHub repo orjoin the Singer Slack.

ShipHero integration summary

Stitch’s ShipHero integration replicates data using theShipHero API (v1.2). Refer to theSchema section for a list of objects available for replication.

ShipHero feature snapshot

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

STITCH
Release status	Released on March 8, 2019	Supported by	Singer Community
Stitch plan	Standard	API availability	Available
Singer GitHub repository	singer-io/tap-shiphero
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Supported
Table-level reset	Unsupported	Configurable Replication Methods	Unsupported
DATA SELECTION
Table selection	Supported	Column selection	Supported
Select all	Supported
TRANSPARENCY
Extraction Logs	Supported	Loading Reports	Supported

Connecting ShipHero

Step 1: Generate a ShipHero API token

Sign into yourShipHero account.
Using the top menu in ShipHero, clickMy Account > Settings > API.
On theAPI Credentials page, click into theShop Name field and enter the name of the shop you want to use.
Click theAdd button to generate the API credentials.

TheAPI Key on this page is what you’ll need to complete the setup in Stitch.

Step 2: Add ShipHero as a Stitch data source

Sign into your Stitch account.
On the Stitch Dashboard page, click theAdd Integration button.
Click theShipHero icon.
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 ShipHero” would create a schema calledstitch_shiphero in the destination.Note: Schema names cannot be changed after you save the integration.
In theShipHero Token field, paste the value from theAPI Key field in ShipHero.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your ShipHero 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 ShipHero’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

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to theReplication Scheduling documentation for more information.

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.

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

Step 5: Set objects to replicate

Is an object missing or not replicating? Verify that the object meets the requirements forselection andreplication.

The last step is to select the tables and columns you want to replicate.Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For ShipHero integrations, you can select:

Individual tables and columns
All tables and columns

Click the tabs to view instructions for each selection method.

In the integration’sTables to Replicate tab, locate a table you want to replicate.
To track a table, click thecheckbox next to the table’s name. A blue checkmark means the table is set to replicate.
To track a column, click thecheckbox next to the column’s name. A blue checkmark means the column is set to replicate.
Repeat this process for all the tables and columns you want to replicate.
When finished, click theFinalize Your Selections button at the bottom of the screen to save your selections.

Important: Using theSelect All feature will overwrite any previous selections. However, selections aren’t final untilFinalize Your Selections is clicked. ClickingCancel will restore your previous selections.Refer to theSelect All guide for more info about this feature.

Click into the integration from the Stitch Dashboard page.
Click theTables to Replicate tab.
In the list of tables, click the box next to theTable Names column.
In the menu that displays, clickTrack all Tables and Fields:
Click theFinalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up ShipHero, 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.

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 theAnchor Scheduling 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.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure topause ordelete the integration to prevent unwanted usage.

ShipHero table reference

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 forversion 1 of this integration.

This is the latest version of the ShipHero integration.

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 theLoading Guide for your destination for more info.

orders

Theorders table contains info about the orders in your ShipHero account.

Replication Method

Key-based Incremental

Primary Key

Useful links

orders schema on GitHub

ShipHero API method

orders table foreign keys

Join orders with	on
shipments	orders.id = shipments.order_id orders.id = shipments.order.id orders.line_items.product_id = shipments.order.line_items.product_id orders.line_items.warehouse_id = shipments.order.line_items.warehouse_id
products	orders.line_items.product_id = products.id orders.line_items.warehouse_id = products.warehouses.warehouse_id

Join orders with

shipments

orders.id = shipments.order_id

orders.id = shipments.order.id

orders.line_items.product_id = shipments.order.line_items.product_id

orders.line_items.warehouse_id = shipments.order.line_items.warehouse_id

products

orders.line_items.product_id = products.id

orders.line_items.warehouse_id = products.warehouses.warehouse_id

orders table schema

account_id

INTEGER

adult_signature_required

INTEGER

alcohol

INTEGER

allocation_priority

INTEGER

allow_partial

INTEGER

allow_split

INTEGER

billing_address

OBJECT

Click to expand billing_address

address1

STRING

address2

STRING

city

STRING

company

STRING

country

STRING

country_code

STRING

email

STRING

first_name

STRING

last_name

STRING

phone

STRING

province

STRING

province_code

STRING

zip

STRING

created_at

DATE-TIME

currency

STRING

discount

STRING

expected_weight_in_oz

NUMBER

flagged

INTEGER

fraudscore

INTEGER

fraudscore_details

STRING

fulfillment_status

STRING

gift_invoice

INTEGER

gift_note

STRING

has_dry_ice

INTEGER

hold_shipment_until

DATE-TIME

holds

OBJECT

Click to expand holds

address

INTEGER

fraud

INTEGER

operator

INTEGER

payment

INTEGER

shipping_method

INTEGER

ignore_address_validation_errors

INTEGER

insurance

INTEGER

insurance_amount

INTEGER

invoice

STRING

line_items

ARRAY

Click to expand line_items

backorder_quantity

INTEGER

barcode

STRING

created_at

DATE-TIME

custom_barcode

STRING

custom_options

STRING

customs_value

STRING

eligible_for_return

INTEGER

fulfillment_status

STRING

INTEGER

large_thumbnail

STRING

locked_to_warehouse_id

INTEGER

name

STRING

option_title

STRING

partner_line_item_id

STRING

price

STRING

product_id

STRING

quantity

INTEGER

quantity_allocated

INTEGER

quantity_pending_fulfillment

INTEGER

quantity_shipped

INTEGER

sku

STRING

subtotal

STRING

thumbnail

STRING

updated_at

DATE-TIME

warehouse

STRING

warehouse_id

INTEGER

lock_data

OBJECT

order_date

DATE-TIME

order_history

ARRAY

Click to expand order_history

created_at

DATE-TIME

information

STRING

username

STRING

order_number

STRING

packing_note

STRING

partner_order_id

STRING

payment_method

STRING

priority_flag

INTEGER

profile

STRING

requested_delivery_at

DATE-TIME

require_signature

INTEGER

required_ship_date

DATE-TIME

saturday_delivery

INTEGER

shipping_address

OBJECT

Click to expand shipping_address

address1

STRING

address2

STRING

city

STRING

company

STRING

country

STRING

email

STRING

first_name

STRING

last_name

STRING

phone

STRING

province

STRING

zip

STRING

shipping_lines

OBJECT

Click to expand shipping_lines

carrier

STRING

method

STRING

title

STRING

shipping_price

NUMBER

shop_name

STRING

source

STRING

subtotal

STRING

tags

ARRAY

third_party_shipper

OBJECT

Click to expand third_party_shipper

account_number

STRING

country

STRING

zip

STRING

total_price

STRING

total_tax

STRING

updated_at

DATE-TIME

products

Theproducts table contains info about the products in your ShipHero account.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	updated_at
Useful links	products schema on GitHub ShipHero API method

products table foreign keys

Join products with	on
orders	products.id = orders.line_items.product_id products.warehouses.warehouse_id = orders.line_items.warehouse_id
shipments	products.id = shipments.order.line_items.product_id products.warehouses.warehouse_id = shipments.order.line_items.warehouse_id

Join products with

orders

products.id = orders.line_items.product_id

products.warehouses.warehouse_id = orders.line_items.warehouse_id

shipments

products.id = shipments.order.line_items.product_id

products.warehouses.warehouse_id = shipments.order.line_items.warehouse_id

products table schema

account_id

INTEGER

active

BOOLEAN

barcode

STRING

brand

STRING

country_of_manufacture

STRING

created_at

DATE-TIME

custom

INTEGER

customs_description

STRING

customs_value

NUMBER

do_not_count

BOOLEAN

dropship

INTEGER

final_sale

BOOLEAN

height

NUMBER

INTEGER

ignore_on_customs

BOOLEAN

ignore_on_invoice

BOOLEAN

images

ARRAY

Click to expand images

sort

INTEGER

url

STRING

kit

BOOLEAN

kit_build

BOOLEAN

kit_components

ARRAY

Click to expand kit_components

quantity

INTEGER

sku

STRING

length

NUMBER

name

STRING

no_air

BOOLEAN

option

STRING

price

NUMBER

product_note

STRING

reorder_amount

INTEGER

reorder_level

INTEGER

reserve_inventory

INTEGER

sku

STRING

tags

ARRAY

tariff_code

STRING

thumbnail

STRING

updated_at

DATE-TIME

value

NUMBER

value_currency

STRING

virtual

BOOLEAN

warehouses

ARRAY

Click to expand warehouses

active

NUMBER

allocated

INTEGER

available

NUMBER

backorder

INTEGER

customs_value

NUMBER

INTEGER

inventory_bin

STRING

inventory_overstock_bin

STRING

name

STRING

on_hand

INTEGER

price

NUMBER

purchase_orders

ARRAY

Click to expand purchase_orders

expected_date

DATE-TIME

po_id

STRING

quantity

INTEGER

quantity_received

INTEGER

sell_ahead

INTEGER

sell_ahead

NUMBER

value

NUMBER

value_currency

STRING

warehouse

STRING

warehouse_id

INTEGER

weight

NUMBER

weight_in_oz

NUMBER

width

NUMBER

shipments

Theshipments table contains info about the shipments in your ShipHero account.

Replication Method

Key-based Incremental

Primary Key

shipment_id

Useful links

shipments schema on GitHub

ShipHero API method

shipments table foreign keys

Join shipments with	on
orders	shipments.order_id = orders.id shipments.order.id = orders.id shipments.order.line_items.product_id = orders.line_items.product_id shipments.order.line_items.warehouse_id = orders.line_items.warehouse_id
products	shipments.order.line_items.product_id = products.id shipments.order.line_items.warehouse_id = products.warehouses.warehouse_id

Join shipments with

orders

shipments.order_id = orders.id

shipments.order.id = orders.id

shipments.order.line_items.product_id = orders.line_items.product_id

shipments.order.line_items.warehouse_id = orders.line_items.warehouse_id

products

shipments.order.line_items.product_id = products.id

shipments.order.line_items.warehouse_id = products.warehouses.warehouse_id

shipments table schema

carrier

STRING

date

DATE-TIME

height

NUMBER

label_cost

NUMBER

length

NUMBER

line_items

ARRAY

Click to expand line_items

line_item_id

STRING

partner_line_item_id

STRING

quantity

INTEGER

shipment_line_item_id

STRING

sku

STRING

method

STRING

order

OBJECT

Click to expand order

authorizations

ARRAY

Click to expand authorizations

authorized_amount

NUMBER

card_type

STRING

date

DATE-TIME

postauthed_amount

NUMBER

refunded_amount

NUMBER

transaction_id

STRING

fulfillment_status

STRING

INTEGER

line_items

ARRAY

Click to expand line_items

backorder_quantity

INTEGER

barcode

STRING

created_at

DATE-TIME

custom_barcode

STRING

custom_options

STRING

customs_value

STRING

eligible_for_return

INTEGER

fulfillment_status

STRING

INTEGER

large_thumbnail

STRING

locked_to_warehouse_id

INTEGER

name

STRING

option_title

STRING

partner_line_item_id

STRING

price

STRING

product_attributes

STRING

product_id

STRING

quantity

INTEGER

quantity_allocated

INTEGER

quantity_pending_fulfillment

INTEGER

quantity_shipped

INTEGER

sku

STRING

subtotal

STRING

thumbnail

STRING

updated_at

DATE-TIME

warehouse

STRING

warehouse_id

INTEGER

note_attributes

ARRAY

Click to expand note_attributes

name

STRING

value

STRING

order_date

DATE-TIME

order_history

ARRAY

Click to expand order_history

created_at

DATE-TIME

information

STRING

username

STRING

order_number

STRING

partner_order_id

STRING

payment_method

STRING

ready_to_ship

INTEGER

shipping_address

OBJECT

Click to expand shipping_address

address1

STRING

address2

STRING

city

STRING

company

STRING

country

STRING

country_code

STRING

email

STRING

first_name

STRING

last_name

STRING

phone

STRING

province

STRING

province_code

STRING

zip

STRING

shipping_lines

OBJECT

Click to expand shipping_lines

carrier

STRING

method

STRING

price

NUMBER

title

STRING

shop_name

STRING

subtotal_price

STRING

tags

ARRAY, STRING

total_discounts

NUMBER

total_price

STRING

total_tax

STRING

order_id

STRING

order_number

STRING

shipment_id

STRING

shipper_email

STRING

shipper_id

STRING

shipping_name

STRING

status

STRING

tracking

STRING

warehouse

STRING

weight

NUMBER

width

NUMBER

vendors

Thevendors table contains info about the vendors in your ShipHero account.

Replication Method

Full Table

Primary Key

vendor_id

Useful links

vendors schema on GitHub

ShipHero API method

vendors table schema

email

STRING

name

STRING

vendor_id

INTEGER

Related	Troubleshooting
Destination & Integration Compatibility Replication Scheduling Syncing Historical SaaS Data Resetting Replication Keys Nested Data Structures & Row Count Impact	Third-Party Downtime Understanding & Reducing Your Usage Re-Authorizing Integrations Replication Issues

Questions? Feedback?

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.

Movatterモバイル変換

ShipHero (v1)

ShipHero integration summary

ShipHero feature snapshot

Connecting ShipHero

Step 1: Generate a ShipHero API token

Step 2: Add ShipHero as a Stitch data source

Step 3: Define the historical replication start date

Step 4: Create a replication schedule

Step 5: Set objects to replicate

Initial and historical replication jobs

Free historical data loads

ShipHero table reference

orders

orders table foreign keys

orders table schema

products

products table foreign keys

products table schema

shipments

shipments table foreign keys

shipments table schema

vendors

vendors table schema