A Third-Party Developer user (or developer user) is a ShipHero user created for an external integration that connects to the ShipHero GraphQL Public API. When you create a developer user, ShipHero generates the API Access Token and Refresh Token the integration uses to connect. These tokens are sometimes called API keys or API credentials.
Before You Begin
- Unique email: The developer user needs an email address that no other ShipHero user has. The same email cannot be used for more than one user.
- Account: Create the developer user in the ShipHero account the integration needs to access. API tokens only work in the account where they were created.
Developer user or regular user? Use a developer user when a third-party integration or a custom-built app needs its own API tokens. To connect an AI assistant through the ShipHero MCP or the ShipHero Public API Skill, give a regular ShipHero user API access instead. See How to Create and Manage Users in ShipHero and Overview: ShipHero AI Toolkit.
How to Create a ShipHero Developer User and Get API Tokens
Create a developer user from the Developer Users page. ShipHero shows the new developer user's API Access Token and Refresh Token as soon as the user is created.
- Go to the My Account > Developer Users page.
-
Select Add Third-Party Developer at the top of the Developer Users page.
- Enter the developer's First Name, Last Name, and Email, then select Add Developer.
- Copy the API Access Token and Refresh Token that appear, and send them to your developer.
The ShipHero API Access Token Is Only Shown Once
ShipHero displays the API Access Token only once, right after the developer user is created. Copy it before you leave the page. If you lose the Access Token, or it expires, use the Refresh Token to generate a new one.
To give a developer user access to Recurring Data Exports, select Enable Data Exports on the Developer Users page. See How to Give Users Access to Recurring Data Exports.
ShipHero API Token Expiration and Account Rules
ShipHero API Access Tokens expire after 28 days. Refresh Tokens stay active as long as the account is active. These rules apply to every developer user:
- The Refresh Token remains active and does not change as long as the associated account is active.
- The API Access Token expires after 28 days. Use the Refresh Token to generate a new Access Token. For the request format, see the ShipHero developer documentation.
- API tokens are tied to the account where they were created and only work in that account.
- When an account is canceled, suspended, or inactive, its tokens do not work, even if generating a token appears successful.
- Create a separate developer user for each third-party integration to avoid account-related problems.