ShipHero snapshot

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

STITCH
Release Status

Open Beta

Supported By

Singer Community

Stitch Plan

Free

Singer GitHub Repository

ShipHero Repository

DATA SELECTION
Table Selection

Supported

Column Selection

Supported

REPLICATION SETTINGS
Anchor Scheduling

Supported

Table-level Reset

Unsupported

Configurable Replication Methods

Unsupported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting ShipHero

Step 1: Generate a ShipHero API token

  1. Sign into your ShipHero account.
  2. Using the top menu in ShipHero, click My Account > Settings > API.
  3. On the API Credentials page, click into the Shop Name field and enter the name of the shop you want to use.
  4. 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

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the ShipHero 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 ShipHero” would create a schema called stitch_shiphero in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the ShipHero Token field, paste the value from the API Key field in ShipHero.

Step 3: Define the historical sync

The Sync Historical Data setting will define the starting date for your ShipHero integration. This means that:

  • For tables using Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
  • 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 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.

Stitch offers two methods of creating a replication schedule:

  • Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
  • Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:

    • A Replication Frequency of at least one hour is required to use anchor scheduling.
    • An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

To help prevent overages, 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 tables and columns to replicate

To complete the setup, you’ll need to select the tables and columns you want to replicate to your data warehouse.

Check out the Schema section to learn more about the available tables in ShipHero and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A green checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

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.

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 schemas

Replication Method :

Key-based Incremental

Replication Key :

updated_from:updated_to

Primary Key :

id

API endpoint :

Get orders

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

id
INTEGER

The order ID.

Reference:

account_id
INTEGER

The customer’s account ID.

adult_signature_required
INTEGER

Indicates if an adult’s signature is required.

alcohol
INTEGER

Indicates if alcohol is included in the order.

allocation_priority
INTEGER
allow_partial
INTEGER
allow_split
INTEGER
billing_address__address1
STRING

The first line of the billing address.

billing_address__address2
STRING

The second line of the billing address.

billing_address__city
STRING

The city of the billing address.

billing_address__company
STRING

The company associated with the billing address.

billing_address__country
STRING

The country of the billing address.

billing_address__country_code
STRING

The country code.

billing_address__email
STRING

The email address.

billing_address__first_name
STRING

The first name.

billing_address__last_name
STRING

The last name.

billing_address__phone
STRING

The phone number of the billing address.

billing_address__province
STRING

The province of the billing address.

billing_address__province_code
STRING

The province code.

billing_address__zip
STRING

The zip code.

created_at
DATE-TIME

The time the order was created.

currency
STRING

The currency of the order.

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__address
INTEGER
holds__fraud
INTEGER
holds__operator
INTEGER
holds__payment
INTEGER
holds__shipping_method
INTEGER
ignore_address_validation_errors
INTEGER
insurance
INTEGER

Indicates if the order has insurance.

insurance_amount
INTEGER

The amount of insurance associated with the order.

invoice
STRING
line_items

Details about the line items in the order.

If your destination doesn't natively support nested data, this data may be denested into a subtable named orders__line_items. Refer to the Singer schema for details on possible attributes.

_sdc_source_key_id
INTEGER

The order ID.

_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

id
INTEGER

The line item ID.

backorder_quantity
INTEGER
barcode
STRING

The barcode associated with the line item.

created_at
DATE-TIME

The time the line item was created.

custom_barcode
STRING

The custom barcode associated with the line item.

custom_options
STRING
customs_value
STRING
eligible_for_return
INTEGER

Indicates if the item is eligible for return.

fulfillment_status
STRING

The fulfillment status of the line item.

large_thumbnail
STRING
locked_to_warehouse_id
INTEGER
name
STRING

The name of the line item.

option_title
STRING
partner_line_item_id
STRING
price
STRING

The price of the line item.

product_id
STRING

The product ID of the line item.

Reference:

quantity
INTEGER

The quantity of the item in the order.

quantity_allocated
INTEGER

The allocated quantity of the line item.

quantity_pending_fulfillment
INTEGER

The quantity pending fulfillment.

quantity_shipped
INTEGER

The quantity that has been shipped.

sku
STRING

The SKU associated with the line item.

subtotal
STRING

The subtotal of the line item. This is calculated as price x quantity.

thumbnail
STRING
updated_at
DATE-TIME

The time the line item was last updated.

warehouse
STRING
warehouse_id
INTEGER

Reference:

order_date
DATE-TIME

The date of the order.

order_history

If your destination doesn't natively support nested data, this data may be denested into a subtable named orders__order_history. Refer to the Singer schema for details on possible attributes.

_sdc_source_key_id
INTEGER

The order ID.

_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

created_at
DATE-TIME
information
STRING
username
STRING
order_number
STRING

The order number.

packing_note
STRING
partner_order_id
STRING
payment_method
STRING

The payment method associated with the order.

priority_flag
INTEGER
profile
STRING
requested_delivery_at
DATE-TIME

The requested delivery date for the order.

require_signature
INTEGER

Indicates if a signature is required for the order.

required_ship_date
DATE-TIME

The required ship date for the order.

saturday_delivery
INTEGER
shipping_address__address1
STRING

The first line of the shipping address.

shipping_address__address2
STRING

The second line of the shipping address.

shipping_address__city
STRING

The city of the shipping address.

shipping_address__company
STRING

The company associated with the shipping address.

shipping_address__country
STRING

The country of the shipping address.

shipping_address__country_code
STRING

The country code.

shipping_address__email
STRING

The email address.

shipping_address__first_name
STRING

The first name.

shipping_address__last_name
STRING

The last name.

shipping_address__phone
STRING

The phone number of the shipping address.

shipping_address__province
STRING

The province of the shipping address.

shipping_address__province_code
STRING

The province code.

shipping_address__zip
STRING

The zip code.

shipping_lines__carrier
STRING

The shipping carrier.

shipping_lines__method
STRING

The shipping method.

shipping_lines__title
STRING

The shipping title.

shipping_price
NUMBER

The price of shipping for the order.

shop_name
STRING

The shop name associated with the order.

source
STRING

The source of the order.

subtotal
STRING

The subtotal of the order.

tags

Tags that have been applied to the order.

If your destination doesn't natively support nested data, this data may be denested into a subtable named orders__tags. Refer to the Singer schema for details on possible attributes.

_sdc_source_key_id
INTEGER

The order ID.

_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

value
STRING

The tag applied to the order.

third_party_shipper__account_number
STRING
third_party_shipper__country
STRING
third_party_shipper__zip
STRING
total_price
STRING

The total of the order.

total_tax
STRING

The total tax on the order.

updated_at
DATE-TIME

The time the order was last updated.


Replication Method :

Key-based Incremental

Replication Key :

updated_at

Primary Key :

id

API endpoint :

Get products

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

id
INTEGER

Reference:

updated_at
DATE-TIME

The time the product was last updated.

account_id
INTEGER
active
BOOLEAN

Indicates if the product is active.

barcode
STRING

The product’s barcode.

brand
STRING

The brand of the product.

country_of_manufacture
STRING

The country of manufucture for the product.

created_at
DATE-TIME

The time the product was created.

custom
INTEGER
customs_description
STRING

The description of the product for customs.

customs_value
NUMBER

The value of the product for customs.

do_not_count
BOOLEAN
dropship
INTEGER
final_sale
BOOLEAN

Indicates if the product is final sale.

height
NUMBER

The height of the product.

ignore_on_customs
BOOLEAN
ignore_on_invoice
BOOLEAN
images

Images associated with the product.

If your destination doesn't natively support nested data, this data may be denested into a subtable named products__images. Refer to the Singer schema for details on possible attributes.

_sdc_source_key_id
INTEGER
_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

sort
INTEGER

The sort order of the image.

url
STRING

The URL of the image.

kit
BOOLEAN

The kit associated with the product.

kit_build
BOOLEAN
kit_components

The components of the kit associated with the order.

If your destination doesn't natively support nested data, this data may be denested into a subtable named products__kit_components. Refer to the Singer schema for details on possible attributes.

_sdc_source_key_id
INTEGER
_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

quantity
INTEGER

The quantity.

sku
STRING

The SKU.

length
NUMBER

The length of the product.

name
STRING

The name of the product.

no_air
BOOLEAN
option
STRING
price
NUMBER

The price of the product.

product_note
STRING
reorder_amount
INTEGER
reorder_level
INTEGER
reserve_inventory
INTEGER
sku
STRING

The SKU of the product.

tags

Tags associated with the product.

If your destination doesn't natively support nested data, this data may be denested into a subtable named products__tags. Refer to the Singer schema for details on possible attributes.

_sdc_source_key_id
INTEGER
_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

value
STRING

The tag.

tariff_code
STRING
thumbnail
STRING
value
NUMBER
value_currency
STRING
virtual
BOOLEAN

Indicates if the product is digital.

warehouses

Details about the warehoues associated with the product.

If your destination doesn't natively support nested data, this data may be denested into a subtable named products__warehouses. Refer to the Singer schema for details on possible attributes.

_sdc_source_key_id
INTEGER
_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

id
INTEGER

The warehouse ID.

Reference:

active
NUMBER

Indicates if the warehouse is active.

allocated
INTEGER
available
NUMBER
backorder
INTEGER
customs_value
NUMBER
inventory_bin
STRING
inventory_overstock_bin
STRING
name
STRING
on_hand
INTEGER
price
NUMBER
purchase_orders

If your destination doesn't natively support nested data, this data may be denested into a subtable named products__warehouses__purchase_orders. Refer to the Singer schema for details on possible attributes.

sell_ahead
NUMBER
value
NUMBER
value_currency
STRING
warehouse
STRING
warehouse_id
INTEGER
weight
NUMBER

The weight of the product.

weight_in_oz
NUMBER

The weight of the product in ounces.

width
NUMBER

The width of the product.


Replication Method :

Key-based Incremental

Replication Key :

updated_from:updated_to

Primary Key :

shipment_id

API endpoint :

Get shipments

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

shipment_id
STRING

The shipment ID.

carrier
STRING

The carrier associated with the shipment.

date
DATE-TIME

The date of the shipment.

height
NUMBER

The height of the shipment.

label_cost
NUMBER

The cost of the shipping label.

length
NUMBER

The length of the shipment.

line_items

Details about the line items in the shipment.

If your destination doesn't natively support nested data, this data may be denested into a subtable named shipments__line_items. Refer to the Singer schema for details on possible attributes.

_sdc_source_key_shipment_id
STRING

The shipment ID.

_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

line_item_id
STRING

The line item ID.

partner_line_item_id
STRING

The partner line item ID.

quantity
INTEGER

The quantity.

shipment_line_item_id
STRING

The shipment line item ID.

sku
STRING

The SKU.

method
STRING

The shipping method.

order__authorizations

Details about the order associated with the shipment.

If your destination doesn't natively support nested data, this data may be denested into a subtable named shipments__order__authorizations. Refer to the Singer schema for details on possible attributes.

order__fulfillment_status
STRING

The fulfillment status of the order.

order__id
INTEGER

The ID of the order associated with the shipment.

Reference:

order__line_items

Details about the order associated with the shipment.

If your destination doesn't natively support nested data, this data may be denested into a subtable named shipments__order__line_items. Refer to the Singer schema for details on possible attributes.

order__note_attributes

Details about the order associated with the shipment.

If your destination doesn't natively support nested data, this data may be denested into a subtable named shipments__order__note_attributes. Refer to the Singer schema for details on possible attributes.

order__order_date
DATE-TIME

The date of the order.

order__order_history

Details about the order associated with the shipment.

If your destination doesn't natively support nested data, this data may be denested into a subtable named shipments__order__order_history. Refer to the Singer schema for details on possible attributes.

order__order_number
STRING

The order number.

order__partner_order_id
STRING
order__payment_method
STRING

The payment method associated with the order.

order__ready_to_ship
INTEGER

Indicates if the order is ready to ship.

order__shipping_address__address1
STRING

The first line of the shipping address.

order__shipping_address__address2
STRING

The second line of the shipping address.

order__shipping_address__city
STRING

The city of the shipping address.

order__shipping_address__company
STRING

The company associated with the shipping address.

order__shipping_address__country
STRING

The country of the shipping address.

order__shipping_address__country_code
STRING

The country code.

order__shipping_address__email
STRING

The email address.

order__shipping_address__first_name
STRING

The first name.

order__shipping_address__last_name
STRING

The last name.

order__shipping_address__phone
STRING

The phone number of the shipping address.

order__shipping_address__province
STRING

The province of the shipping address.

order__shipping_address__province_code
STRING

The province code.

order__shipping_address__zip
STRING

The zip code.

order__shipping_lines__carrier
STRING

The shipping carrier.

order__shipping_lines__method
STRING

The shipping method.

order__shipping_lines__price
NUMBER

The price of the shipping line.

order__shipping_lines__title
STRING

The shipping title.

order__shop_name
STRING

The shop name associated with the order.

order__subtotal_price
STRING

The subtotal for the order.

order__tags

Details about the order associated with the shipment.

If your destination doesn't natively support nested data, this data may be denested into a subtable named shipments__order__tags. Refer to the Singer schema for details on possible attributes.

order__total_discounts
NUMBER

The total discounts applied to the order.

order__total_price
STRING

The total cost of the order.

order__total_tax
STRING

The total tax applied to the order.

order_id
STRING

The ID of the order associated with the shipment.

Reference:

order_number
STRING

The order number.

shipper_email
STRING

The shipper email.

shipper_id
STRING

The shipper ID.

shipping_name
STRING

The shipping name. For example: UPS Ground

status
STRING

The status of the shipment.

tracking
STRING

The tracking number for the shipment.

warehouse
STRING

The warehouse associated with the shipment.

weight
NUMBER

The weight of the shipment.

width
NUMBER

The width of the shipment.


Replication Method :

Full Table

Primary Key :

vendor_id

API endpoint :

List vendors

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

vendor_id
INTEGER

The vendor ID.

email
STRING

The vendor email.

name
STRING

The vendor name.



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.