Integration Management

Updated on February 23rd, 2023

+ More

Order Destinations

ShipHero API Updates - July 31st, 2020

In July 2019 ShipHero announced they would be deprecating their old API system and transitioning to a new GraphQL interface. This new ShipHero interface is a different communication system than Extensiv Integration Manager has historically used and carries new requirements and features for data transactions. Please read this article carefully to understand how this could impact your connection between our two systems.

ShipHero is deprecating the API July 31st but the connection will continue to work until September 1st. This means that you can continue using the old system until 09/01 after which it will cease to function. ShipHero will not provide support for the legacy API connection after July 31st.

What this means for Integration Manager accounts

On July 17th Integration Manager will make the new ShipHero connection available for accounts looking to transition. Although accounts can technically continue using the legacy connection up until September 1st users are encouraged to migrate to the new interface as soon as possible. You can find our guide for setting the new ShipHero connection here.

We will continue to provide service and support for the legacy API connection after the July 31st date but can not support it past the hard deadline of September 1st. After that date, ShipHero will disable all ability to retrieve or send data over the legacy system. To avoid interruptions to service accounts must change to the new interface before that date.

Connection differences

Integration Manager's current primary goal is to make sure that all features formerly supported using the legacy connection will continue to be available on this new system. All settings and features on the deprecated system have been set up to work with the new GraphQL interface with the exception of order cancellation. The ability to detect canceled orders and send order cancellations to ShipHero will be released at a later date. If you have any concerns about support for a feature through this new interface please reach out to Integration Manager support for more information.

New authentication method

To authenticate using the updated ShipHero you will need to provide a Bearer token and a Refresh token. Our guide on how to locate those can be found here.

3PL accounts

Fulfillment (3PL) accounts using ShipHero will want to review a new setting at the merchant level. Previously the API Keys used to connect to ShipHero were linked to a specific Shop and Customer Record in the ShipHero system. With the new authentication method there is no link between customer or shop and API Key. Fulfillment accounts that want to continue designating orders for specific customer accounts or shops will need to edit the Customer Account Email and Default Shop Name fields in their Merchant Settings for each merchant.

It is also recommended that a new Third-Party Developer user is created in ShipHero for each individual merchant. This will help keep each client's order flow separate from the others and decrease the possibility for future problems. Information on setting up a Third-Party developer can be found here.

Will this affect any recent orders?

Upgrading your ShipHero connection will not affect any orders that have already been sent for fulfillment. Integration Manager will still be able to download the shipping data and return it to your order sources. You will have continuous order coverage with the upgrade.