This integration is powered by Singer's ShipHero tap. For support, visit the GitHub repo or join the Singer Slack.
ShipHero integration summary
Stitch’s ShipHero integration replicates data using the ShipHero API (v1.2). Refer to the Schema 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 | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| 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 your ShipHero account.
- Using the top menu in ShipHero, click My Account > Settings > API.
- On the API Credentials page, click into the Shop Name field and enter the name of the shop you want to use.
- Click the Add button to generate the API credentials.
The API 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 the Add Integration button.
-
Click the ShipHero 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 called
stitch_shipheroin the destination. Note: Schema names cannot be changed after you save the integration. - In the ShipHero Token field, paste the value from the API 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 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 ShipHero’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.
ShipHero integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (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 for tips on reducing your usage.
Step 5: Set objects to replicate
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’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox 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 the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize 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, 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.
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 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.
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 for version 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 the Loading Guide for your destination for more info.
orders
The orders table contains info about the orders in your ShipHero account.
|
Key-based Incremental |
|
|
Primary Key |
id |
| Useful links |
| 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 |
|
account_id INTEGER |
||||||||||||||||||||||||||
|
adult_signature_required INTEGER |
||||||||||||||||||||||||||
|
alcohol INTEGER |
||||||||||||||||||||||||||
|
allocation_priority INTEGER |
||||||||||||||||||||||||||
|
allow_partial INTEGER |
||||||||||||||||||||||||||
|
allow_split INTEGER |
||||||||||||||||||||||||||
|
billing_address OBJECT
|
||||||||||||||||||||||||||
|
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
|
||||||||||||||||||||||||||
|
id
INTEGER |
||||||||||||||||||||||||||
|
ignore_address_validation_errors INTEGER |
||||||||||||||||||||||||||
|
insurance INTEGER |
||||||||||||||||||||||||||
|
insurance_amount INTEGER |
||||||||||||||||||||||||||
|
invoice STRING |
||||||||||||||||||||||||||
|
line_items ARRAY
|
||||||||||||||||||||||||||
|
lock_data OBJECT |
||||||||||||||||||||||||||
|
order_date DATE-TIME |
||||||||||||||||||||||||||
|
order_history ARRAY
|
||||||||||||||||||||||||||
|
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
|
||||||||||||||||||||||||||
|
shipping_lines OBJECT
|
||||||||||||||||||||||||||
|
shipping_price NUMBER |
||||||||||||||||||||||||||
|
shop_name STRING |
||||||||||||||||||||||||||
|
source STRING |
||||||||||||||||||||||||||
|
subtotal STRING |
||||||||||||||||||||||||||
|
tags ARRAY |
||||||||||||||||||||||||||
|
third_party_shipper OBJECT
|
||||||||||||||||||||||||||
|
total_price STRING |
||||||||||||||||||||||||||
|
total_tax STRING |
||||||||||||||||||||||||||
|
updated_at DATE-TIME |
products
The products table contains info about the products in your ShipHero account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
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 |
||||||||||||||||||||||
|
id
INTEGER |
||||||||||||||||||||||
|
ignore_on_customs BOOLEAN |
||||||||||||||||||||||
|
ignore_on_invoice BOOLEAN |
||||||||||||||||||||||
|
images ARRAY
|
||||||||||||||||||||||
|
kit BOOLEAN |
||||||||||||||||||||||
|
kit_build BOOLEAN |
||||||||||||||||||||||
|
kit_components ARRAY
|
||||||||||||||||||||||
|
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
|
||||||||||||||||||||||
|
weight NUMBER |
||||||||||||||||||||||
|
weight_in_oz NUMBER |
||||||||||||||||||||||
|
width NUMBER |
shipments
The shipments table contains info about the shipments in your ShipHero account.
|
Key-based Incremental |
|
|
Primary Key |
shipment_id |
| Useful links |
| 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 |
|
carrier STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
date DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
height NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
label_cost NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
length NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
line_items ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
method STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
order OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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
The vendors table contains info about the vendors in your ShipHero account.
|
Full Table |
|
|
Primary Key |
vendor_id |
| Useful links |
|
STRING |
|
name STRING |
|
vendor_id
INTEGER |
| Related | Troubleshooting |
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.