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_shiphero
in 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:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
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
Replication Method : |
Key-based Incremental |
Replication Key |
updated_from:updated_to |
Primary Key |
id |
API endpoint : |
The orders
table contains info about the orders in your ShipHero account.
id
The order ID. Reference: |
||||||||||||||||||||||||||
account_id
The customer’s account ID. |
||||||||||||||||||||||||||
adult_signature_required
Indicates if an adult’s signature is required. |
||||||||||||||||||||||||||
alcohol
Indicates if alcohol is included in the order. |
||||||||||||||||||||||||||
allocation_priority
|
||||||||||||||||||||||||||
allow_partial
|
||||||||||||||||||||||||||
allow_split
|
||||||||||||||||||||||||||
billing_address
The customer’s billing address.
|
||||||||||||||||||||||||||
created_at
The time the order was created. |
||||||||||||||||||||||||||
currency
The currency of the order. |
||||||||||||||||||||||||||
discount
|
||||||||||||||||||||||||||
expected_weight_in_oz
|
||||||||||||||||||||||||||
flagged
|
||||||||||||||||||||||||||
fraudscore
|
||||||||||||||||||||||||||
fraudscore_details
|
||||||||||||||||||||||||||
fulfillment_status
|
||||||||||||||||||||||||||
gift_invoice
|
||||||||||||||||||||||||||
gift_note
|
||||||||||||||||||||||||||
has_dry_ice
|
||||||||||||||||||||||||||
hold_shipment_until
|
||||||||||||||||||||||||||
holds
|
||||||||||||||||||||||||||
ignore_address_validation_errors
|
||||||||||||||||||||||||||
insurance
Indicates if the order has insurance. |
||||||||||||||||||||||||||
insurance_amount
The amount of insurance associated with the order. |
||||||||||||||||||||||||||
invoice
|
||||||||||||||||||||||||||
line_items
Details about the line items in the order.
|
||||||||||||||||||||||||||
lock_data
|
||||||||||||||||||||||||||
order_date
The date of the order. |
||||||||||||||||||||||||||
order_history
|
||||||||||||||||||||||||||
order_number
The order number. |
||||||||||||||||||||||||||
packing_note
|
||||||||||||||||||||||||||
partner_order_id
|
||||||||||||||||||||||||||
payment_method
The payment method associated with the order. |
||||||||||||||||||||||||||
priority_flag
|
||||||||||||||||||||||||||
profile
|
||||||||||||||||||||||||||
requested_delivery_at
The requested delivery date for the order. |
||||||||||||||||||||||||||
require_signature
Indicates if a signature is required for the order. |
||||||||||||||||||||||||||
required_ship_date
The required ship date for the order. |
||||||||||||||||||||||||||
saturday_delivery
|
||||||||||||||||||||||||||
shipping_address
|
||||||||||||||||||||||||||
shipping_lines
Details about the shipping lines in the order.
|
||||||||||||||||||||||||||
shipping_price
The price of shipping for the order. |
||||||||||||||||||||||||||
shop_name
The shop name associated with the order. |
||||||||||||||||||||||||||
source
The source of the order. |
||||||||||||||||||||||||||
subtotal
The subtotal of the order. |
||||||||||||||||||||||||||
tags
Tags that have been applied to the order.
orders (table), tags (attribute)
|
||||||||||||||||||||||||||
third_party_shipper
|
||||||||||||||||||||||||||
total_price
The total of the order. |
||||||||||||||||||||||||||
total_tax
The total tax on the order. |
||||||||||||||||||||||||||
updated_at
The time the order was last updated. |
products
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
API endpoint : |
The products
table contains info about the products in your ShipHero account.
id
Reference: |
||||||||||||||||||||||
updated_at
The time the product was last updated. |
||||||||||||||||||||||
account_id
|
||||||||||||||||||||||
active
Indicates if the product is active. |
||||||||||||||||||||||
barcode
The product’s barcode. |
||||||||||||||||||||||
brand
The brand of the product. |
||||||||||||||||||||||
country_of_manufacture
The country of manufucture for the product. |
||||||||||||||||||||||
created_at
The time the product was created. |
||||||||||||||||||||||
custom
|
||||||||||||||||||||||
customs_description
The description of the product for customs. |
||||||||||||||||||||||
customs_value
The value of the product for customs. |
||||||||||||||||||||||
do_not_count
|
||||||||||||||||||||||
dropship
|
||||||||||||||||||||||
final_sale
Indicates if the product is final sale. |
||||||||||||||||||||||
height
The height of the product. |
||||||||||||||||||||||
ignore_on_customs
|
||||||||||||||||||||||
ignore_on_invoice
|
||||||||||||||||||||||
images
Images associated with the product.
|
||||||||||||||||||||||
kit
The kit associated with the product. |
||||||||||||||||||||||
kit_build
|
||||||||||||||||||||||
kit_components
The components of the kit associated with the order.
|
||||||||||||||||||||||
length
The length of the product. |
||||||||||||||||||||||
name
The name of the product. |
||||||||||||||||||||||
no_air
|
||||||||||||||||||||||
option
|
||||||||||||||||||||||
price
The price of the product. |
||||||||||||||||||||||
product_note
|
||||||||||||||||||||||
reorder_amount
|
||||||||||||||||||||||
reorder_level
|
||||||||||||||||||||||
reserve_inventory
|
||||||||||||||||||||||
sku
The SKU of the product. |
||||||||||||||||||||||
tags
Tags associated with the product.
products (table), tags (attribute)
|
||||||||||||||||||||||
tariff_code
|
||||||||||||||||||||||
thumbnail
|
||||||||||||||||||||||
value
|
||||||||||||||||||||||
value_currency
|
||||||||||||||||||||||
virtual
Indicates if the product is digital. |
||||||||||||||||||||||
warehouses
Details about the warehoues associated with the product.
|
||||||||||||||||||||||
weight
The weight of the product. |
||||||||||||||||||||||
weight_in_oz
The weight of the product in ounces. |
||||||||||||||||||||||
width
The width of the product. |
shipments
Replication Method : |
Key-based Incremental |
Replication Key |
updated_from:updated_to |
Primary Key |
shipment_id |
API endpoint : |
The shipments
table contains info about the shipments in your ShipHero account.
shipment_id
The shipment ID. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
carrier
The carrier associated with the shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
date
The date of the shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
height
The height of the shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
label_cost
The cost of the shipping label. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
length
The length of the shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
line_items
Details about the line items in the shipment.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
method
The shipping method. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order
Details about the order associated with the shipment.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order_id
The ID of the order associated with the shipment. Reference: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order_number
The order number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipper_email
The shipper email. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipper_id
The shipper ID. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_name
The shipping name. For example: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
The status of the shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tracking
The tracking number for the shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
warehouse
The warehouse associated with the shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
weight
The weight of the shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
width
The width of the shipment. |
vendors
Replication Method : |
Full Table |
Primary Key |
vendor_id |
API endpoint : |
The vendors
table contains info about the vendors in your ShipHero account.
vendor_id
The vendor ID. |
email
The vendor email. |
name
The vendor name. |
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.