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

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

  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 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:

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:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.

  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue 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.
  1. Click into the integration from the Stitch Dashboard page.

  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.

  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

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

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

orders

View table schema on GitHub
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.

orders table schema

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
OBJECT

The customer’s billing address.

Click to expand billing_address

address1
STRING

The first line of the address.

address2
STRING

The second line of the address.

city
STRING

The city of the address.

company
STRING

The company associated with the address.

country
STRING

The country of the address.

country_code
STRING

The country code.

email
STRING

The email address.

first_name
STRING

The first name.

last_name
STRING

The last name.

phone
STRING

The phone number of the address.

province
STRING

The province of the address.

province_code
STRING

The province code.

zip
STRING

The zip code.
orders (table), billing_address (attribute)

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
OBJECT

Click to expand holds

address
INTEGER

fraud
INTEGER

operator
INTEGER

payment
INTEGER

shipping_method
INTEGER

orders (table), holds (attribute)

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
ARRAY

Details about the line items in the order.

Click to expand line_items

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:

orders (table), line_items (attribute)

lock_data
OBJECT

order_date
DATE-TIME

The date of the order.

order_history
ARRAY

Click to expand order_history

created_at
DATE-TIME

information
STRING

username
STRING

orders (table), order_history (attribute)

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
OBJECT

Click to expand shipping_address

address1
STRING

The first line of the address.

address2
STRING

The second line of the address.

city
STRING

The city of the address.

company
STRING

The company associated with the address.

country
STRING

The country of the address.

country_code
STRING

The country code.

email
STRING

The email address.

first_name
STRING

The first name.

last_name
STRING

The last name.

phone
STRING

The phone number of the address.

province
STRING

The province of the address.

province_code
STRING

The province code.

zip
STRING

The zip code.
orders (table), shipping_address (attribute)

shipping_lines
OBJECT

Details about the shipping lines in the order.

Click to expand shipping_lines

carrier
STRING

The shipping carrier.

method
STRING

The shipping method.

title
STRING

The shipping title.
orders (table), shipping_lines (attribute)

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
ARRAY

Tags that have been applied to the order.

Click to expand tags

value
STRING

The tag applied to the order.
orders (table), tags (attribute)

third_party_shipper
OBJECT

Click to expand third_party_shipper

account_number
STRING

country
STRING

zip
STRING

orders (table), third_party_shipper (attribute)

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.

products

View table schema on GitHub
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.

products table schema

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
ARRAY

Images associated with the product.

Click to expand images

sort
INTEGER

The sort order of the image.

url
STRING

The URL of the image.
products (table), images (attribute)

kit
BOOLEAN

The kit associated with the product.

kit_build
BOOLEAN

kit_components
ARRAY

The components of the kit associated with the order.

Click to expand kit_components

quantity
INTEGER

The quantity.

sku
STRING

The SKU.
products (table), kit_components (attribute)

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
ARRAY

Tags associated with the product.

Click to expand tags

value
STRING

The tag.
products (table), tags (attribute)

tariff_code
STRING

thumbnail
STRING

value
NUMBER

value_currency
STRING

virtual
BOOLEAN

Indicates if the product is digital.

warehouses
ARRAY

Details about the warehoues associated with the product.

Click to expand warehouses

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
ARRAY

Click to expand purchase_orders

expected_date
DATE-TIME

po_id
STRING

quantity
INTEGER

quantity_received
INTEGER

sell_ahead
INTEGER

products (table), purchase_orders (attribute)

sell_ahead
NUMBER

value
NUMBER

value_currency
STRING

warehouse
STRING

warehouse_id
INTEGER

products (table), warehouses (attribute)

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.

shipments

View table schema on GitHub
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.

shipments table schema

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
ARRAY

Details about the line items in the shipment.

Click to expand line_items

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.
shipments (table), line_items (attribute)

method
STRING

The shipping method.

order
OBJECT

Details about the order associated with the shipment.

Click to expand order

authorizations
ARRAY

Details about the authorizations associated with the order.

Click to expand authorizations

authorized_amount
NUMBER

The authorized amount.

card_type
STRING

The card type.

date
DATE-TIME

The date of the authorization.

postauthed_amount
NUMBER

refunded_amount
NUMBER

The refunded amount.

transaction_id
STRING

The transaction ID.
shipments (table), authorizations (attribute)

fulfillment_status
STRING

The fulfillment status of the order.

id
INTEGER

The ID of the order associated with the shipment.

Reference:

line_items
ARRAY

Details about the line items in the order.

Click to expand line_items

id
INTEGER

The line item ID.

backorder_quantity
INTEGER

barcode
STRING

The line item ID.

created_at
DATE-TIME

The date the line item was created.

custom_barcode
STRING

custom_options
STRING

customs_value
STRING

eligible_for_return
INTEGER

Indicates if the line 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_attributes
STRING

product_id
STRING

The product ID.

Reference:

quantity
INTEGER

The quantity of the product in the order.

quantity_allocated
INTEGER

quantity_pending_fulfillment
INTEGER

quantity_shipped
INTEGER

sku
STRING

The SKU.

subtotal
STRING

The subtotal for the line item.

thumbnail
STRING

updated_at
DATE-TIME

The date the line item was last updated.

warehouse
STRING

warehouse_id
INTEGER

The ID of the warehouse associated with the linte item.

Reference:

shipments (table), line_items (attribute)

note_attributes
ARRAY

Click to expand note_attributes

name
STRING

value
STRING

shipments (table), note_attributes (attribute)

order_date
DATE-TIME

The date of the order.

order_history
ARRAY

Click to expand order_history

created_at
DATE-TIME

information
STRING

username
STRING

shipments (table), order_history (attribute)

order_number
STRING

The order number.

partner_order_id
STRING

payment_method
STRING

The payment method associated with the order.

ready_to_ship
INTEGER

Indicates if the order is ready to ship.

shipping_address
OBJECT

Click to expand shipping_address

address1
STRING

The first line of the shipping address.

address2
STRING

The second line of the shipping address.

city
STRING

The city of the shipping address.

company
STRING

The company associated with the shipping address.

country
STRING

The country of the shipping address.

country_code
STRING

The country code.

email
STRING

The email address.

first_name
STRING

The first name.

last_name
STRING

The last name.

phone
STRING

The phone number of the shipping address.

province
STRING

The province of the shipping address.

province_code
STRING

The province code.

zip
STRING

The zip code.
shipments (table), shipping_address (attribute)

shipping_lines
OBJECT

Details about the shipping lines in the order.

Click to expand shipping_lines

carrier
STRING

The shipping carrier.

method
STRING

The shipping method.

price
NUMBER

The price of the shipping line.

title
STRING

The shipping title.
shipments (table), shipping_lines (attribute)

shop_name
STRING

The shop name associated with the order.

subtotal_price
STRING

The subtotal for the order.

tags
ARRAY

Tags applied to the order.

Click to expand tags

value
STRING

The tag.
shipments (table), tags (attribute)

total_discounts
NUMBER

The total discounts applied to the order.

total_price
STRING

The total cost of the order.

total_tax
STRING

The total tax applied to the order.
shipments (table), order (attribute)

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.

vendors

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

vendor_id
API endpoint :

List vendors

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

vendors table schema

vendor_id
INTEGER

The vendor ID.

email
STRING

The vendor email.

name
STRING

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.