API Users and Roles

Cory M. Updated by Cory M.

To manage API users go to System > API. This article will instruct users on:

  • Overview of the ShipStream API
  • Creating API Users
  • Creating API Roles

Overview of the ShipStream API

The ShipStream API is has useful endpoints for developers to directly tap into live ShipStream data such as orders and inventory. Developers implementing applications using the ShipStream API should consult the ShipStream API Docs. This article describes how to manage API Users and API Roles which are the credentials needed to authenticate a third-party system with your ShipStream WMS.

Creating API Users

There can be any number of API Users unique to each merchant, which allows for merchants to directly interact with a 3PL's data.

Follow these steps to create an API user:

  1. Navigate to System > API.
  2. Click Add New User.
  3. Select an existing User or create a new one by clicking Add New User.
  4. Select a Merchant to associate this API user with.
  5. Choose a User Name that will be used to connect with the API from the external system.
  6. Fill out the First and Last Name and Email in case ShipStream needs to contact you regarding the usage of the API.
  7. Choose an API Key to act as a password for access to your ShipStream data.
  8. Click on the left side menu item User Role, and choose the role with the correct permissions for this user.
  9. Click Save User.
A new API Key can be chosen at any time, but the selected Merchant cannot be changed.

Creating API Roles

If you would like to provide API access to a third-party that has restricted permissions, you can create a new API Role and assign it to an API User. Create a role by following these steps:

  1. Navigate to System > API.
  2. Click API Roles at the top right of the screen.
  3. Click Add New Role.
  4. Assign the role a Name, and define which permissions to grant the role under Role Resources.
    1. The options in Resource Access are "All" or "Custom". Choosing All will grant all permissions to the role, and choosing Custom will allow users to pick the permissions from a tree view that mirrors the main navigation menu options.
    2. For example, if admin users wish to grant API access for the role to Retrieve Orders Info, but not actually create or modify the orders in anyway, they should select Custom and only check the box next to "Retrieve orders info" under the Sales > Order tree item.
  5. Once the API Role is defined click Save Role, admin users can create a new API User to have these permissions.

How did we do?

External Shipping Method API