ShipStation

ShipStation is a cloud-based shipment platform that streamlines the shipping process for online retailers. It provides order processing, inventory management, creation of shipping labels, and customer communication all into one easy-to-use interface. It can be integrated directly with sellers (online or offline). It also allows you to track the shipment status and manage returns for an order.

ShipStation authenticates API requests from Hevo to access your account data with HTTP Basic authentication where the username is your API key and password is your API secret.


Prerequisites

  • An active ShipStation account from which data is to be ingested.

  • An API key and secret are available to authenticate Hevo on your ShipStation account. Refer to section, Obtaining the API Key and Secret for the steps to generate the API key and secret.

  • You are logged in as an Admin user, to obtain the API key and secret. You can also log in as a user who has the required privileges for obtaining the API key and secret.


Obtaining the API Key and Secret

You must generate your API keys to authenticate Hevo on your ShipStation account. These API keys do not expire and can be reused for all your Pipelines.

To generate the API Key and secret:

  1. Log in to your ShipStation account.

  2. In the top right of the page, click the Account icon.

    Account ShipStation

  3. From the drop-down menu, click My Profile.

  4. In the left navigation pane, under Account, click API Settings.

    Nav Bar

  5. In the API Settings page, under API Keys section, click Generate API Keys.

    Generate API Keys

You have successfully created your API key and secret. Use the API key and secret for creating Hevo Pipelines.


Configuring ShipStation as a Source

Perform the following steps to configure ShipStation as the Source in your Pipeline:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select ShipStation.

  4. In the Configure your ShipStation Source page, specify the following:

    ShipStation config

  5. Click TEST & CONTINUE.

  6. Proceed to configuring the data ingestion and setting up the Destination.


Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
1 hr 1 hr 24 hrs 1-24

Note: You must set the custom frequency in hours as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

  • Historical Data: In the first run of the Pipeline, Hevo ingests all historical data for the supported objects and loads it to the Destination.

  • Incremental Data: Once the historical load is complete, all new and updated records for the Fulfillments, Orders, and Shipments objects are synchronized with your Destination according to the ingestion frequency.


Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination database:


Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Object Mode Description
Carriers Full Load Contains the details of all the shipping provider companies connected to your ShipStation account.
Customers Full Load Contains the details of individuals or organizations who have placed an order.
Fulfillments Incremental Contains the details of orders that are shipped.
Marketplaces Full Load Contains the details of all the sellers that you can integrate with your ShipStation account.
Orders Incremental Contains the details of all orders placed by customers.
Packages Full Load Contains the list of orders available for shipment by a specific carrier.
Products Full Load Contains the details of items available for sale in the stores that are integrated with your ShipStation account.
Services Full Load Contains the list of shipping methods available for a carrier.
Shipments Incremental Contains the details of all orders for which shipping labels have been generated in your ShipStation account.
Stores Full Load Contains the details of all sellers integrated with your ShipStation account.
Users Full Load Contains the list of users that can access your ShipStation account.
Warehouses Full Load Contains the details of the locations where the order is shipped from or returned to.

Source Considerations

  • Pagination: An API response for each ShipStation object fetches one page with up to 500 records.

  • Rate Limit: ShipStation imposes a limit of a maximum of 40 API calls per minute per API key and secret to ensure that their system remains stable for usage by all users. Read API Rate Limits to know more about rate limits in ShipStation, and configure a suitable ingestion frequency for your Pipeline.

  • ShipStation supports the Pacific Standard Time (PST), and not UTC, due to which Hevo displays the position of the incremental objects in PST.


Limitations

  • Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.

  • Hevo does not provide you with the option to select the historical sync duration for loading historical data. All the historical data in your ShipStation account is loaded.


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Oct-25-2022 2.00 New document.
Last updated on 23 Nov 2022

Tell us what went wrong