ShipHero - Gather API Credentials

Neil G · Updated

DropStream connects to ShipHero with two credentials, both generated in the ShipHero app:

  • Access Token
  • Refresh Token

DropStream reads the Customer Account ID from the Access Token, so you don’t need to collect it separately.

Heads up: ShipHero no longer creates API tokens from a username and password. Generate them in the ShipHero web app instead. Some tokens created the old way have stopped working. If your ShipHero connection has stopped sending orders or importing tracking, generate new tokens and update them in DropStream.

Step 1: Choose the ShipHero user

A token can do only what its ShipHero user is allowed to do. If that user is missing a permission, the matching DropStream actions fail.

We recommend a dedicated user for DropStream, such as dropstream@yourcompany.com, rather than a person’s own login. The connection then keeps working if that person’s role changes or they leave.

In ShipHero, open Users & Roles (shipping.shiphero.com/users) and make sure the user’s role allows:

DropStream needs to… ShipHero access the user needs
Send orders to ShipHero Create and edit orders
Bring tracking back to your sales channels View shipments
Sync stock levels View products / inventory
Connect and list your warehouses View account and warehouses

The user also needs Public API access turned on.

Step 2: Generate the tokens

  1. Sign in to ShipHero as an admin and open Users & Roles (shipping.shiphero.com/users).
  2. Edit the user you chose in Step 1.
  3. In the API Access section, generate an Access Token and a Refresh Token.
  4. Copy both tokens and keep them somewhere secure. Anyone who has them can act on your ShipHero account.

Then enter the tokens in DropStream. See ShipHero - Enable API Access.

Troubleshooting

“User does not have permissions to access …” or “User has no permission for resource”. The token’s ShipHero user lacks a permission DropStream needs. Generating a new token for the same user won’t fix this. Either add the missing permission to the user’s role under Users & Roles, or generate tokens for a user that already has it and update them in DropStream.

“Public API access is disabled for this user”. Turn on API access for the user in ShipHero, then try again.

“Unable to find appropriate key”. Your tokens were created before ShipHero’s authentication change and no longer work. DropStream can’t renew them automatically. Generate new tokens (Step 2) and update them in DropStream.

“Token not found” or 401 Unauthorized. The token was revoked or mistyped. Generate new tokens and update them in DropStream.

For help with ShipHero users and roles, contact ShipHero support.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.